~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/configuration.txt

  • Committer: Alexander Belchenko
  • Date: 2007-01-04 23:36:44 UTC
  • mfrom: (2224 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2225.
  • Revision ID: bialix@ukr.net-20070104233644-7znkxoj9b0y7ev28
merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
 
5
5
Information on how to configure Bazaar.
6
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``.
 
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.
22
13
 
23
14
General Format
24
15
==============
34
25
Section Headers
35
26
---------------
36
27
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::
 
28
of a line, typical section headers look like this::
38
29
 
39
30
    [DEFAULT]
40
31
 
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.
 
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.
44
35
 
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::
 
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::
49
40
 
50
41
    [http://mybranches.isp.com/~jdoe/branchdir]
51
42
    [/home/jdoe/branches/]
52
43
 
53
44
 
 
45
 
54
46
Section Variables
55
47
-----------------
56
48
 
57
49
A section variable resides within a section. A section variable contains a
58
 
variable name, an equals sign and a value.  For example::
 
50
variable name, an equals sign and a value and generally takes the following
 
51
form::
59
52
 
60
53
    email            = John Doe <jdoe@isp.com>
61
54
    check_signatures = require
94
87
The main configuration file, bazaar.conf
95
88
----------------------------------------
96
89
 
97
 
The main configuration file, ``$HOME/.bazaar/bazaar.conf``, only allows one
98
 
section called ``[DEFAULT]``. This default section contains the default
 
90
The main configuration file, $HOME/.bazaar/bazaar.conf, only allows one
 
91
section called '''[DEFAULT]'''. This default section contains the default
99
92
configuration options for all branches. The default section can be
100
 
overriden by providing a branch-specific section in ``locations.conf``.
 
93
overriden by providing a branch specific section in locations.conf.
101
94
 
102
 
A typical ``bazaar.conf`` section often looks like the following::
 
95
A typical bazaar.conf section often looks like the following::
103
96
 
104
97
    [DEFAULT]
105
98
    email             = John Doe <jdoe@isp.com>
107
100
    check_signatures  = check-available
108
101
    create_signatures = when-required
109
102
 
110
 
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for a
 
103
$HOME/.bazaar/locations.conf allows one to specify overriding settings for a
111
104
specific branch. The format is almost identical to the default section in
112
105
bazaar.conf with one significant change: The section header, instead of
113
106
saying default, will be the path to a branch that you wish to override a
114
 
value for. The '?' and '*' wildcards are supported::
 
107
value for. The ? and * wildcards are supported::
115
108
 
116
109
    [/home/jdoe/branches/nethack]
117
110
    email = Nethack Admin <nethack@nethack.com>
123
116
    [http://bazaar-vcs.org/bzr/*]
124
117
    check_signatures  = require
125
118
 
126
 
Common Variable Options
 
119
Common Variable options
127
120
=======================
128
121
 
129
122
email
136
129
editor
137
130
------
138
131
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``.
 
132
a commit log message. This setting is trumped by the environment variable
 
133
$BZR_EDITOR, and overrides $VISUAL and $EDITOR.
141
134
 
142
135
check_signatures
143
136
----------------
144
137
Defines the behavior for signatures.
145
138
 
146
139
require
147
 
    The gnupg signature for revisions must be present and must be valid.
 
140
    the gnupg signature for revisions must be present and must be valid
148
141
 
149
142
ignore
150
 
    Do not check gnupg signatures of revisions.
 
143
    Do not check gnupg signatures of revisions. 
151
144
 
152
145
check-available
153
146
    (default) If gnupg signatures for revisions are present, check them.
154
147
    Bazaar will fail if it finds a bad signature, but will not fail if
155
 
    no signature is present.
 
148
    no signature is present
156
149
 
157
150
create_signatures
158
151
-----------------
159
 
Defines the behaviour of signing revisions.
 
152
Defines the behaviour of signing revisions. Has three possible values:
 
153
always, never and when-requied.
160
154
 
161
155
always
162
 
    Sign every new revision that is committed.
 
156
    sign every new revision that is committed
163
157
 
164
158
when-required
165
159
    (default) Sign newly committed revisions only when the branch requires
166
 
    signed revisions.
 
160
    signed revisions
167
161
 
168
162
never
169
 
    Refuse to sign newly committed revisions, even if the branch
170
 
    requires signatures.
 
163
    Refuse to sign newly committed revisions, even if the branch requires signatures
171
164
 
172
165
recurse
173
166
-------
174
 
Only useful in ``locations.conf``. Defines whether or not the
175
 
configuration for this section applies to subdirectories:
 
167
Only useful in locations.conf. Defines whether or not the configuration for
 
168
this section applies to subdirectories:
176
169
 
177
170
true
178
 
    (default) This section applies to subdirectories as well.
 
171
    (default) This section applies to subdirectories as well
179
172
 
180
173
false
181
174
    This section only applies to the branch at this directory and not
182
 
    branches below it.
 
175
    branches 
183
176
 
184
177
gpg_signing_command
185
178
-------------------
186
179
(Default: "gpg"). Which program should be used to sign and check revisions.
187
 
For example::
 
180
example::
188
181
 
189
182
    gpg_signing_command = /usr/bin/gnpg
190
183
 
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