ilusha/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2026-09-29 12:10:30 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Small whitespace fixes for shutil.rmtree() docs.

Browse source
This commit is contained in:
Georg Brandl 2012-06-24 17:39:05 +02:00
parent 4a7e25f4df
commit 96acb73dd5
1 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

16
Doc/library/shutil.rst
View file

@ -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*)