Merge branch 'jc/maint-add-u-remove-conflicted'
[gitweb.git] / Documentation / git-clean.txt
index c61afbcdbac49ccbb7ee755e3fdb19d7d77225d0..8a114509f4a19b4fa6c6d8de8afdc94938d24b82 100644 (file)
@@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree
 SYNOPSIS
 --------
 [verse]
-'git-clean' [-d] [-n] [-q] [-x | -X] [--] <paths>...
+'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <path>...
 
 DESCRIPTION
 -----------
@@ -16,8 +16,8 @@ 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.
-When optional `<paths>...` arguments are given, the paths
-affected are further limited to those that match them.
+If any optional `<path>...` arguments are given, only those paths
+are affected.
 
 
 OPTIONS
@@ -25,17 +25,23 @@ OPTIONS
 -d::
        Remove untracked directories in addition to untracked files.
 
+-f::
+       If the git configuration specifies clean.requireForce as true,
+       'git-clean' will refuse to run unless given -f or -n.
+
 -n::
+--dry-run::
        Don't actually remove anything, just show what would be done.
 
 -q::
+--quiet::
        Be quiet, only report errors, but not the files that are
        successfully removed.
 
 -x::
        Don't use the ignore rules.  This allows removing all untracked
        files, including build products.  This can be used (possibly in
-       conjunction with gitlink:git-reset[1]) to create a pristine
+       conjunction with 'git-reset') to create a pristine
        working directory to test a clean build.
 
 -X::
@@ -50,4 +56,4 @@ Written by Pavel Roskin <proski@gnu.org>
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[1] suite