← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/configuration.txt

  • Committer: Vincent Ladeuil
  • Date: 2011-04-08 15:55:02 UTC
  • mto: (5743.5.5 config-concrete-stores)
  • mto: This revision was merged to the branch mainline in revision 5832.
  • Revision ID: v.ladeuil+lp@free.fr-20110408155502-9ojf971rtcrwnr9s
Some doc for the stores.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/configuration.txt
21
21
MutableSection are needed to set or remove an option, ReadOnlySection should
22
22
be used otherwise.
23
23
 
 
24
Stores
 
25
------
 
26
 
 
27
Options can persistent in which case they are saved into Stores.
 
28
 
 
29
``config.Store`` defines the abstract interface that all stores should
 
30
implement.
 
31
 
 
32
This object doesn't provide a direct access to the options, it only provides
 
33
access to Sections. This is deliberate to ensure that sections can be properly
 
34
shared by reusing the same underlying objects. Accessing options should be
 
35
done via the ``Section`` objects.
 
36
 
 
37
A ``Store`` can contain one or more sections, each section is uniquely
 
38
identified by a unicode string.
 
39
 
 
40
``config.ConfigObjStore`` is an implementation that use ``ConfigObj``.
 
41
 
 
42
Depending on the object it is associated with (or not) a ``Store`` also needs
 
43
to implement a locking mechanism. ``LockableConfigObjStore`` implements such a
 
44
mechanism for ``ConfigObj`` based stores.