[Collab-qa-commits] r1213 - udd/doc

[lucas at alioth.debian.org]

Author: lucas
Date: 2008-09-07 16:56:01 +0000 (Sun, 07 Sep 2008)
New Revision: 1213

Added:
   udd/doc/README.config
Removed:
   udd/doc/config.README
Log:
renamed config.README to README.config

Copied: udd/doc/README.config (from rev 1209, udd/doc/config.README)
===================================================================
--- udd/doc/README.config	                        (rev 0)
+++ udd/doc/README.config	2008-09-07 16:56:01 UTC (rev 1213)
@@ -0,0 +1,44 @@
+OVERVIEW:
+  The configuration file is in YAML format. See src/test.yaml for an example.
+
+  There are two types of top nodes:
+    - One with name 'general'
+    - The rest specified sources. Here the name corresponds to the name of the
+      source it describes
+
+GENERAL:
+  In the 'general' part, you specify:
+    - dbname: The name of the database you will access
+    - debug: 0 if you want no debug output, 1 otherwise
+    - types:
+      This subtree specified the possible source types. Each sub-node names a
+      type, and contains exactly one sub-node. This sub-node is a string,
+      either beginning with 'exec' or 'module'. To gather a source, the
+      dispatcher look into the configuraiton file for the source's type, and
+      then fetches the string specifed in the according sub-node of
+      general->types. If this string begins with 'exec', the rest of the string
+      is excuted as a command, with the path of the configuration file and the
+      name of the source appended to the command line. If this string begins
+      with 'module', the dispatcher assumes, that the rest of the line names a
+      module, which can be imported into python. The dispatcher expects the
+      module to provide function called get_gatherer, which should return an
+      object behaving like the class in src/udd/gatherer.py suggests.
+    - update-timestamps-folder:
+      If specified, each time a source is successfully updated via
+      src/udd-update.py, a file named like the source is created/modified in
+      the folder specified by this stanza, containing the date and time.
+
+SOURCES:
+  Each such sub-tree whose top node is not called 'general', represents a
+  source. The source's name is specified by the name of the top node.  The
+  sub-nodes of that tree specify the configuration of that source.  All
+  sources have to have a 'type' node, specifying the type of the source.  The
+  type has to have an corresponding entry in general->types. See the GENERAL
+  section.
+  Each source can have an 'update-command' node. If the name of a source is
+  passed as an argument to src/udd-update.py, and the sub-tree of that source
+  contains a node called 'update-command', the sub-node of that node is
+  executed with the system command, and is expected to fetch the data of that
+  source.
+  Other than that, each source type, has its own format, see doc/sources/ for the
+  format of each source type.

Deleted: udd/doc/config.README
===================================================================
--- udd/doc/config.README	2008-09-07 16:55:17 UTC (rev 1212)
+++ udd/doc/config.README	2008-09-07 16:56:01 UTC (rev 1213)
@@ -1,44 +0,0 @@
-OVERVIEW:
-  The configuration file is in YAML format. See src/test.yaml for an example.
-
-  There are two types of top nodes:
-    - One with name 'general'
-    - The rest specified sources. Here the name corresponds to the name of the
-      source it describes
-
-GENERAL:
-  In the 'general' part, you specify:
-    - dbname: The name of the database you will access
-    - debug: 0 if you want no debug output, 1 otherwise
-    - types:
-      This subtree specified the possible source types. Each sub-node names a
-      type, and contains exactly one sub-node. This sub-node is a string,
-      either beginning with 'exec' or 'module'. To gather a source, the
-      dispatcher look into the configuraiton file for the source's type, and
-      then fetches the string specifed in the according sub-node of
-      general->types. If this string begins with 'exec', the rest of the string
-      is excuted as a command, with the path of the configuration file and the
-      name of the source appended to the command line. If this string begins
-      with 'module', the dispatcher assumes, that the rest of the line names a
-      module, which can be imported into python. The dispatcher expects the
-      module to provide function called get_gatherer, which should return an
-      object behaving like the class in src/udd/gatherer.py suggests.
-    - update-timestamps-folder:
-      If specified, each time a source is successfully updated via
-      src/udd-update.py, a file named like the source is created/modified in
-      the folder specified by this stanza, containing the date and time.
-
-SOURCES:
-  Each such sub-tree whose top node is not called 'general', represents a
-  source. The source's name is specified by the name of the top node.  The
-  sub-nodes of that tree specify the configuration of that source.  All
-  sources have to have a 'type' node, specifying the type of the source.  The
-  type has to have an corresponding entry in general->types. See the GENERAL
-  section.
-  Each source can have an 'update-command' node. If the name of a source is
-  passed as an argument to src/udd-update.py, and the sub-tree of that source
-  contains a node called 'update-command', the sub-node of that node is
-  executed with the system command, and is expected to fetch the data of that
-  source.
-  Other than that, each source type, has its own format, see doc/sources/ for the
-  format of each source type.