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
When an option is local to a Section, it cannot be referred to from option
337
values in any other section from the same ``Store`` nor from any other
301
341
The main configuration file, bazaar.conf
302
342
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
330
369
[http://hypothetical.site.com/branches/devel-branch]
331
370
create_signatures = always
332
check_signatures = always
334
[http://example.com/bzr/*]
335
check_signatures = require
337
372
The authentication configuration file, authentication.conf
338
373
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
342
377
of bzr that requires authentication (smtp for example).
344
379
The syntax of the file obeys the same rules as the others except for the
345
variable policies which don't apply.
380
option policies which don't apply.
347
382
For more information on the possible uses of the authentication configuration
348
383
file see :doc:`authentication-help`.
351
Common variable options
352
-----------------------
402
442
create_signatures
403
443
~~~~~~~~~~~~~~~~~
405
Defines the behaviour of signing revisions.
445
Defines the behaviour of signing revisions on commits. By default bzr will not
408
Sign every new revision that is committed.
449
Sign every new revision that is committed. If the signing fails then the
450
commit will not be made.
411
(default) Sign newly committed revisions only when the branch requires
453
Reserved for future use.
415
Refuse to sign newly committed revisions, even if the branch
456
Reserved for future use.
458
In future it is planned that ``when-required`` will sign newly
459
committed revisions only when the branch requires them. ``never`` will refuse
460
to sign newly committed revisions, even if the branch requires signatures.
465
If true (default), working tree metadata changes are flushed through the
466
OS buffers to physical disk. This is somewhat slower, but means data
467
should not be lost if the machine crashes. See also repository.fdatasync.
472
The GnuPG user identity to use when signing commits. Can be an e-mail
473
address, key fingerprint or full key ID. When unset or when set to
474
"default" Bazaar will use the user e-mail set with ``whoami``.
462
522
These settings are only needed if the SMTP server requires authentication
528
If set to true, bzr will automatically break locks held by processes from
529
the same machine and user that are no longer alive. Otherwise, it will
530
print a message and you can break the lock manually, if you are satisfied
531
the object is no longer in use.
488
556
:mapi: Use your preferred e-mail client on Windows.
489
557
:xdg-email: Use xdg-email to run your preferred mail program
562
If true (default), repository changes are flushed through the OS buffers
563
to physical disk. This is somewhat slower, but means data should not be
564
lost if the machine crashes. See also dirstate.fdatasync.
593
668
If present, defines the ``--strict`` option default value for checking
594
669
uncommitted changes before sending a merge directive.
671
add.maximum_file_size
672
~~~~~~~~~~~~~~~~~~~~~
674
Defines the maximum file size the command line "add" operation will allow
675
in recursive mode, with files larger than this value being skipped. You may
676
specify this value as an integer (in which case it is interpreted as bytes),
677
or you may specify the value using SI units, i.e. 10KB, 20MB, 1G. A value of 0
678
will disable skipping.
597
680
External Merge Tools
598
681
--------------------
added
removed
bzrlib/help_topics/en/configuration.txt
