5
Information on how to configure Bazaar.
7
Location of configuration file
8
==============================
9
Each user gets a pair of configurations files in ``$HOME/.bazaar``. The first
10
one, named ``bazaar.conf``, includes default configuration options. The other
11
file, ``locations.conf``, contains configuration information for specific
12
branch locations. These files are sometimes referred to as ``ini files``.
16
An ini file has three types of contructs: section headers, section
17
variables and comments.
21
A comment is any line that starts with a "#" (sometimes called a "hash
22
mark", "pound sign" or "number sign"). Comment lines are ignored by
23
Bazaar when parsing ini files.
27
A section header is a word enclosed in brackets that starts at the begining
28
of a line. A typical section header looks like this::
32
The only valid section header for bazaar.conf is [DEFAULT], which is
33
case sensitive. The default section provides for setting variables
34
which can be overridden with the branch config file.
36
For ``locations.conf``, the variables from the section with the
37
longest matching section header are used to the exclusion of other
38
potentially valid section headers. A section header uses the path for
39
the branch as the section header. Some examples include::
41
[http://mybranches.isp.com/~jdoe/branchdir]
42
[/home/jdoe/branches/]
49
A section variable resides within a section. A section variable contains a
50
variable name, an equals sign and a value. For example::
52
email = John Doe <jdoe@isp.com>
53
check_signatures = require
59
Variables defined in a section affect the named directory or URL plus
60
any locations they contain. Policies can be used to change how a
61
variable value is interpreted for contained locations. Currently
62
there are three policies available:
65
the value is interpreted the same for contained locations. This is
66
the default behaviour.
68
the value is only used for the exact location specified by the
71
for contained locations, any additional path components are
72
appended to the value.
74
Policies are specified by keys with names of the form "$var:policy".
75
For example, to define the push location for a tree of branches, the
76
following could be used::
79
push_location = sftp://example.com/location
80
push_location:policy = appendpath
82
With this configuration, the push location for ``/top/location/branch1``
83
would be ``sftp://example.com/location/branch1``.
86
The main configuration file, bazaar.conf
87
----------------------------------------
89
The main configuration file, ``$HOME/.bazaar/bazaar.conf``, only allows one
90
section called ``[DEFAULT]``. This default section contains the default
91
configuration options for all branches. The default section can be
92
overriden by providing a branch-specific section in ``locations.conf``.
94
A typical ``bazaar.conf`` section often looks like the following::
97
email = John Doe <jdoe@isp.com>
99
check_signatures = check-available
100
create_signatures = when-required
102
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for a
103
specific branch. The format is almost identical to the default section in
104
bazaar.conf with one significant change: The section header, instead of
105
saying default, will be the path to a branch that you wish to override a
106
value for. The '?' and '*' wildcards are supported::
108
[/home/jdoe/branches/nethack]
109
email = Nethack Admin <nethack@nethack.com>
111
[http://hypothetical.site.com/branches/devel-branch]
112
create_signatures = always
113
check_signatures = always
115
[http://bazaar-vcs.org/bzr/*]
116
check_signatures = require
118
Common Variable Options
119
=======================
123
The email address to use when committing a branch. Typically takes the form
126
email = Full Name <account@hostname.tld>
130
The path of the editor that you wish to use if *bzr commit* is run without
131
a commit log message. This setting is trumped by the environment variable
132
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
136
Defines the behavior for signatures.
139
The gnupg signature for revisions must be present and must be valid.
142
Do not check gnupg signatures of revisions.
145
(default) If gnupg signatures for revisions are present, check them.
146
Bazaar will fail if it finds a bad signature, but will not fail if
147
no signature is present.
151
Defines the behaviour of signing revisions.
154
Sign every new revision that is committed.
157
(default) Sign newly committed revisions only when the branch requires
161
Refuse to sign newly committed revisions, even if the branch
166
Only useful in ``locations.conf``. Defines whether or not the
167
configuration for this section applies to subdirectories:
170
(default) This section applies to subdirectories as well.
173
This section only applies to the branch at this directory and not
178
(Default: "gpg"). Which program should be used to sign and check revisions.
181
gpg_signing_command = /usr/bin/gnpg
185
(Default: "localhost"). SMTP server to use when Bazaar needs to send
186
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
188
smtp_username, smtp_password
189
----------------------------
190
User and password to authenticate to the SMTP server. If smtp_username
191
is set, and smtp_password is not, Bazaar will prompt for a password.
197
These options apply only to branches that use the "experimental-branch6"
198
format. They are usually set in ``.bzr/branch/branch.conf`` automatically, but
199
may be manually set in ``locations.conf`` or ``bazaar.conf``.
201
append_revisions_only
202
---------------------
203
If set to "True" then revisions can only be appended to the log, not
204
removed. A branch with this setting enabled can only pull from
205
another branch if the other branch's log is a longer version of its
206
own. This is normally set by ``bzr init --append-revisions-only``.
210
If present, the location of the default branch for pull or merge.
211
This option is normally set by ``pull --remember`` or ``merge
216
If present, the location of the default branch for push. This option
217
is normally set by ``push --remember``.
221
The location that commits should go to when acting as a checkout.
222
This option is normally set by ``bind``.
226
If set to "True", the branch should act as a checkout, and push each commit to
227
the bound_location. This option is normally set by ``bind``/``unbind``.
233
These options can go into bazaar.conf, branch.conf or into a branch-specific
234
configuration section in locations.conf.
236
bugzilla_<tracker_abbreviation>_url
237
-----------------------------------
238
If present, the location of the Bugzilla bug tracker referred to by
239
<tracker_abbreviation>. This option can then be used together with ``bzr commit
240
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
243
bugzilla_squid_url = http://www.squid-cache.org/bugs
245
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
248
trac_<tracker_abbrevation>_url
249
------------------------------
250
If present, the location of the Trac instance referred to by
251
<tracker_abbreviation>. This option can then be used together with ``bzr commit
252
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
255
trac_twisted_url = http://www.twistedmatrix.com/trac
257
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
added
removed
doc/configuration.txt
