NAME
git-check-ignore - Debug gitignore / exclude filesSYNOPSIS
git check-ignore [<options>] <pathname>... git check-ignore [<options>] --stdin
DESCRIPTION
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.OPTIONS
-q, --quietDon’t output anything, just set exit
status. This is only valid with a single pathname.
-v, --verbose
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 means the
path is excluded, but if the pattern begins with " !" then it
is a negated pattern and matching it means the path is NOT excluded.)
For precedence rules within and between exclude sources, see
gitignore(5).
--stdin
Read pathnames from the standard input, one
per line, instead of from the command-line.
-z
The output format is modified to be
machine-parsable (see below). If --stdin is also given, input paths are
separated with a NUL character instead of a linefeed character.
-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.
--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.
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.EXIT STATUS
0One or more of the provided paths is
ignored.
1
None of the provided paths are ignored.
128
A fatal error was encountered.
SEE ALSO
gitignore(5) git-config(1) git-ls-files(1)GIT
Part of the git(1) suite02/28/2023 | Git 2.39.2 |