Merge branch 'nd/decorate-grafts'

[git.git] / Documentation / git-clean.txt

diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index 8a114509f4a19b4fa6c6d8de8afdc94938d24b82..974e04ef1abaf4a3018b83b0323a46cbaa5339d4 100644 (file)
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -8,26 +8,33 @@ git-clean - Remove untracked files from the working tree
 SYNOPSIS
 --------
 [verse]
-'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <path>...
+'git clean' [-d] [-f] [-n] [-q] [-e <pattern>] [-x | -X] [--] <path>...
 
 DESCRIPTION
 -----------
-Removes files unknown to git.  This allows to clean the working tree
-from files that are not under version control.  If the '-x' option is
-specified, ignored files are also removed, allowing to remove all
-build products.
+
+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
+example, be useful to remove all build products.
+
 If any optional `<path>...` arguments are given, only those paths
 are affected.
 
-
 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::
@@ -38,22 +45,22 @@ OPTIONS
        Be quiet, only report errors, but not the files that are
        successfully removed.
 
+-e <pattern>::
+--exclude=<pattern>::
+       Specify special exceptions to not be cleaned.  Each <pattern> is
+       the same form as in $GIT_DIR/info/excludes and this option can be
+       given multiple times.
+
 -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::
        Remove only files ignored by git.  This may be useful to rebuild
        everything from scratch, but keep manually created files.
 
-
-Author
-------
-Written by Pavel Roskin <proski@gnu.org>
-
-
 GIT
 ---
 Part of the linkgit:git[1] suite