r203 - branches/rewrite/doc

[Nat Budin]

Author: natbudin-guest
Date: Mon Jul 26 16:19:07 2004
New Revision: 203

Modified:
   branches/rewrite/doc/HACKING
Log:
Added information about the Config object hierarchy.


Modified: branches/rewrite/doc/HACKING
==============================================================================
--- branches/rewrite/doc/HACKING	(original)
+++ branches/rewrite/doc/HACKING	Mon Jul 26 16:19:07 2004
@@ -31,4 +31,30 @@
 (Functionality: figure out which packages need updating; pull updates 
 from source)
 
-$Id$
\ No newline at end of file
+Config(ConfigParser.ConfigParser) - the debpartial-mirror configuration 
+  |                                 database, read from a text file
+  |
+  +-------> uses several ConfigSection objects (see below)
+
+(Functionality: read the config file, verify that its format is ok, and 
+store it in memory.  Allow access to config options.)
+
+ConfigSection - a section of the config file
+  |
+  +-------> ConfigGlobal - the GLOBAL section of the config file
+  |
+  +-------> ConfigBackend - a backend section
+               |
+               +------> ConfigBackendMirror - a mirroring backend (pulls 
+               |                              package files from a 
+               |                              remote repository)
+               |
+               +------> ConfigBackendMerge - a merging backend (combines 
+                                             several mirroring backends 
+                                             into one repository)
+
+(Functionality: read one section of the config file and verify that its 
+members are correctly formatted, then give it back to the Config 
+object.)
+
+$Id$