~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/configuration.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-05-05 08:29:29 UTC
  • mfrom: (1697.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060505082929-a037ee137f1ff240
Merge break-lock command.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
====================
2
 
Bazaar configuration
3
 
====================
4
 
 
5
 
Information on how to configure Bazaar.
6
 
 
7
 
.. TODO: Should have some explanation of why you'd want things in
8
 
.. branch.conf.
9
 
 
10
 
Location of configuration files
11
 
===============================
12
 
Each user gets a pair of configurations files in ``$HOME/.bazaar``. The first
13
 
one, named ``bazaar.conf``, includes default configuration options. The other
14
 
file, ``locations.conf``, contains configuration information for specific
15
 
branch locations.  These files are sometimes referred to as ``ini files``.
16
 
 
17
 
Each branch can also contain a configuration file that sets values specific
18
 
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
19
 
branch. This file is visible to all users of a branch, if you wish to override
20
 
one of the values for a branch with a setting that is specific to you then you
21
 
can do so in ``locations.conf``.
 
1
Location of configuration file
 
2
==============================
 
3
Each user gets a pair of configurations files in $HOME/.bazaar. The first
 
4
one, named bazaar.conf, includes default configuration options. The other
 
5
file, branches.conf, contains configuration information for specific
 
6
branches.
22
7
 
23
8
General Format
24
9
==============
25
10
An ini file has three types of contructs: section headers, section
26
11
variables and comments.
27
12
 
28
 
Comments
29
 
--------
 
13
comment
 
14
-------
30
15
A comment is any line that starts with a "#" (sometimes called a "hash
31
16
mark", "pound sign" or "number sign"). Comment lines are ignored by
32
 
Bazaar when parsing ini files.
 
17
Bazaar-NG when parsing ini files.
33
18
 
34
 
Section Headers
35
 
---------------
 
19
section header
 
20
--------------
36
21
A section header is a word enclosed in brackets that starts at the begining
37
 
of a line.  A typical section header looks like this::
 
22
of a line, typical section headers look like this::
38
23
 
39
24
    [DEFAULT]
40
25
 
41
 
The only valid section header for bazaar.conf is [DEFAULT], which is
42
 
case sensitive. The default section provides for setting variables
43
 
which can be overridden with the branch config file.
 
26
The only valid section header for bazaar.conf is [DEFAULT], which is case
 
27
senstive. The default section provides for setting variables which can be
 
28
overridden with the branch config file.
44
29
 
45
 
For ``locations.conf``, the variables from the section with the
46
 
longest matching section header are used to the exclusion of other
47
 
potentially valid section headers. A section header uses the path for
48
 
the branch as the section header. Some examples include::
 
30
For branches.conf, the variables from the section with the longest matching
 
31
section header are used to the exclusion of other potentially valid section
 
32
headers. A section header uses the path for the branch as the section
 
33
header. Some examples include::
49
34
 
50
35
    [http://mybranches.isp.com/~jdoe/branchdir]
51
36
    [/home/jdoe/branches/]
52
37
 
53
38
 
54
 
Section Variables
 
39
 
 
40
section variables
55
41
-----------------
56
42
 
57
43
A section variable resides within a section. A section variable contains a
58
 
variable name, an equals sign and a value.  For example::
 
44
variable name, an equals sign and a value and generally takes the following
 
45
form::
59
46
 
60
47
    email            = John Doe <jdoe@isp.com>
61
48
    check_signatures = require
62
49
 
63
50
 
64
 
Variable Policies
65
 
-----------------
66
 
 
67
 
Variables defined in a section affect the named directory or URL plus
68
 
any locations they contain.  Policies can be used to change how a
69
 
variable value is interpreted for contained locations.  Currently
70
 
there are three policies available:
71
 
 
72
 
 none:
73
 
   the value is interpreted the same for contained locations.  This is
74
 
   the default behaviour.
75
 
 norecurse:
76
 
   the value is only used for the exact location specified by the
77
 
   section name.
78
 
 appendpath:
79
 
   for contained locations, any additional path components are
80
 
   appended to the value.
81
 
 
82
 
Policies are specified by keys with names of the form "$var:policy".
83
 
For example, to define the push location for a tree of branches, the
84
 
following could be used::
85
 
 
86
 
  [/top/location]
87
 
  push_location = sftp://example.com/location
88
 
  push_location:policy = appendpath
89
 
 
90
 
With this configuration, the push location for ``/top/location/branch1``
91
 
would be ``sftp://example.com/location/branch1``.
92
 
 
93
 
 
94
51
The main configuration file, bazaar.conf
95
52
----------------------------------------
96
53
 
97
 
The main configuration file, ``$HOME/.bazaar/bazaar.conf``, only allows one
98
 
section called ``[DEFAULT]``. This default section contains the default
 
54
The main configuration file, $HOME/.bazaar/bazaar.conf, only allows one
 
55
section called '''[DEFAULT]'''. This default section contains the default
99
56
configuration options for all branches. The default section can be
100
 
overriden by providing a branch-specific section in ``locations.conf``.
 
57
overriden by providing a branch specific section in branches.conf.
101
58
 
102
 
A typical ``bazaar.conf`` section often looks like the following::
 
59
A typical bazaar.conf section often looks like the following::
103
60
 
104
61
    [DEFAULT]
105
62
    email             = John Doe <jdoe@isp.com>
107
64
    check_signatures  = check-available
108
65
    create_signatures = when-required
109
66
 
110
 
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for a
 
67
$HOME/.bazaar/branches.conf allows one to specify overriding settings for a
111
68
specific branch. The format is almost identical to the default section in
112
69
bazaar.conf with one significant change: The section header, instead of
113
70
saying default, will be the path to a branch that you wish to override a
114
 
value for. The '?' and '*' wildcards are supported::
 
71
value for. The ? and * wildcards are supported::
115
72
 
116
73
    [/home/jdoe/branches/nethack]
117
74
    email = Nethack Admin <nethack@nethack.com>
120
77
    create_signatures = always
121
78
    check_signatures  = always
122
79
 
123
 
    [http://bazaar-vcs.org/bzr/*]
 
80
    [http://bazaar-ng.org/bzr/*]
124
81
    check_signatures  = require
125
82
 
126
 
Common Variable Options
 
83
Common Variable options
127
84
=======================
128
85
 
129
86
email
136
93
editor
137
94
------
138
95
The path of the editor that you wish to use if *bzr commit* is run without
139
 
a commit message. This setting is trumped by the environment variable
140
 
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
 
96
a commit log message. This setting is trumped by the environment variables
 
97
$BZREDITOR or $EDITOR.
141
98
 
142
99
check_signatures
143
100
----------------
144
101
Defines the behavior for signatures.
145
102
 
146
103
require
147
 
    The gnupg signature for revisions must be present and must be valid.
 
104
    the gnupg signature for revisions must be present and must be valid
148
105
 
149
106
ignore
150
 
    Do not check gnupg signatures of revisions.
 
107
    Do not check gnupg signatures of revisions. 
151
108
 
152
109
check-available
153
110
    (default) If gnupg signatures for revisions are present, check them.
154
 
    Bazaar will fail if it finds a bad signature, but will not fail if
155
 
    no signature is present.
 
111
    Bazaar-NG will fail if it finds a bad signature, but will not fail if
 
112
    no signature is present
156
113
 
157
114
create_signatures
158
115
-----------------
159
 
Defines the behaviour of signing revisions.
 
116
Defines the behaviour of signing revisions. Has three possible values:
 
117
always, never and when-requied.
160
118
 
161
119
always
162
 
    Sign every new revision that is committed.
 
120
    sign every new revision that is committed
163
121
 
164
122
when-required
165
123
    (default) Sign newly committed revisions only when the branch requires
166
 
    signed revisions.
 
124
    signed revisions
167
125
 
168
126
never
169
 
    Refuse to sign newly committed revisions, even if the branch
170
 
    requires signatures.
 
127
    Refuse to sign newly committed revisions, even if the branch requires signatures
171
128
 
172
129
recurse
173
130
-------
174
 
Only useful in ``locations.conf``. Defines whether or not the
175
 
configuration for this section applies to subdirectories:
 
131
Only useful in branches.conf. Defines whether or not the configuration for
 
132
this section applies to subdirectories:
176
133
 
177
134
true
178
 
    (default) This section applies to subdirectories as well.
 
135
    (default) This section applies to subdirectories as well
179
136
 
180
137
false
181
138
    This section only applies to the branch at this directory and not
182
 
    branches below it.
 
139
    branches 
183
140
 
184
141
gpg_signing_command
185
142
-------------------
186
143
(Default: "gpg"). Which program should be used to sign and check revisions.
187
 
For example::
 
144
example::
188
145
 
189
146
    gpg_signing_command = /usr/bin/gnpg
190
147
 
191
 
smtp_server
192
 
-----------
193
 
(Default: "localhost"). SMTP server to use when Bazaar needs to send
194
 
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
195
 
 
196
 
smtp_username, smtp_password
197
 
----------------------------
198
 
User and password to authenticate to the SMTP server. If smtp_username
199
 
is set, and smtp_password is not, Bazaar will prompt for a password.
200
 
These settings are only needed if the SMTP server requires authentication
201
 
to send mail.
202
 
 
203
 
 
204
 
Branch 6 Options
205
 
================
206
 
 
207
 
These options apply only to branches that use the "experimental-branch6"
208
 
format.  They are usually set in ``.bzr/branch/branch.conf`` automatically, but
209
 
may be manually set in ``locations.conf`` or ``bazaar.conf``.
210
 
 
211
 
append_revisions_only
212
 
---------------------
213
 
If set to "True" then revisions can only be appended to the log, not
214
 
removed.  A branch with this setting enabled can only pull from
215
 
another branch if the other branch's log is a longer version of its
216
 
own.  This is normally set by ``bzr init --append-revisions-only``.
217
 
 
218
 
parent_location
219
 
---------------
220
 
If present, the location of the default branch for pull or merge.
221
 
This option is normally set by ``pull --remember`` or ``merge
222
 
--remember``.
223
 
 
224
 
push_location
225
 
-------------
226
 
If present, the location of the default branch for push.  This option
227
 
is normally set by ``push --remember``.
228
 
 
229
 
bound_location
230
 
--------------
231
 
The location that commits should go to when acting as a checkout.
232
 
This option is normally set by ``bind``.
233
 
 
234
 
bound
235
 
-----
236
 
If set to "True", the branch should act as a checkout, and push each commit to
237
 
the bound_location.  This option is normally set by ``bind``/``unbind``.
238