[Python-checkins] r80409 - in python/branches/py3k: Doc/library/shutil.rst Lib/shutil.py

[tarek.ziade]

Author: tarek.ziade
Date: Fri Apr 23 15:03:50 2010
New Revision: 80409

Log:
added a note about the ignore_dangling_symlinks option

Modified:
   python/branches/py3k/Doc/library/shutil.rst
   python/branches/py3k/Lib/shutil.py

Modified: python/branches/py3k/Doc/library/shutil.rst
==============================================================================
--- python/branches/py3k/Doc/library/shutil.rst	(original)
+++ python/branches/py3k/Doc/library/shutil.rst	Fri Apr 23 15:03:50 2010
@@ -103,7 +103,8 @@
    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

Modified: python/branches/py3k/Lib/shutil.py
==============================================================================
--- python/branches/py3k/Lib/shutil.py	(original)
+++ python/branches/py3k/Lib/shutil.py	Fri Apr 23 15:03:50 2010
@@ -161,8 +161,8 @@
     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