← 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: 2006-09-11 22:48:57 UTC
  • mto: This revision was merged to the branch mainline in revision 2004.
  • Revision ID: john@arbash-meinel.com-20060911224857-d7008be21aeee33e
Switch from individual functions to a class

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/configuration.txt
 
1
====================
 
2
Bazaar configuration
 
3
====================
 
4
 
 
5
Information on how to configure Bazaar.
 
6
 
1
7
Location of configuration file
2
8
==============================
3
9
Each user gets a pair of configurations files in $HOME/.bazaar. The first
4
10
one, named bazaar.conf, includes default configuration options. The other
5
 
file, branches.conf, contains configuration information for specific
6
 
branches.
 
11
file, locations.conf, contains configuration information for specific
 
12
branch locations.
7
13
 
8
14
General Format
9
15
==============
14
20
-------
15
21
A comment is any line that starts with a "#" (sometimes called a "hash
16
22
mark", "pound sign" or "number sign"). Comment lines are ignored by
17
 
Bazaar-NG when parsing ini files.
 
23
Bazaar when parsing ini files.
18
24
 
19
25
section header
20
26
--------------
27
33
senstive. The default section provides for setting variables which can be
28
34
overridden with the branch config file.
29
35
 
30
 
For branches.conf, the variables from the section with the longest matching
 
36
For locations.conf, the variables from the section with the longest matching
31
37
section header are used to the exclusion of other potentially valid section
32
38
headers. A section header uses the path for the branch as the section
33
39
header. Some examples include::
54
60
The main configuration file, $HOME/.bazaar/bazaar.conf, only allows one
55
61
section called '''[DEFAULT]'''. This default section contains the default
56
62
configuration options for all branches. The default section can be
57
 
overriden by providing a branch specific section in branches.conf.
 
63
overriden by providing a branch specific section in locations.conf.
58
64
 
59
65
A typical bazaar.conf section often looks like the following::
60
66
 
64
70
    check_signatures  = check-available
65
71
    create_signatures = when-required
66
72
 
67
 
$HOME/.bazaar/branches.conf allows one to specify overriding settings for a
 
73
$HOME/.bazaar/locations.conf allows one to specify overriding settings for a
68
74
specific branch. The format is almost identical to the default section in
69
75
bazaar.conf with one significant change: The section header, instead of
70
76
saying default, will be the path to a branch that you wish to override a
77
83
    create_signatures = always
78
84
    check_signatures  = always
79
85
 
80
 
    [http://bazaar-ng.org/bzr/*]
 
86
    [http://bazaar-vcs.org/bzr/*]
81
87
    check_signatures  = require
82
88
 
83
89
Common Variable options
94
100
------
95
101
The path of the editor that you wish to use if *bzr commit* is run without
96
102
a commit log message. This setting is trumped by the environment variables
97
 
$BZREDITOR or $EDITOR.
 
103
$BZR_EDITOR or $EDITOR.
98
104
 
99
105
check_signatures
100
106
----------------
108
114
 
109
115
check-available
110
116
    (default) If gnupg signatures for revisions are present, check them.
111
 
    Bazaar-NG will fail if it finds a bad signature, but will not fail if
 
117
    Bazaar will fail if it finds a bad signature, but will not fail if
112
118
    no signature is present
113
119
 
114
120
create_signatures
128
134
 
129
135
recurse
130
136
-------
131
 
Only useful in branches.conf. Defines whether or not the configuration for
 
137
Only useful in locations.conf. Defines whether or not the configuration for
132
138
this section applies to subdirectories:
133
139
 
134
140
true