summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Denton Liu <liu.denton@gmail.com>2019-03-07 00:25:28 -0800
committerLibravatar Junio C Hamano <gitster@pobox.com>2019-03-08 09:11:21 +0900
commit407e7680729945126b414a634365be15075fc3bb (patch)
treeaae60811b997da0ae0adedea5246493dd09a28b5 /Documentation
parentMerge tag 'l10n-2.21.0-rnd2.1' of git://github.com/git-l10n/git-po (diff)
downloadtgif-407e7680729945126b414a634365be15075fc3bb.tar.xz
git-clean.txt: clarify ignore pattern files
In the git-clean documentation, -x and -e documented .gitignore, $GIT_DIR/info/excludes but neglected to mention the file pointed to by core.excludesFile. Remove specific list of files and, instead, reference gitignore(5) documentation so that information is consolidated and the git-clean documentation is more precise. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> Helped-by: Martin Ă…gren <martin.agren@gmail.com> Helped-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Denton Liu <liu.denton@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-clean.txt11
1 files changed, 5 insertions, 6 deletions
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index 03056dad0d..db876f7dde 100644
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -55,14 +55,13 @@ OPTIONS
-e <pattern>::
--exclude=<pattern>::
- 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.
+ Use the given exclude pattern in addition to the standard ignore rules
+ (see linkgit:gitignore[5]).
-x::
- 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
+ Don't use the standard ignore rules (see linkgit:gitignore[5]), but
+ still use the ignore rules given with `-e` options from the command
+ line. 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.