Clarifies the situations under which removeDirectoryRecursive may fail

haskell · Feb 18, 2015 · fd8c99d · fd8c99d
1 parent 692ae76
commit fd8c99d
Showing 1 changed file with 3 additions and 2 deletions.
diff --git 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