简体中文 ▾ 主题 ▾ 最新版本 ▾ git-check-ignore 最后更新于 2.52.0

名称

git-check-ignore - 调试 gitignore / 排除文件

概要

git check-ignore [<options>] <pathname>…​
git check-ignore [<options>] --stdin

描述

对于通过命令行或通过 --stdin 从文件给出的每个路径名,检查该文件是否被 .gitignore(或其他排除机制的输入文件)排除,如果被排除则输出该路径。

默认情况下,已跟踪的文件根本不会显示,因为它们不受排除规则的约束;但请参阅 ‘--no-index’。

选项

-q
--quiet

不输出任何内容,仅设置退出状态。这仅在处理单个路径名时有效。

-v
--verbose

不只是打印被排除的路径,而是针对每个匹配排除模式的路径,同时打印排除模式和该路径。(匹配排除模式通常意味着路径被排除,但如果模式以 "!" 开头,则它是一个取反模式,匹配它意味着路径未被排除。)

有关排除源内部及相互之间的优先级规则,请参阅 gitignore[5]

--stdin

从标准输入读取路径名,每行一个,而不是从命令行读取。

-z

输出格式修改为机器可解析的格式(见下文)。如果同时给出了 --stdin,则输入路径以 NUL 字符分隔,而不是换行符。

-n
--non-matching

显示不匹配任何模式的给定路径。这仅在启用 --verbose 时有意义,否则将无法区分匹配模式的路径和不匹配模式的路径。

--no-index

在进行检查时不查询索引。这可以用于调试为什么某个路径被跟踪(例如通过 git add .)而没有按用户预期被规则忽略,或者在开发包含取反逻辑的模式以匹配先前使用 git add -f 添加的路径时使用。

输出

默认情况下,给定路径名中匹配忽略模式的任何路径都将被输出,每行一个。如果没有模式匹配给定路径,则该路径不会有任何输出;这意味着该路径不会被忽略。

如果指定了 --verbose,输出将是一系列具有以下形式的行:

<source> <COLON> <linenum> <COLON> <pattern> <HT> <pathname>

<pathname> 是被查询的文件路径,<pattern> 是匹配的模式,<source> 是模式的源文件,<linenum> 是该源文件中模式的行号。如果模式包含 "!" 前缀或 "/" 后缀,它将在输出中保留。当引用由 core.excludesFile 配置的文件时,<source> 将是绝对路径;当引用 .git/info/exclude 或特定目录的排除文件时,将相对于仓库根目录。

如果指定了 -z,输出中的路径名由 null 字符分隔;如果同时指定了 --verbose,则 null 字符也将用于替代冒号和制表符(HT)。

<source> <NULL> <linenum> <NULL> <pattern> <NULL> <pathname> <NULL>

如果指定了 -n--non-matching,非匹配的路径名也将被输出,在这种情况下,除 <pathname> 之外的每个输出记录中的所有字段都将为空。这在非交互式运行时很有用,以便文件可以增量地流式传输到一个长期运行的 check-ignore 进程的 STDIN,并且对于这些文件中的每一个,STDOUT 将指示该文件是否匹配某个模式。(如果没有这个选项,将无法区分给定文件没有输出是因为它不匹配任何模式,还是因为输出尚未生成。)

缓冲行为遵循 git[1]GIT_FLUSH 选项的文档。调用者负责避免由于填满输入缓冲区或从空输出缓冲区读取而导致的死锁。

退出状态

0

提供的一个或多个路径被忽略。

1

提供的路径都没有被忽略。

128

遇到致命错误。

GIT

Git[1] 套件的一部分