[commit: packages/directory] improve-tests, improve-tests-for-real, master: Clarifies the situations under which removeDirectoryRecursive may fail (fd8c99d)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/directory

On branches: improve-tests,improve-tests-for-real,master
Link       : http://ghc.haskell.org/trac/ghc/changeset/fd8c99d7b36226f3485de83d4f953d54f61fbcb3/directory

>---------------------------------------------------------------

commit fd8c99d7b36226f3485de83d4f953d54f61fbcb3
Author: Elliot Robinson <elliot.robinson at argiopetech.com>
Date:   Wed Feb 18 15:16:33 2015 -0500

    Clarifies the situations under which removeDirectoryRecursive may fail


>---------------------------------------------------------------

fd8c99d7b36226f3485de83d4f953d54f61fbcb3
 System/Directory.hs | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/System/Directory.hs b/System/Directory.hs
index c44cad6..d6d21eb 100644
--- a/System/Directory.hs
+++ b/System/Directory.hs
@@ -458,8 +458,9 @@ removeDirectory path =
 #endif
 
 -- | @'removeDirectoryRecursive' dir@  removes an existing directory /dir/
--- together with its content and all subdirectories. Be careful,
--- if the directory contains symlinks, the function will follow them.
+-- together with its content and all subdirectories. Be careful, if the
+-- directory contains symlinks, this function will follow them if you don't
+-- have permission to delete them.
 removeDirectoryRecursive :: FilePath -> IO ()
 removeDirectoryRecursive startLoc = do
   cont <- getDirectoryContents startLoc