← 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-04-17 00:59:30 UTC
  • mfrom: (1551.15.4 Aaron's mergeable stuff)
  • Revision ID: pqm@pqm.ubuntu.com-20070417005930-rofskshyjsfzrahh
Fix ftp transport with servers that don't support atomic rename

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
147
139
    The gnupg signature for revisions must be present and must be valid.
148
140
 
149
141
ignore
150
 
    Do not check gnupg signatures of revisions.
 
142
    Do not check gnupg signatures of revisions. 
151
143
 
152
144
check-available
153
145
    (default) If gnupg signatures for revisions are present, check them.
179
171
 
180
172
false
181
173
    This section only applies to the branch at this directory and not
182
 
    branches below it.
 
174
    branches below it. 
183
175
 
184
176
gpg_signing_command
185
177
-------------------
188
180
 
189
181
    gpg_signing_command = /usr/bin/gnpg
190
182
 
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
183
 
204
184
Branch 6 Options
205
185
================
219
199
---------------
220
200
If present, the location of the default branch for pull or merge.
221
201
This option is normally set by ``pull --remember`` or ``merge
222
 
--remember``.
 
202
--remember``
223
203
 
224
204
push_location
225
205
-------------
235
215
-----
236
216
If set to "True", the branch should act as a checkout, and push each commit to
237
217
the bound_location.  This option is normally set by ``bind``/``unbind``.
238