2013-01-06 17:58:13 +01:00
|
|
|
git-check-ignore(1)
|
|
|
|
|
===================
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
|
|
|
|
git-check-ignore - Debug gitignore / exclude files
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
|
|
|
|
[verse]
|
2018-05-24 22:11:39 +02:00
|
|
|
'git check-ignore' [<options>] <pathname>...
|
|
|
|
|
'git check-ignore' [<options>] --stdin
|
2013-01-06 17:58:13 +01:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
For each pathname given via the command-line or from a file via
|
2015-11-20 21:30:48 +01:00
|
|
|
`--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.
|
2013-01-06 17:58:13 +01:00
|
|
|
|
2014-12-04 16:23:05 +01:00
|
|
|
By default, tracked files are not shown at all since they are not
|
|
|
|
|
subject to exclude rules; but see `--no-index'.
|
|
|
|
|
|
2013-01-06 17:58:13 +01:00
|
|
|
OPTIONS
|
|
|
|
|
-------
|
|
|
|
|
-q, --quiet::
|
|
|
|
|
Don't output anything, just set exit status. This is only
|
|
|
|
|
valid with a single pathname.
|
|
|
|
|
|
|
|
|
|
-v, --verbose::
|
check-ignore: fix documentation and implementation to match
check-ignore has two different modes, and neither of these modes has an
implementation that matches the documentation. These modes differ in
whether they just print paths or whether they also print the final
pattern matched by the path. The fix is different for both modes, so
I'll discuss both separately.
=== First (default) mode ===
The first mode is documented as:
For each pathname given via the command-line or from a file via
--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.
However, it fails to do this because it did not account for negated
patterns. Commands other than check-ignore verify exclusion rules via
calling
... -> treat_one_path() -> is_excluded() -> last_matching_pattern()
while check-ignore has a call path of the form:
... -> check_ignore() -> last_matching_pattern()
The fact that the latter does not include the call to is_excluded()
means that it is susceptible to to messing up negated patterns (since
that is the only significant thing is_excluded() adds over
last_matching_pattern()). Unfortunately, we can't make it just call
is_excluded(), because the same codepath is used by the verbose mode
which needs to know the matched pattern in question. This brings us
to...
=== Second (verbose) mode ===
The second mode, known as verbose mode, references the first in the
documentation and says:
Also output details about the matching pattern (if any) for each
given pathname. For precedence rules within and between exclude
sources, see gitignore(5).
The "Also" means it will print patterns that match the exclude rules as
noted for the first mode, and also print which pattern matches. Unless
more information is printed than just pathname and pattern (which is not
done), this definition is somewhat ill-defined and perhaps even
self-contradictory for negated patterns: A path which matches a negated
exclude pattern is NOT excluded and thus shouldn't be printed by the
former logic, while it certainly does match one of the explicit patterns
and thus should be printed by the latter logic.
=== Resolution ==
Since the second mode exists to find out which pattern matches given
paths, and showing the user a pattern that begins with a '!' is
sufficient for them to figure out whether the pattern is excluded, the
existing behavior is desirable -- we just need to update the
documentation to match the implementation (i.e. it is about printing
which pattern is matched by paths, not about showing which paths are
excluded).
For the first or default mode, users just want to know whether a pattern
is excluded. As such, the existing documentation is desirable; change
the implementation to match the documented behavior.
Finally, also adjust a few tests in t0008 that were caught up by this
discrepancy in how negated paths were handled.
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-02-19 00:05:37 +01:00
|
|
|
Instead of printing the paths that are excluded, for each path
|
|
|
|
|
that matches an exclude pattern, print the exclude pattern
|
|
|
|
|
together with the path. (Matching an exclude pattern usually
|
2022-02-03 11:16:43 +01:00
|
|
|
means the path is excluded, but if the pattern begins with "`!`"
|
check-ignore: fix documentation and implementation to match
check-ignore has two different modes, and neither of these modes has an
implementation that matches the documentation. These modes differ in
whether they just print paths or whether they also print the final
pattern matched by the path. The fix is different for both modes, so
I'll discuss both separately.
=== First (default) mode ===
The first mode is documented as:
For each pathname given via the command-line or from a file via
--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.
However, it fails to do this because it did not account for negated
patterns. Commands other than check-ignore verify exclusion rules via
calling
... -> treat_one_path() -> is_excluded() -> last_matching_pattern()
while check-ignore has a call path of the form:
... -> check_ignore() -> last_matching_pattern()
The fact that the latter does not include the call to is_excluded()
means that it is susceptible to to messing up negated patterns (since
that is the only significant thing is_excluded() adds over
last_matching_pattern()). Unfortunately, we can't make it just call
is_excluded(), because the same codepath is used by the verbose mode
which needs to know the matched pattern in question. This brings us
to...
=== Second (verbose) mode ===
The second mode, known as verbose mode, references the first in the
documentation and says:
Also output details about the matching pattern (if any) for each
given pathname. For precedence rules within and between exclude
sources, see gitignore(5).
The "Also" means it will print patterns that match the exclude rules as
noted for the first mode, and also print which pattern matches. Unless
more information is printed than just pathname and pattern (which is not
done), this definition is somewhat ill-defined and perhaps even
self-contradictory for negated patterns: A path which matches a negated
exclude pattern is NOT excluded and thus shouldn't be printed by the
former logic, while it certainly does match one of the explicit patterns
and thus should be printed by the latter logic.
=== Resolution ==
Since the second mode exists to find out which pattern matches given
paths, and showing the user a pattern that begins with a '!' is
sufficient for them to figure out whether the pattern is excluded, the
existing behavior is desirable -- we just need to update the
documentation to match the implementation (i.e. it is about printing
which pattern is matched by paths, not about showing which paths are
excluded).
For the first or default mode, users just want to know whether a pattern
is excluded. As such, the existing documentation is desirable; change
the implementation to match the documented behavior.
Finally, also adjust a few tests in t0008 that were caught up by this
discrepancy in how negated paths were handled.
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-02-19 00:05:37 +01:00
|
|
|
then it is a negated pattern and matching it means the path is
|
|
|
|
|
NOT excluded.)
|
|
|
|
|
+
|
|
|
|
|
For precedence rules within and between exclude sources, see
|
|
|
|
|
linkgit:gitignore[5].
|
2013-01-06 17:58:13 +01:00
|
|
|
|
|
|
|
|
--stdin::
|
usage: do not insist that standard input must come from a file
The synopsys text and the usage string of subcommands that read list
of things from the standard input are often shown like this:
git gostak [--distim] < <list-of-doshes>
This is problematic in a number of ways:
* The way to use these commands is more often to feed them the
output from another command, not feed them from a file.
* Manual pages outside Git, commands that operate on the data read
from the standard input, e.g "sort", "grep", "sed", etc., are not
described with such a "< redirection-from-file" in their synopsys
text. Our doing so introduces inconsistency.
* We do not insist on where the output should go, by saying
git gostak [--distim] < <list-of-doshes> > <output>
* As it is our convention to enclose placeholders inside <braket>,
the redirection operator followed by a placeholder filename
becomes very hard to read, both in the documentation and in the
help text.
Let's clean them all up, after making sure that the documentation
clearly describes the modes that take information from the standard
input and what kind of things are expected on the input.
[jc: stole example for fmt-merge-msg from Jonathan]
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2015-10-16 20:27:42 +02:00
|
|
|
Read pathnames from the standard input, one per line,
|
|
|
|
|
instead of from the command-line.
|
2013-01-06 17:58:13 +01:00
|
|
|
|
|
|
|
|
-z::
|
2019-11-05 18:07:20 +01:00
|
|
|
The output format is modified to be machine-parsable (see
|
2013-01-06 17:58:13 +01:00
|
|
|
below). If `--stdin` is also given, input paths are separated
|
|
|
|
|
with a NUL character instead of a linefeed character.
|
|
|
|
|
|
2013-04-11 14:05:10 +02:00
|
|
|
-n, --non-matching::
|
|
|
|
|
Show given paths which don't match any pattern. This only
|
|
|
|
|
makes sense when `--verbose` is enabled, otherwise it would
|
|
|
|
|
not be possible to distinguish between paths which match a
|
|
|
|
|
pattern and those which don't.
|
|
|
|
|
|
2013-09-05 18:08:01 +02:00
|
|
|
--no-index::
|
|
|
|
|
Don't look in the index when undertaking the checks. This can
|
|
|
|
|
be used to debug why a path became tracked by e.g. `git add .`
|
|
|
|
|
and was not ignored by the rules as expected by the user or when
|
|
|
|
|
developing patterns including negation to match a path previously
|
|
|
|
|
added with `git add -f`.
|
|
|
|
|
|
2013-01-06 17:58:13 +01:00
|
|
|
OUTPUT
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
By default, any of the given pathnames which match an ignore pattern
|
|
|
|
|
will be output, one per line. If no pattern matches a given path,
|
|
|
|
|
nothing will be output for that path; this means that path will not be
|
|
|
|
|
ignored.
|
|
|
|
|
|
|
|
|
|
If `--verbose` is specified, the output is a series of lines of the form:
|
|
|
|
|
|
|
|
|
|
<source> <COLON> <linenum> <COLON> <pattern> <HT> <pathname>
|
|
|
|
|
|
|
|
|
|
<pathname> is the path of a file being queried, <pattern> is the
|
|
|
|
|
matching pattern, <source> is the pattern's source file, and <linenum>
|
|
|
|
|
is the line number of the pattern within that source. If the pattern
|
2022-02-03 11:16:43 +01:00
|
|
|
contained a "`!`" prefix or "`/`" suffix, it will be preserved in the
|
2013-01-06 17:58:13 +01:00
|
|
|
output. <source> will be an absolute path when referring to the file
|
2015-03-11 21:32:45 +01:00
|
|
|
configured by `core.excludesFile`, or relative to the repository root
|
2013-01-06 17:58:13 +01:00
|
|
|
when referring to `.git/info/exclude` or a per-directory exclude file.
|
|
|
|
|
|
|
|
|
|
If `-z` is specified, the pathnames in the output are delimited by the
|
|
|
|
|
null character; if `--verbose` is also specified then null characters
|
|
|
|
|
are also used instead of colons and hard tabs:
|
|
|
|
|
|
|
|
|
|
<source> <NULL> <linenum> <NULL> <pattern> <NULL> <pathname> <NULL>
|
|
|
|
|
|
2013-04-11 14:05:10 +02:00
|
|
|
If `-n` or `--non-matching` are specified, non-matching pathnames will
|
|
|
|
|
also be output, in which case all fields in each output record except
|
|
|
|
|
for <pathname> will be empty. This can be useful when running
|
|
|
|
|
non-interactively, so that files can be incrementally streamed to
|
|
|
|
|
STDIN of a long-running check-ignore process, and for each of these
|
|
|
|
|
files, STDOUT will indicate whether that file matched a pattern or
|
|
|
|
|
not. (Without this option, it would be impossible to tell whether the
|
|
|
|
|
absence of output for a given file meant that it didn't match any
|
|
|
|
|
pattern, or that the output hadn't been generated yet.)
|
2013-01-06 17:58:13 +01:00
|
|
|
|
2013-04-11 14:05:13 +02:00
|
|
|
Buffering happens as documented under the `GIT_FLUSH` option in
|
|
|
|
|
linkgit:git[1]. The caller is responsible for avoiding deadlocks
|
|
|
|
|
caused by overfilling an input buffer or reading from an empty output
|
|
|
|
|
buffer.
|
|
|
|
|
|
2013-01-06 17:58:13 +01:00
|
|
|
EXIT STATUS
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
0::
|
|
|
|
|
One or more of the provided paths is ignored.
|
|
|
|
|
|
|
|
|
|
1::
|
|
|
|
|
None of the provided paths are ignored.
|
|
|
|
|
|
|
|
|
|
128::
|
|
|
|
|
A fatal error was encountered.
|
|
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
|
|
|
|
linkgit:gitignore[5]
|
2016-05-04 19:36:24 +02:00
|
|
|
linkgit:git-config[1]
|
2013-06-30 14:05:28 +02:00
|
|
|
linkgit:git-ls-files[1]
|
2013-01-06 17:58:13 +01:00
|
|
|
|
|
|
|
|
GIT
|
|
|
|
|
---
|
|
|
|
|
Part of the linkgit:git[1] suite
|