[Zodb-checkins] CVS: StandaloneZODB/Doc - storage.tex:1.4

[Fred L. Drake, Jr.]

Update of /cvs-repository/StandaloneZODB/Doc
In directory cvs.zope.org:/tmp/cvs-serv11178

Modified Files:
	storage.tex 
Log Message:
Fix use of incorrect markup, and use consistent indentation.

=== StandaloneZODB/Doc/storage.tex 1.3 => 1.4 ===
 The various exceptions that can be raised.
 
-\begin{classdesc}{Storage}{}
-  
+\begin{classdesc*}{Storage}{}
   An object that implements the storage interface must support the
   following methods.
+\end{classdesc*}
 
-\begin{funcdesc}{tpc_begin}{transaction\optional{, tid\optional{,
+\begin{methoddesc}{tpc_begin}{transaction\optional{, tid\optional{,
         status}}}
-  
   Begin the two-phase commit for \var{transaction}.  
 
   This method blocks until the storage is in the not committing state,
@@ -60,12 +59,10 @@
   not specified, the implementation chooses the timestamp.
 
   The optional \var{status} argument, which has a default value of
-  \code{' '}, has something to do with copying transactions.
+  \code{'~'}, has something to do with copying transactions.
+\end{methoddesc}
 
-\end{funcdesc}
-
-\begin{funcdesc}{store}{oid, serial, data, version, transaction}
-  
+\begin{methoddesc}{store}{oid, serial, data, version, transaction}
   Store \var{data}, a Python pickle, for the object id, \var{oid}.  A
   Storage need not and often will not write data immediately. If data
   are written, then the storage should be prepared to undo the write
@@ -111,13 +108,10 @@
         \item \exception{StorageError} or, more often, a subclass of
           it, is raised when an internal error occurs while the
           storage is handling the \method{store()} call.
-
   \end{itemize}
+\end{methoddesc}
 
-\end{funcdesc}
-
-\begin{funcdesc}{tpc_finish}{transaction, func}
-
+\begin{methoddesc}{tpc_finish}{transaction, func}
   Finish the transaction, making any transaction changes
   permanent.  Changes must be made permanent at this point.
 
@@ -128,40 +122,40 @@
   held, but possibly before the updated date is made durable.  This
   argument exists to support the \class{Connection} object's
   invalidation protocol.
+\end{methoddesc}
 
-\end{funcdesc}
+\begin{methoddesc}{abortVersion}{version, transaction}
+  Clear any changes made by the given version.  \var{version} is the
+  version to be aborted; it may not be the empty string.
+  \var{transaction} is the current transaction.
+
+  This method is state dependent. It is an error to call this method
+  if the storage is not committing, or if the given transaction is not
+  the transaction given in the most recent \method{tpc_begin()}.
+
+  If undo is not supported, then version data may be simply
+  discarded.  If undo is supported, however, then the
+  \method{abortVersion()} operation must be undoable, which implies
+  that version data must be retained.
+\end{methoddesc}
+
+\begin{methoddesc}{commitVersion}{source, destination, transaction}
+  Store changes made in the \var{source} version into the
+  \var{destination} version.  A \exception{VersionCommitError} is
+  raised if the \var{source} and \var{destination} are equal or if
+  \var{source} is an empty string.  The \var{destination} may be an
+  empty string, in which case the data are saved to non-version
+  storage.
+
+  This method is state dependent.  It is an error to call this method
+  if the storage is not committing, or if the given transaction is not
+  the transaction given in the most recent \method{tpc_begin()}.
+
+  If the storage doesn't support undo, then the old version data may
+  be discarded.  If undo is supported, then this operation must be
+  undoable and old transaction data may not be discarded. 
+\end{methoddesc}
 
-\begin{funcdesc}{abortVersion}{version, transaction}
-Clear any changes made by the given version.  \var{version} is the version
-to be aborted; it may not be the empty string.  \var{transaction} is the
-current transaction.
-
-This method is state dependent. It is an error to call this method if
-the storage is not committing, or if the given transaction is not the
-transaction given in the most recent \method{tpc_begin()}.
-
-If undo is not supported, then version data may be simply discarded.
-If undo is supported, however, then the \method{abortVersion()}
-operation must be undoable, which implies that version data must be
-retained.
-\end{funcdesc}
-
-\begin{funcdesc}{commitVersion}{source, destination, transaction}
-Store changes made in the \var{source} version into the \var{destination}
-version.  A \exception{VersionCommitError} is raised if the \var{source}
-and \var{destination} are equal or if \var{source} is an empty string. The
-\var{destination} may be an empty string, in which case the data are saved
-to non-version storage.
-
-This method is state dependent. It is an error to call this method if
-the storage is not committing, or if the given transaction is not the
-transaction given in the most recent \method{tpc_begin()}.
-
-If the storage doesn't support undo, then the old version data may be
-discarded. If undo is supported, then this operation must be undoable
-and old transaction data may not be discarded. 
-\end{funcdesc}
-\end{classdesc}
 
 \section{ZODB.BaseStorage Implementation}