[Python-checkins] CVS: python/dist/src/Doc/lib libmmap.tex,1.3,1.4

[Fred L. Drake]

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

Modified Files:
	libmmap.tex 
Log Message:

Updated descriptions to incorporate additional information from Tim Peters.
This mostly closes SF bug #128251.


Index: libmmap.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libmmap.tex,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** libmmap.tex	2000/09/05 13:50:21	1.3
--- libmmap.tex	2001/01/11 22:49:49	1.4
***************
*** 21,43 ****
  \strong{(Windows version)}  Maps \var{length} bytes from the file
  specified by the file handle \var{fileno}, and returns a mmap object.
  If you wish to map an existing Python file object, use its
  \method{fileno()} method to obtain the correct value for the
! \var{fileno} parameter.
  
! \var{tagname}, if specified, is a string giving a tag name for the mapping. 
! Windows allows you to have many different mappings against the same
! file.  If you specify the name of an existing tag, that tag is opened,
! otherwise a new tag of this name is created.  If this parameter is
! None, the mapping is created without a name.  Avoiding the use of the
! tag parameter will assist in keeping your code portable between Unix
! and Windows.
  \end{funcdesc}
  
  \begin{funcdesc}{mmap}{fileno, size\optional{, flags, prot}}
! \strong{(Unix version)}  Maps \var{length} bytes from the file
  specified by the file handle \var{fileno}, and returns a mmap object.
  If you wish to map an existing Python file object, use its
  \method{fileno()} method to obtain the correct value for the
! \var{fileno} parameter.
  
  \var{flags} specifies the nature of the mapping.  
--- 21,45 ----
  \strong{(Windows version)}  Maps \var{length} bytes from the file
  specified by the file handle \var{fileno}, and returns a mmap object.
+ If \var{length} is \code{0}, the maximum length of the map will be the
+ current size of the file when \function{mmap()} is called.
  If you wish to map an existing Python file object, use its
  \method{fileno()} method to obtain the correct value for the
! \var{fileno} parameter.  The file must be opened for update.
  
! \var{tagname}, if specified and not \code{None}, is a string giving a
! tag name for the mapping.  Windows allows you to have many different
! mappings against the same file.  If you specify the name of an
! existing tag, that tag is opened, otherwise a new tag of this name is
! created.  If this parameter is omitted or \code{None}, the mapping is
! created without a name.  Avoiding the use of the tag parameter will
! assist in keeping your code portable between \UNIX{} and Windows.
  \end{funcdesc}
  
  \begin{funcdesc}{mmap}{fileno, size\optional{, flags, prot}}
! \strong{(\UNIX{} version)}  Maps \var{length} bytes from the file
  specified by the file handle \var{fileno}, and returns a mmap object.
  If you wish to map an existing Python file object, use its
  \method{fileno()} method to obtain the correct value for the
! \var{fileno} parameter.  The file must be opened for update.
  
  \var{flags} specifies the nature of the mapping.