added a note about the ignore_dangling_symlinks option

diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 4191e0eeb415c6312865c91cac04a729b012cddc..d089dc48ec5e07f871a5d46117ce5dbe55b43dac 100644 (file)
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -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

diff --git a/Lib/shutil.py b/Lib/shutil.py
index 465f84150755768883f09bc4a53d5650f85274c1..8890d24a54f2db3774dd69fafe9c0122b5d044b2 100644 (file)
--- a/Lib/shutil.py
+++ b/Lib/shutil.py
@@ -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