241
241
The only valid section headers for bazaar.conf currently are [DEFAULT] and
242
242
[ALIASES]. Section headers are case sensitive. The default section provides for
243
setting variables which can be overridden with the branch config file.
243
setting options which can be overridden with the branch config file.
245
For ``locations.conf``, the variables from the section with the
245
For ``locations.conf``, the options from the section with the
246
246
longest matching section header are used to the exclusion of other
247
247
potentially valid section headers. A section header uses the path for
248
248
the branch as the section header. Some examples include::
251
251
[/home/jdoe/branches/]
257
A section variable resides within a section. A section variable contains a
258
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::
260
260
email = John Doe <jdoe@isp.com>
261
check_signatures = require
261
gpg_signing_key = Amy Pond <amy@example.com>
263
A variable can reference other variables **in the same configuration file** by
264
enclosing them in curly brackets::
263
A option can reference other options by enclosing them in curly brackets::
266
265
my_branch_name = feature_x
267
266
my_server = bzr+ssh://example.com
268
267
push_location = {my_server}/project/{my_branch_name}
274
Variables defined in a section affect the named directory or URL plus
275
any locations they contain. Policies can be used to change how a
276
variable value is interpreted for contained locations. Currently
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
277
275
there are three policies available:
286
284
for contained locations, any additional path components are
287
285
appended to the value.
289
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".
290
288
For example, to define the push location for a tree of branches, the
291
289
following could be used::
297
295
With this configuration, the push location for ``/top/location/branch1``
298
296
would be ``sftp://example.com/location/branch1``.
298
Section local options
299
^^^^^^^^^^^^^^^^^^^^^
301
Some options are defined automatically inside a given section and can be
302
refered to in this section only.
304
For example, the ``appendpath`` policy can be used like this::
306
[/home/vila/src/bzr/bugs]
307
mypush = lp:~vila/bzr
308
mypush:policy=appendpath
310
Using ``relpath`` to achieve the same result is done like this::
312
[/home/vila/src/bzr/bugs]
313
mypush = lp:~vila/bzr/{relpath}
315
In both cases, when used in a directory like
316
``/home/vila/src/bzr/bugs/832013-expand-in-stack`` we'll get::
319
lp:~vila/bzr/832013-expand-in-stack
321
Another such option is ``basename`` which can be used like this::
324
mypush = lp:~vila/bzr/{basename}
326
When used in a directory like
327
``/home/vila/src/bzr/bugs/832013-expand-in-stack`` we'll get::
330
lp:~vila/bzr/832013-expand-in-stack
332
Note that ``basename`` here refers to the base name of ``relpath`` which
333
itself is defined as the relative path between the section name and the
336
Another such option is ``branchname``, which refers to the name of a colocated
337
branch. For non-colocated branches, it behaves like basename. It can be used
340
[/home/vila/src/bzr/bugs]
341
mypush = lp:~vila/bzr/{branchname}
343
When used with a colocated branch named ``832013-expand-in-stack``, we'll get::
346
lp:~vila/bzr/832013-expand-in-stack
348
When an option is local to a Section, it cannot be referred to from option
349
values in any other section from the same ``Store`` nor from any other
301
353
The main configuration file, bazaar.conf
302
354
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
330
381
[http://hypothetical.site.com/branches/devel-branch]
331
382
create_signatures = always
332
check_signatures = always
334
[http://example.com/bzr/*]
335
check_signatures = require
337
384
The authentication configuration file, authentication.conf
338
385
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
342
389
of bzr that requires authentication (smtp for example).
344
391
The syntax of the file obeys the same rules as the others except for the
345
variable policies which don't apply.
392
option policies which don't apply.
347
394
For more information on the possible uses of the authentication configuration
348
395
file see :doc:`authentication-help`.
351
Common variable options
352
-----------------------
420
471
committed revisions only when the branch requires them. ``never`` will refuse
421
472
to sign newly committed revisions, even if the branch requires signatures.
477
If true (default), working tree metadata changes are flushed through the
478
OS buffers to physical disk. This is somewhat slower, but means data
479
should not be lost if the machine crashes. See also repository.fdatasync.
484
The GnuPG user identity to use when signing commits. Can be an e-mail
485
address, key fingerprint or full key ID. When unset or when set to
486
"default" Bazaar will use the user e-mail set with ``whoami``.
501
568
:mapi: Use your preferred e-mail client on Windows.
502
569
:xdg-email: Use xdg-email to run your preferred mail program
574
If true (default), repository changes are flushed through the OS buffers
575
to physical disk. This is somewhat slower, but means data should not be
576
lost if the machine crashes. See also dirstate.fdatasync.
606
680
If present, defines the ``--strict`` option default value for checking
607
681
uncommitted changes before sending a merge directive.
683
add.maximum_file_size
684
~~~~~~~~~~~~~~~~~~~~~
686
Defines the maximum file size the command line "add" operation will allow
687
in recursive mode, with files larger than this value being skipped. You may
688
specify this value as an integer (in which case it is interpreted as bytes),
689
or you may specify the value using SI units, i.e. 10KB, 20MB, 1G. A value of 0
690
will disable skipping.
610
692
External Merge Tools
611
693
--------------------
632
714
bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
716
Because ``mergetool`` and ``config`` itself both use curly braces as
717
interpolation markers, trying to display the mergetool line results in the
721
$ bzr config bzr.mergetool.kdiff3='kdiff3 {base} {this} {other} -o {result}'
722
$ bzr config bzr.mergetool.kdiff3
723
bzr: ERROR: Option base is not defined while expanding "kdiff3 {base} {this} {other} -o {result}".
725
To avoid this, ``config`` can be instructed not to try expanding variables::
727
$ bzr config --all bzr.mergetool.kdiff3
729
bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
634
732
bzr.default_mergetool
635
733
~~~~~~~~~~~~~~~~~~~~~
added
removed
bzrlib/help_topics/en/configuration.txt
