[Python-checkins] cpython (merge 3.2 -> default): shutil copy module reference doc fix.

[senthil.kumaran]

http://hg.python.org/cpython/rev/e1301a2e2316
changeset:   74912:e1301a2e2316
parent:      74907:06a6fed0da56
parent:      74911:282a0eca40b1
user:        Senthil Kumaran <senthil at uthcode.com>
date:        Mon Feb 13 23:35:44 2012 +0800
summary:
  shutil copy module reference doc fix.

files:
  Doc/library/shutil.rst |  44 +++++++++++++++--------------
  1 files changed, 23 insertions(+), 21 deletions(-)


diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -21,8 +21,8 @@
 
 .. warning::
 
-   Even the higher-level file copying functions (:func:`copy`, :func:`copy2`)
-   cannot copy all file metadata.
+   Even the higher-level file copying functions (:func:`shutil.copy`,
+   :func:`shutil.copy2`) cannot copy all file metadata.
 
    On POSIX platforms, this means that file owner and group are lost as well
    as ACLs.  On Mac OS, the resource fork and other metadata are not used.
@@ -49,10 +49,11 @@
 
 .. function:: copyfile(src, dst[, symlinks=False])
 
-   Copy the contents (no metadata) of the file named *src* to a file named *dst*.
-   *dst* must be the complete target file name; look at :func:`copy` for a copy that
-   accepts a target directory path.  If *src* and *dst* are the same files,
-   :exc:`Error` is raised.
+   Copy the contents (no metadata) of the file named *src* to a file named
+   *dst*.  *dst* must be the complete target file name; look at
+   :func:`shutil.copy` for a copy that accepts a target directory path.  If
+   *src* and *dst* are the same files, :exc:`Error` is raised.
+
    The destination location must be writable; otherwise,  an :exc:`OSError` exception
    will be raised. If *dst* already exists, it will be replaced.   Special files
    such as character or block devices and pipes cannot be copied with this
@@ -101,10 +102,11 @@
 
 .. function:: copy2(src, dst[, symlinks=False])
 
-   Similar to :func:`copy`, but metadata is copied as well -- in fact, this is just
-   :func:`copy` followed by :func:`copystat`.  This is similar to the
-   Unix command :program:`cp -p`.  If *symlinks* is true, symbolic links won't
-   be followed but recreated instead -- this resembles GNU's :program:`cp -P`.
+   Similar to :func:`shutil.copy`, but metadata is copied as well -- in fact,
+   this is just :func:`shutil.copy` followed by :func:`copystat`.  This is
+   similar to the Unix command :program:`cp -p`.  If *symlinks* is true,
+   symbolic links won't be followed but recreated instead -- this resembles
+   GNU's :program:`cp -P`.
 
    .. versionchanged:: 3.3
       Added *symlinks* argument.
@@ -119,10 +121,10 @@
 .. function:: copytree(src, dst, symlinks=False, ignore=None, copy_function=copy2, ignore_dangling_symlinks=False)
 
    Recursively copy an entire directory tree rooted at *src*.  The destination
-   directory, named by *dst*, must not already exist; it will be created as well
-   as missing parent directories.  Permissions and times of directories are
-   copied with :func:`copystat`, individual files are copied using
-   :func:`copy2`.
+   directory, named by *dst*, must not already exist; it will be created as
+   well as missing parent directories.  Permissions and times of directories
+   are copied with :func:`copystat`, individual files are copied using
+   :func:`shutil.copy2`.
 
    If *symlinks* is true, symbolic links in the source tree are represented as
    symbolic links in the new tree and the metadata of the original links will
@@ -148,10 +150,10 @@
 
    If exception(s) occur, an :exc:`Error` is raised with a list of reasons.
 
-   If *copy_function* is given, it must be a callable that will be used
-   to copy each file. It will be called with the source path and the
-   destination path as arguments. By default, :func:`copy2` is used, but any
-   function that supports the same signature (like :func:`copy`) can be used.
+   If *copy_function* is given, it must be a callable that will be used to copy
+   each file. It will be called with the source path and the destination path
+   as arguments. By default, :func:`shutil.copy2` is used, but any function
+   that supports the same signature (like :func:`shutil.copy`) can be used.
 
    .. versionchanged:: 3.2
       Added the *copy_function* argument to be able to provide a custom copy
@@ -197,9 +199,9 @@
    :func:`os.rename` semantics.
 
    If the destination is on the current filesystem, then :func:`os.rename` is
-   used.  Otherwise, *src* is copied (using :func:`copy2`) to *dst* and then
-   removed. In case of symlinks, a new symlink pointing to the target of *src*
-   will be created in or as *dst* and *src* will be removed.
+   used.  Otherwise, *src* is copied (using :func:`shutil.copy2`) to *dst* and
+   then removed. In case of symlinks, a new symlink pointing to the target of
+   *src* will be created in or as *dst* and *src* will be removed.
 
    .. versionchanged:: 3.3
       Added explicit symlink handling for foreign filesystems, thus adapting

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