summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2012-06-24 15:39:05 (GMT)
committerGeorg Brandl <georg@python.org>2012-06-24 15:39:05 (GMT)
commit96acb73dd586bff63324186ff4b3b99175db050e (patch)
tree0b122a9806d00625bfee5a866fb24aba71d43a7b
parent4a7e25f4df31cf73e4cc28119744b5c2c82a54ab (diff)
downloadcpython-96acb73dd586bff63324186ff4b3b99175db050e.zip
cpython-96acb73dd586bff63324186ff4b3b99175db050e.tar.gz
cpython-96acb73dd586bff63324186ff4b3b99175db050e.tar.bz2
Small whitespace fixes for shutil.rmtree() docs.
-rw-r--r--Doc/library/shutil.rst16
1 files changed, 9 insertions, 7 deletions
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index aeaf62c..1460d60 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -180,6 +180,7 @@ Directory and files operations
.. versionchanged:: 3.3
Added return of the *dst*.
+
.. function:: rmtree(path, ignore_errors=False, onerror=None)
.. index:: single: directory; deleting
@@ -193,12 +194,12 @@ Directory and files operations
.. note::
On platforms that support the necessary fd-based functions a symlink
- attack resistant version of :func:`rmtree` is used by default. On other
- platforms, the :func:`rmtree` implementation is susceptible to a
- symlink attack: given proper timing and circumstances, attackers can
- manipulate symlinks on the filesystem to delete files they wouldn't
- be able to access otherwise. Applications can use the :data:`rmtree.avoids_symlink_attacks` function attribute to
- determine which case applies.
+ attack resistant version of :func:`rmtree` is used by default. On other
+ platforms, the :func:`rmtree` implementation is susceptible to a symlink
+ attack: given proper timing and circumstances, attackers can manipulate
+ symlinks on the filesystem to delete files they wouldn't be able to access
+ otherwise. Applications can use the :data:`rmtree.avoids_symlink_attacks`
+ function attribute to determine which case applies.
If *onerror* is provided, it must be a callable that accepts three
parameters: *function*, *path*, and *excinfo*.
@@ -216,11 +217,12 @@ Directory and files operations
.. data:: rmtree.avoids_symlink_attacks
Indicates whether the current platform and implementation provides a
- symlink attack resistant version of :func:`rmtree`. Currently this is
+ symlink attack resistant version of :func:`rmtree`. Currently this is
only true for platforms supporting fd-based directory access functions.
.. versionadded:: 3.3
+
.. function:: move(src, dst)
Recursively move a file or directory (*src*) to another location (*dst*)