2006-04-05 08:00:48 +02:00
|
|
|
git-clean(1)
|
|
|
|
============
|
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
|
|
|
git-clean - Remove untracked files from the working tree
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
|
|
|
[verse]
|
2010-07-20 21:35:56 +02:00
|
|
|
'git clean' [-d] [-f] [-n] [-q] [-e <pattern>] [-x | -X] [--] <path>...
|
2006-04-05 08:00:48 +02:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
2009-04-25 17:13:41 +02:00
|
|
|
|
2009-05-06 19:48:26 +02:00
|
|
|
Cleans the working tree by recursively removing files that are not
|
|
|
|
under version control, starting from the current directory.
|
2009-04-25 17:13:41 +02:00
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
Normally, only files unknown to Git are removed, but if the '-x'
|
2009-04-25 17:13:41 +02:00
|
|
|
option is specified, ignored files are also removed. This can, for
|
|
|
|
example, be useful to remove all build products.
|
|
|
|
|
2008-07-30 11:33:43 +02:00
|
|
|
If any optional `<path>...` arguments are given, only those paths
|
|
|
|
are affected.
|
2006-05-08 21:02:44 +02:00
|
|
|
|
2006-04-05 08:00:48 +02:00
|
|
|
OPTIONS
|
|
|
|
-------
|
|
|
|
-d::
|
|
|
|
Remove untracked directories in addition to untracked files.
|
2013-01-21 20:17:53 +01:00
|
|
|
If an untracked directory is managed by a different Git
|
2009-07-01 00:33:45 +02:00
|
|
|
repository, it is not removed by default. Use -f option twice
|
|
|
|
if you really want to remove such a directory.
|
2006-04-05 08:00:48 +02:00
|
|
|
|
2007-04-24 02:18:16 +02:00
|
|
|
-f::
|
2009-08-29 11:05:00 +02:00
|
|
|
--force::
|
2013-01-21 20:17:53 +01:00
|
|
|
If the Git configuration variable clean.requireForce is not set
|
2010-02-04 17:01:16 +01:00
|
|
|
to false, 'git clean' will refuse to run unless given -f or -n.
|
2007-04-24 02:18:16 +02:00
|
|
|
|
2006-04-05 08:00:48 +02:00
|
|
|
-n::
|
2008-06-08 03:36:10 +02:00
|
|
|
--dry-run::
|
2006-04-05 08:00:48 +02:00
|
|
|
Don't actually remove anything, just show what would be done.
|
|
|
|
|
|
|
|
-q::
|
2008-06-08 03:36:10 +02:00
|
|
|
--quiet::
|
2006-04-05 08:00:48 +02:00
|
|
|
Be quiet, only report errors, but not the files that are
|
|
|
|
successfully removed.
|
|
|
|
|
2010-07-20 21:35:56 +02:00
|
|
|
-e <pattern>::
|
|
|
|
--exclude=<pattern>::
|
2011-08-25 20:29:57 +02:00
|
|
|
In addition to those found in .gitignore (per directory) and
|
|
|
|
$GIT_DIR/info/exclude, also consider these patterns to be in the
|
|
|
|
set of the ignore rules in effect.
|
2010-07-20 21:35:56 +02:00
|
|
|
|
2006-04-05 08:00:48 +02:00
|
|
|
-x::
|
2011-08-25 20:29:57 +02:00
|
|
|
Don't use the standard ignore rules read from .gitignore (per
|
|
|
|
directory) and $GIT_DIR/info/exclude, but do still use the ignore
|
|
|
|
rules given with `-e` options. This allows removing all untracked
|
2006-04-05 08:00:48 +02:00
|
|
|
files, including build products. This can be used (possibly in
|
2010-01-10 00:33:00 +01:00
|
|
|
conjunction with 'git reset') to create a pristine
|
2006-04-05 08:00:48 +02:00
|
|
|
working directory to test a clean build.
|
|
|
|
|
|
|
|
-X::
|
2013-01-21 20:17:53 +01:00
|
|
|
Remove only files ignored by Git. This may be useful to rebuild
|
2006-04-05 08:00:48 +02:00
|
|
|
everything from scratch, but keep manually created files.
|
|
|
|
|
2012-09-19 01:25:33 +02:00
|
|
|
SEE ALSO
|
|
|
|
--------
|
|
|
|
linkgit:gitignore[5]
|
|
|
|
|
2006-04-05 08:00:48 +02:00
|
|
|
GIT
|
|
|
|
---
|
2008-06-06 09:07:32 +02:00
|
|
|
Part of the linkgit:git[1] suite
|