[Zope3-checkins] CVS: Zope3/src/zope/app/process - schema.xml:1.1.2.2

[Fred L. Drake, Jr.]

Update of /cvs-repository/Zope3/src/zope/app/process
In directory cvs.zope.org:/tmp/cvs-serv16708

Modified Files:
      Tag: fdrake-zconfig-in-zope-3-branch
	schema.xml 
Log Message:
start filling in documentation


=== Zope3/src/zope/app/process/schema.xml 1.1.2.1 => 1.1.2.2 ===
--- Zope3/src/zope/app/process/schema.xml:1.1.2.1	Mon Jun 23 18:07:58 2003
+++ Zope3/src/zope/app/process/schema.xml	Tue Jun 24 14:18:18 2003
@@ -1,4 +1,11 @@
 <schema>
+  <description>
+    Zope 3 configuration schema.
+
+    This schema describes the configuration options available to a
+    site administrator via the zope.conf configuration file.
+  </description>
+
   <!-- database and storage types -->
   <import package="zodb" />
 
@@ -12,12 +19,50 @@
   </sectiontype>
 
   <section type="zodb.database" name="*" required="yes"
-           attribute="database" />
-  <section type="eventlog" attribute="eventlog" name="*" />
+           attribute="database">
+    <description>
+      The main application database that should be used.
+    </description>
+  </section>
+
+  <section type="eventlog" attribute="eventlog" name="*">
+    <description>
+      Configuration for the event log.
+    </description>
+  </section>
+
   <multisection type="server" name="*" attribute="servers" />
 
-  <key name="site-definition" default="site.zcml" />
+  <key name="site-definition" default="site.zcml">
+    <description>
+      The name of the top-level ZCML file that defines the component
+      configuration used for this site.
+    </description>
+  </key>
+
   <key name="interrupt-check-interval" datatype="integer" default="120"
-       attribute="check_interval" />
-  <key name="threads" datatype="integer" default="4" />
+       attribute="check_interval">
+    <description>
+      Value passed to Python's sys.setcheckinterval() function.
+
+      This integer value determines how often the interpreter checks
+      for periodic things such as thread switches and signal handlers.
+      Setting it to a larger value may increase performance for
+      programs using threads.  Setting it to a value <= 0 checks every
+      virtual instruction, maximizing responsiveness as well as
+      overhead.
+    </description>
+  </key>
+
+  <key name="threads" datatype="integer" default="4">
+    <description>
+      The number of threads which should be used to serve requests.
+
+      The threads are placed in a pool and are used to serve requests
+      received from the servers configured using &lt;server&gt;
+      sections.  This does not constrain the total number of threads
+      used by the application server; additional threads may be used
+      for internal purposes.
+    </description>
+  </key>
 </schema>