summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDennis Kaarsemaker <dennis@kaarsemaker.net>2015-11-20 21:30:48 +0100
committerJeff King <peff@peff.net>2015-11-24 17:13:36 -0500
commit219cbf091a3d2e2e0a9bb82ba7c297eb5da413a3 (patch)
treef026b2006967959d160aecc5b583d8117e6f8c95
parentaf40944bda352190f05d22b7cb8fe88beb17f3a7 (diff)
downloadgit-dk/check-ignore-docs.tar.gz
check-ignore: correct documentation about outputdk/check-ignore-docs
By default git check-ignore shows only the filenames that will be ignored, not the pattern that causes their exclusion. Instead of moving the partial exclude pattern precendence information to the -v option where it belongs, link to gitignore(5) which describes this more thoroughly. Signed-off-by: Dennis Kaarsemaker <dennis@kaarsemaker.net> Signed-off-by: Jeff King <peff@peff.net>
-rw-r--r--Documentation/git-check-ignore.txt10
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt
index 59531abba4..e94367a5ed 100644
--- a/Documentation/git-check-ignore.txt
+++ b/Documentation/git-check-ignore.txt
@@ -16,10 +16,9 @@ DESCRIPTION
-----------
For each pathname given via the command-line or from a file via
-`--stdin`, show the pattern from .gitignore (or other input files to
-the exclude mechanism) that decides if the pathname is excluded or
-included. Later patterns within a file take precedence over earlier
-ones.
+`--stdin`, check whether the file is excluded by .gitignore (or other
+input files to the exclude mechanism) and output the path if it is
+excluded.
By default, tracked files are not shown at all since they are not
subject to exclude rules; but see `--no-index'.
@@ -32,7 +31,8 @@ OPTIONS
-v, --verbose::
Also output details about the matching pattern (if any)
- for each given pathname.
+ for each given pathname. For precedence rules within and
+ between exclude sources, see linkgit:gitignore[5].
--stdin::
Read pathnames from the standard input, one per line,