← Back to branch summary

~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: 2007-06-28 07:08:27 UTC
  • mfrom: (2553.1.3 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070628070827-h5s313dg5tnag9vj
(robertc) Show the names of commit hooks during commit.

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
 
.. TODO: Should have some explanation of why you'd want things in
8
 
.. branch.conf.
9
 
 
10
 
Location of configuration files
11
 
===============================
 
7
Location of configuration file
 
8
==============================
12
9
Each user gets a pair of configurations files in ``$HOME/.bazaar``. The first
13
10
one, named ``bazaar.conf``, includes default configuration options. The other
14
11
file, ``locations.conf``, contains configuration information for specific
15
12
branch locations.  These files are sometimes referred to as ``ini files``.
16
13
 
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
 
 
23
14
General Format
24
15
==============
25
16
An ini file has three types of contructs: section headers, section
51
42
    [/home/jdoe/branches/]
52
43
 
53
44
 
 
45
 
54
46
Section Variables
55
47
-----------------
56
48
 
136
128
editor
137
129
------
138
130
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
 
131
a commit log message. This setting is trumped by the environment variable
140
132
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
141
133
 
142
134
check_signatures
197
189
----------------------------
198
190
User and password to authenticate to the SMTP server. If smtp_username
199
191
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
192
 
203
193
 
204
194
Branch 6 Options
219
209
---------------
220
210
If present, the location of the default branch for pull or merge.
221
211
This option is normally set by ``pull --remember`` or ``merge
222
 
--remember``.
 
212
--remember``
223
213
 
224
214
push_location
225
215
-------------
236
226
If set to "True", the branch should act as a checkout, and push each commit to
237
227
the bound_location.  This option is normally set by ``bind``/``unbind``.
238
228
 
 
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.