summaryrefslogtreecommitdiff
path: root/Documentation/git-clean.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2011-08-25 11:29:57 -0700
committerJunio C Hamano <gitster@pobox.com>2011-08-28 23:47:55 -0700
commitb6194678b0eebdaf36d41e894b484206810f8221 (patch)
tree733679406a2a5364e56a99ffd3361512a8d01fca /Documentation/git-clean.txt
parentccef6048cd697063967e5e02937911fd8125b364 (diff)
downloadgit-b6194678b0eebdaf36d41e894b484206810f8221.tar.gz
Documentation: clarify "git clean -e <pattern>"
The current explanation of -e can be misread as allowing the user to say I know 'git clean -XYZ' (substitute -XYZ with any option and/or parameter) will remove paths A, B, and C, and I want them all removed except for paths matching this pattern by adding '-e C' to the same command line, i.e. 'git clean -e C -XYZ'. But that is not what this option does. It augments the set of ignore rules from the command line, just like the same "-e <pattern>" argument does with the "ls-files" command (the user could probably pass "-e \!C" to tell the command to clean everything the command would normally remove, except for C). Also error out when both -x and -e are given with an explanation of what -e means---it is a symptom of misunderstanding what -e does. It also fixes small style nit in the parameter to add_exclude() call. The current code only works because EXC_CMDL happens to be defined as 0. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-clean.txt')
-rw-r--r--Documentation/git-clean.txt10
1 files changed, 6 insertions, 4 deletions
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index 974e04ef1a..79fb984144 100644
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -47,12 +47,14 @@ OPTIONS
-e <pattern>::
--exclude=<pattern>::
- Specify special exceptions to not be cleaned. Each <pattern> is
- the same form as in $GIT_DIR/info/excludes and this option can be
- given multiple times.
+ 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.
-x::
- Don't use the ignore rules. This allows removing all untracked
+ 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
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.