[commit: packages/directory] master: Warn about effects of removePathForcibly on hard links (30d5e2d)

[git at git.haskell.org]

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

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/30d5e2ddac84a008d914b278dcbc11077c7240ed/directory

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

commit 30d5e2ddac84a008d914b278dcbc11077c7240ed
Author: Phil Ruffwind <rf at rufflewind.com>
Date:   Thu Jan 19 18:18:30 2017 -0500

    Warn about effects of removePathForcibly on hard links


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

30d5e2ddac84a008d914b278dcbc11077c7240ed
 System/Directory.hs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/System/Directory.hs b/System/Directory.hs
index 7829ecf..f4475c4 100644
--- a/System/Directory.hs
+++ b/System/Directory.hs
@@ -530,7 +530,8 @@ removeContentsRecursive path =
 -- Unlike other removal functions, this function will also attempt to delete
 -- files marked as read-only or otherwise made unremovable due to permissions.
 -- As a result, if the removal is incomplete, the permissions or attributes on
--- the remaining files may be altered.
+-- the remaining files may be altered.  If there are hard links in the
+-- directory, then permissions on all related hard links may be altered.
 --
 -- If an entry within the directory vanishes while @removePathForcibly@ is
 -- running, it is silently ignored.