check-ignore: correct documentation about output
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>
Dennis Kaarsemaker committed
Nov 20, 2015 at 21:30 UTC
219cbf091a3d2e2e0a9bb82ba7c297eb5da413a3
1 file changed
+5
-5
Documentation/git-check-ignore.txt
+5
-5
@@ -16,10 +16,9 @@ DESCRIPTION
16
-----------
17
18
For each pathname given via the command-line or from a file via
19
-`--stdin`, show the pattern from .gitignore (or other input files to
20
-the exclude mechanism) that decides if the pathname is excluded or
21
-included. Later patterns within a file take precedence over earlier
22
-ones.
19
+`--stdin`, check whether the file is excluded by .gitignore (or other
20
+input files to the exclude mechanism) and output the path if it is
21
+excluded.
22
23
By default, tracked files are not shown at all since they are not
24
subject to exclude rules; but see `--no-index'.
@@ -32,7 +31,8 @@ OPTIONS
31
32
-v, --verbose::
33
Also output details about the matching pattern (if any)
35
- for each given pathname.
34
+ for each given pathname. For precedence rules within and
35
+ between exclude sources, see linkgit:gitignore[5].
36
37
--stdin::
38
Read pathnames from the standard input, one per line,