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 7b5cf8be18 (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 <kipras@xxxxxxxxxx>
---
Here's some variants I considered for mergetool.<vimdiff variant>.layout
in Documentation/config/mergetool.txt, but discarded for a shorter
version. Feel free to pick & edit the final.
a)
The `<vimdiff variant>` is any of `vimdiff`, `nvimdiff`, `gvimdiff`. When
you run `git mergetool` with `--tool=<vimdiff variant>`, Git will consult
`mergetool.<vimdiff variant>.layout` to determine the tool's layout. If it's
not specified, `vimdiff`'s is used as fallback. If that too is not available,
a default layout with 4 windows is used. See BACKEND SPECIFIC HINTS section
ifndef::git-mergetool[]
in linkgit:git-mergetool[1]
endif::[]
for details.
b)
Configure a custom layout for your mergetool. The `<variant>` 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.<vimdiff variant>.layout` to determine the tool's
layout. If the variant-specific config is not available, `vimdiff`'s is
used as fallback. If that too is not available, a default layout with 4
windows will be used. See BACKEND SPECIFIC HINTS section
ifndef::git-mergetool[]
in linkgit:git-mergetool[1]
endif::[]
for details.
The ifdef + ifndef is used to avoid an extra space before the final "."
Range-diff against v2:
1: 070280d95d ! 1: 60be87c3d5 mergetools: vimdiff: use correct tool's name when reading mergetool config
@@ Documentation/config/mergetool.txt: mergetool.meld.useAutoMerge::
- 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.{g,n,}vimdiff.layout::
-+ The vimdiff backend uses this variable to control how its split windows
-+ appear. Use `mergetool.vimdiff` for regular Vim, `mergetool.nvimdiff` for
-+ Neovim and `mergetool.gvimdiff` for gVim to configure the merge tool. See
-+ BACKEND SPECIFIC HINTS section
- ifndef::git-mergetool[]
- in linkgit:git-mergetool[1].
+-ifndef::git-mergetool[]
+- in linkgit:git-mergetool[1].
++mergetool.<vimdiff variant>.layout::
++ Git's vimdiff backend uses this variable to control how the split windows of
++ `<vimdiff variant>` appear. Here `<vimdiff variant>` is any of `vimdiff`,
++ `nvimdiff`, `gvimdiff`. To configure the layout and use the tool, see the
++ `BACKEND SPECIFIC HINTS`
++ifdef::git-mergetool[]
++ section.
++endif::[]
++ifndef::git-mergetool[]
++ section in linkgit:git-mergetool[1].
endif::[]
+- for details.
+
+ mergetool.hideResolved::
+ During a merge, Git will automatically resolve as many conflicts as
## mergetools/vimdiff ##
@@ mergetools/vimdiff: diff_cmd_help () {
@@ mergetools/vimdiff: diff_cmd_help () {
+ TOOL=$1
- case "$1" in
-+ layout=$(git config mergetool.$TOOL.layout)
++ layout=$(git config "mergetool.$TOOL.layout")
+
-+ # backwards-compatibility:
++ # backward compatibility:
+ if test -z "$layout"
+ then
+ layout=$(git config mergetool.vimdiff.layout)
Documentation/config/mergetool.txt | 17 ++++++++++-------
mergetools/vimdiff | 12 ++++++++++--
2 files changed, 20 insertions(+), 9 deletions(-)
diff --git a/Documentation/config/mergetool.txt b/Documentation/config/mergetool.txt
index 294f61efd1..f79c798b74 100644
--- a/Documentation/config/mergetool.txt
+++ b/Documentation/config/mergetool.txt
@@ -45,14 +45,17 @@ 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
-ifndef::git-mergetool[]
- in linkgit:git-mergetool[1].
+mergetool.<vimdiff variant>.layout::
+ Git's vimdiff backend uses this variable to control how the split windows of
+ `<vimdiff variant>` appear. Here `<vimdiff variant>` is any of `vimdiff`,
+ `nvimdiff`, `gvimdiff`. To configure the layout and use the tool, see the
+ `BACKEND SPECIFIC HINTS`
+ifdef::git-mergetool[]
+ section.
+endif::[]
+ifndef::git-mergetool[]
+ section in linkgit:git-mergetool[1].
endif::[]
- for details.
mergetool.hideResolved::
During a merge, Git will automatically resolve as many conflicts as
diff --git a/mergetools/vimdiff b/mergetools/vimdiff
index 06937acbf5..97e376329b 100644
--- a/mergetools/vimdiff
+++ b/mergetools/vimdiff
@@ -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
base-commit: 3e0d3cd5c7def4808247caf168e17f2bbf47892b
--
2.43.1
