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 'git merge-base' [-a|--all] <commit> <commit>...
  12
  13 DESCRIPTION
  14 -----------
  15
  16 'git merge-base' finds best common ancestor(s) between two commits to use
  17 in a three-way merge.  One common ancestor is 'better' than another common
  18 ancestor if the latter is an ancestor of the former.  A common ancestor
  19 that does not have any better common ancestor is a 'best common
  20 ancestor', i.e. a 'merge base'.  Note that there can be more than one
  21 merge base for a pair of commits.
  22
  23 Among the two commits to compute the merge base from, one is specified by
  24 the first commit argument on the command line; the other commit is a
  25 (possibly hypothetical) commit that is a merge across all the remaining
  26 commits on the command line.  As the most common special case, specifying only
  27 two commits on the command line means computing the merge base between
  28 the given two commits.
  29
  30 OPTIONS
  31 -------
  32 -a::
  33 --all::
  34         Output all merge bases for the commits, instead of just one.
  35
  36 DISCUSSION
  37 ----------
  38
  39 Given two commits 'A' and 'B', `git merge-base A B` will output a commit
  40 which is reachable from both 'A' and 'B' through the parent relationship.
  41
  42 For example, with this topology:
  43
  44                  o---o---o---B
  45                 /
  46         ---o---1---o---o---o---A
  47
  48 the merge base between 'A' and 'B' is '1'.
  49
  50 Given three commits 'A', 'B' and 'C', `git merge-base A B C` will compute the
  51 merge base between 'A' and a hypothetical commit 'M', which is a merge
  52 between 'B' and 'C'.  For example, with this topology:
  53
  54                o---o---o---o---C
  55               /
  56              /   o---o---o---B
  57             /   /
  58         ---2---1---o---o---o---A
  59
  60 the result of `git merge-base A B C` is '1'.  This is because the
  61 equivalent topology with a merge commit 'M' between 'B' and 'C' is:
  62
  63
  64                o---o---o---o---o
  65               /                 \
  66              /   o---o---o---o---M
  67             /   /
  68         ---2---1---o---o---o---A
  69
  70 and the result of `git merge-base A M` is '1'.  Commit '2' is also a
  71 common ancestor between 'A' and 'M', but '1' is a better common ancestor,
  72 because '2' is an ancestor of '1'.  Hence, '2' is not a merge base.
  73
  74 When the history involves criss-cross merges, there can be more than one
  75 'best' common ancestor for two commits.  For example, with this topology:
  76
  77        ---1---o---A
  78            \ /
  79             X
  80            / \
  81        ---2---o---o---B
  82
  83 both '1' and '2' are merge-bases of A and B.  Neither one is better than
  84 the other (both are 'best' merge bases).  When the `--all` option is not given,
  85 it is unspecified which best one is output.
  86
  87 Author
  88 ------
  89 Written by Linus Torvalds <torvalds@osdl.org>
  90
  91 Documentation
  92 --------------
  93 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  94
  95 GIT
  96 ---
  97 Part of the linkgit:git[1] suite