I want to know an exact algorithm (or near that) behind \'git merge\'. The answers at least to these sub-questions will be helpful:
I'm interested too. I don't know the answer, but...
A complex system that works is invariably found to have evolved from a simple system that worked
I think git's merging is highly sophisticated and will be very difficult to understand - but one way to approach this is from its precursors, and to focus on the heart of your concern. That is, given two files that don't have a common ancestor, how does git merge work out how to merge them, and where conflicts are?
Let's try to find some precursors. From git help merge-file
:
git merge-file is designed to be a minimal clone of RCS merge; that is,
it implements all of RCS merge's functionality which is needed by
git(1).
From wikipedia: http://en.wikipedia.org/wiki/Git_%28software%29 -> http://en.wikipedia.org/wiki/Three-way_merge#Three-way_merge -> http://en.wikipedia.org/wiki/Diff3 -> http://www.cis.upenn.edu/~bcpierce/papers/diff3-short.pdf
That last link is a pdf of a paper describing the diff3
algorithm in detail. Here's a google pdf-viewer version. It's only 12 pages long, and the algorithm is only a couple of pages - but a full-on mathematical treatment. That might seem a bit too formal, but if you want to understand git's merge, you'll need to understand the simpler version first. I haven't checked yet, but with a name like diff3
, you'll probably also need to understand diff (which uses a longest common subsequence algorithm). However, there may be a more intuitive explanation of diff3
out there, if you have a google...
Now, I just did an experiment comparing diff3
and git merge-file
. They take the same three input files version1 oldversion version2 and mark conflicts the way same, with <<<<<<< version1
, =======
, >>>>>>> version2
(diff3
also has ||||||| oldversion
), showing their common heritage.
I used an empty file for oldversion, and near-identical files for version1 and version2 with just one extra line added to version2.
Result: git merge-file
identified the single changed line as the conflict; but diff3
treated the whole two files as a conflict. Thus, sophisticated as diff3 is, git's merge is even more sophisticated, even for this simplest of cases.
Here's the actual results (I used @twalberg's answer for the text). Note the options needed (see respective manpages).
$ git merge-file -p fun1.txt fun0.txt fun2.txt
You might be best off looking for a description of a 3-way merge algorithm. A
high-level description would go something like this:
Find a suitable merge base B - a version of the file that is an ancestor of
both of the new versions (X and Y), and usually the most recent such base
(although there are cases where it will have to go back further, which is one
of the features of gits default recursive merge) Perform diffs of X with B and
Y with B. Walk through the change blocks identified in the two diffs. If both
sides introduce the same change in the same spot, accept either one; if one
introduces a change and the other leaves that region alone, introduce the
change in the final; if both introduce changes in a spot, but they don't match,
mark a conflict to be resolved manually.
<<<<<<< fun1.txt
=======
THIS IS A BIT DIFFERENT
>>>>>>> fun2.txt
The full algorithm deals with this in a lot more detail, and even has some
documentation (/usr/share/doc/git-doc/technical/trivial-merge.txt for one,
along with the git help XXX pages, where XXX is one of merge-base, merge-file,
merge, merge-one-file and possibly a few others). If that's not deep enough,
there's always source code...
$ diff3 -m fun1.txt fun0.txt fun2.txt
<<<<<<< fun1.txt
You might be best off looking for a description of a 3-way merge algorithm. A
high-level description would go something like this:
Find a suitable merge base B - a version of the file that is an ancestor of
both of the new versions (X and Y), and usually the most recent such base
(although there are cases where it will have to go back further, which is one
of the features of gits default recursive merge) Perform diffs of X with B and
Y with B. Walk through the change blocks identified in the two diffs. If both
sides introduce the same change in the same spot, accept either one; if one
introduces a change and the other leaves that region alone, introduce the
change in the final; if both introduce changes in a spot, but they don't match,
mark a conflict to be resolved manually.
The full algorithm deals with this in a lot more detail, and even has some
documentation (/usr/share/doc/git-doc/technical/trivial-merge.txt for one,
along with the git help XXX pages, where XXX is one of merge-base, merge-file,
merge, merge-one-file and possibly a few others). If that's not deep enough,
there's always source code...
||||||| fun0.txt
=======
You might be best off looking for a description of a 3-way merge algorithm. A
high-level description would go something like this:
Find a suitable merge base B - a version of the file that is an ancestor of
both of the new versions (X and Y), and usually the most recent such base
(although there are cases where it will have to go back further, which is one
of the features of gits default recursive merge) Perform diffs of X with B and
Y with B. Walk through the change blocks identified in the two diffs. If both
sides introduce the same change in the same spot, accept either one; if one
introduces a change and the other leaves that region alone, introduce the
change in the final; if both introduce changes in a spot, but they don't match,
mark a conflict to be resolved manually.
THIS IS A BIT DIFFERENT
The full algorithm deals with this in a lot more detail, and even has some
documentation (/usr/share/doc/git-doc/technical/trivial-merge.txt for one,
along with the git help XXX pages, where XXX is one of merge-base, merge-file,
merge, merge-one-file and possibly a few others). If that's not deep enough,
there's always source code...
>>>>>>> fun2.txt
If you are truly interested in this, it's a bit of a rabbit hole. To me, it seems as deep as regular expressions, the longest common subsequence algorithm of diff, context free grammars, or relational algebra. If you want to get to the bottom of it, I think you can, but it will take some determined study.
How does git detect the context of a particular non-conflicting change?
How does git find out that there is a conflict in these exact lines?
If the same line has changed on both side of the merge, it's a conflict; if they haven't, the change from one side (if existent) is accepted.
Which things does git auto-merge?
Changes that do not conflict (see above)
How does git perform when there are multiple common bases for merging branches?
By the definition of a Git merge-base, there is only ever one (the latest common ancestor).
What happens when I merge multiple branches at once?
That depends on the merge strategy (only the octopus
and the ours
/theirs
strategies support merging more than two branches).
What is a difference between merge strategies?
This is explained in the git merge manpage.
Here is the original implementation
http://git.kaarsemaker.net/git/blob/857f26d2f41e16170e48076758d974820af685ff/git-merge-recursive.py
Basically you create a list of common ancestors for two commits and then recursively merge them, either fast forwarding them, or creating virtual commits that get used for the basis of a three-way merge on the files.
How does git perform when there are multiple common bases for merging branches?
This article was very helpful: http://codicesoftware.blogspot.com/2011/09/merge-recursive-strategy.html (here is part 2).
Recursive uses diff3 recursively to generate a virtual branch which will be used as the ancestor.
E.g.:
(A)----(B)----(C)-----(F)
| | |
| | +---+
| | |
| +-------+
| | |
| +---+ |
| | |
+-----(D)-----(E)
Then:
git checkout E
git merge F
There are 2 best common ancestors (common ancestors that are not ancestors of any other), C
and D
. Git merges them into a new virtual branch V
, and then uses V
as the base.
(A)----(B)----(C)--------(F)
| | |
| | +---+
| | |
| +----------+
| | | |
| +--(V) | |
| | | |
| +---+ | |
| | | |
| +------+ |
| | |
+-----(D)--------(E)
I suppose Git would just continue with the if there were more best common ancestors, merging V
with the next one.
The article says that if there is a merge conflict while generating the virtual branch Git just leaves the conflict markers where they are and continues.
What happens when I merge multiple branches at once?
As @Nevik Rehnel explained, it depends on the strategy, it is well explained on man git-merge
MERGE STRATEGIES
section.
Only octopus
and ours
/ theirs
support merging multiple branches at once, recursive
for example does not.
octopus
refuses to merge if there would be conflicts, and ours
is a trivial merge so there can be no conflicts.
Those commands generate a new commit will have more than 2 parents.
I did one merge -X octopus
on Git 1.8.5 without conflicts to see how it goes.
Initial state:
+--B
|
A--+--C
|
+--D
Action:
git checkout B
git merge -Xoctopus C D
New state:
+--B--+
| |
A--+--C--+--E
| |
+--D--+
As expected, E
has 3 parents.
TODO: how exactly octopus operates on a single file modifications. Recursive two-by-two 3-way merges?
How does git perform when there is no common base for merging branches?
@Torek mentions that since 2.9, merge fails without --allow-unrelated-histories
.
I tried it out empirically on on Git 1.8.5:
git init
printf 'a\nc\n' > a
git add .
git commit -m a
git checkout --orphan b
printf 'a\nb\nc\n' > a
git add .
git commit -m b
git merge master
a
contains:
a
<<<<<<< ours
b
=======
>>>>>>> theirs
c
Then:
git checkout --conflict=diff3 -- .
a
contains:
<<<<<<< ours
a
b
c
||||||| base
=======
a
c
>>>>>>> theirs
Interpretation:
a\nc\n
as a single line additionYou might be best off looking for a description of a 3-way merge algorithm. A high-level description would go something like this:
B
- a version of the file that is an ancestor of both of the new versions (X
and Y
), and usually the most recent such base (although there are cases where it will have to go back further, which is one of the features of git
s default recursive
merge)X
with B
and Y
with B
.The full algorithm deals with this in a lot more detail, and even has some documentation (https://github.com/git/git/blob/master/Documentation/technical/trivial-merge.txt for one, along with the git help XXX
pages, where XXX is one of merge-base
, merge-file
, merge
, merge-one-file
and possibly a few others). If that's not deep enough, there's always source code...