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>
This commit is contained in:
Dennis Kaarsemaker 2015-11-20 21:30:48 +01:00 committed by Jeff King
parent af40944bda
commit 219cbf091a

View File

@ -16,10 +16,9 @@ DESCRIPTION
----------- -----------
For each pathname given via the command-line or from a file via For each pathname given via the command-line or from a file via
`--stdin`, show the pattern from .gitignore (or other input files to `--stdin`, check whether the file is excluded by .gitignore (or other
the exclude mechanism) that decides if the pathname is excluded or input files to the exclude mechanism) and output the path if it is
included. Later patterns within a file take precedence over earlier excluded.
ones.
By default, tracked files are not shown at all since they are not By default, tracked files are not shown at all since they are not
subject to exclude rules; but see `--no-index'. subject to exclude rules; but see `--no-index'.
@ -32,7 +31,8 @@ OPTIONS
-v, --verbose:: -v, --verbose::
Also output details about the matching pattern (if any) 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:: --stdin::
Read pathnames from the standard input, one per line, Read pathnames from the standard input, one per line,