/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/developers/configuration.txt

  • Committer: Jelmer Vernooij
  • Date: 2017-07-23 22:06:41 UTC
  • mfrom: (6738 trunk)
  • mto: This revision was merged to the branch mainline in revision 6739.
  • Revision ID: jelmer@jelmer.uk-20170723220641-69eczax9bmv8d6kk
Merge trunk, address review comments.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/configuration.txt
1
 
Configuring Breezy
 
1
Configuring Bazaar
2
2
==================
3
3
 
4
4
.. contents::
5
5
   :depth: 2
6
6
 
7
 
As a Breezy developer there are a few things you need to know about
 
7
As a Bazaar developer there are a few things you need to know about
8
8
configuration:
9
9
 
10
10
* how to add a new option,
63
63
 
64
64
But before doing that, you must be sure that the stack you're using have a
65
65
writable section (this is true for ``GlobalStack`` which uses the
66
 
``DEFAULT`` section in ``breezy.conf`` and for ``BranchStack``which uses the
 
66
``DEFAULT`` section in ``bazaar.conf`` and for ``BranchStack``which uses the
67
67
no-name section in ``branch.conf``).
68
68
 
69
69
Old and new configuration code
112
112
associated levels of generality and query them in the appropriate order
113
113
returning the first definition found. For example, the
114
114
``append_revisions_only`` option may be declared for all branches of a user
115
 
in ``breezy.conf``, or for a hierarchy of branches in ``locations.conf`` or
 
115
in ``bazaar.conf``, or for a hierarchy of branches in ``locations.conf`` or
116
116
in a single branch in ``branch.conf``.
117
117
 
118
118
Defining a new stack means you need a new way to expose these levels to the
138
138
The following stores are used by ``brz`` in ways that illustrate various
139
139
uses of sections.
140
140
 
141
 
breezy.conf
 
141
bazaar.conf
142
142
===========
143
143
 
144
144
``brz`` itself defines two sections here:
154
154
though). The ``bzr-bookmarks`` plugin defines a ``BOOKMARKS`` section there
155
155
for example.
156
156
 
 
157
pkgimport.conf
 
158
==============
 
159
 
 
160
The Ubuntu package importer defines a store and two stacks involving
 
161
``pkgimport.conf``. A no-name section contains the options common to all
 
162
packages and sections named after their corresponding package can also be
 
163
defined.
 
164
 
 
165
The ``ImporterStack`` uses ``locations.conf`` and the no-name section in
 
166
``pkgimport.conf`` for the importer options.
 
167
 
 
168
The ``PackageStack`` uses only ``pkgimport.conf`` and uses the section name
 
169
after the package followed by the no-name section.
 
170
 
157
171
location.conf
158
172
=============
159
173
 
247
261
to implement a locking mechanism. ``LockableIniFileStore`` implements such a
248
262
mechanism for ``IniFileStore`` based stores.
249
263
 
250
 
Classes are provided for the usual Breezy configuration files and could be
 
264
Classes are provided for the usual Bazaar configuration files and could be
251
265
used as examples to define new ones if needed. The associated tests provides a
252
266
basis for new classes which only need to register themselves in the right
253
267
places to inherit from the existing basic tests and add their own specific