Rev 5527: Some more brain dump. in file:///home/vila/src/bzr/experimental/config/

[Vincent Ladeuil]

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

------------------------------------------------------------
revno: 5527
revision-id: v.ladeuil+lp at free.fr-20110203104503-17puvkgjfr3r4wfn
parent: v.ladeuil+lp at free.fr-20110203104102-kfkghol9y49uk4qd
committer: Vincent Ladeuil <v.ladeuil+lp at free.fr>
branch nick: doc-new-config
timestamp: Thu 2011-02-03 11:45:03 +0100
message:
  Some more brain dump.
-------------- next part --------------
=== modified file 'doc/developers/configuration.txt'
--- a/doc/developers/configuration.txt	2010-12-02 08:35:25 +0000
+++ b/doc/developers/configuration.txt	2011-02-03 10:45:03 +0000
@@ -431,3 +431,54 @@
 
   * The ``appendpath`` policy should be implemented via interpolation and a
     ``relpath`` option provided by the configuration framework.
+
+Notes
+=====
+
+User facing concepts
+--------------------
+
+An option can be:
+* read
+* created
+* modified
+* deleted
+
+A config file can define:
+* one or several sections
+* each section can contain one or several option definitions
+
+Developer facing concepts
+-------------------------
+
+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)
+
+Section
+~~~~~~~
+* name (DEFAULT is a synonym for None somehow)
+* dict of (name, value) pair defining options
+* dict of (name, value) pairs for section specific options
+  (relpath) this can't be changed by the user
+
+
+Config
+~~~~~~
+* ID
+* list of Sections in priority order
+* dict of (name, value) pairs for config specific options
+  (path) this can't be changed by the user
+
+ConfigFile
+~~~~~~~~~~
+* url
+* list of Sections
+
+
+relationship between Config and ConfigFile still unclear. an config specific env is needed intuitively, but do we need to make ConfigFile to inherit from Config and make Config use a list of Configs instead of a list of Sections ?