Merge branch 'em/checkout-orphan'
[gitweb.git] / Documentation / git-clean.txt
index 43b2de7db3b5f21ab9b3eb03e0c167892ae37f3f..a81cb6c28050e83778f11f2957d3489f50fa6004 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,10 +27,14 @@ 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,
-       'git-clean' will refuse to run unless given -f or -n.
+--force::
+       If the git configuration variable clean.requireForce is not set
+       to false, 'git clean' will refuse to run unless given -f or -n.
 
 -n::
 --dry-run::
@@ -44,7 +48,7 @@ OPTIONS
 -x::
        Don't use the ignore rules.  This allows removing all untracked
        files, including build products.  This can be used (possibly in
-       conjunction with 'git-reset') to create a pristine
+       conjunction with 'git reset') to create a pristine
        working directory to test a clean build.
 
 -X::