/usr/share/doc/git-buildpackage/apidocs/gbp.config.GbpOptionParser-class.html is in git-buildpackage 0.6.9.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>gbp.config.GbpOptionParser</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="https://honk.sigxcpu.org/piki/projects/git-buildpackage/">git-buildpackage</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="gbp-module.html">Package gbp</a> ::
<a href="gbp.config-module.html">Module config</a> ::
Class GbpOptionParser
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="gbp.config.GbpOptionParser-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class GbpOptionParser</h1><p class="nomargin-top"></p>
<pre class="base-tree">
optparse.OptionContainer --+
|
optparse.OptionParser --+
|
<strong class="uidshort">GbpOptionParser</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="gbp.config.GbpOptionParserDebian-class.html">GbpOptionParserDebian</a></li> </ul>
</dd></dl>
<hr />
<p>Handles commandline options and parsing of config files</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_parse_config_files"></a><span class="summary-sig-name">_parse_config_files</span>(<span class="summary-sig-arg">self</span>)</span><br />
Parse the possible config files and set appropriate values default
values</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="gbp.config.GbpOptionParser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">command</span>,
<span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">usage</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">sections</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_is_boolean"></a><span class="summary-sig-name">_is_boolean</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">dummy</span>,
<span class="summary-sig-arg">*unused</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
is option_name a boolean option</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_get_bool_default"></a><span class="summary-sig-name">_get_bool_default</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">option_name</span>)</span><br />
get default for boolean options this way we can handle no-foo=True
and foo=False</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_default"></a><span class="summary-sig-name">get_default</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">option_name</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
get the default value</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="gbp.config.GbpOptionParser-class.html#add_config_file_option" class="summary-sig-name">add_config_file_option</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">option_name</span>,
<span class="summary-sig-arg">dest</span>,
<span class="summary-sig-arg">help</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
set a option for the command line parser, the default is read from
the config file</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="add_boolean_config_file_option"></a><span class="summary-sig-name">add_boolean_config_file_option</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">option_name</span>,
<span class="summary-sig-arg">dest</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>optparse.OptionParser</code></b>:
<code>add_option_group</code>,
<code>check_values</code>,
<code>destroy</code>,
<code>disable_interspersed_args</code>,
<code>enable_interspersed_args</code>,
<code>error</code>,
<code>exit</code>,
<code>expand_prog_name</code>,
<code>format_epilog</code>,
<code>format_help</code>,
<code>format_option_help</code>,
<code>get_default_values</code>,
<code>get_description</code>,
<code>get_option_group</code>,
<code>get_prog_name</code>,
<code>get_usage</code>,
<code>get_version</code>,
<code>parse_args</code>,
<code>print_help</code>,
<code>print_usage</code>,
<code>print_version</code>,
<code>set_default</code>,
<code>set_defaults</code>,
<code>set_process_default_values</code>,
<code>set_usage</code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>optparse.OptionParser</code></b> (private):
<code>_add_help_option</code>,
<code>_add_version_option</code>,
<code>_create_option_list</code>,
<code>_get_all_options</code>,
<code>_get_args</code>,
<code>_get_encoding</code>,
<code>_init_parsing_state</code>,
<code>_match_long_opt</code>,
<code>_populate_option_list</code>,
<code>_process_args</code>,
<code>_process_long_opt</code>,
<code>_process_short_opts</code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>optparse.OptionContainer</code></b>:
<code>add_option</code>,
<code>add_options</code>,
<code>format_description</code>,
<code>get_option</code>,
<code>has_option</code>,
<code>remove_option</code>,
<code>set_conflict_handler</code>,
<code>set_description</code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>optparse.OptionContainer</code></b> (private):
<code>_check_conflict</code>,
<code>_create_option_mappings</code>,
<code>_share_option_mappings</code>
</p></div>
</td>
</tr>
</table>
<!-- ==================== CLASS METHODS ==================== -->
<a name="section-ClassMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>list</code>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>conf_backup = os.getenv(<span class="py-string">'GBP_CONF_FILES'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">if</span> conf_backup <span class="py-keyword">is</span> <span class="py-keyword">not</span> None: <span class="py-keyword">del</span> os.environ[<span class="py-string">'GBP_CONF_FILES'</span>]
<span class="py-prompt">>>> </span>files = GbpOptionParser.get_config_files()</pre>
<p># Remove the ~-expanded one >>> del files[1] >>>
files ['/etc/git-buildpackage/gbp.conf', '.gbp.conf',
'debian/gbp.conf', '.git/gbp.conf']</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>os.environ[<span class="py-string">'GBP_CONF_FILES'</span>] = <span class="py-string">'test1:test2'</span>
<span class="py-prompt">>>> </span>GbpOptionParser.get_config_files()
<span class="py-output">['test1', 'test2']</span>
<span class="py-output"></span><span class="py-prompt">>>> </span><span class="py-keyword">del</span> os.environ[<span class="py-string">'GBP_CONF_FILES'</span>]
<span class="py-prompt">>>> </span><span class="py-keyword">if</span> conf_backup <span class="py-keyword">is</span> <span class="py-keyword">not</span> None: os.environ[<span class="py-string">'GBP_CONF_FILES'</span>] = conf_backup</pre></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="gbp.config.GbpOptionParser-class.html#get_config_files" class="summary-sig-name">get_config_files</a>(<span class="summary-sig-arg">klass</span>)</span><br />
Get list of config files from the <i>GBP_CONF_FILES</i> environment
variable.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<a href="gbp.config.GbpOptionParser-class.html#defaults" class="summary-name">defaults</a> = <code title="{'allow-unauthenticated': 'False',
'arch': '',
'author-date-is-committer-date': 'False',
'author-is-committer': 'False',
'color': 'auto',
'color-scheme': '',
'commit-msg': 'Update changelog for %(version)s release',
'compression': 'auto',
..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">allow-unauthenticated</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">False</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">arch</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">aut</code><code class="variable-ellipsis">...</code></code><br />
defaults value of an option if not in the config file or given on the
command line
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<a href="gbp.config.GbpOptionParser-class.html#help" class="summary-name">help</a> = <code title="{'allow-unauthenticated': 'Don\'t verify integrity of downloaded sourc\
e, default is \'%(allow-unauthenticated)s\'',
'arch': 'Build for this architecture when using git-pbuilder, default\
is \'%(arch)s\'',
'author-date-is-committer-date': 'Use the authors\'s date as the comi\
tter\'s date, default is \'%(author-date-is-committer-date)s\'',
'author-is-committer': 'Use the authors\'s name also as the comitter\\
's name, default is \'%(author-is-committer)s\'',
..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">allow-unauthenticated</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Don\'t verify integrity of d</code><code class="variable-ellipsis">...</code></code><br />
help messages
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list</span>
</td><td class="summary">
<a href="gbp.config.GbpOptionParser-class.html#def_config_files" class="summary-name">def_config_files</a> = <code title="['/etc/git-buildpackage/gbp.conf',
'~/.gbp.conf',
'.gbp.conf',
'debian/gbp.conf',
'.git/gbp.conf']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">/etc/git-buildpackage/gbp.conf</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">~/.gbp.</code><code class="variable-ellipsis">...</code></code><br />
list of default config files we parse
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>optparse.OptionParser</code></b>:
<code>standard_option_list</code>
</p>
</td>
</tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">string</span>
</td><td class="summary">
<a name="command"></a><span class="summary-name">command</span><br />
the gbp command we store the options for
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">dict</span>
</td><td class="summary">
<a name="config"></a><span class="summary-name">config</span><br />
current configuration parameters
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">string</span>
</td><td class="summary">
<a name="prefix"></a><span class="summary-name">prefix</span><br />
prefix to prepend to all commandline options
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="get_config_files"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_config_files</span>(<span class="sig-arg">klass</span>)</span>
<br /><em class="fname">Class Method</em>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Get list of config files from the <i>GBP_CONF_FILES</i> environment
variable.</p>
<dl class="fields">
<dt>Returns: <code>list</code>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>conf_backup = os.getenv(<span class="py-string">'GBP_CONF_FILES'</span>)
<span class="py-prompt">>>> </span><span class="py-keyword">if</span> conf_backup <span class="py-keyword">is</span> <span class="py-keyword">not</span> None: <span class="py-keyword">del</span> os.environ[<span class="py-string">'GBP_CONF_FILES'</span>]
<span class="py-prompt">>>> </span>files = GbpOptionParser.get_config_files()</pre>
<p># Remove the ~-expanded one >>> del files[1] >>>
files ['/etc/git-buildpackage/gbp.conf', '.gbp.conf',
'debian/gbp.conf', '.git/gbp.conf']</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>os.environ[<span class="py-string">'GBP_CONF_FILES'</span>] = <span class="py-string">'test1:test2'</span>
<span class="py-prompt">>>> </span>GbpOptionParser.get_config_files()
<span class="py-output">['test1', 'test2']</span>
<span class="py-output"></span><span class="py-prompt">>>> </span><span class="py-keyword">del</span> os.environ[<span class="py-string">'GBP_CONF_FILES'</span>]
<span class="py-prompt">>>> </span><span class="py-keyword">if</span> conf_backup <span class="py-keyword">is</span> <span class="py-keyword">not</span> None: os.environ[<span class="py-string">'GBP_CONF_FILES'</span>] = conf_backup</pre></dt>
<dd>list of config files we need to parse</dd>
</dl>
</td></tr></table>
</div>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">command</span>,
<span class="sig-arg">prefix</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="sig-arg">usage</span>=<span class="sig-default">None</span>,
<span class="sig-arg">sections</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>command</code></strong> (<code>str</code>) - the command to build the config parser for</li>
<li><strong class="pname"><code>prefix</code></strong> (<code>str</code>) - A prefix to add to all command line options</li>
<li><strong class="pname"><code>usage</code></strong> (<code>str</code>) - a usage description</li>
<li><strong class="pname"><code>sections</code></strong> (<code>list</code> of <code>str</code>) - additional (non optional) config file sections to parse</li>
</ul></dd>
<dt>Overrides:
optparse.OptionContainer.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="add_config_file_option"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">add_config_file_option</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">option_name</span>,
<span class="sig-arg">dest</span>,
<span class="sig-arg">help</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>set a option for the command line parser, the default is read from the
config file</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>option_name</code></strong> (string) - name of the option</li>
<li><strong class="pname"><code>dest</code></strong> (string) - where to store this option</li>
<li><strong class="pname"><code>help</code></strong> (string) - help text</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variable Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariableDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="defaults"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">defaults</h3>
defaults value of an option if not in the config file or given on the
command line
<dl class="fields">
<dt>Type:</dt>
<dd>dict</dd>
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">allow-unauthenticated</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">False</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">arch</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">author-date-is-committer-date</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">False</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">author-is-committer</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">False</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">color</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">auto</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">color-scheme</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">commit-msg</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Update changelog for %(version)s release</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">compression</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">auto</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="help"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">help</h3>
help messages
<dl class="fields">
<dt>Type:</dt>
<dd>dict</dd>
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">allow-unauthenticated</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Don\'t verify integrity of downloaded sourc</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">e, default is \'%(allow-unauthenticated)s\'</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">arch</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Build for this architecture when using git-pbuilder, default</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string"> is \'%(arch)s\'</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">author-date-is-committer-date</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Use the authors\'s date as the comi</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">tter\'s date, default is \'%(author-date-is-committer-date)s\'</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">author-is-committer</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">Use the authors\'s name also as the comitter\</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">'s name, default is \'%(author-is-committer)s\'</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="def_config_files"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">def_config_files</h3>
list of default config files we parse
<dl class="fields">
<dt>Type:</dt>
<dd>list</dd>
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">/etc/git-buildpackage/gbp.conf</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">~/.gbp.conf</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">.gbp.conf</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">debian/gbp.conf</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">.git/gbp.conf</code><code class="variable-quote">'</code><code class="variable-group">]</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="https://honk.sigxcpu.org/piki/projects/git-buildpackage/">git-buildpackage</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sat Feb 15 17:52:06 2014
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|