projects / thirdparty / git.git / blame
| Commit | Line | Data |
|---|---|---|
| c3b831bd PR |
1 | git-clean(1) |
| 2 | ============ | |
| 3 | ||
| 4 | NAME | |
| 5 | ---- | |
| 6 | git-clean - Remove untracked files from the working tree | |
| 7 | ||
| 8 | SYNOPSIS | |
| 9 | -------- | |
| 10 | [verse] | |
| f448e24e | 11 | 'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <path>... |
| c3b831bd PR |
12 | |
| 13 | DESCRIPTION | |
| 14 | ----------- | |
| 911198f6 | 15 | |
| 6a260f53 JH |
16 | Cleans the working tree by recursively removing files that are not |
| 17 | under version control, starting from the current directory. | |
| 911198f6 WL |
18 | |
| 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. | |
| 22 | ||
| f448e24e AMS |
23 | If any optional `<path>...` arguments are given, only those paths |
| 24 | are affected. | |
| 393e3b19 | 25 | |
| c3b831bd PR |
26 | OPTIONS |
| 27 | ------- | |
| 28 | -d:: | |
| 29 | Remove untracked directories in addition to untracked files. | |
| 30 | ||
| 2122591b | 31 | -f:: |
| 0fc4baeb | 32 | If the git configuration specifies clean.requireForce as true, |
| ba020ef5 | 33 | 'git-clean' will refuse to run unless given -f or -n. |
| 2122591b | 34 | |
| c3b831bd | 35 | -n:: |
| 459cf2e9 | 36 | --dry-run:: |
| c3b831bd PR |
37 | Don't actually remove anything, just show what would be done. |
| 38 | ||
| 39 | -q:: | |
| 459cf2e9 | 40 | --quiet:: |
| c3b831bd PR |
41 | Be quiet, only report errors, but not the files that are |
| 42 | successfully removed. | |
| 43 | ||
| 44 | -x:: | |
| 45 | Don't use the ignore rules. This allows removing all untracked | |
| 46 | files, including build products. This can be used (possibly in | |
| ba020ef5 | 47 | conjunction with 'git-reset') to create a pristine |
| c3b831bd PR |
48 | working directory to test a clean build. |
| 49 | ||
| 50 | -X:: | |
| 51 | Remove only files ignored by git. This may be useful to rebuild | |
| 52 | everything from scratch, but keep manually created files. | |
| 53 | ||
| 54 | ||
| 55 | Author | |
| 56 | ------ | |
| 57 | Written by Pavel Roskin <proski@gnu.org> | |
| 58 | ||
| 59 | ||
| 60 | GIT | |
| 61 | --- | |
| 9e1f0a85 | 62 | Part of the linkgit:git[1] suite |