← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/configuration.txt

  • Committer: joe blow
  • Date: 2007-02-27 21:24:38 UTC
  • mto: (2293.1.5 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 2311.
  • Revision ID: joe@blow.com-20070227212438-ndpq6lsmn9ahroz5
Updated documents for grammer, spelling, and clarity.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/configuration.txt
6
6
 
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
12
 
branch locations.
 
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``.
13
13
 
14
14
General Format
15
15
==============
25
25
Section Headers
26
26
---------------
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 headers look like this::
29
29
 
30
30
    [DEFAULT]
31
31
 
32
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
 
33
sensitive. The default section provides for setting variables which can be
34
34
overridden with the branch config file.
35
35
 
36
 
For locations.conf, the variables from the section with the longest matching
 
36
For ``locations.conf``, the variables from the section with the longest matching
37
37
section header are used to the exclusion of other potentially valid section
38
38
headers. A section header uses the path for the branch as the section
39
39
header. Some examples include::
47
47
-----------------
48
48
 
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
51
 
form::
 
50
variable name, an equals sign and a value.  For example::
52
51
 
53
52
    email            = John Doe <jdoe@isp.com>
54
53
    check_signatures = require
87
86
The main configuration file, bazaar.conf
88
87
----------------------------------------
89
88
 
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``.
94
93
 
95
 
A typical bazaar.conf section often looks like the following::
 
94
A typical ``bazaar.conf`` section often looks like the following::
96
95
 
97
96
    [DEFAULT]
98
97
    email             = John Doe <jdoe@isp.com>
100
99
    check_signatures  = check-available
101
100
    create_signatures = when-required
102
101
 
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::
108
107
 
109
108
    [/home/jdoe/branches/nethack]
110
109
    email = Nethack Admin <nethack@nethack.com>
116
115
    [http://bazaar-vcs.org/bzr/*]
117
116
    check_signatures  = require
118
117
 
119
 
Common Variable options
 
118
Common Variable Options
120
119
=======================
121
120
 
122
121
email
130
129
------
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``.
134
133
 
135
134
check_signatures
136
135
----------------
137
136
Defines the behavior for signatures.
138
137
 
139
138
require
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.
141
140
 
142
141
ignore
143
142
    Do not check gnupg signatures of revisions. 
145
144
check-available
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.
149
148
 
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.
154
152
 
155
153
always
156
 
    sign every new revision that is committed
 
154
    Sign every new revision that is committed.
157
155
 
158
156
when-required
159
157
    (default) Sign newly committed revisions only when the branch requires
160
 
    signed revisions
 
158
    signed revisions.
161
159
 
162
160
never
163
 
    Refuse to sign newly committed revisions, even if the branch requires signatures
 
161
    Refuse to sign newly committed revisions, even if the branch requires signatures.
164
162
 
165
163
recurse
166
164
-------
167
 
Only useful in locations.conf. Defines whether or not the configuration for
 
165
Only useful in ``locations.conf``. Defines whether or not the configuration for
168
166
this section applies to subdirectories:
169
167
 
170
168
true
171
 
    (default) This section applies to subdirectories as well
 
169
    (default) This section applies to subdirectories.
172
170
 
173
171
false
174
172
    This section only applies to the branch at this directory and not
175
 
    branches 
 
173
    branches below it. 
176
174
 
177
175
gpg_signing_command
178
176
-------------------
179
177
(Default: "gpg"). Which program should be used to sign and check revisions.
180
 
example::
 
178
For example::
181
179
 
182
180
    gpg_signing_command = /usr/bin/gnpg
183
181
 
186
184
================
187
185
 
188
186
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
 
187
format.  They are usually set in ``.bzr/branch/branch.conf`` automatically, but
 
188
may be manually set in ``locations.conf`` or ``bazaar.conf``.
191
189
 
192
190
append_revisions_only
193
191
---------------------
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.
197
 
 
198
 
This is normally set by ``bzr init --append-revisions-only``.
 
192
If set to "true" then revisions can only be appended to the log, not
 
193
removed.  A branch with this setting enabled can only pull from
 
194
another branch if the other branch's log is a longer version of its
 
195
own.  This is normally set by ``bzr init --append-revisions-only``.
199
196
 
200
197
parent_location
201
198
---------------
202
199
If present, the location of the default branch for pull or merge.
203
 
 
204
 
This is normally set by ``pull --remember`` or ``merge --remember``
 
200
This option is normally set by ``pull --remember`` or ``merge
 
201
--remember``
205
202
 
206
203
push_location
207
204
-------------
208
 
If present, the location of the default branch for push.  This is normally
209
 
set by ``push --remember``.
 
205
If present, the location of the default branch for push.  This option
 
206
is normally set by ``push --remember``.
210
207
 
211
208
bound_location
212
209
--------------
213
 
The location that commits should go to when acting as a checkout.  (Normally
214
 
set by ``bind``)
 
210
The location that commits should go to when acting as a checkout.
 
211
This option is normally set by ``bind``.
215
212
 
216
213
bound
217
214
-----
218
215
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``.)
 
216
the bound_location.  This option is normally set by ``bind``/``unbind``.