57
55
Path to the Bazaar executable to use when using the bzr+ssh protocol.
59
See also the ``bzr_remote_path`` configuration value.
57
See also the ``bzr_remote_path`` configuration option.
64
62
Path to the editor Bazaar should use for commit messages, etc.
67
Location of the Bazaar log file. You can check the current location by
68
running ``bzr version``.
70
The log file contains debug information that is useful for diagnosing or
71
reporting problems with Bazaar.
73
Setting this to ``NUL`` on Windows or ``/dev/null`` on other platforms
69
80
The path to the plugins directory that Bazaar should use.
81
If not set, Bazaar will search for plugins in:
83
* the user specific plugin directory (containing the ``user`` plugins),
85
* the bzrlib directory (containing the ``core`` plugins),
87
* the site specific plugin directory if applicable (containing
88
the ``site`` plugins).
90
If ``BZR_PLUGIN_PATH`` is set in any fashion, it will change the
91
the way the plugin are searched.
93
As for the ``PATH`` variables, if multiple directories are
94
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
95
platform specific appropriate character (':' on Unix,
98
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
99
in ``user``. However it will continue to search in ``core`` and
100
``site`` unless they are explicitly removed.
102
If you need to change the order or remove one of these
103
directories, you should use special values:
105
* ``-user``, ``-core``, ``-site`` will remove the corresponding
106
path from the default values,
108
* ``+user``, ``+core``, ``+site`` will add the corresponding path
109
before the remaining default values (and also remove it from
112
Note that the special values 'user', 'core' and 'site' should be
113
used literally, they will be substituted by the corresponding,
114
platform specific, values.
116
The examples below use ':' as the separator, windows users
119
Overriding the default user plugin directory::
121
BZR_PLUGIN_PATH='/path/to/my/other/plugins'
123
Disabling the site directory while retaining the user directory::
125
BZR_PLUGIN_PATH='-site:+user'
127
Disabling all plugins (better achieved with --no-plugins)::
129
BZR_PLUGIN_PATH='-user:-core:-site'
131
Overriding the default site plugin directory::
133
BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user
138
Under special circumstances (mostly when trying to diagnose a
139
bug), it's better to disable a plugin (or several) rather than
140
uninstalling them completely. Such plugins can be specified in
141
the ``BZR_DISABLE_PLUGINS`` environment variable.
143
In that case, ``bzr`` will stop loading the specified plugins and
144
will raise an import error if they are explicitly imported (by
145
another plugin that depends on them for example).
147
Disabling ``myplugin`` and ``yourplugin`` is achieved by::
149
BZR_DISABLE_PLUGINS='myplugin:yourplugin'
154
When adding a new feature or working on a bug in a plugin,
155
developers often need to use a specific version of a given
156
plugin. Since python requires that the directory containing the
157
code is named like the plugin itself this make it impossible to
158
use arbitrary directory names (using a two-level directory scheme
159
is inconvenient). ``BZR_PLUGINS_AT`` allows such directories even
160
if they don't appear in ``BZR_PLUGIN_PATH`` .
162
Plugins specified in this environment variable takes precedence
163
over the ones in ``BZR_PLUGIN_PATH``.
165
The variable specified a list of ``plugin_name@plugin path``,
166
``plugin_name`` being the name of the plugin as it appears in
167
python module paths, ``plugin_path`` being the path to the
168
directory containing the plugin code itself
169
(i.e. ``plugins/myplugin`` not ``plugins``). Use ':' as the list
170
separator, use ';' on windows.
175
Using a specific version of ``myplugin``:
176
``BZR_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin``
135
251
[/home/jdoe/branches/]
141
A section variable resides within a section. A section variable contains a
142
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::
144
260
email = John Doe <jdoe@isp.com>
145
check_signatures = require
151
Variables defined in a section affect the named directory or URL plus
152
any locations they contain. Policies can be used to change how a
153
variable value is interpreted for contained locations. Currently
261
gpg_signing_key = Amy Pond <amy@example.com>
263
A option can reference other options by enclosing them in curly brackets::
265
my_branch_name = feature_x
266
my_server = bzr+ssh://example.com
267
push_location = {my_server}/project/{my_branch_name}
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
154
275
there are three policies available:
174
295
With this configuration, the push location for ``/top/location/branch1``
175
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
178
353
The main configuration file, bazaar.conf
179
354
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
181
``bazaar.conf`` only allows one
182
section called ``[DEFAULT]``. This default section contains the default
356
``bazaar.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
357
The default section contains the default
183
358
configuration options for all branches. The default section can be
184
359
overriden by providing a branch-specific section in ``locations.conf``.
263
454
create_signatures
264
455
~~~~~~~~~~~~~~~~~
266
Defines the behaviour of signing revisions.
457
Defines the behaviour of signing revisions on commits. By default bzr will not
269
Sign every new revision that is committed.
461
Sign every new revision that is committed. If the signing fails then the
462
commit will not be made.
272
(default) Sign newly committed revisions only when the branch requires
465
Reserved for future use.
276
Refuse to sign newly committed revisions, even if the branch
468
Reserved for future use.
470
In future it is planned that ``when-required`` will sign newly
471
committed revisions only when the branch requires them. ``never`` will refuse
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``.
361
588
A publically-accessible version of this branch (implying that this version is
362
589
not publically-accessible). Used (and set) by ``bzr send``.
594
A list of strings, each string represent a warning that can be emitted by
595
bzr. Mentioning a warning in this list tells bzr to not emit it.
599
* ``format_deprecation``:
600
whether the format deprecation warning is shown on repositories that are
601
using deprecated formats.
606
A format name for the default format used when creating branches. See ``bzr
607
help formats`` for possible values.
616
A Python unicode encoding name for text output from bzr, such as log
617
information. Values include: utf8, cp850, ascii, iso-8859-1. The default
618
is the terminal encoding prefered by the operating system.
365
621
Branch type specific options
366
622
----------------------------
374
630
~~~~~~~~~~~~~~~~~~~~~
376
632
If set to "True" then revisions can only be appended to the log, not
377
removed. A branch with this setting enabled can only pull from
378
another branch if the other branch's log is a longer version of its
379
own. This is normally set by ``bzr init --append-revisions-only``.
633
removed. A branch with this setting enabled can only pull from another
634
branch if the other branch's log is a longer version of its own. This is
635
normally set by ``bzr init --append-revisions-only``. If you set it
636
manually, use either 'True' or 'False' (case-sensitive) to maintain
637
compatibility with previous bzr versions (older than 2.2).
384
If present, the location of the default branch for pull or merge.
385
This option is normally set by ``pull --remember`` or ``merge
642
If present, the location of the default branch for pull or merge. This option
643
is normally set when creating a branch, the first ``pull`` or by ``pull
391
649
If present, the location of the default branch for push. This option
392
is normally set by ``push --remember``.
650
is normally set by the first ``push`` or ``push --remember``.
655
If present, defines the ``--strict`` option default value for checking
656
uncommitted changes before pushing.
661
If present, defines the ``--strict`` option default value for checking
662
uncommitted changes before pushing into a different VCS without any
403
674
If set to "True", the branch should act as a checkout, and push each commit to
404
675
the bound_location. This option is normally set by ``bind``/``unbind``.
680
If present, defines the ``--strict`` option default value for checking
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.
698
Defines an external merge tool called <name> with the given command-line.
699
Arguments containing spaces should be quoted using single or double quotes. The
700
executable may omit its path if it can be found on the PATH.
702
The following markers can be used in the command-line to substitute filenames
703
involved in the merge conflict::
709
{this_temp} temp copy of file.THIS, used to overwrite output file if merge
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}
732
bzr.default_mergetool
733
~~~~~~~~~~~~~~~~~~~~~
735
Specifies which external merge tool (as defined above) should be selected by
736
default in tools such as ``bzr qconflicts``.
740
bzr.default_mergetool = kdiff3
added
removed
bzrlib/help_topics/en/configuration.txt
