7
7
Location of configuration file
8
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
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``.
27
27
A section header is a word enclosed in brackets that starts at the begining
28
of a line, typical section headers look like this::
28
of a line. A typical section header looks like this::
32
The only valid section header for bazaar.conf is [DEFAULT], which is case
33
senstive. The default section provides for setting variables which can be
34
overridden with the branch config file.
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 longest matching
37
section header are used to the exclusion of other potentially valid section
38
headers. A section header uses the path for the branch as the section
39
header. Some examples include::
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
41
[http://mybranches.isp.com/~jdoe/branchdir]
42
42
[/home/jdoe/branches/]
49
49
A section variable resides within a section. A section variable contains a
50
variable name, an equals sign and a value and generally takes the following
50
variable name, an equals sign and a value. For example::
53
52
email = John Doe <jdoe@isp.com>
54
53
check_signatures = require
87
86
The main configuration file, bazaar.conf
88
87
----------------------------------------
90
The main configuration file, $HOME/.bazaar/bazaar.conf, only allows one
91
section called '''[DEFAULT]'''. This default section contains the default
89
The main configuration file, ``$HOME/.bazaar/bazaar.conf``, only allows one
90
section called ``[DEFAULT]``. This default section contains the default
92
91
configuration options for all branches. The default section can be
93
overriden by providing a branch specific section in locations.conf.
92
overriden by providing a branch-specific section in ``locations.conf``.
95
A typical bazaar.conf section often looks like the following::
94
A typical ``bazaar.conf`` section often looks like the following::
98
97
email = John Doe <jdoe@isp.com>
100
99
check_signatures = check-available
101
100
create_signatures = when-required
103
$HOME/.bazaar/locations.conf allows one to specify overriding settings for a
102
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for a
104
103
specific branch. The format is almost identical to the default section in
105
104
bazaar.conf with one significant change: The section header, instead of
106
105
saying default, will be the path to a branch that you wish to override a
107
value for. The ? and * wildcards are supported::
106
value for. The '?' and '*' wildcards are supported::
109
108
[/home/jdoe/branches/nethack]
110
109
email = Nethack Admin <nethack@nethack.com>
131
130
The path of the editor that you wish to use if *bzr commit* is run without
132
131
a commit log message. This setting is trumped by the environment variable
133
$BZR_EDITOR, and overrides $VISUAL and $EDITOR.
132
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
137
136
Defines the behavior for signatures.
140
the gnupg signature for revisions must be present and must be valid
139
The gnupg signature for revisions must be present and must be valid.
143
142
Do not check gnupg signatures of revisions.
146
145
(default) If gnupg signatures for revisions are present, check them.
147
146
Bazaar will fail if it finds a bad signature, but will not fail if
148
no signature is present
147
no signature is present.
150
149
create_signatures
151
150
-----------------
152
Defines the behaviour of signing revisions. Has three possible values:
153
always, never and when-requied.
151
Defines the behaviour of signing revisions.
156
sign every new revision that is committed
154
Sign every new revision that is committed.
159
157
(default) Sign newly committed revisions only when the branch requires
163
Refuse to sign newly committed revisions, even if the branch requires signatures
161
Refuse to sign newly committed revisions, even if the branch
167
Only useful in locations.conf. Defines whether or not the configuration for
168
this section applies to subdirectories:
166
Only useful in ``locations.conf``. Defines whether or not the
167
configuration for this section applies to subdirectories:
171
(default) This section applies to subdirectories as well
170
(default) This section applies to subdirectories as well.
174
173
This section only applies to the branch at this directory and not
177
176
gpg_signing_command
178
177
-------------------
179
178
(Default: "gpg"). Which program should be used to sign and check revisions.
182
181
gpg_signing_command = /usr/bin/gnpg
188
187
These options apply only to branches that use the "experimental-branch6"
189
format. They are usually set in .bzr/branch/branch.conf automatically, but
190
may be manually set in locations.conf or bazaar.conf
188
format. They are usually set in ``.bzr/branch/branch.conf`` automatically, but
189
may be manually set in ``locations.conf`` or ``bazaar.conf``.
192
191
append_revisions_only
193
192
---------------------
194
If set to "True", then revisions can only be appended to the log, not removed.
195
A branch with this setting enabled can only pull from another branch if the
196
other branch's log is a longer version of its own.
198
This is normally set by ``bzr init --append-revisions-only``.
193
If set to "True" then revisions can only be appended to the log, not
194
removed. A branch with this setting enabled can only pull from
195
another branch if the other branch's log is a longer version of its
196
own. This is normally set by ``bzr init --append-revisions-only``.
202
200
If present, the location of the default branch for pull or merge.
204
This is normally set by ``pull --remember`` or ``merge --remember``
201
This option is normally set by ``pull --remember`` or ``merge
208
If present, the location of the default branch for push. This is normally
209
set by ``push --remember``.
206
If present, the location of the default branch for push. This option
207
is normally set by ``push --remember``.
213
The location that commits should go to when acting as a checkout. (Normally
211
The location that commits should go to when acting as a checkout.
212
This option is normally set by ``bind``.
218
216
If set to "True", the branch should act as a checkout, and push each commit to
219
the bound_location. (Normally set by ``bind``/``unbind``.)
217
the bound_location. This option is normally set by ``bind``/``unbind``.
added
removed
doc/configuration.txt
