Merge branch 'pb/prepare-commit-msg'
[gitweb.git] / Documentation / git-clean.txt
index 36890c543d1eac30167b3c267c10db9b0f5b2fa2..5e9da036ba5ce14c0b7fb6f1b9ff8389af4770e4 100644 (file)
@@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree
 SYNOPSIS
 --------
 [verse]
-'git-clean' [-d] [-n] [-q] [-x | -X]
+'git-clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>...
 
 DESCRIPTION
 -----------
@@ -16,12 +16,19 @@ 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.
+
 
 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::
        Don't actually remove anything, just show what would be done.
 
@@ -32,7 +39,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 gitlink:git-reset[1]) to create a pristine
+       conjunction with linkgit:git-reset[1]) to create a pristine
        working directory to test a clean build.
 
 -X::
@@ -47,4 +54,4 @@ Written by Pavel Roskin <proski@gnu.org>
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[7] suite