Skip to content

Commit

Permalink
mergetools: vimdiff: use correct tool's name when reading mergetool c…
Browse files Browse the repository at this point in the history
…onfig

The /mergetools/vimdiff script, which handles both vimdiff, nvimdiff
and gvimdiff mergetools (the latter 2 simply source the vimdiff script), has a
function merge_cmd() which read the layout variable from git config, and it
would always read the value of mergetool.**vimdiff**.layout, instead of the
mergetool being currently used (vimdiff or nvimdiff or gvimdiff).

It looks like in 7b5cf8b (vimdiff: add tool documentation, 2022-03-30),
we explained the current behavior in Documentation/config/mergetool.txt:

```
mergetool.vimdiff.layout::
	The vimdiff backend uses this variable to control how its split
	windows look like. Applies even if you are using Neovim (`nvim`) or
	gVim (`gvim`) as the merge tool. See BACKEND SPECIFIC HINTS section
```

which makes sense why it's explained this way - the vimdiff backend is used by
gvim and nvim. But the mergetool's configuration should be separate for each tool,
and indeed that's confirmed in same commit at Documentation/mergetools/vimdiff.txt:

```
Variants

Instead of `--tool=vimdiff`, you can also use one of these other variants:
  * `--tool=gvimdiff`, to open gVim instead of Vim.
  * `--tool=nvimdiff`, to open Neovim instead of Vim.

When using these variants, in order to specify a custom layout you will have to
set configuration variables `mergetool.gvimdiff.layout` and
`mergetool.nvimdiff.layout` instead of `mergetool.vimdiff.layout`
```

So it looks like we just forgot to update the 1 part of the vimdiff script
that read the config variable. Cheers.

Though, for backward compatibility, I've kept the mergetool.vimdiff
fallback, so that people who unknowingly relied on it, won't have their
setup broken now.

Signed-off-by: Kipras Melnikovas <[email protected]>
Signed-off-by: Junio C Hamano <[email protected]>
  • Loading branch information
kiprasmel authored and gitster committed Feb 19, 2024
1 parent 96c8a07 commit b21d164
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 9 deletions.
19 changes: 13 additions & 6 deletions Documentation/config/mergetool.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,21 @@ mergetool.meld.useAutoMerge::
value of `false` avoids using `--auto-merge` altogether, and is the
default value.

mergetool.vimdiff.layout::
The vimdiff backend uses this variable to control how its split
windows appear. Applies even if you are using Neovim (`nvim`) or
gVim (`gvim`) as the merge tool. See BACKEND SPECIFIC HINTS section
mergetool.<vimdiff variant>.layout::
Configure the split window layout for vimdiff's `<variant>`, which is any of `vimdiff`,
`nvimdiff`, `gvimdiff`.
Upon launching `git mergetool` with `--tool=<variant>` (or without `--tool`
if `merge.tool` is configured as `<variant>`), Git will consult
`mergetool.<variant>.layout` to determine the tool's layout. If the
variant-specific configuration is not available, `vimdiff`'s is used as
fallback. If that too is not available, a default layout with 4 windows
will be used. To configure the layout, see the `BACKEND SPECIFIC HINTS`
ifdef::git-mergetool[]
section.
endif::[]
ifndef::git-mergetool[]
in linkgit:git-mergetool[1].
section in linkgit:git-mergetool[1].
endif::[]
for details.

mergetool.hideResolved::
During a merge, Git will automatically resolve as many conflicts as
Expand Down
3 changes: 2 additions & 1 deletion Documentation/mergetools/vimdiff.txt
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,8 @@ Instead of `--tool=vimdiff`, you can also use one of these other variants:

When using these variants, in order to specify a custom layout you will have to
set configuration variables `mergetool.gvimdiff.layout` and
`mergetool.nvimdiff.layout` instead of `mergetool.vimdiff.layout`
`mergetool.nvimdiff.layout` instead of `mergetool.vimdiff.layout` (though the
latter will be used as fallback if the variant-specific one is not set).

In addition, for backwards compatibility with previous Git versions, you can
also append `1`, `2` or `3` to either `vimdiff` or any of the variants (ex:
Expand Down
12 changes: 10 additions & 2 deletions mergetools/vimdiff
Original file line number Diff line number Diff line change
Expand Up @@ -371,9 +371,17 @@ diff_cmd_help () {


merge_cmd () {
layout=$(git config mergetool.vimdiff.layout)
TOOL=$1

case "$1" in
layout=$(git config "mergetool.$TOOL.layout")

# backward compatibility:
if test -z "$layout"
then
layout=$(git config mergetool.vimdiff.layout)
fi

case "$TOOL" in
*vimdiff)
if test -z "$layout"
then
Expand Down

0 comments on commit b21d164

Please sign in to comment.