[Python-checkins] CVS: python/dist/src/Doc/lib libos.tex,1.53,1.54

[Fred L. Drake]

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

Modified Files:
	libos.tex 
Log Message:

readlink() description:  Added note that the return value may be either
    absolute or relative.

remove(), rename() descriptions:  Give more information about the cross-
    platform behavior of these functions, so single-platform developers
    can be aware of the potential issues when writing portable code.

This closes SF patch #426598.


Index: libos.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libos.tex,v
retrieving revision 1.53
retrieving revision 1.54
diff -C2 -r1.53 -r1.54
*** libos.tex	2000/10/19 05:33:46	1.53
--- libos.tex	2001/05/29 18:13:06	1.54
***************
*** 651,662 ****
  \begin{funcdesc}{readlink}{path}
  Return a string representing the path to which the symbolic link
! points.
  Availability: \UNIX{}.
  \end{funcdesc}
  
  \begin{funcdesc}{remove}{path}
! Remove the file \var{path}.  See \function{rmdir()} below to remove a
! directory.  This is identical to the \function{unlink()} function
! documented below.
  Availability: Macintosh, \UNIX{}, Windows.
  \end{funcdesc}
--- 651,668 ----
  \begin{funcdesc}{readlink}{path}
  Return a string representing the path to which the symbolic link
! points.  The result may be either an absolute or relative pathname; if
! it is relative, it may be converted to an absolute pathname using
! \code{os.path.join(os.path.dirname(\var{path}), \var{result})}.
  Availability: \UNIX{}.
  \end{funcdesc}
  
  \begin{funcdesc}{remove}{path}
! Remove the file \var{path}.  If \var{path} is a directory,
! \exception{OSError} is raised; see \function{rmdir()} below to remove
! a directory.  This is identical to the \function{unlink()} function
! documented below.  On Windows, attempting to remove a file that is in
! use causes an exception to be raised; on \UNIX, the directory entry is
! removed but the storage allocated to the file is not made available
! until the original file is no longer in use.
  Availability: Macintosh, \UNIX{}, Windows.
  \end{funcdesc}
***************
*** 675,679 ****
  
  \begin{funcdesc}{rename}{src, dst}
! Rename the file or directory \var{src} to \var{dst}.
  Availability: Macintosh, \UNIX{}, Windows.
  \end{funcdesc}
--- 681,694 ----
  
  \begin{funcdesc}{rename}{src, dst}
! Rename the file or directory \var{src} to \var{dst}.  If \var{dst} is
! a directory, \exception{OSError} will be raised.  On \UNIX, if
! \var{dst} exists and is a file, it will be removed silently if the
! user has permission.  The operation may fail on some \UNIX{} flavors
! is \var{src} and \var{dst} are on different filesystems.  If
! successful, the renaming will be an atomic operation (this is a
! \POSIX{} requirement).  On Windows, if \var{dst} already exists,
! \exception{OSError} will be raised even if it is a file; there may be
! no way to implement an atomic rename when \var{dst} names an existing
! file.
  Availability: Macintosh, \UNIX{}, Windows.
  \end{funcdesc}