diff options
Diffstat (limited to 'Documentation/git-clean.txt')
| -rw-r--r-- | Documentation/git-clean.txt | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt new file mode 100644 index 0000000000..43b2de7db3 --- /dev/null +++ b/Documentation/git-clean.txt @@ -0,0 +1,62 @@ +git-clean(1) +============ + +NAME +---- +git-clean - Remove untracked files from the working tree + +SYNOPSIS +-------- +[verse] +'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <path>... + +DESCRIPTION +----------- + +This allows cleaning the working tree by removing files that are not +under version control. + +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. + +-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 '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 |