clean: require double -f options to nuke nested git repository and work tree
[gitweb.git] / Documentation / git-clean.txt
index 43b2de7db3b5f21ab9b3eb03e0c167892ae37f3f..ae8938b2de9a5930ab18a220a6e8dd90ee6db3b1 100644 (file)
@@ -13,8 +13,8 @@ SYNOPSIS
 DESCRIPTION
 -----------
 
-This allows cleaning the working tree by removing files that are not
-under version control.
+Cleans the working tree by recursively removing files that are not
+under version control, starting from the current directory.
 
 Normally, only files unknown to git are removed, but if the '-x'
 option is specified, ignored files are also removed. This can, for
@@ -27,6 +27,9 @@ OPTIONS
 -------
 -d::
        Remove untracked directories in addition to untracked files.
+       If an untracked directory is managed by a different git
+       repository, it is not removed by default.  Use -f option twice
+       if you really want to remove such a directory.
 
 -f::
        If the git configuration specifies clean.requireForce as true,