Git
English ▾ 主题 ▾ 最新版本 ▾ git-check-ignore 最后更新于 2.43.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，则输入路径用空字符分隔，而不是换行符。

-n, --non-matching

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

--no-index

在进行检查时不要查看索引。这可以用来调试为什么路径被例如 git add . 跟踪并且没有按用户预期被规则忽略，或者在开发包括否定以匹配先前使用 git add -f 添加的路径的模式时。

输出

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

如果指定了 --verbose，则输出将是一系列以下形式的行：

<源> <冒号> <行号> <冒号> <模式> <水平制表符> <路径名>

<路径名> 是正在查询的文件的路径，<模式> 是匹配的模式，<源> 是模式的源文件，<行号> 是该模式在该源文件中的行号。如果模式包含“!”前缀或“/”后缀，它将在输出中保留。当引用由 core.excludesFile 配置的文件时，<源> 将是绝对路径；当引用 .git/info/exclude 或每个目录的排除文件时，<源> 将相对于存储库根目录。

如果指定了 -z，则输出中的路径名由空字符分隔；如果也指定了 --verbose，则也使用空字符代替冒号和水平制表符

<源> <空> <行号> <空> <模式> <空> <路径名> <空>

如果指定了 -n 或 --non-matching，则不匹配的路径名也将输出，在这种情况下，每个输出记录中除 <路径名> 之外的所有字段都将为空。这在非交互式运行时非常有用，以便可以将文件增量地流式传输到长时间运行的 check-ignore 进程的 STDIN，并且对于这些文件中的每一个，STDOUT 将指示该文件是否匹配模式。（如果没有此选项，则无法判断给定文件的输出缺失是意味着它不匹配任何模式，还是输出尚未生成。）

缓冲按照 git[1] 中 GIT_FLUSH 选项下记录的方式发生。调用方负责避免因输入缓冲区溢出或从空输出缓冲区读取而导致的死锁。

退出状态

0

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

1

没有提供的路径被忽略。

128

遇到致命错误。

另请参阅

gitignore[5] git-config[1] git-ls-files[1]

GIT

是 git[1] 套件的一部分

scroll-to-top