Rev 5537: Fix rst. in file:///home/vila/src/bzr/experimental/config/

[Vincent Ladeuil]

At file:///home/vila/src/bzr/experimental/config/

------------------------------------------------------------
revno: 5537
revision-id: v.ladeuil+lp at free.fr-20110331153701-qtx9frnrktsnfgql
parent: v.ladeuil+lp at free.fr-20110331135639-6mb3rf1fs5v45edv
committer: Vincent Ladeuil <v.ladeuil+lp at free.fr>
branch nick: doc-new-config
timestamp: Thu 2011-03-31 17:37:01 +0200
message:
  Fix rst.
-------------- next part --------------
=== modified file 'doc/developers/configuration.txt'
--- a/doc/developers/configuration.txt	2011-03-31 13:56:39 +0000
+++ b/doc/developers/configuration.txt	2011-03-31 15:37:01 +0000
@@ -449,15 +449,20 @@
 --------------------
 
 An option can be:
+
 * read
+
 * created
+
 * modified
+
 * deleted
 
 A config file can define:
 
 * one or several sections. A unique section identifier is required if more
   than one section is defined.
+
 * each section can contain one or several option definitions
 
 
@@ -466,12 +471,17 @@
 
 Option
 ~~~~~~
+
 * name
+
 * help
+
 * default value (optional)
+
 * list of allowed Config IDs (this allows a list of possible
   config files in bazaar.conf only option and use it while
   bootstrapping the config creations)
+
 * blacklist of config IDs (some options *can't* be stored (modified) by the
   user)
 
@@ -481,14 +491,17 @@
 
 Section
 ~~~~~~~
+
 * section ID (for a given Store)
+
 * dict of (name, value) pairs defining options
 
 * dict of (name, original_value) pairs used to detect conflicting
-  modifications
+  modifications if the section is mutable
 
 Stack
 ~~~~~
+
 * A list of read-only Section/Stack objects
 
 * A single mutable Section object and its associated Store (defined only if
@@ -512,12 +525,18 @@
 ~~~~~
 
 * url
+
 * config ID
+
 * can serialize/deserialize a dict of Sections
+
 * can cache reads and writes
+
 * ensures that the transaction is the object life time (i.e. modifications
   will be taken into account *iff* they are committed explicitly).
+
 * can be read-only or read/write at build time
+
 * can provide an ordered list of Section for a given context
 
 Examples
@@ -527,9 +546,13 @@
 ~~~~~~~~~~~~~~~~
 
 * os.environ
+
 * options provided on the command-line
+
 * actual branch.conf
+
 * any section in a Store
+
 * a dict for section or store specific options ('relpath', 'nick', etc)
 
 store examples:
@@ -543,15 +566,23 @@
 ~~~~~~~~~~~~~~
 
 The actual GlobalConfig will become a stack with:
+
 * options from the command-line
+
 * os.environ
+
 * the default section from bazaar.conf
 
 The actual BranchConfig will become a stack with:
+
 * options from the command-line
+
 * os.environ
+
 * a stack for the matching sections in locations.conf
+
 * a stack for the matching sections in branch.conf
+
 * a stack for the matching sections in bazaar.conf
 
 The modifications will be made to the section in branch.conf specified when