简体中文 ▾ 主题 ▾ 最新版本 ▾ git-difftool 最后更新于 2.49.0

名称

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

概要

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

描述

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

选项

-d
--dir-diff

将修改后的文件复制到临时位置,并对它们执行目录差异比较。在此模式下,启动差异工具前不会进行提示。

-y
--no-prompt

启动差异工具前不进行提示。

--prompt

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

--rotate-to=<file>

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

--skip-to=<file>

开始显示给定路径的差异,跳过此路径之前的所有路径。

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

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

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

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

除了运行已知的差异工具之外,git difftool 还可以通过在配置变量 difftool.<tool>.cmd 中指定要调用的命令行来定制运行其他程序。

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

--tool-help

打印可与 --tool 一起使用的差异工具列表。

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

指定 --no-symlinks 指示 git difftool 创建副本而不是符号链接。在 Windows 上,--no-symlinks 是默认设置。

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

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

-g
--[no-]gui

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

--[no-]trust-exit-code

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

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

有关支持的选项的完整列表,请参阅 git-diff[1]

配置

当差异工具的等效配置变量未定义时,git difftool 会回退到 git mergetool 的配置变量。

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

diff.tool

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

diff.guitool

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

指定调用指定差异工具的命令。指定的命令将在 shell 中执行,并提供以下变量:LOCAL 设置为包含差异预镜像内容的临时文件名称,REMOTE 设置为包含差异后镜像内容的临时文件名称。

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

difftool.<tool>.path

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

difftool.trustExitCode

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

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

difftool.prompt

每次调用差异工具前进行提示。

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] 套件的一部分

scroll-to-top