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

名称

git-mergetool - 运行合并冲突解决工具来解决合并冲突

概要

git mergetool [--tool=<tool>] [-y | --[no-]prompt] [<file>…​]

描述

使用 git mergetool 来运行多个合并工具中的一个来解决合并冲突。它通常在 git merge 之后运行。

如果给出了一个或多个 <file> 参数,则会运行合并工具程序来解决每个文件中的差异(跳过没有冲突的文件)。指定一个目录将包括该路径下的所有未解决的文件。如果未指定任何 <file> 名称,git mergetool 将在所有有合并冲突的文件上运行合并工具程序。

选项

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

使用 <tool> 指定的合并分辨率程序。有效值包括 emergegvimdiffkdiff3meldvimdifftortoisemerge。运行 git mergetool --tool-help 获取有效 <tool> 设置的列表。

如果没有指定合并分辨率程序,git mergetool 将使用配置变量 merge.tool。如果未设置 merge.tool 配置变量,git mergetool 将选择一个合适的默认值。

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

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

git mergetool 使用此工具调用时(通过 -t--tool 选项或 merge.tool 配置变量),配置的命令行将使用 BASE 设置为包含合并共同基础的临时文件的名称(如果可用);LOCAL 设置为包含当前分支文件内容的临时文件的名称;REMOTE 设置为包含要合并文件的内容的临时文件的名称;MERGED 设置为合并工具应将合并分辨率结果写入的文件名称。

如果自定义合并工具通过其退出码正确指示了合并分辨率的成功,则配置变量 mergetool.<tool>.trustExitCode 可以设置为 true。否则,git mergetool 将提示用户在自定义工具退出后指示分辨率的成功。

--tool-help

打印可以使用 --tool 的合并工具列表。

-y
--no-prompt

在每次调用合并分辨率程序之前不进行提示。如果使用 --tool 选项或 merge.tool 配置变量显式指定了合并分辨率程序,则这是默认行为。

--prompt

在每次调用合并分辨率程序之前提示,以便用户有机会跳过该路径。

-g
--gui

git-mergetool 使用 -g--gui 选项调用时,将从配置的 merge.guitool 变量而不是 merge.tool 读取默认合并工具。如果未设置 merge.guitool,我们将回退到 merge.tool 下配置的工具。这可以通过配置变量 mergetool.guiDefault 自动选择。

--no-gui

这会覆盖先前的 -g--gui 设置或 mergetool.guiDefault 配置,并从配置的 merge.tool 变量读取默认合并工具。

-O<orderfile>

<orderfile> 中指定的顺序处理文件,该文件每行有一个 shell glob 模式。这会覆盖 diff.orderFile 配置变量(参见 git-config[1])。要取消 diff.orderFile,请使用 -O/dev/null

配置

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

mergetool.<tool>.path

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

mergetool.<tool>.cmd

指定调用指定合并工具的命令。指定的命令将在 shell 中进行评估,并可用以下变量:BASE 是要合并的文件的公共基础的临时文件名(如果可用);LOCAL 是当前分支文件内容的临时文件名;REMOTE 是正在合并的分支的文件内容的临时文件名;MERGED 包含合并工具应将成功合并结果写入的文件名。

mergetool.<tool>.hideResolved

允许用户覆盖特定工具的全局 mergetool.hideResolved 值。有关完整描述,请参阅 mergetool.hideResolved

mergetool.<tool>.trustExitCode

对于自定义合并命令,指定是否可以使用合并命令的退出码来确定合并是否成功。如果未设置为 true,则会检查合并目标文件的修改时间戳,并且假定当文件已更新时合并成功;否则,将提示用户指示合并的成功。

mergetool.meld.hasOutput

旧版本的 meld 不支持 --output 选项。Git 将尝试通过检查 meld --help 的输出来检测 meld 是否支持 --output。配置 mergetool.meld.hasOutput 将使 Git 跳过这些检查并使用配置的值。将 mergetool.meld.hasOutput 设置为 true 会告诉 Git 无条件使用 --output 选项,而 false 则会避免使用 --output

mergetool.meld.useAutoMerge

当给出 --auto-merge 时,meld 将自动合并所有非冲突部分,突出显示冲突部分,并等待用户决定。将 mergetool.meld.useAutoMerge 设置为 true 会告诉 Git 无条件地将 --auto-merge 选项与 meld 一起使用。将此值设置为 auto 会使 git 检测 --auto-merge 是否受支持,并且仅在可用时才使用 --auto-merge。值为 false 则会完全避免使用 --auto-merge,这也是默认值。

mergetool.<variant>.layout

为 vimdiff 的 <variant> 配置分屏布局,<variant> 可以是 vimdiffnvimdiffgvimdiff 中的任何一个。当使用 --tool=<variant> (或者如果 merge.tool 配置为 <variant> 且没有 --tool) 调用 git mergetool 时,Git 将查阅 mergetool.<variant>.layout 来确定工具的布局。如果变体特定的配置不可用,将使用 vimdiff 的作为回退。如果这也不可用,将使用默认的 4 窗口布局。有关如何配置布局,请参阅 *特定后端提示* 部分。

mergetool.hideResolved

在合并过程中,Git 将自动解决尽可能多的冲突,并将包含冲突标记的 $MERGED 文件写入其中,并在任何它无法解决的冲突周围;$LOCAL$REMOTE 通常是 Git 冲突解决之前的文件的版本。此标志会导致 $LOCAL$REMOTE 被覆盖,以便只有未解决的冲突呈现给合并工具。可以通过 mergetool.<tool>.hideResolved 配置变量为每个工具配置。默认为 false

mergetool.keepBackup

执行合并后,原始的带有冲突标记的文件可以保存为扩展名为 .orig 的文件。如果此变量设置为 false,则此文件不会被保留。默认为 true(即保留备份文件)。

mergetool.keepTemporaries

调用自定义合并工具时,Git 使用一组临时文件传递给工具。如果工具返回错误并且此变量设置为 true,则将保留这些临时文件;否则,在工具退出后它们将被删除。默认为 false

mergetool.writeToTemp

默认情况下,Git 在工作树中写入冲突文件的临时 BASELOCALREMOTE 版本。当设置为 true 时,Git 将尝试为这些文件使用临时目录。默认为 false

mergetool.prompt

在每次调用合并分辨率程序之前提示。

mergetool.guiDefault

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

临时文件

git mergetool 在解决合并时会创建 *.orig 备份文件。一旦文件被合并并且其 git mergetool 会话完成,就可以安全地删除这些文件。

mergetool.keepBackup 配置变量设置为 false 会导致 git mergetool 在文件成功合并后自动删除备份文件。

特定后端提示

vimdiff

描述

当在 git mergetool 中指定 --tool=vimdiff 时,Git 将使用 4 窗口布局打开 Vim,布局如下:

------------------------------------------
|             |           |              |
|   LOCAL     |   BASE    |   REMOTE     |
|             |           |              |
------------------------------------------
|                                        |
|                MERGED                  |
|                                        |
------------------------------------------

LOCALBASEREMOTE 是只读缓冲区,显示冲突文件在特定提交中的内容(分别是“你正在合并到的提交”、“共同祖先提交”和“你正在合并的提交”)。

MERGED 是一个可写缓冲区,你必须在那里解决冲突(使用其他只读缓冲区作为参考)。一旦你完成,像往常一样保存并退出 Vim(:wq),或者如果你想中止,请使用 :cq 退出。

布局配置

你可以通过设置配置变量 mergetool.vimdiff.layout 来更改 Vim 使用的窗口布局,该变量接受一个字符串,其中以下分隔符具有特殊含义:

  • + 用于“打开一个新标签页”

  • , 用于“打开一个新垂直分割”

  • / 用于“打开一个新水平分割”

  • @ 用于指示包含解决冲突后最终版本的文件。如果不存在,默认为 MERGED

操作符的优先级如下(你可以使用括号来改变它)

`@` > `+` > `/` > `,`

让我们看一些例子来理解它是如何工作的:

  • layout = "(LOCAL,BASE,REMOTE)/MERGED"

    这与我们已经看到的默认布局完全相同。

    请注意,/ 的优先级高于 ,,因此在这种情况下不需要括号。下一个布局定义是等效的:

    layout = "LOCAL,BASE,REMOTE / MERGED"
  • layout = "LOCAL,MERGED,REMOTE"

    如果我们出于某种原因,对 BASE 缓冲区不感兴趣:

    ------------------------------------------
    |             |           |              |
    |             |           |              |
    |   LOCAL     |   MERGED  |   REMOTE     |
    |             |           |              |
    |             |           |              |
    ------------------------------------------
  • layout = "MERGED"

    只会显示 MERGED 缓冲区。但请注意,所有其他缓冲区仍然加载在 vim 中,你可以使用“buffers”命令访问它们。

    ------------------------------------------
    |                                        |
    |                                        |
    |                 MERGED                 |
    |                                        |
    |                                        |
    ------------------------------------------
  • layout = "@LOCAL,REMOTE"

    当布局中不存在 MERGED 时,你必须用一个 `@` 符号标记一个缓冲区。这将成为你在解决冲突后需要编辑和保存的缓冲区。

    ------------------------------------------
    |                   |                    |
    |                   |                    |
    |                   |                    |
    |     LOCAL         |    REMOTE          |
    |                   |                    |
    |                   |                    |
    |                   |                    |
    ------------------------------------------
  • layout = "LOCAL,BASE,REMOTE / MERGED + BASE,LOCAL + BASE,REMOTE"

    将打开三个标签页:第一个是默认布局的副本,而另外两个仅显示 (BASELOCAL) 以及 (BASEREMOTE) 之间的差异。

    ------------------------------------------
    | <TAB #1> |  TAB #2  |  TAB #3  |       |
    ------------------------------------------
    |             |           |              |
    |   LOCAL     |   BASE    |   REMOTE     |
    |             |           |              |
    ------------------------------------------
    |                                        |
    |                MERGED                  |
    |                                        |
    ------------------------------------------
    ------------------------------------------
    |  TAB #1  | <TAB #2> |  TAB #3  |       |
    ------------------------------------------
    |                   |                    |
    |                   |                    |
    |                   |                    |
    |     BASE          |    LOCAL           |
    |                   |                    |
    |                   |                    |
    |                   |                    |
    ------------------------------------------
    ------------------------------------------
    |  TAB #1  |  TAB #2  | <TAB #3> |       |
    ------------------------------------------
    |                   |                    |
    |                   |                    |
    |                   |                    |
    |     BASE          |    REMOTE          |
    |                   |                    |
    |                   |                    |
    |                   |                    |
    ------------------------------------------
  • layout = "LOCAL,BASE,REMOTE / MERGED + BASE,LOCAL + BASE,REMOTE + (LOCAL/BASE/REMOTE),MERGED"

    与上一个示例相同,但添加了第四个标签页,其中包含与第一个标签页相同的信息,但布局不同。

    ---------------------------------------------
    |  TAB #1  |  TAB #2  |  TAB #3  | <TAB #4> |
    ---------------------------------------------
    |       LOCAL         |                     |
    |---------------------|                     |
    |       BASE          |        MERGED       |
    |---------------------|                     |
    |       REMOTE        |                     |
    ---------------------------------------------

    请注意,在第三个标签页定义中,我们如何需要使用括号来使 , 的优先级高于 /

变体

除了 --tool=vimdiff,你还可以使用以下其他变体:

  • --tool=gvimdiff,用于在 gVim 中打开而不是 Vim。

  • --tool=nvimdiff,用于在 Neovim 中打开而不是 Vim。

使用这些变体时,要指定自定义布局,你必须设置配置变量 mergetool.gvimdiff.layoutmergetool.nvimdiff.layout,而不是 mergetool.vimdiff.layout(尽管如果变体特定的布局不可用,后者将被用作回退)。

此外,为了向后兼容以前的 Git 版本,你还可以将 123 追加到 vimdiff 或任何变体(例如 vimdiff3nvimdiff1 等)以使用预定义的布局。换句话说,使用 --tool=[g|n]vimdiff<x> 等同于使用 --tool=[g|n]vimdiff 并将配置变量 mergetool.[g|n]vimdiff.layout 设置为…​

  • <x>=1: "@LOCAL, REMOTE"

  • <x>=2: "LOCAL, MERGED, REMOTE"

  • <x>=3: "MERGED"

例如:使用 --tool=gvimdiff2 将以三个列(LOCALMERGEDREMOTE)打开 gvim

GIT

Git[1] 套件的一部分