added a note about the ignore_dangling_symlinks option

This commit is contained in:
Tarek Ziadé 2010-04-23 13:03:50 +00:00
parent 51a6f72d19
commit 8c26c7d907
2 changed files with 4 additions and 3 deletions

View File

@ -103,7 +103,8 @@ Directory and files operations
exist, a exception will be added in the list of errors raised in
a :exc:`Error` exception at the end of the copy process.
You can set the optional *ignore_dangling_symlinks* flag to true if you
want to silence this exception.
want to silence this exception. Notice that this option has no effect
on platforms that don't support :func:`os.symlink`.
If *ignore* is given, it must be a callable that will receive as its
arguments the directory being visited by :func:`copytree`, and a list of its

View File

@ -161,8 +161,8 @@ def copytree(src, dst, symlinks=False, ignore=None, copy_function=copy2,
an Error exception at the end of the copy process.
You can set the optional ignore_dangling_symlinks flag to true if you
want to silence this exception.
want to silence this exception. Notice that this has no effect on
platforms that don't support os.symlink.
The optional ignore argument is a callable. If given, it
is called with the `src` parameter, which is the directory