← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/configuration.txt

  • Committer: Andrew Bennetts
  • Date: 2011-05-18 15:45:07 UTC
  • mto: This revision was merged to the branch mainline in revision 5895.
  • Revision ID: andrew.bennetts@canonical.com-20110518154507-t3qudgcb7fj3omjc
Use pydoctor in api-docs make target.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/configuration.txt
3
3
 
4
4
A configuration option has:
5
5
 
6
 
* a name: a valid python identifier (even if it's not used as an
 
6
- a name: a valid python identifier (even if it's not used as an
7
7
  identifier in python itself)
8
8
 
9
 
* a value: a unicode string
10
 
 
11
 
Option
12
 
------
13
 
 
14
 
The Option object is used to define its properties:
15
 
 
16
 
* name: a name: a valid python identifier (even if it's not used as an
17
 
  identifier in python itself). This is also used to register the option.
18
 
 
19
 
* default: the default value that Stack.get() should return if no
20
 
  value can be found for the option.
21
 
 
22
 
Since plugins should be able to lazily register options, the associated help
23
 
is not part of the object but provided at registration time.
 
9
- a value: a unicode string
24
10
 
25
11
Sections
26
12
--------
28
14
Options are grouped into sections which share some properties with the well
29
15
known dict objects:
30
16
 
31
 
* the key is the name,
32
 
* you can get, set and remove an option,
33
 
* the value is a unicode string.
 
17
- the key is the name,
 
18
- you can get, set and remove an option,
 
19
- the value is a unicode string.
34
20
 
35
21
MutableSection is needed to set or remove an option, ReadOnlySection should
36
22
be used otherwise.