Documentation/git-clean.txt: document that -f may need to be given twice

This is needed in build automation where the tree really needs to
be reset to known state.

Signed-off-by: Mikko Rapeli <mikko.rapeli@iki.fi>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index 89979228b12080606f5becc268792c6eae8f128e..719f076b99b992dbff6cd5c4fb33c64376f8d0b0 100644 (file)
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -34,8 +34,12 @@ OPTIONS
 -f::
 --force::
        If the Git configuration variable clean.requireForce is not set
 -f::
 --force::
        If the Git configuration variable clean.requireForce is not set

-       to false, 'git clean' will refuse to run unless given -f, -n or
-       -i.
+       to false, 'git clean' will refuse to delete files or directories
+       unless given -f, -n or -i. Git will refuse to delete directories
+       with .git sub directory or file unless a second -f
+       is given. This affects also git submodules where the storage area
+       of the removed submodule under .git/modules/ is not removed until
+       -f is given twice.

 
 -i::
 --interactive::
 
 -i::
 --interactive::