← 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-01-02 20:10:16 UTC
  • mfrom: (2216.1.1 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070102201016-ce62560cd118fd90
(James Henstridge) update doc/configuration.txt with info about config variable policies.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/configuration.txt
16
16
An ini file has three types of contructs: section headers, section
17
17
variables and comments.
18
18
 
19
 
comment
20
 
-------
 
19
Comments
 
20
--------
21
21
A comment is any line that starts with a "#" (sometimes called a "hash
22
22
mark", "pound sign" or "number sign"). Comment lines are ignored by
23
23
Bazaar when parsing ini files.
24
24
 
25
 
section header
26
 
--------------
 
25
Section Headers
 
26
---------------
27
27
A section header is a word enclosed in brackets that starts at the begining
28
28
of a line, typical section headers look like this::
29
29
 
43
43
 
44
44
 
45
45
 
46
 
section variables
 
46
Section Variables
47
47
-----------------
48
48
 
49
49
A section variable resides within a section. A section variable contains a
54
54
    check_signatures = require
55
55
 
56
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
 
57
87
The main configuration file, bazaar.conf
58
88
----------------------------------------
59
89