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] | |
| b1889c36 | 11 | 'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>... |
| c3b831bd PR |
12 | |
| 13 | DESCRIPTION | |
| 14 | ----------- | |
| 15 | Removes files unknown to git. This allows to clean the working tree | |
| 16 | from files that are not under version control. If the '-x' option is | |
| 17 | specified, ignored files are also removed, allowing to remove all | |
| 18 | build products. | |
| 393e3b19 JH |
19 | When optional `<paths>...` arguments are given, the paths |
| 20 | affected are further limited to those that match them. | |
| 21 | ||
| c3b831bd PR |
22 | |
| 23 | OPTIONS | |
| 24 | ------- | |
| 25 | -d:: | |
| 26 | Remove untracked directories in addition to untracked files. | |
| 27 | ||
| 2122591b | 28 | -f:: |
| 0fc4baeb | 29 | If the git configuration specifies clean.requireForce as true, |
| 2122591b JT |
30 | git-clean will refuse to run unless given -f or -n. |
| 31 | ||
| c3b831bd | 32 | -n:: |
| 459cf2e9 | 33 | --dry-run:: |
| c3b831bd PR |
34 | Don't actually remove anything, just show what would be done. |
| 35 | ||
| 36 | -q:: | |
| 459cf2e9 | 37 | --quiet:: |
| c3b831bd PR |
38 | Be quiet, only report errors, but not the files that are |
| 39 | successfully removed. | |
| 40 | ||
| 41 | -x:: | |
| 42 | Don't use the ignore rules. This allows removing all untracked | |
| 43 | files, including build products. This can be used (possibly in | |
| 5162e697 | 44 | conjunction with linkgit:git-reset[1]) to create a pristine |
| c3b831bd PR |
45 | working directory to test a clean build. |
| 46 | ||
| 47 | -X:: | |
| 48 | Remove only files ignored by git. This may be useful to rebuild | |
| 49 | everything from scratch, but keep manually created files. | |
| 50 | ||
| 51 | ||
| 52 | Author | |
| 53 | ------ | |
| 54 | Written by Pavel Roskin <proski@gnu.org> | |
| 55 | ||
| 56 | ||
| 57 | GIT | |
| 58 | --- | |
| 9e1f0a85 | 59 | Part of the linkgit:git[1] suite |