Documentation/git-merge-base.txt

   1 git-merge-base(1)
   2 =================
   3
   4 NAME
   5 ----
   6 git-merge-base - Find as good common ancestors as possible for a merge
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git merge-base' [-a|--all] <commit> <commit>...
  13 'git merge-base' [-a|--all] --octopus <commit>...
  14 'git merge-base' --is-ancestor <commit> <commit>
  15 'git merge-base' --independent <commit>...
  16 'git merge-base' --fork-point <ref> [<commit>]
  17
  18 DESCRIPTION
  19 -----------
  20
  21 'git merge-base' finds best common ancestor(s) between two commits to use
  22 in a three-way merge.  One common ancestor is 'better' than another common
  23 ancestor if the latter is an ancestor of the former.  A common ancestor
  24 that does not have any better common ancestor is a 'best common
  25 ancestor', i.e. a 'merge base'.  Note that there can be more than one
  26 merge base for a pair of commits.
  27
  28 OPERATION MODES
  29 ---------------
  30
  31 As the most common special case, specifying only two commits on the
  32 command line means computing the merge base between the given two commits.
  33
  34 More generally, among the two commits to compute the merge base from,
  35 one is specified by the first commit argument on the command line;
  36 the other commit is a (possibly hypothetical) commit that is a merge
  37 across all the remaining commits on the command line.
  38
  39 As a consequence, the 'merge base' is not necessarily contained in each of the
  40 commit arguments if more than two commits are specified. This is different
  41 from linkgit:git-show-branch[1] when used with the `--merge-base` option.
  42
  43 --octopus::
  44         Compute the best common ancestors of all supplied commits,
  45         in preparation for an n-way merge.  This mimics the behavior
  46         of 'git show-branch --merge-base'.
  47
  48 --independent::
  49         Instead of printing merge bases, print a minimal subset of
  50         the supplied commits with the same ancestors.  In other words,
  51         among the commits given, list those which cannot be reached
  52         from any other.  This mimics the behavior of 'git show-branch
  53         --independent'.
  54
  55 --is-ancestor::
  56         Check if the first <commit> is an ancestor of the second <commit>,
  57         and exit with status 0 if true, or with status 1 if not.
  58         Errors are signaled by a non-zero status that is not 1.
  59
  60 --fork-point::
  61         Find the point at which a branch (or any history that leads
  62         to <commit>) forked from another branch (or any reference)
  63         <ref>. This does not just look for the common ancestor of
  64         the two commits, but also takes into account the reflog of
  65         <ref> to see if the history leading to <commit> forked from
  66         an earlier incarnation of the branch <ref> (see discussion
  67         on this mode below).
  68
  69 OPTIONS
  70 -------
  71 -a::
  72 --all::
  73         Output all merge bases for the commits, instead of just one.
  74
  75 DISCUSSION
  76 ----------
  77
  78 Given two commits 'A' and 'B', `git merge-base A B` will output a commit
  79 which is reachable from both 'A' and 'B' through the parent relationship.
  80
  81 For example, with this topology:
  82
  83                  o---o---o---B
  84                 /
  85         ---o---1---o---o---o---A
  86
  87 the merge base between 'A' and 'B' is '1'.
  88
  89 Given three commits 'A', 'B' and 'C', `git merge-base A B C` will compute the
  90 merge base between 'A' and a hypothetical commit 'M', which is a merge
  91 between 'B' and 'C'.  For example, with this topology:
  92
  93                o---o---o---o---C
  94               /
  95              /   o---o---o---B
  96             /   /
  97         ---2---1---o---o---o---A
  98
  99 the result of `git merge-base A B C` is '1'.  This is because the
 100 equivalent topology with a merge commit 'M' between 'B' and 'C' is:
 101
 102
 103                o---o---o---o---o
 104               /                 \
 105              /   o---o---o---o---M
 106             /   /
 107         ---2---1---o---o---o---A
 108
 109 and the result of `git merge-base A M` is '1'.  Commit '2' is also a
 110 common ancestor between 'A' and 'M', but '1' is a better common ancestor,
 111 because '2' is an ancestor of '1'.  Hence, '2' is not a merge base.
 112
 113 The result of `git merge-base --octopus A B C` is '2', because '2' is
 114 the best common ancestor of all commits.
 115
 116 When the history involves criss-cross merges, there can be more than one
 117 'best' common ancestor for two commits.  For example, with this topology:
 118
 119         ---1---o---A
 120             \ /
 121              X
 122             / \
 123         ---2---o---o---B
 124
 125 both '1' and '2' are merge-bases of A and B.  Neither one is better than
 126 the other (both are 'best' merge bases).  When the `--all` option is not given,
 127 it is unspecified which best one is output.
 128
 129 A common idiom to check "fast-forward-ness" between two commits A
 130 and B is (or at least used to be) to compute the merge base between
 131 A and B, and check if it is the same as A, in which case, A is an
 132 ancestor of B.  You will see this idiom used often in older scripts.
 133
 134         A=$(git rev-parse --verify A)
 135         if test "$A" = "$(git merge-base A B)"
 136         then
 137                 ... A is an ancestor of B ...
 138         fi
 139
 140 In modern git, you can say this in a more direct way:
 141
 142         if git merge-base --is-ancestor A B
 143         then
 144                 ... A is an ancestor of B ...
 145         fi
 146
 147 instead.
 148
 149 Discussion on fork-point mode
 150 -----------------------------
 151
 152 After working on the `topic` branch created with `git checkout -b
 153 topic origin/master`, the history of remote-tracking branch
 154 `origin/master` may have been rewound and rebuilt, leading to a
 155 history of this shape:
 156
 157                          o---B2
 158                         /
 159         ---o---o---B1--o---o---o---B (origin/master)
 160                 \
 161                  B0
 162                   \
 163                    D0---D1---D (topic)
 164
 165 where `origin/master` used to point at commits B0, B1, B2 and now it
 166 points at B, and your `topic` branch was started on top of it back
 167 when `origin/master` was at B0, and you built three commits, D0, D1,
 168 and D, on top of it.  Imagine that you now want to rebase the work
 169 you did on the topic on top of the updated origin/master.
 170
 171 In such a case, `git merge-base origin/master topic` would return the
 172 parent of B0 in the above picture, but B0^..D is *not* the range of
 173 commits you would want to replay on top of B (it includes B0, which
 174 is not what you wrote; it is a commit the other side discarded when
 175 it moved its tip from B0 to B1).
 176
 177 `git merge-base --fork-point origin/master topic` is designed to
 178 help in such a case.  It takes not only B but also B0, B1, and B2
 179 (i.e. old tips of the remote-tracking branches your repository's
 180 reflog knows about) into account to see on which commit your topic
 181 branch was built and finds B0, allowing you to replay only the
 182 commits on your topic, excluding the commits the other side later
 183 discarded.
 184
 185 Hence
 186
 187     $ fork_point=$(git merge-base --fork-point origin/master topic)
 188
 189 will find B0, and
 190
 191     $ git rebase --onto origin/master $fork_point topic
 192
 193 will replay D0, D1 and D on top of B to create a new history of this
 194 shape:
 195
 196                          o---B2
 197                         /
 198         ---o---o---B1--o---o---o---B (origin/master)
 199                 \                   \
 200                  B0                  D0'--D1'--D' (topic - updated)
 201                   \
 202                    D0---D1---D (topic - old)
 203
 204 A caveat is that older reflog entries in your repository may be
 205 expired by `git gc`.  If B0 no longer appears in the reflog of the
 206 remote-tracking branch `origin/master`, the `--fork-point` mode
 207 obviously cannot find it and fails, avoiding to give a random and
 208 useless result (such as the parent of B0, like the same command
 209 without the `--fork-point` option gives).
 210
 211 Also, the remote-tracking branch you use the `--fork-point` mode
 212 with must be the one your topic forked from its tip.  If you forked
 213 from an older commit than the tip, this mode would not find the fork
 214 point (imagine in the above sample history B0 did not exist,
 215 origin/master started at B1, moved to B2 and then B, and you forked
 216 your topic at origin/master^ when origin/master was B1; the shape of
 217 the history would be the same as above, without B0, and the parent
 218 of B1 is what `git merge-base origin/master topic` correctly finds,
 219 but the `--fork-point` mode will not, because it is not one of the
 220 commits that used to be at the tip of origin/master).
 221
 222
 223 See also
 224 --------
 225 linkgit:git-rev-list[1],
 226 linkgit:git-show-branch[1],
 227 linkgit:git-merge[1]
 228
 229 GIT
 230 ---
 231 Part of the linkgit:git[1] suite