How to use `git mergetool` to resolve conflicts in Vim / NeoVim

Git_mergetool_tutorial_with_Vim.md

Table Of Content

Skip to the relevant sections if needed.

• 2-min tutorial to do it the quick-and-dirty-way
• Concepts for resolving Git conflicts
• Setting up different editors / tool for using git mergetool
  • Finding out what mergetool editors are supported
• mergetool simple code example for vimdiff
  • Resolving conflict from a Git pull
• Other great references and tutorials

Concepts for resolving Git conflicts

For using mergetool in git, we need to understand the following terminology to understand what is being merged:

• LOCAL - the head for the file(s) from the current branch on the machine that you are using.
• REMOTE - the head for files(s) from a remote location that you are trying to merge into your LOCAL branch.
• BASE - the common ancestor(s) of LOCAL and REMOTE.
• MERGED - the tag / HEAD object after the merge - this is saved as a new commit.

Common mergetool from editors will display both LOCAL and REMOTE so you can decide which changes to keep. Please read this tutorial explaining the HEAD objects if you do not know what it is. It will help your understanding of Git tremendously.

Setting up different editors / tool for using git mergetool

We have to change the git config to set a default mergetool. In this example, we will use vimdiff:

$ git config merge.tool vimdiff      

We can also set the editor to display the common ancestor BASE while we examine what changes are in LOCAL and REMOTE with the following setting:

$ git config merge.conflictstyle diff3  

back to top

Finding out what mergetool editors are supported

$ git mergetool --tool-help

And we list a few of them:

Command line mergetool editors

• Emacs based diff tools: emerge, or Ediff
• Vim based diff tool: vimdiff

GUI mergetool editors

• gvimdiff - almost identical to vimdiff but uses the Linux GUI for Vim, please refer to vimdiff if you still use the keyboard commands for GVim.
• kdiff3
• meld
• tortoisemerge

Or consult the community of your favorite editor to see how to do the equivalent operations for your editor.

Other useful mergetool settings

Do not prompt before launching the merge resolution tool

$ git config mergetool.prompt false

back to top

mergetool simple code example

Ref1 for the example
Ref2

creating the git repo

$ mkdir galaxyZoo
$ cd galaxyZoo
$ git init
$ vim astrophy_obj.txt

Add some galaxy types into astrophy_obj.txt then save the file.

# content of astrophy_obj.txt
spiral
elliptical
bar 
irregular

save then commit the file.

$ git add astrophy_obj.txt
$ git commit -m 'Initial commit'
$ git branch astrophy_objects   # create a new branch
$ git checkout astrophy_objects # change to new branch
$ vim astrophy_obj.txt          # make changes to file 

Change bar to barred in the file.

$ git commit -am 'changed bar to barred'
$ git checkout master   # change back to master branch
$ vim astrophy_obj.txt  
# add the word `galaxy` to the end of each line using Vim REGEX 
# type `:%s/$/ galaxy/g` in Vim then press enter and save `:wq`

$ git commit -am 'added galaxy to each line'
# merge from the astrophy_objects branch to current branch, i.e. master
$ git merge astrophy_objects  

Then you will see some error messages:

Auto-merging astrophy_obj.txt
CONFLICT (content): Merge conflict in astrophy_obj.txt
Automatic merge failed; fix conflicts and then commit the result.

We can bring up the mergetool:

$ git mergetool

Then it will bring up the different versions of the file in different Vim splits panels.

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

The top left split panel is the LOCAL, top middle split is BASE and top right split is REMOTE. The bottom split refers to the MERGED version. You can find this info in the bottom bar of each split (I have put 3 yellow rectangles to highlight that info).

As you can see form the below image, my Vim has highlighted the differences in red for me.

Now if your terminal has any GUI capability and you have compiled Vim correctly with GUI support, you can use your mouse to click on the bottom split to edit it. Or if you are a Vim ninja, you can use the keyboard shortcut to move to different splits.

Ctrl w + h   # move to the split on the left 
Ctrl w + j   # move to the split below
Ctrl w + k   # move to the split on top
Ctrl w + l   # move to the split on the right

You can either incorporate the changes by manually editing the MERGED split, or use Vim shortcuts pull from one of the LOCAL, BASE ad REMOTE versions.

:diffg RE  # get from REMOTE
:diffg BA  # get from BASE
:diffg LO  # get from LOCAL

save the changes then quit with :wqa to close all the splits. Remember to commit the merge.

$ git commit -am 'merged from several branches'

Resolving conflict from a git pull

If you were trying to do a git pull when you ran into merge conflicts, follow all steps in the previous section for using the mergetool, then do:

$ git rebase –continue

This command will

Forward-port local commits to the updated upstream HEAD.

according to the documentation, meaning your local commits will be pushed to the upstream remote branch as a new forward commit that doesn't interfere with previous commits. Hooray now you can claim that you can collaborate with others with Git without messing up with your collaborators' commits.

back to top

Other vimdiff keyboard shortcuts

]c - Jump to the next change.
[c - Jump to the previous change.

ref

Other great references and tutorials

• Git mergetool documentation on git-scm.com
• Must-read tutorial: the concepts of branching and merging from Charles Duan
• Improving Vimdiff as a Git mergetool

Update (2020/09/20)

Thanks to @ekalosak's comment, I have fixed a mistake confusing the difference branches.

back to top

This was pretty helpful! Thank you beyond words. ❤️

Thank you so much for this article. I rebase a fork of nixos configuration to upstream rn using your guidance !

Thanks ❤️

Very helpful, thanks!

Just a update, recent versions of Git support "vimdiff" and "nvimdiff" by default, there's no need to create a new entry in the config and specify the cmd. It's also possible to customize the layout. More details can be found here in the doc: https://github.com/git/git/blob/master/Documentation/mergetools/vimdiff.txt

Just a update, recent versions of Git support "vimdiff" and "nvimdiff" by default, there's no need to create a new entry in the config and specify the cmd. It's also possible to customize the layout. More details can be found here in the doc: https://github.com/git/git/blob/master/Documentation/mergetools/vimdiff.txt

Thank you @gmmoreira. TL;DR, the simplest config for using Neovim as the diff and merge tool is:

git config --global diff.tool nvimdiff
git config --global merge.tool nvimdiff

If for some reason the window layout is not the classic one, it can be reconfigured by:

git config --global difftool.nvimdiff.layout "LOCAL,REMOTE"
git config --global mergetool.nvimdiff.layout "LOCAL,BASE,REMOTE / MERGED"

git config --global difftool.nvimdiff.layout "LOCAL,REMOTE"
git config --global mergetool.nvimdiff.layout "LOCAL,BASE,REMOTE / MERGED"

fyi for anyone else who stumbles across this gist, the key for me was that for neovim I could NOT use mergetool.nvimdiff.layout and had to use mergetool.vimdiff.layout instead even though it is using neovim. Then my custom layout would work. Below is my config for diff/merge items in gitconfig that I was able to get working.

[diff]
  tool = nvimdiff
  guitool = nvimdiff
[difftool]
  prompt = false
  guiDefault = false
[merge]
  tool = nvimdiff
  guitool = nvimdiff
[mergetool]
  prompt = false
  guiDefault = false
  keepBackup = false

# NOTE: must set "vimdiff" here and NOT "nvimdiff" for custom layout to work
# But just for this [mergetool "vimdiff"] section.
# The other [merge] and [mergetool] sections above MUST be set to "nvimdiff"
[mergetool "vimdiff"]
  layout = (LOCAL,BASE,REMOTE) / MERGED + (LOCAL,MERGED,REMOTE) + LOCAL,REMOTE + (LOCAL,MERGED) / (REMOTE,MERGED) + (BASE,LOCAL) / (BASE,REMOTE)

To setup local keymappings for nvim

-- Check if diff mode is enabled
if vim.opt.diff:get() then
	-- Define key mappings for diff mode
	vim.api.nvim_set_keymap("n", "<localleader>1", ":diffget LOCAL<CR>", { noremap = true, silent = true })
	vim.api.nvim_set_keymap("n", "<localleader>2", ":diffget BASE<CR>", { noremap = true, silent = true })
	vim.api.nvim_set_keymap("n", "<localleader>3", ":diffget REMOTE<CR>", { noremap = true, silent = true })
end

If you have which-key.nvim, you can also do

vim.api.nvim_create_autocmd("BufEnter", {
	pattern = "*",
	callback = function()
		if vim.opt.diff:get() then
			local wk = require("which-key")
			local opts = {
				mode = "n", -- NORMAL mode
				buffer = vim.api.nvim_get_current_buf(), -- Specify a buffer number for buffer local mappings
			}
			local mappings = {
				["<localleader>"] = {
					["1"] = { ":diffget LOCAL<CR>", "Get LOCAL" },
					["2"] = { ":diffget BASE<CR>", "Get BASE" },
					["3"] = { ":diffget REMOTE<CR>", "Get REMOTE" },
				},
			}

			wk.register(mappings, opts)
		end
	end,
})