[Python-checkins] python/dist/src/Doc/lib libanydbm.tex,1.20,1.21 libdumbdbm.tex,1.1,1.2

[fdrake@users.sourceforge.net]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1:/tmp/cvs-serv2590

Modified Files:
	libanydbm.tex libdumbdbm.tex 
Log Message:
Merge the old dumbdbm documetation into the new docs that have been added.
Make some module references hyperlinks.


Index: libanydbm.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libanydbm.tex,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -d -r1.20 -r1.21
*** libanydbm.tex	7 Dec 2001 21:56:13 -0000	1.20
--- libanydbm.tex	21 Jul 2003 15:30:15 -0000	1.21
***************
*** 58,96 ****
                        existing database.}
  \end{seealso}
- 
- 
- \section{\module{dumbdbm} ---
-          Portable DBM implementation}
- 
- \declaremodule{standard}{dumbdbm}
- \modulesynopsis{Portable implementation of the simple DBM interface.}
- 
- 
- A simple and slow database implemented entirely in Python.  This
- should only be used when no other DBM-style database is available.
- 
- 
- \begin{funcdesc}{open}{filename\optional{, flag\optional{, mode}}}
- Open the database file \var{filename} and return a corresponding
- object.  The \var{flag} argument, used to control how the database is
- opened in the other DBM implementations, is ignored in
- \module{dumbdbm}; the database is always opened for update, and will
- be created if it does not exist.
- 
- The optional \var{mode} argument is the \UNIX{} mode of the file, used
- only when the database has to be created.  It defaults to octal
- \code{0666} (and will be modified by the prevailing umask).
- \versionchanged[The \var{mode} argument was ignored in earlier
-                 versions]{2.2}
- \end{funcdesc}
- 
- \begin{excdesc}{error}
- Raised for errors not reported as \exception{KeyError} errors.
- \end{excdesc}
- 
- 
- \begin{seealso}
-   \seemodule{anydbm}{Generic interface to \code{dbm}-style databases.}
-   \seemodule{whichdb}{Utility module used to determine the type of an
-                       existing database.}
- \end{seealso}
--- 58,59 ----

Index: libdumbdbm.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libdumbdbm.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** libdumbdbm.tex	14 Jul 2003 12:12:37 -0000	1.1
--- libdumbdbm.tex	21 Jul 2003 15:30:15 -0000	1.2
***************
*** 1,18 ****
  \section{\module{dumbdbm} ---
!          Simple ``database'' interface written in Python}
  
! \declaremodule{builtin}{dumbdbm}
! \modulesynopsis{A dbm-style module available on all platforms.}
  
  \index{databases}
  
! \note{The \module{dumbdbm} module is intended as a last resort fallback for
! the \module{anydbm} module when no other more robust module is available.
  The \module{dumbdbm} module is not written for speed and is not nearly as
! heavily used as the other database modules.}
  
! The \module{dumbdbm} module provides a persisten dictionary-like interface
  which is written entirely in Python.  Unlike other modules such as
! {}\module{gdbm} and \module{bsddb}, no external library is required.  As
  with other persistent mappings, the keys and values must always be strings.
  
--- 1,20 ----
  \section{\module{dumbdbm} ---
!          Portable DBM implementation}
  
! \declaremodule{standard}{dumbdbm}
! \modulesynopsis{Portable implementation of the simple DBM interface.}
  
  \index{databases}
  
! \begin{notice}
! The \module{dumbdbm} module is intended as a last resort fallback for
! the \refmodule{anydbm} module when no more robust module is available.
  The \module{dumbdbm} module is not written for speed and is not nearly as
! heavily used as the other database modules.
! \end{notice}
  
! The \module{dumbdbm} module provides a persistent dictionary-like interface
  which is written entirely in Python.  Unlike other modules such as
! \refmodule{gdbm} and \refmodule{bsddb}, no external library is required.  As
  with other persistent mappings, the keys and values must always be strings.
  
***************
*** 25,50 ****
  
  \begin{funcdesc}{open}{filename\optional{, flag\optional{, mode}}}
- 
  Open a dumbdbm database and return a dumbdbm object.  The \var{filename}
  argument is the basename of the database file (without any specific
! extensions).  When a dumbdbm database is created, files with \code{.dat} and
! \code{.dir} extensions are created.
  
! The optional \var{flag} argument is currently ignored.
  
  The optional \var{mode} argument is the \UNIX{} mode of the file, used
  only when the database has to be created.  It defaults to octal
! \code{0666}.
  \end{funcdesc}
  
- \subsection{Dumbdbm Objects \label{dumbdbm-objects}}
- 
- In addition to the methods provided by the \class{UserDict.DictMixin} class,
- \class{dumbdbm} objects provide the following methods.
- 
- \begin{methoddesc}{sync}{}
- Synchronize the on-disk directory and data files.  This method is called by
- the \method{sync} method of \class{Shelve} objects.
- \end{methoddesc}
  
  \begin{seealso}
--- 27,45 ----
  
  \begin{funcdesc}{open}{filename\optional{, flag\optional{, mode}}}
  Open a dumbdbm database and return a dumbdbm object.  The \var{filename}
  argument is the basename of the database file (without any specific
! extensions).  When a dumbdbm database is created, files with \file{.dat} and
! \file{.dir} extensions are created.
  
! The optional \var{flag} argument is currently ignored; the database is
! always opened for update, and will be created if it does not exist.
  
  The optional \var{mode} argument is the \UNIX{} mode of the file, used
  only when the database has to be created.  It defaults to octal
! \code{0666} (and will be modified by the prevailing umask).
! \versionchanged[The \var{mode} argument was ignored in earlier
!                 versions]{2.2}
  \end{funcdesc}
  
  
  \begin{seealso}
***************
*** 56,57 ****
--- 51,63 ----
                        existing database.}
  \end{seealso}
+ 
+ 
+ \subsection{Dumbdbm Objects \label{dumbdbm-objects}}
+ 
+ In addition to the methods provided by the \class{UserDict.DictMixin} class,
+ \class{dumbdbm} objects provide the following methods.
+ 
+ \begin{methoddesc}{sync}{}
+ Synchronize the on-disk directory and data files.  This method is called by
+ the \method{sync} method of \class{Shelve} objects.
+ \end{methoddesc}