aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-clean.txt
blob: 8a114509f4a19b4fa6c6d8de8afdc94938d24b82 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
git-clean(1)
============

NAME
----
git-clean - Remove untracked files from the working tree

SYNOPSIS
--------
[verse]
'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <path>...

DESCRIPTION
-----------
Removes files unknown to git.  This allows to clean the working tree
from files that are not under version control.  If the '-x' option is
specified, ignored files are also removed, allowing to remove all
build products.
If any optional `<path>...` arguments are given, only those paths
are affected.


OPTIONS
-------
-d::
	Remove untracked directories in addition to untracked files.

-f::
	If the git configuration specifies clean.requireForce as true,
	'git-clean' will refuse to run unless given -f or -n.

-n::
--dry-run::
	Don't actually remove anything, just show what would be done.

-q::
--quiet::
	Be quiet, only report errors, but not the files that are
	successfully removed.

-x::
	Don't use the ignore rules.  This allows removing all untracked
	files, including build products.  This can be used (possibly in
	conjunction with 'git-reset') to create a pristine
	working directory to test a clean build.

-X::
	Remove only files ignored by git.  This may be useful to rebuild
	everything from scratch, but keep manually created files.


Author
------
Written by Pavel Roskin <proski@gnu.org>


GIT
---
Part of the linkgit:git[1] suite