← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/configuration.txt

  • Committer: Aaron Bentley
  • Date: 2007-07-17 13:27:14 UTC
  • mfrom: (2624 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2631.
  • Revision ID: abentley@panoramicfeedback.com-20070717132714-tmzx9khmg9501k51
Merge from bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/configuration.txt
4
4
 
5
5
Information on how to configure Bazaar.
6
6
 
7
 
Location of configuration file
8
 
==============================
 
7
.. TODO: Should have some explanation of why you'd want things in
 
8
.. branch.conf.
 
9
 
 
10
Location of configuration files
 
11
===============================
9
12
Each user gets a pair of configurations files in ``$HOME/.bazaar``. The first
10
13
one, named ``bazaar.conf``, includes default configuration options. The other
11
14
file, ``locations.conf``, contains configuration information for specific
12
15
branch locations.  These files are sometimes referred to as ``ini files``.
13
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``.
 
22
 
14
23
General Format
15
24
==============
16
25
An ini file has three types of contructs: section headers, section
42
51
    [/home/jdoe/branches/]
43
52
 
44
53
 
45
 
 
46
54
Section Variables
47
55
-----------------
48
56
 
128
136
editor
129
137
------
130
138
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
 
139
a commit message. This setting is trumped by the environment variable
132
140
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
133
141
 
134
142
check_signatures
189
197
----------------------------
190
198
User and password to authenticate to the SMTP server. If smtp_username
191
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.
192
202
 
193
203
 
194
204
Branch 6 Options
209
219
---------------
210
220
If present, the location of the default branch for pull or merge.
211
221
This option is normally set by ``pull --remember`` or ``merge
212
 
--remember``
 
222
--remember``.
213
223
 
214
224
push_location
215
225
-------------
226
236
If set to "True", the branch should act as a checkout, and push each commit to
227
237
the bound_location.  This option is normally set by ``bind``/``unbind``.
228
238
 
229
 
 
230
 
Bug Tracker Options
231
 
===================
232
 
 
233
 
These options can go into bazaar.conf, branch.conf or into a branch-specific
234
 
configuration section in locations.conf.
235
 
 
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
241
 
example::
242
 
 
243
 
    bugzilla_squid_url = http://www.squid-cache.org/bugs
244
 
 
245
 
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
246
 
fixed.
247
 
 
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
253
 
example::
254
 
 
255
 
    trac_twisted_url = http://www.twistedmatrix.com/trac
256
 
 
257
 
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
258
 
fixed.