]> git.ipfire.org Git - thirdparty/git.git/blob - Documentation/git-clean.txt
Merge branch 'maint'
[thirdparty/git.git] / Documentation / git-clean.txt
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]
11 'git-clean' [-d] [-n] [-q] [-x | -X] [--] <paths>...
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.
19 When optional `<paths>...` arguments are given, the paths
20 affected are further limited to those that match them.
21
22
23 OPTIONS
24 -------
25 -d::
26 Remove untracked directories in addition to untracked files.
27
28 -n::
29 Don't actually remove anything, just show what would be done.
30
31 -q::
32 Be quiet, only report errors, but not the files that are
33 successfully removed.
34
35 -x::
36 Don't use the ignore rules. This allows removing all untracked
37 files, including build products. This can be used (possibly in
38 conjunction with gitlink:git-reset[1]) to create a pristine
39 working directory to test a clean build.
40
41 -X::
42 Remove only files ignored by git. This may be useful to rebuild
43 everything from scratch, but keep manually created files.
44
45
46 Author
47 ------
48 Written by Pavel Roskin <proski@gnu.org>
49
50
51 GIT
52 ---
53 Part of the gitlink:git[7] suite