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] | |
| 07de4eba | 11 | 'git clean' [-d] [-f] [-n] [-q] [-e <pattern>] [-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 | 18 | |
| 2de9b711 | 19 | Normally, only files unknown to Git are removed, but if the '-x' |
| 911198f6 WL |
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. | |
| 2de9b711 | 30 | If an untracked directory is managed by a different Git |
| a0f4afbe JH |
31 | repository, it is not removed by default. Use -f option twice |
| 32 | if you really want to remove such a directory. | |
| c3b831bd | 33 | |
| 2122591b | 34 | -f:: |
| f7aec129 | 35 | --force:: |
| 2de9b711 | 36 | If the Git configuration variable clean.requireForce is not set |
| 89c38500 | 37 | to false, 'git clean' will refuse to run unless given -f or -n. |
| 2122591b | 38 | |
| c3b831bd | 39 | -n:: |
| 459cf2e9 | 40 | --dry-run:: |
| c3b831bd PR |
41 | Don't actually remove anything, just show what would be done. |
| 42 | ||
| 43 | -q:: | |
| 459cf2e9 | 44 | --quiet:: |
| c3b831bd PR |
45 | Be quiet, only report errors, but not the files that are |
| 46 | successfully removed. | |
| 47 | ||
| 07de4eba JH |
48 | -e <pattern>:: |
| 49 | --exclude=<pattern>:: | |
| b6194678 JH |
50 | In addition to those found in .gitignore (per directory) and |
| 51 | $GIT_DIR/info/exclude, also consider these patterns to be in the | |
| 52 | set of the ignore rules in effect. | |
| 07de4eba | 53 | |
| c3b831bd | 54 | -x:: |
| b6194678 JH |
55 | Don't use the standard ignore rules read from .gitignore (per |
| 56 | directory) and $GIT_DIR/info/exclude, but do still use the ignore | |
| 57 | rules given with `-e` options. This allows removing all untracked | |
| c3b831bd | 58 | files, including build products. This can be used (possibly in |
| 0b444cdb | 59 | conjunction with 'git reset') to create a pristine |
| c3b831bd PR |
60 | working directory to test a clean build. |
| 61 | ||
| 62 | -X:: | |
| 2de9b711 | 63 | Remove only files ignored by Git. This may be useful to rebuild |
| c3b831bd PR |
64 | everything from scratch, but keep manually created files. |
| 65 | ||
| 068c6745 PO |
66 | SEE ALSO |
| 67 | -------- | |
| 68 | linkgit:gitignore[5] | |
| 69 | ||
| c3b831bd PR |
70 | GIT |
| 71 | --- | |
| 9e1f0a85 | 72 | Part of the linkgit:git[1] suite |