Skip to content

Commit 219cbf0

Browse files
seveaspeff
authored andcommitted
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 <[email protected]> Signed-off-by: Jeff King <[email protected]>
1 parent af40944 commit 219cbf0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Documentation/git-check-ignore.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,9 @@ DESCRIPTION
1616
-----------
1717

1818
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.
2322

2423
By default, tracked files are not shown at all since they are not
2524
subject to exclude rules; but see `--no-index'.
@@ -32,7 +31,8 @@ OPTIONS
3231

3332
-v, --verbose::
3433
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].
3636

3737
--stdin::
3838
Read pathnames from the standard input, one per line,

0 commit comments

Comments
 (0)