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

名称

git-difftool - 使用通用 diff 工具显示更改

概要

git difftool [<options>] [<commit> [<commit>]] [--] [<path>…​]

描述

git difftool 是一个 Git 命令,允许您使用通用的 diff 工具在不同修订版本之间比较和编辑文件。git difftoolgit diff 的前端,并接受相同的选项和参数。请参阅 git-diff[1]

选项

-d
--dir-diff

将修改后的文件复制到临时位置并对其执行目录 diff。此模式在启动 diff 工具之前从不提示。

-y
--no-prompt

启动 diff 工具前不进行提示。

--prompt

在每次调用 diff 工具之前进行提示。这是默认行为;提供此选项是为了覆盖任何配置设置。

--rotate-to=<file>

开始显示给定路径的 diff,它之前的路径将移动到末尾并输出。

--skip-to=<file>

开始显示给定路径的 diff,跳过它之前的所有路径。

-t <tool>
--tool=<tool>

使用 <tool> 指定的 diff 工具。有效值包括 emerge、kompare、meld 和 vimdiff。运行 git difftool --tool-help 可获取有效 <tool> 设置的列表。

如果未指定 diff 工具,git difftool 将使用配置变量 diff.tool。如果未设置 diff.tool 配置变量,git difftool 将选择一个合适的默认值。

您可以通过设置配置变量 difftool.<tool>.path 来显式提供工具的完整路径。例如,您可以通过设置 difftool.kdiff3.path 来配置 kdiff3 的绝对路径。否则,git difftool 假定该工具可在 PATH 中找到。

而不是运行已知的 diff 工具之一,git difftool 可以通过在配置变量 difftool.<tool>.cmd 中指定要调用的命令行来定制以运行替代程序。

git difftool 使用此工具调用时(无论是通过 -t--tool 选项还是 diff.tool 配置变量),配置的命令行将使用以下可用变量调用:$LOCAL 设置为包含 diff 前像内容的临时文件名,$REMOTE 设置为包含 diff 后像内容的临时文件名。$MERGED 是正在比较的文件名。$BASE 是为与自定义合并工具命令兼容而提供的,并且与 $MERGED 的值相同。

--tool-help

打印一个可以使用 --tool 的 diff 工具列表。

git difftool--dir-diff 模式下运行时,当比较的右侧与工作树中的文件内容相同时,默认行为是创建指向工作树的符号链接。

指定 --no-symlinks 会指示 git difftool 创建副本。在 Windows 上,--no-symlinks 是默认设置。

-x <command>
--extcmd=<command>

指定用于查看 diff 的自定义命令。git difftool 会忽略配置的默认值,并在指定此选项时运行 <command> $LOCAL $REMOTE。此外,$BASE 会在环境中设置。

-g
--gui
--no-gui

git difftool 使用 -g--gui 选项调用时,将从配置的 diff.guitool 变量读取默认 diff 工具,而不是 diff.tool。可以使用配置变量 difftool.guiDefault 自动选择此项。--no-gui 选项可用于覆盖这些设置。如果未设置 diff.guitool,我们将按 merge.guitooldiff.toolmerge.tool 的顺序回退,直到找到一个工具。

--trust-exit-code
--no-trust-exit-code

默认情况下,diff 工具报告的错误会被忽略。使用 --trust-exit-code 可使 git difftool 在调用的 diff 工具返回非零退出代码时退出。

当使用 --trust-exit-code 时,git difftool 会转发所调用工具的退出代码。

请参阅 git-diff[1] 获取支持选项的完整列表。

配置

git difftool 在 difftool 等效项未定义时,会回退到 git mergetool 配置变量。

本节中此行以上的所有内容均未包含在 git-config[1] 文档中。以下内容与该文档中的内容相同

diff.tool

控制 git-difftool[1] 使用哪个 diff 工具。此变量覆盖 merge.tool 中配置的值。下面的列表显示了有效的内置值。任何其他值都被视为自定义 diff 工具,并且需要定义相应的 difftool.<tool>.cmd 变量。

diff.guitool

控制 git-difftool[1] 在指定 -g/--gui 标志时使用的 diff 工具。此变量覆盖 merge.guitool 中配置的值。下面的列表显示了有效的内置值。任何其他值都被视为自定义 diff 工具,并且需要定义相应的 difftool.<guitool>.cmd 变量。

  • araxis

  • bc

  • codecompare

  • deltawalker

  • diffmerge

  • diffuse

  • ecmerge

  • emerge

  • examdiff

  • guiffy

  • gvimdiff

  • kdiff3

  • kompare

  • meld

  • nvimdiff

  • opendiff

  • p4merge

  • smerge

  • tkdiff

  • vimdiff

  • vscode

  • winmerge

  • xxdiff

difftool.<tool>.cmd

指定调用指定 diff 工具的命令。指定的命令在 shell 中进行求值,并提供以下可用变量:LOCAL 设置为包含 diff 前像内容的临时文件名,REMOTE 设置为包含 diff 后像内容的临时文件名。

有关更多详细信息,请参阅 git-difftool[1] 中的 --tool=<tool> 选项。

difftool.<tool>.path

覆盖给定工具的路径。当您的工具不在 PATH 中时,这很有用。

difftool.trustExitCode

如果调用的 diff 工具返回非零退出状态,则退出 difftool。

有关更多详细信息,请参阅 git-difftool[1] 中的 --trust-exit-code 选项。

difftool.prompt

在每次调用 diff 工具之前进行提示。

difftool.guiDefault

设置 true 以默认使用 diff.guitool(等同于指定 --gui 参数),或设置 auto 以根据 DISPLAY 环境变量的值是否存在来选择 diff.guitooldiff.tool。默认值为 false,此时必须显式提供 --gui 参数才能使用 diff.guitool

另请参阅

git-diff[1]

显示提交之间、提交与工作树之间等的更改

git-mergetool[1]

运行合并冲突解决工具来解决合并冲突

git-config[1]

获取和设置存储库或全局选项

GIT

Git[1] 套件的一部分