← 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-02-01 23:48:08 UTC
  • mfrom: (2225.1.6 revert)
  • Revision ID: pqm@pqm.ubuntu.com-20070201234808-3b1302d73474bd8c
Display changes made by revert

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
10
16
An ini file has three types of contructs: section headers, section
11
17
variables and comments.
12
18
 
13
 
comment
14
 
-------
 
19
Comments
 
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
 
section header
20
 
--------------
 
25
Section Headers
 
26
---------------
21
27
A section header is a word enclosed in brackets that starts at the begining
22
28
of a line, typical section headers look like this::
23
29
 
37
43
 
38
44
 
39
45
 
40
 
section variables
 
46
Section Variables
41
47
-----------------
42
48
 
43
49
A section variable resides within a section. A section variable contains a
48
54
    check_signatures = require
49
55
 
50
56
 
 
57
Variable Policies
 
58
-----------------
 
59
 
 
60
Variables defined in a section affect the named directory or URL plus
 
61
any locations they contain.  Policies can be used to change how a
 
62
variable value is interpreted for contained locations.  Currently
 
63
there are three policies available:
 
64
 
 
65
 none:
 
66
   the value is interpreted the same for contained locations.  This is
 
67
   the default behaviour.
 
68
 norecurse:
 
69
   the value is only used for the exact location specified by the
 
70
   section name.
 
71
 appendpath:
 
72
   for contained locations, any additional path components are
 
73
   appended to the value.
 
74
 
 
75
Policies are specified by keys with names of the form "$var:policy".
 
76
For example, to define the push location for a tree of branches, the
 
77
following could be used::
 
78
 
 
79
  [/top/location]
 
80
  push_location = sftp://example.com/location
 
81
  push_location:policy = appendpath
 
82
 
 
83
With this configuration, the push location for ``/top/location/branch1``
 
84
would be ``sftp://example.com/location/branch1``.
 
85
 
 
86
 
51
87
The main configuration file, bazaar.conf
52
88
----------------------------------------
53
89
 
77
113
    create_signatures = always
78
114
    check_signatures  = always
79
115
 
80
 
    [http://bazaar-ng.org/bzr/*]
 
116
    [http://bazaar-vcs.org/bzr/*]
81
117
    check_signatures  = require
82
118
 
83
119
Common Variable options
93
129
editor
94
130
------
95
131
The path of the editor that you wish to use if *bzr commit* is run without
96
 
a commit log message. This setting is trumped by the environment variables
97
 
$BZREDITOR or $EDITOR.
 
132
a commit log message. This setting is trumped by the environment variable
 
133
$BZR_EDITOR, and overrides $VISUAL and $EDITOR.
98
134
 
99
135
check_signatures
100
136
----------------
108
144
 
109
145
check-available
110
146
    (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
 
147
    Bazaar will fail if it finds a bad signature, but will not fail if
112
148
    no signature is present
113
149
 
114
150
create_signatures