X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-clean.txt;h=37a82ee4b8ed2dc939e56140821a42d452e1b4b5;hb=77d3ecee85dbf354d2059d7ef65d788d90db3efa;hp=36890c543d1eac30167b3c267c10db9b0f5b2fa2;hpb=3d990f110c2e5b8df83f6ab3ef83497f43c7fd47;p=git.git diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 36890c543..37a82ee4b 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -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] [--] ... DESCRIPTION ----------- @@ -16,23 +16,32 @@ 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 `...` 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:: +--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 linkgit:git-reset[1]) to create a pristine working directory to test a clean build. -X:: @@ -47,4 +56,4 @@ Written by Pavel Roskin GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[1] suite