← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/configuration.txt

  • Committer: John Arbash Meinel
  • Date: 2007-07-16 19:55:36 UTC
  • mfrom: (2601.1.3 bzr.dev.docs)
  • mto: This revision was merged to the branch mainline in revision 2621.
  • Revision ID: john@arbash-meinel.com-20070716195536-7swyum1epmk0313d
(James Westby) documentation updates (plugins, configuration, etc)

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
 
 
8
7
.. TODO: Should have some explanation of why you'd want things in
9
8
.. branch.conf.
10
9
 
11
 
Location of configuration file
12
 
==============================
 
10
Location of configuration files
 
11
===============================
13
12
Each user gets a pair of configurations files in ``$HOME/.bazaar``. The first
14
13
one, named ``bazaar.conf``, includes default configuration options. The other
15
14
file, ``locations.conf``, contains configuration information for specific
16
15
branch locations.  These files are sometimes referred to as ``ini files``.
17
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
 
18
23
General Format
19
24
==============
20
25
An ini file has three types of contructs: section headers, section
46
51
    [/home/jdoe/branches/]
47
52
 
48
53
 
49
 
 
50
54
Section Variables
51
55
-----------------
52
56
 
132
136
editor
133
137
------
134
138
The path of the editor that you wish to use if *bzr commit* is run without
135
 
a commit log message. This setting is trumped by the environment variable
 
139
a commit message. This setting is trumped by the environment variable
136
140
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
137
141
 
138
142
check_signatures
193
197
----------------------------
194
198
User and password to authenticate to the SMTP server. If smtp_username
195
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.
196
202
 
197
203
 
198
204
Branch 6 Options
213
219
---------------
214
220
If present, the location of the default branch for pull or merge.
215
221
This option is normally set by ``pull --remember`` or ``merge
216
 
--remember``
 
222
--remember``.
217
223
 
218
224
push_location
219
225
-------------
230
236
If set to "True", the branch should act as a checkout, and push each commit to
231
237
the bound_location.  This option is normally set by ``bind``/``unbind``.
232
238
 
233
 
 
234
 
Bug Tracker Options
235
 
===================
236
 
 
237
 
These options can go into bazaar.conf, branch.conf or into a branch-specific
238
 
configuration section in locations.conf.
239
 
 
240
 
bugzilla_<tracker_abbreviation>_url
241
 
-----------------------------------
242
 
If present, the location of the Bugzilla bug tracker referred to by
243
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
244
 
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
245
 
example::
246
 
 
247
 
    bugzilla_squid_url = http://www.squid-cache.org/bugs
248
 
 
249
 
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
250
 
fixed.
251
 
 
252
 
trac_<tracker_abbrevation>_url
253
 
------------------------------
254
 
If present, the location of the Trac instance referred to by
255
 
<tracker_abbreviation>. This option can then be used together with ``bzr commit
256
 
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
257
 
example::
258
 
 
259
 
    trac_twisted_url = http://www.twistedmatrix.com/trac
260
 
 
261
 
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
262
 
fixed.