[Python-checkins] cpython: Note that equivalents are valid for 3.3+ only.

[georg.brandl]

http://hg.python.org/cpython/rev/3a40f50d7e64
changeset:   77692:3a40f50d7e64
user:        Georg Brandl <georg at python.org>
date:        Sun Jun 24 12:38:14 2012 +0200
summary:
  Note that equivalents are valid for 3.3+ only.

files:
  Doc/library/os.rst |  36 ++++++++++++++++++---------------
  1 files changed, 20 insertions(+), 16 deletions(-)


diff --git a/Doc/library/os.rst b/Doc/library/os.rst
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -678,9 +678,9 @@
 
 .. function:: fchmod(fd, mode)
 
-   Change the mode of the file given by *fd* to the numeric *mode*.  See the docs
-   for :func:`chmod` for possible values of *mode*.
-   Equivalent to ``os.chmod(fd, mode)``.
+   Change the mode of the file given by *fd* to the numeric *mode*.  See the
+   docs for :func:`chmod` for possible values of *mode*.  From Python 3.3, this
+   is equivalent to ``os.chmod(fd, mode)``.
 
    Availability: Unix.
 
@@ -688,8 +688,9 @@
 .. function:: fchown(fd, uid, gid)
 
    Change the owner and group id of the file given by *fd* to the numeric *uid*
-   and *gid*.  To leave one of the ids unchanged, set it to -1.  Equivalent
-   to ``os.chown(fd, uid, gid)``.
+   and *gid*.  To leave one of the ids unchanged, set it to -1.  See
+   :func:`chown`.  From Python 3.3, this is equivalent to ``os.chown(fd, uid,
+   gid)``.
 
    Availability: Unix.
 
@@ -725,15 +726,17 @@
 
 .. function:: fstat(fd)
 
-   Return status for file descriptor *fd*, like :func:`~os.stat`.
+   Return status for file descriptor *fd*, like :func:`~os.stat`.  From Python
+   3.3, this is equivalent to ``os.stat(fd)``.
 
    Availability: Unix, Windows.
 
 
 .. function:: fstatvfs(fd)
 
-   Return information about the filesystem containing the file associated with file
-   descriptor *fd*, like :func:`statvfs`.
+   Return information about the filesystem containing the file associated with
+   file descriptor *fd*, like :func:`statvfs`.  From Python 3.3, this is
+   equivalent to ``os.statvfs(fd)``.
 
    Availability: Unix.
 
@@ -1309,7 +1312,7 @@
 
    Change the current working directory to the directory represented by the file
    descriptor *fd*.  The descriptor must refer to an opened directory, not an
-   open file.  Equivalent to ``os.chdir(fd)``.
+   open file.  From Python 3.3, this is equivalent to ``os.chdir(fd)``.
 
    Availability: Unix.
 
@@ -1425,8 +1428,8 @@
 .. function:: lchflags(path, flags)
 
    Set the flags of *path* to the numeric *flags*, like :func:`chflags`, but do
-   not follow symbolic links.  Equivalent to ``os.chflags(path, flags,
-   follow_symlinks=False)``.
+   not follow symbolic links.  From Python 3.3, this is equivalent to
+   ``os.chflags(path, flags, follow_symlinks=False)``.
 
    Availability: Unix.
 
@@ -1435,8 +1438,8 @@
 
    Change the mode of *path* to the numeric *mode*. If path is a symlink, this
    affects the symlink rather than the target.  See the docs for :func:`chmod`
-   for possible values of *mode*.  Equivalent to ``os.chmod(path, mode,
-   follow_symlinks=False)``.
+   for possible values of *mode*.  From Python 3.3, this is equivalent to
+   ``os.chmod(path, mode, follow_symlinks=False)``.
 
    Availability: Unix.
 
@@ -1444,8 +1447,8 @@
 .. function:: lchown(path, uid, gid)
 
    Change the owner and group id of *path* to the numeric *uid* and *gid*.  This
-   function will not follow symbolic links.  Equivalent to ``os.chown(path, uid,
-   gid, follow_symlinks=False)``.
+   function will not follow symbolic links.  From Python 3.3, this is equivalent
+   to ``os.chown(path, uid, gid, follow_symlinks=False)``.
 
    Availability: Unix.
 
@@ -1502,7 +1505,8 @@
    Perform the equivalent of an :c:func:`lstat` system call on the given path.
    Similar to :func:`~os.stat`, but does not follow symbolic links.  On
    platforms that do not support symbolic links, this is an alias for
-   :func:`~os.stat`.  (Equivalent to ``os.stat(path, follow_symlinks=False)``.)
+   :func:`~os.stat`.  From Python 3.3, this is equivalent to ``os.stat(path,
+   dir_fd=dir_fd, follow_symlinks=False)``.
 
    This function can also support :ref:`paths relative to directory descriptors
    <dir_fd>`.

-- 
Repository URL: http://hg.python.org/cpython