[PATCH v2] check-ignore: correct documentation about output
- From
Dennis Kaarsemaker <dennis@kaarsemaker.net>
- Date
- Nov 20, 2015, 20:30 UTC
- Message-ID
- <20151120203045.GA16353@spirit>
- In-Reply-To
- <1448051381.6899.2.camel@kaarsemaker.net>
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> --- Documentation/git-check-ignore.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt index 59531ab..e94367a 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,
-- 2.6.3-495-gf0a7f49 -- Dennis Kaarsemaker <dennis@kaarsemaker.net> http://twitter.com/seveas