[Zope-Checkins] CVS: Packages/ZConfig/doc - zconfig.tex:1.6

[Fred L. Drake, Jr.]

Update of /cvs-repository/Packages/ZConfig/doc
In directory cvs.zope.org:/tmp/cvs-serv24045

Modified Files:
	zconfig.tex 
Log Message:
Fill in a little more.


=== Packages/ZConfig/doc/zconfig.tex 1.5 => 1.6 ===
--- Packages/ZConfig/doc/zconfig.tex:1.5	Thu Oct 10 11:22:22 2002
+++ Packages/ZConfig/doc/zconfig.tex	Thu Oct 10 17:49:30 2002
@@ -48,6 +48,14 @@
 \declaremodule{}{ZConfig}
 \modulesynopsis{Configuration package}
 
+The main \module{ZConfig} package exports a single function:
+
+\begin{funcdesc}{load}{url}
+  Load and return a configuration from a URL or pathname given by
+  \var{url}.  \var{url} may be a URL, absolute pathname, or relative
+  pathname.
+\end{funcdesc}
+
 
 \section{\module{ZConfig.Context} --- Application context}
 
@@ -66,11 +74,46 @@
 \declaremodule{}{ZConfig.Common}
 \modulesynopsis{Exceptions}
 
+\begin{excdesc}{ConfigurationError}
+  Base class for exceptions specific to the \module{ZConfig} package.
+  All instances provide a \member{message} attribute that describes
+  the specific error.
+\end{excdesc}
+
+\begin{excdesc}{ConfigurationSyntaxError}
+  Exception raised when a configuration source does not conform to the
+  allowed syntax.  In addition to the \member{message} attribute,
+  exceptions of this type offer the \member{url} and \member{lineno}
+  attributes, which provide the URL and line number at which the error
+  was detected.
+\end{excdesc}
+
+\begin{excdesc}{ConfigurationTypeError}
+\end{excdesc}
+
+\begin{excdesc}{ConfigurationMissingSectionError}
+\end{excdesc}
+
+\begin{excdesc}{ConfigurationConflictingSectionError}
+\end{excdesc}
+
 
 \section{\module{ZConfig.ApacheStyle} --- Apache-style parser}
 
 \declaremodule{}{ZConfig.ApacheStyle}
 \modulesynopsis{Parser for Apache-style configurations}
+
+The \module{ZConfig.ApacheStyle} module implements the configuration
+parser.  Most applications will not need to use this module directly.
+
+This module provides a single function:
+
+\begin{funcdesc}{Parse}{file, context, section, url}
+  Parse text from the open file object \var{file}.  The application
+  context is given as \var{context}, the section object that values
+  and sections should be added to is given as \var{section}, and the
+  URL of the resource being parsed is given in \var{url}.
+\end{funcdesc}
 
 
 \section{\module{ZConfig.Interpolation} --- String interpolation}