/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/help_topics/en/configuration.txt

  • Committer: Shannon Weyrick
  • Date: 2011-11-16 20:59:10 UTC
  • mto: This revision was merged to the branch mainline in revision 6268.
  • Revision ID: weyrick@mozek.us-20111116205910-1xbpqbimbw3fvfqw
A version of the patch, based on suggestions from John Meinel, which detects an empty page differently to avoid false positives.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/configuration.txt
14
14
 
15
15
  "John Doe <jdoe@example.com>"
16
16
 
17
 
See also the ``email`` configuration value.
 
17
See also the ``email`` configuration option.
18
18
 
19
19
BZR_PROGRESS_BAR
20
20
~~~~~~~~~~~~~~~~
21
21
 
22
 
Override the progress display.  Possible values are "none", "dots", "tty"
 
22
Override the progress display.  Possible values are "none" or "text".  If
 
23
the value is "none" then no progress bar is displayed.  The value "text" draws
 
24
the ordinary command line progress bar.
23
25
 
24
26
BZR_SIGQUIT_PDB
25
27
~~~~~~~~~~~~~~~
52
54
 
53
55
Path to the Bazaar executable to use when using the bzr+ssh protocol.
54
56
 
55
 
See also the ``bzr_remote_path`` configuration value.
 
57
See also the ``bzr_remote_path`` configuration option.
56
58
 
57
59
BZR_EDITOR
58
60
~~~~~~~~~~
59
61
 
60
62
Path to the editor Bazaar should use for commit messages, etc.
61
63
 
 
64
BZR_LOG
 
65
~~~~~~~
 
66
 
 
67
Location of the Bazaar log file. You can check the current location by
 
68
running ``bzr version``.
 
69
 
 
70
The log file contains debug information that is useful for diagnosing or
 
71
reporting problems with Bazaar.
 
72
 
 
73
Setting this to ``NUL`` on Windows or ``/dev/null`` on other platforms
 
74
will disable logging.
 
75
 
 
76
 
62
77
BZR_PLUGIN_PATH
63
78
~~~~~~~~~~~~~~~
64
79
 
77
92
 
78
93
As for the ``PATH`` variables, if multiple directories are
79
94
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
80
 
platform specific appropriate character (':' on Unix/Linux/etc,
 
95
platform specific appropriate character (':' on Unix,
81
96
';' on windows)
82
97
 
83
98
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
166
181
The path where Bazaar should look for shell plugin external commands.
167
182
 
168
183
 
 
184
http_proxy, https_proxy
 
185
~~~~~~~~~~~~~~~~~~~~~~~
 
186
 
 
187
Specifies the network proxy for outgoing connections, for example::
 
188
 
 
189
  http_proxy=http://proxy.example.com:3128/ 
 
190
  https_proxy=http://proxy.example.com:3128/
 
191
 
 
192
 
169
193
Configuration files
170
194
-------------------
171
195
 
172
196
Location
173
197
~~~~~~~~
174
198
 
175
 
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
 
199
Configuration files are located in ``$HOME/.bazaar`` on Unix and
176
200
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
177
201
Windows. (You can check the location for your system by using
178
202
``bzr version``.)
197
221
~~~~~~~~~~~~~~
198
222
 
199
223
An ini file has three types of contructs: section headers, section
200
 
variables and comments.
 
224
options and comments.
201
225
 
202
226
Comments
203
227
^^^^^^^^
216
240
 
217
241
The only valid section headers for bazaar.conf currently are [DEFAULT] and
218
242
[ALIASES].  Section headers are case sensitive. The default section provides for
219
 
setting variables which can be overridden with the branch config file.
 
243
setting options which can be overridden with the branch config file.
220
244
 
221
 
For ``locations.conf``, the variables from the section with the
 
245
For ``locations.conf``, the options from the section with the
222
246
longest matching section header are used to the exclusion of other
223
247
potentially valid section headers. A section header uses the path for
224
248
the branch as the section header. Some examples include::
227
251
    [/home/jdoe/branches/]
228
252
 
229
253
 
230
 
Section variables
231
 
^^^^^^^^^^^^^^^^^
 
254
Section options
 
255
^^^^^^^^^^^^^^^
232
256
 
233
 
A section variable resides within a section. A section variable contains a
234
 
variable name, an equals sign and a value.  For example::
 
257
A section option resides within a section. A section option contains an
 
258
option name, an equals sign and a value.  For example::
235
259
 
236
260
    email            = John Doe <jdoe@isp.com>
237
 
    check_signatures = require
238
 
 
239
 
 
240
 
Variable policies
241
 
^^^^^^^^^^^^^^^^^
242
 
 
243
 
Variables defined in a section affect the named directory or URL plus
244
 
any locations they contain.  Policies can be used to change how a
245
 
variable value is interpreted for contained locations.  Currently
 
261
    gpg_signing_key  = Amy Pond <amy@example.com>
 
262
 
 
263
A option can reference other options by enclosing them in curly brackets::
 
264
 
 
265
    my_branch_name = feature_x
 
266
    my_server      = bzr+ssh://example.com
 
267
    push_location   = {my_server}/project/{my_branch_name}
 
268
 
 
269
Option policies
 
270
^^^^^^^^^^^^^^^
 
271
 
 
272
Options defined in a section affect the named directory or URL plus
 
273
any locations they contain.  Policies can be used to change how an
 
274
option value is interpreted for contained locations.  Currently
246
275
there are three policies available:
247
276
 
248
277
 none:
255
284
   for contained locations, any additional path components are
256
285
   appended to the value.
257
286
 
258
 
Policies are specified by keys with names of the form "$var:policy".
 
287
Policies are specified by keys with names of the form "<option_name>:policy".
259
288
For example, to define the push location for a tree of branches, the
260
289
following could be used::
261
290
 
266
295
With this configuration, the push location for ``/top/location/branch1``
267
296
would be ``sftp://example.com/location/branch1``.
268
297
 
 
298
Section local options
 
299
^^^^^^^^^^^^^^^^^^^^^
 
300
 
 
301
Some options are defined automatically inside a given section and can be
 
302
refered to in this section only. 
 
303
 
 
304
For example, the ``appendpath`` policy can be used like this::
 
305
 
 
306
  [/home/vila/src/bzr/bugs]
 
307
  mypush = lp:~vila/bzr
 
308
  mypush:policy=appendpath
 
309
 
 
310
Using ``relpath`` to achieve the same result is done like this::
 
311
 
 
312
  [/home/vila/src/bzr/bugs]
 
313
  mypush = lp:~vila/bzr/{relpath}
 
314
 
 
315
In both cases, when used in a directory like
 
316
``/home/vila/src/bzr/bugs/832013-expand-in-stack`` we'll get::
 
317
 
 
318
   $ bzr config mypush
 
319
   lp:~vila/bzr/832013-expand-in-stack
 
320
 
 
321
When an option is local to a Section, it cannot be referred to from option
 
322
values in any other section from the same ``Store`` nor from any other
 
323
``Store``.
 
324
 
269
325
 
270
326
The main configuration file, bazaar.conf
271
327
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
280
336
    [DEFAULT]
281
337
    email             = John Doe <jdoe@isp.com>
282
338
    editor            = /usr/bin/vim
283
 
    check_signatures  = check-available
284
339
    create_signatures = when-required
285
340
 
286
341
 
298
353
 
299
354
    [http://hypothetical.site.com/branches/devel-branch]
300
355
    create_signatures = always
301
 
    check_signatures  = always
302
 
 
303
 
    [http://bazaar-vcs.org/bzr/*]
304
 
    check_signatures  = require
305
356
 
306
357
The authentication configuration file, authentication.conf
307
358
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
311
362
of bzr that requires authentication (smtp for example).
312
363
 
313
364
The syntax of the file obeys the same rules as the others except for the
314
 
variable policies which don't apply.
 
365
option policies which don't apply.
315
366
 
316
367
For more information on the possible uses of the authentication configuration
317
368
file see :doc:`authentication-help`.
318
369
 
319
370
 
320
 
Common variable options
321
 
-----------------------
 
371
Common options
 
372
--------------
322
373
 
323
374
debug_flags
324
375
~~~~~~~~~~~
329
380
 
330
381
    debug_flags = hpss
331
382
 
 
383
or::
 
384
 
 
385
    debug_flags = hpss,evil
 
386
 
332
387
email
333
388
~~~~~
334
389
 
355
410
check_signatures
356
411
~~~~~~~~~~~~~~~~
357
412
 
358
 
Defines the behavior for signatures.
 
413
Reserved for future use.  These options will allow a policy for branches to
 
414
require signatures.
359
415
 
360
416
require
361
417
    The gnupg signature for revisions must be present and must be valid.
371
427
create_signatures
372
428
~~~~~~~~~~~~~~~~~
373
429
 
374
 
Defines the behaviour of signing revisions.
 
430
Defines the behaviour of signing revisions on commits.  By default bzr will not
 
431
sign new commits.
375
432
 
376
433
always
377
 
    Sign every new revision that is committed.
 
434
    Sign every new revision that is committed.  If the signing fails then the
 
435
    commit will not be made.
378
436
 
379
437
when-required
380
 
    (default) Sign newly committed revisions only when the branch requires
381
 
    signed revisions.
 
438
    Reserved for future use.
382
439
 
383
440
never
384
 
    Refuse to sign newly committed revisions, even if the branch
385
 
    requires signatures.
 
441
    Reserved for future use.
 
442
 
 
443
In future it is planned that ``when-required`` will sign newly
 
444
committed revisions only when the branch requires them.  ``never`` will refuse
 
445
to sign newly committed revisions, even if the branch requires signatures.
 
446
 
 
447
dirstate.fdatasync
 
448
~~~~~~~~~~~~~~~~~~
 
449
 
 
450
If true (default), working tree metadata changes are flushed through the
 
451
OS buffers to physical disk.  This is somewhat slower, but means data
 
452
should not be lost if the machine crashes.  See also repository.fdatasync.
 
453
 
 
454
gpg_signing_key
 
455
~~~~~~~~~~~~~~~
 
456
 
 
457
The GnuPG user identity to use when signing commits.  Can be an e-mail
 
458
address, key fingerprint or full key ID.  When unset or when set to
 
459
"default" Bazaar will use the user e-mail set with ``whoami``.
386
460
 
387
461
recurse
388
462
~~~~~~~
405
479
 
406
480
    gpg_signing_command = /usr/bin/gnpg
407
481
 
 
482
The specified command must accept the options "--clearsign" and "-u <email>".
 
483
 
408
484
bzr_remote_path
409
485
~~~~~~~~~~~~~~~
410
486
 
431
507
These settings are only needed if the SMTP server requires authentication
432
508
to send mail.
433
509
 
 
510
locks.steal_dead
 
511
~~~~~~~~~~~~~~~~
 
512
 
 
513
If set to true, bzr will automatically break locks held by processes from
 
514
the same machine and user that are no longer alive.  Otherwise, it will
 
515
print a message and you can break the lock manually, if you are satisfied
 
516
the object is no longer in use.
 
517
 
434
518
mail_client
435
519
~~~~~~~~~~~
436
520
 
457
541
:mapi: Use your preferred e-mail client on Windows.
458
542
:xdg-email: Use xdg-email to run your preferred mail program
459
543
 
 
544
repository.fdatasync
 
545
~~~~~~~~~~~~~~~~~~~~
 
546
 
 
547
If true (default), repository changes are flushed through the OS buffers
 
548
to physical disk.  This is somewhat slower, but means data should not be
 
549
lost if the machine crashes.  See also dirstate.fdatasync.
 
550
 
460
551
submit_branch
461
552
~~~~~~~~~~~~~
462
553
 
482
573
    whether the format deprecation warning is shown on repositories that are
483
574
    using deprecated formats.
484
575
 
 
576
default_format
 
577
~~~~~~~~~~~~~~
 
578
 
 
579
A format name for the default format used when creating branches.  See ``bzr
 
580
help formats`` for possible values.
 
581
 
 
582
 
 
583
Unicode options
 
584
---------------
 
585
 
 
586
output_encoding
 
587
~~~~~~~~~~~~~~~
 
588
 
 
589
A Python unicode encoding name for text output from bzr, such as log
 
590
information.  Values include: utf8, cp850, ascii, iso-8859-1.  The default
 
591
is the terminal encoding prefered by the operating system.
 
592
 
485
593
 
486
594
Branch type specific options
487
595
----------------------------
504
612
parent_location
505
613
~~~~~~~~~~~~~~~
506
614
 
507
 
If present, the location of the default branch for pull or merge.
508
 
This option is normally set by ``pull --remember`` or ``merge
 
615
If present, the location of the default branch for pull or merge.  This option
 
616
is normally set when creating a branch, the first ``pull`` or by ``pull
509
617
--remember``.
510
618
 
511
619
push_location
512
620
~~~~~~~~~~~~~
513
621
 
514
622
If present, the location of the default branch for push.  This option
515
 
is normally set by ``push --remember``.
 
623
is normally set by the first ``push`` or ``push --remember``.
516
624
 
517
625
push_strict
518
626
~~~~~~~~~~~
545
653
If present, defines the ``--strict`` option default value for checking
546
654
uncommitted changes before sending a merge directive.
547
655
 
 
656
add.maximum_file_size
 
657
~~~~~~~~~~~~~~~~~~~~~
 
658
 
 
659
Defines the maximum file size the command line "add" operation will allow
 
660
in recursive mode, with files larger than this value being skipped. You may 
 
661
specify this value as an integer (in which case it is interpreted as bytes), 
 
662
or you may specify the value using SI units, i.e. 10KB, 20MB, 1G. A value of 0 
 
663
will disable skipping.
 
664
 
 
665
External Merge Tools
 
666
--------------------
 
667
 
 
668
bzr.mergetool.<name>
 
669
~~~~~~~~~~~~~~~~~~~~
 
670
 
 
671
Defines an external merge tool called <name> with the given command-line.
 
672
Arguments containing spaces should be quoted using single or double quotes. The
 
673
executable may omit its path if it can be found on the PATH.
 
674
 
 
675
The following markers can be used in the command-line to substitute filenames
 
676
involved in the merge conflict::
 
677
 
 
678
  {base}      file.BASE
 
679
  {this}      file.THIS
 
680
  {other}     file.OTHER
 
681
  {result}    output file
 
682
  {this_temp} temp copy of file.THIS, used to overwrite output file if merge
 
683
              succeeds.
 
684
 
 
685
For example::
 
686
 
 
687
  bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
 
688
 
 
689
bzr.default_mergetool
 
690
~~~~~~~~~~~~~~~~~~~~~
 
691
 
 
692
Specifies which external merge tool (as defined above) should be selected by
 
693
default in tools such as ``bzr qconflicts``.
 
694
 
 
695
For example::
 
696
 
 
697
  bzr.default_mergetool = kdiff3