简体中文 ▾ 主题 ▾ 最新版本 ▾ git-apply 上次更新于 2.51.0

名称

git-apply - 将补丁应用于文件和/或索引

概要

git apply [--stat] [--numstat] [--summary] [--check]
	  [--index | --intent-to-add] [--3way] [--ours | --theirs | --union]
	  [--apply] [--no-add] [--build-fake-ancestor=<file>] [-R | --reverse]
	  [--allow-binary-replacement | --binary] [--reject] [-z]
	  [-p<n>] [-C<n>] [--inaccurate-eof] [--recount] [--cached]
	  [--ignore-space-change | --ignore-whitespace]
	  [--whitespace=(nowarn|warn|fix|error|error-all)]
	  [--exclude=<path>] [--include=<path>] [--directory=<root>]
	  [--verbose | --quiet] [--unsafe-paths] [--allow-empty] [<patch>…​]

描述

读取提供的 diff 输出（即“补丁”）并将其应用于文件。当从存储库中的子目录运行时，将忽略目录外的修补路径。使用 --index 选项，补丁也将应用于索引，使用 --cached 选项，补丁仅应用于索引。没有这些选项，命令仅将补丁应用于文件，并且不要求它们位于 Git 存储库中。

此命令应用补丁但不创建提交。使用 git-am[1] 从 git-format-patch[1] 生成的补丁和/或通过电子邮件收到的补丁创建提交。

选项

<patch>…​

用于读取补丁的文件。- 可用于从标准输入读取。

--stat

不应用补丁，而是输出输入文件的 diffstat。关闭“应用”。

--numstat

与 --stat 类似，但以十进制表示法显示添加和删除的行数以及路径名，不加缩写，使其更易于机器处理。对于二进制文件，输出两个 - 而不是说 0 0。关闭“应用”。

--summary

不应用补丁，而是输出从 git diff 扩展头获取的信息的简要摘要，例如创建、重命名和模式更改。关闭“应用”。

--check

不应用补丁，而是检查补丁是否可应用于当前工作树和/或索引文件并检测错误。关闭“应用”。

--index

将补丁应用于索引和工作树（如果生效了 --check，则仅检查它是否可以干净地应用于两者）。请注意，--index 期望索引条目和相关路径的工作树副本是相同的（它们的内容和元数据（如文件模式）必须匹配），即使补丁可以单独干净地应用于索引和工作树，它也会引发错误。

--cached

仅将补丁应用于索引，而不触及工作树。如果生效了 --check，则仅检查它是否可以干净地应用于索引条目。

-N
--intent-to-add

当仅将补丁应用于工作树时，标记新文件稍后将添加到索引（请参阅 git-add[1] 中的 --intent-to-add 选项）。如果使用了 --index 或 --cached，则忽略此选项，并且在 Git 存储库之外没有效果。请注意，--index 可以由其他选项（如 --3way）隐含。

-3
--3way

如果补丁记录了它应该应用的 blob 的标识，并且我们本地拥有这些 blob，则尝试进行 3 向合并，可能会在工作树的文件中留下冲突标记供用户解决。此选项隐含 --index 选项，除非使用了 --cached 选项，并且与 --reject 选项不兼容。当与 --cached 选项一起使用时，任何冲突都将留在缓存的更高阶段。

--ours
--theirs
--union

不将冲突留在文件中，而是解决冲突，优先选择行的我方（或对方或双方）。需要 --3way。

--build-fake-ancestor=<file>

较新的 git diff 输出包含每个 blob 的嵌入式索引信息，以帮助识别补丁适用的原始版本。当给出此标志，并且原始 blob 版本在本地可用时，将构建一个包含这些 blob 的临时索引。

当遇到纯模式更改（没有索引信息）时，该信息将从当前索引读取。

-R
--reverse

反向应用补丁。

--reject

为了原子性，git apply 默认情况下会失败整个补丁，并且在某些不适用的代码块（hunk）时不会触及工作树。此选项使其应用适用的补丁部分，并将被拒绝的代码块保留在相应的 *.rej 文件中。

-z

当给出 --numstat 时，不处理路径名，而是使用 NUL 终止的机器可读格式。

如果没有此选项，包含“不寻常”字符的路径名将按照配置变量 core.quotePath 的解释进行引用（参见 git-config[1]）。

-p<n>

从传统 diff 路径中删除 <n> 个前导路径组件（以斜杠分隔）。例如，使用 -p2，针对 a/dir/file 的补丁将被直接应用于 file。默认值为 1。

-C<n>

确保在每次更改之前和之后至少有 <n> 行的周围上下文匹配。当周围上下文行较少时，它们都必须匹配。默认情况下，从不忽略上下文。

--unidiff-zero

默认情况下，git apply 期望正在应用的补丁是一个统一 diff，至少有一行上下文。这提供了良好的安全措施，但在应用使用 --unified=0 生成的 diff 时会失效。要绕过这些检查，请使用 --unidiff-zero。

注意，由于上述原因，不鼓励使用无上下文补丁。

--apply

如果您使用了上面标记为“关闭应用”的任何选项，git apply 会读取并输出请求的信息而不实际应用补丁。在这些标志之后给出此标志以同时应用补丁。

--no-add

应用补丁时，忽略补丁所做的添加。这可以通过首先对它们运行 diff 并使用此选项应用结果来提取两个文件之间的公共部分，这将应用删除部分但不会应用添加部分。

--allow-binary-replacement
--binary

过去，我们不允许在没有用户明确许可的情况下应用二进制补丁，而此标志是实现此目的的方式。目前，我们始终允许应用二进制补丁，因此这是一个无操作。

--exclude=<path-pattern>

不要将更改应用于与给定路径模式匹配的文件。这在导入补丁集时可能很有用，当您想排除某些文件或目录时。

--include=<path-pattern>

将更改应用于与给定路径模式匹配的文件。这在导入补丁集时可能很有用，当您想包含某些文件或目录时。

当使用 --exclude 和 --include 模式时，它们会按照在命令行上出现的顺序进行检查，第一个匹配项决定是否使用对每个路径的补丁。如果命令行上没有 include 模式，则默认使用与任何 include/exclude 模式都不匹配的路径的补丁，如果有任何 include 模式，则忽略该补丁。

--ignore-space-change
--ignore-whitespace

应用补丁时，在必要时忽略上下文行中的空格更改。上下文行将保留其空格，并且无论 --whitespace 选项的值如何，它们都不会进行空格修复。然而，新行仍然会被修复。

--whitespace=<action>

应用补丁时，检测具有空格错误的新行或已修改的行。什么是空格错误由 core.whitespace 配置控制。默认情况下，尾随空格（包括仅由空格组成的行）以及行初始缩进中紧随制表符之后的空格字符被视为空格错误。

默认情况下，命令输出警告消息但应用补丁。当 git-apply 用于统计而不是应用补丁时，它默认为 nowarn。

您可以使用不同的 <action> 值来控制此行为

  • nowarn 关闭尾随空格警告。

  • warn 输出一些此类错误的警告，但按原样应用补丁（默认）。

  • fix 输出一些此类错误的警告，并在修复它们后应用补丁（strip 是同义词——该工具过去只考虑尾随空格字符为错误，并且修复涉及剥离它们，但现代 Git 会做得更多）。

  • error 输出一些此类错误的警告，并拒绝应用补丁。

  • error-all 类似于 error，但显示所有错误。

--inaccurate-eof

在某些情况下，一些版本的 diff 无法正确检测文件末尾缺少换行符。因此，由这些 diff 程序创建的补丁无法正确记录不完整行。此选项通过解决此错误来支持应用此类补丁。

-v
--verbose

向 stderr 报告进度。默认情况下，只会打印关于当前正在应用的补丁的消息。此选项将导致报告额外的信息。

-q
--quiet

抑制 stderr 输出。将不打印关于补丁状态和进度的消息。

--recount

不信任代码块头中的行数，而是通过检查补丁来推断它们（例如，在编辑补丁而不适当地调整代码块头之后）。

--directory=<root>

将 <root> 添加到所有文件名之前。如果还传递了“-p”参数，则在添加新根之前应用它。

例如，一个关于将 a/git-gui.sh 更新到 b/git-gui.sh 的补丁可以通过运行 git apply --directory=modules/git-gui 来应用于工作树中的文件 modules/git-gui/git-gui.sh。

--unsafe-paths

默认情况下，影响工作区外部的补丁（无论是 Git 控制的工作树，还是在使用“git apply”替代 GNU patch 时使用的当前工作目录）都会因错误（或恶意）而被拒绝。

当 git apply 被用作“更好的 GNU patch”时，用户可以传递 --unsafe-paths 选项来覆盖此安全检查。此选项在 --index 或 --cached 在使用中时没有效果。

--allow-empty

对于不包含 diff 的补丁，不要返回错误。这包括空补丁和仅包含提交文本的补丁。

配置

本节中以下所有内容均从 git-config[1] 文档中选择性地包含。内容与彼处相同：

apply.ignoreWhitespace

设置为change时，告诉git apply忽略空格更改，方式与--ignore-space-change选项相同。设置为以下之一：no, none, never, false，它告诉git apply尊重所有空格差异。请参阅git-apply[1]。

apply.whitespace

告诉git apply如何处理空格，方式与--whitespace选项相同。请参阅git-apply[1]。

子模块

如果补丁包含任何子模块的更改，则git apply将这些更改视为如下。

如果指定了 --index（显式或隐含），则子模块提交必须与索引完全匹配才能应用补丁。如果任何子模块被签出，则这些签出将被完全忽略，即，它们不必是最新的或干净的，并且它们不会被更新。

如果未指定 --index，则将忽略补丁中的子模块提交，并且仅检查（并在可能时更新）相应子目录的存在或不存在。

另请参阅

git-am[1].

GIT

Git[1] 套件的一部分