builtin-mailinfo.c: check error status from rewind and ftruncate
[git/spearce.git] / Documentation / git-clean.txt
blob9d291bdd266b49fe01b017dfce8e73dd288ad785
1 git-clean(1)
2 ============
4 NAME
5 ----
6 git-clean - Remove untracked files from the working tree
8 SYNOPSIS
9 --------
10 [verse]
11 'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <path>...
13 DESCRIPTION
14 -----------
16 Cleans the working tree by recursively removing files that are not
17 under version control, starting from the current directory.
19 Normally, only files unknown to git are removed, but if the '-x'
20 option is specified, ignored files are also removed. This can, for
21 example, be useful to remove all build products.
23 If any optional `<path>...` arguments are given, only those paths
24 are affected.
26 OPTIONS
27 -------
28 -d::
29         Remove untracked directories in addition to untracked files.
30         If an untracked directory is managed by a different git
31         repository, it is not removed by default.  Use -f option twice
32         if you really want to remove such a directory.
34 -f::
35 --force::
36         If the git configuration specifies clean.requireForce as true,
37         'git-clean' will refuse to run unless given -f or -n.
39 -n::
40 --dry-run::
41         Don't actually remove anything, just show what would be done.
43 -q::
44 --quiet::
45         Be quiet, only report errors, but not the files that are
46         successfully removed.
48 -x::
49         Don't use the ignore rules.  This allows removing all untracked
50         files, including build products.  This can be used (possibly in
51         conjunction with 'git-reset') to create a pristine
52         working directory to test a clean build.
54 -X::
55         Remove only files ignored by git.  This may be useful to rebuild
56         everything from scratch, but keep manually created files.
59 Author
60 ------
61 Written by Pavel Roskin <proski@gnu.org>
64 GIT
65 ---
66 Part of the linkgit:git[1] suite