Autogenerated HTML docs for v2.45.1-204-gd8ab1
[git-htmldocs.git] / git-merge-base.html
blobe86337efa9d79da514fd86798cee213239a2fe5a
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>git-merge-base(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-merge-base(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-merge-base -
743 Find as good common ancestors as possible for a merge
744 </p>
745 </div>
746 </div>
747 <div id="content">
748 <div class="sect1">
749 <h2 id="_synopsis">SYNOPSIS</h2>
750 <div class="sectionbody">
751 <div class="verseblock">
752 <pre class="content"><em>git merge-base</em> [-a | --all] &lt;commit&gt; &lt;commit&gt;&#8230;
753 <em>git merge-base</em> [-a | --all] --octopus &lt;commit&gt;&#8230;
754 <em>git merge-base</em> --is-ancestor &lt;commit&gt; &lt;commit&gt;
755 <em>git merge-base</em> --independent &lt;commit&gt;&#8230;
756 <em>git merge-base</em> --fork-point &lt;ref&gt; [&lt;commit&gt;]</pre>
757 <div class="attribution">
758 </div></div>
759 </div>
760 </div>
761 <div class="sect1">
762 <h2 id="_description">DESCRIPTION</h2>
763 <div class="sectionbody">
764 <div class="paragraph"><p><em>git merge-base</em> finds the best common ancestor(s) between two commits to use
765 in a three-way merge. One common ancestor is <em>better</em> than another common
766 ancestor if the latter is an ancestor of the former. A common ancestor
767 that does not have any better common ancestor is a <em>best common
768 ancestor</em>, i.e. a <em>merge base</em>. Note that there can be more than one
769 merge base for a pair of commits.</p></div>
770 </div>
771 </div>
772 <div class="sect1">
773 <h2 id="_operation_modes">OPERATION MODES</h2>
774 <div class="sectionbody">
775 <div class="paragraph"><p>In the most common special case, specifying only two commits on the
776 command line means computing the merge base between the given two commits.</p></div>
777 <div class="paragraph"><p>More generally, among the two commits to compute the merge base from,
778 one is specified by the first commit argument on the command line;
779 the other commit is a (possibly hypothetical) commit that is a merge
780 across all the remaining commits on the command line.</p></div>
781 <div class="paragraph"><p>As a consequence, the <em>merge base</em> is not necessarily contained in each of the
782 commit arguments if more than two commits are specified. This is different
783 from <a href="git-show-branch.html">git-show-branch(1)</a> when used with the <code>--merge-base</code> option.</p></div>
784 <div class="dlist"><dl>
785 <dt class="hdlist1">
786 --octopus
787 </dt>
788 <dd>
790 Compute the best common ancestors of all supplied commits,
791 in preparation for an n-way merge. This mimics the behavior
792 of <em>git show-branch --merge-base</em>.
793 </p>
794 </dd>
795 <dt class="hdlist1">
796 --independent
797 </dt>
798 <dd>
800 Instead of printing merge bases, print a minimal subset of
801 the supplied commits with the same ancestors. In other words,
802 among the commits given, list those which cannot be reached
803 from any other. This mimics the behavior of <em>git show-branch
804 --independent</em>.
805 </p>
806 </dd>
807 <dt class="hdlist1">
808 --is-ancestor
809 </dt>
810 <dd>
812 Check if the first &lt;commit&gt; is an ancestor of the second &lt;commit&gt;,
813 and exit with status 0 if true, or with status 1 if not.
814 Errors are signaled by a non-zero status that is not 1.
815 </p>
816 </dd>
817 <dt class="hdlist1">
818 --fork-point
819 </dt>
820 <dd>
822 Find the point at which a branch (or any history that leads
823 to &lt;commit&gt;) forked from another branch (or any reference)
824 &lt;ref&gt;. This does not just look for the common ancestor of
825 the two commits, but also takes into account the reflog of
826 &lt;ref&gt; to see if the history leading to &lt;commit&gt; forked from
827 an earlier incarnation of the branch &lt;ref&gt; (see discussion
828 of this mode below).
829 </p>
830 </dd>
831 </dl></div>
832 </div>
833 </div>
834 <div class="sect1">
835 <h2 id="_options">OPTIONS</h2>
836 <div class="sectionbody">
837 <div class="dlist"><dl>
838 <dt class="hdlist1">
840 </dt>
841 <dt class="hdlist1">
842 --all
843 </dt>
844 <dd>
846 Output all merge bases for the commits, instead of just one.
847 </p>
848 </dd>
849 </dl></div>
850 </div>
851 </div>
852 <div class="sect1">
853 <h2 id="_discussion">DISCUSSION</h2>
854 <div class="sectionbody">
855 <div class="paragraph"><p>Given two commits <em>A</em> and <em>B</em>, <code>git merge-base A B</code> will output a commit
856 which is reachable from both <em>A</em> and <em>B</em> through the parent relationship.</p></div>
857 <div class="paragraph"><p>For example, with this topology:</p></div>
858 <div class="literalblock">
859 <div class="content">
860 <pre><code> o---o---o---B
862 ---o---1---o---o---o---A</code></pre>
863 </div></div>
864 <div class="paragraph"><p>the merge base between <em>A</em> and <em>B</em> is <em>1</em>.</p></div>
865 <div class="paragraph"><p>Given three commits <em>A</em>, <em>B</em>, and <em>C</em>, <code>git merge-base A B C</code> will compute the
866 merge base between <em>A</em> and a hypothetical commit <em>M</em>, which is a merge
867 between <em>B</em> and <em>C</em>. For example, with this topology:</p></div>
868 <div class="literalblock">
869 <div class="content">
870 <pre><code> o---o---o---o---C
872 / o---o---o---B
874 ---2---1---o---o---o---A</code></pre>
875 </div></div>
876 <div class="paragraph"><p>the result of <code>git merge-base A B C</code> is <em>1</em>. This is because the
877 equivalent topology with a merge commit <em>M</em> between <em>B</em> and <em>C</em> is:</p></div>
878 <div class="literalblock">
879 <div class="content">
880 <pre><code> o---o---o---o---o
882 / o---o---o---o---M
884 ---2---1---o---o---o---A</code></pre>
885 </div></div>
886 <div class="paragraph"><p>and the result of <code>git merge-base A M</code> is <em>1</em>. Commit <em>2</em> is also a
887 common ancestor between <em>A</em> and <em>M</em>, but <em>1</em> is a better common ancestor,
888 because <em>2</em> is an ancestor of <em>1</em>. Hence, <em>2</em> is not a merge base.</p></div>
889 <div class="paragraph"><p>The result of <code>git merge-base --octopus A B C</code> is <em>2</em>, because <em>2</em> is
890 the best common ancestor of all commits.</p></div>
891 <div class="paragraph"><p>When the history involves criss-cross merges, there can be more than one
892 <em>best</em> common ancestor for two commits. For example, with this topology:</p></div>
893 <div class="literalblock">
894 <div class="content">
895 <pre><code>---1---o---A
899 ---2---o---o---B</code></pre>
900 </div></div>
901 <div class="paragraph"><p>both <em>1</em> and <em>2</em> are merge bases of A and B. Neither one is better than
902 the other (both are <em>best</em> merge bases). When the <code>--all</code> option is not given,
903 it is unspecified which best one is output.</p></div>
904 <div class="paragraph"><p>A common idiom to check "fast-forward-ness" between two commits A
905 and B is (or at least used to be) to compute the merge base between
906 A and B, and check if it is the same as A, in which case, A is an
907 ancestor of B. You will see this idiom used often in older scripts.</p></div>
908 <div class="literalblock">
909 <div class="content">
910 <pre><code>A=$(git rev-parse --verify A)
911 if test "$A" = "$(git merge-base A B)"
912 then
913 ... A is an ancestor of B ...
914 fi</code></pre>
915 </div></div>
916 <div class="paragraph"><p>In modern git, you can say this in a more direct way:</p></div>
917 <div class="literalblock">
918 <div class="content">
919 <pre><code>if git merge-base --is-ancestor A B
920 then
921 ... A is an ancestor of B ...
922 fi</code></pre>
923 </div></div>
924 <div class="paragraph"><p>instead.</p></div>
925 </div>
926 </div>
927 <div class="sect1">
928 <h2 id="_discussion_on_fork_point_mode">Discussion on fork-point mode</h2>
929 <div class="sectionbody">
930 <div class="paragraph"><p>After working on the <code>topic</code> branch created with <code>git switch -c
931 topic origin/master</code>, the history of remote-tracking branch
932 <code>origin/master</code> may have been rewound and rebuilt, leading to a
933 history of this shape:</p></div>
934 <div class="literalblock">
935 <div class="content">
936 <pre><code> o---B2
938 ---o---o---B1--o---o---o---B (origin/master)
942 D0---D1---D (topic)</code></pre>
943 </div></div>
944 <div class="paragraph"><p>where <code>origin/master</code> used to point at commits B0, B1, B2 and now it
945 points at B, and your <code>topic</code> branch was started on top of it back
946 when <code>origin/master</code> was at B0, and you built three commits, D0, D1,
947 and D, on top of it. Imagine that you now want to rebase the work
948 you did on the topic on top of the updated origin/master.</p></div>
949 <div class="paragraph"><p>In such a case, <code>git merge-base origin/master topic</code> would return the
950 parent of B0 in the above picture, but B0^..D is <strong>not</strong> the range of
951 commits you would want to replay on top of B (it includes B0, which
952 is not what you wrote; it is a commit the other side discarded when
953 it moved its tip from B0 to B1).</p></div>
954 <div class="paragraph"><p><code>git merge-base --fork-point origin/master topic</code> is designed to
955 help in such a case. It takes not only B but also B0, B1, and B2
956 (i.e. old tips of the remote-tracking branches your repository&#8217;s
957 reflog knows about) into account to see on which commit your topic
958 branch was built and finds B0, allowing you to replay only the
959 commits on your topic, excluding the commits the other side later
960 discarded.</p></div>
961 <div class="paragraph"><p>Hence</p></div>
962 <div class="literalblock">
963 <div class="content">
964 <pre><code>$ fork_point=$(git merge-base --fork-point origin/master topic)</code></pre>
965 </div></div>
966 <div class="paragraph"><p>will find B0, and</p></div>
967 <div class="literalblock">
968 <div class="content">
969 <pre><code>$ git rebase --onto origin/master $fork_point topic</code></pre>
970 </div></div>
971 <div class="paragraph"><p>will replay D0, D1, and D on top of B to create a new history of this
972 shape:</p></div>
973 <div class="literalblock">
974 <div class="content">
975 <pre><code> o---B2
977 ---o---o---B1--o---o---o---B (origin/master)
979 B0 D0'--D1'--D' (topic - updated)
981 D0---D1---D (topic - old)</code></pre>
982 </div></div>
983 <div class="paragraph"><p>A caveat is that older reflog entries in your repository may be
984 expired by <code>git gc</code>. If B0 no longer appears in the reflog of the
985 remote-tracking branch <code>origin/master</code>, the <code>--fork-point</code> mode
986 obviously cannot find it and fails, avoiding to give a random and
987 useless result (such as the parent of B0, like the same command
988 without the <code>--fork-point</code> option gives).</p></div>
989 <div class="paragraph"><p>Also, the remote-tracking branch you use the <code>--fork-point</code> mode
990 with must be the one your topic forked from its tip. If you forked
991 from an older commit than the tip, this mode would not find the fork
992 point (imagine in the above sample history B0 did not exist,
993 origin/master started at B1, moved to B2 and then B, and you forked
994 your topic at origin/master^ when origin/master was B1; the shape of
995 the history would be the same as above, without B0, and the parent
996 of B1 is what <code>git merge-base origin/master topic</code> correctly finds,
997 but the <code>--fork-point</code> mode will not, because it is not one of the
998 commits that used to be at the tip of origin/master).</p></div>
999 </div>
1000 </div>
1001 <div class="sect1">
1002 <h2 id="_see_also">See also</h2>
1003 <div class="sectionbody">
1004 <div class="paragraph"><p><a href="git-rev-list.html">git-rev-list(1)</a>,
1005 <a href="git-show-branch.html">git-show-branch(1)</a>,
1006 <a href="git-merge.html">git-merge(1)</a></p></div>
1007 </div>
1008 </div>
1009 <div class="sect1">
1010 <h2 id="_git">GIT</h2>
1011 <div class="sectionbody">
1012 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1013 </div>
1014 </div>
1015 </div>
1016 <div id="footnotes"><hr /></div>
1017 <div id="footer">
1018 <div id="footer-text">
1019 Last updated
1020 2023-10-23 14:43:46 PDT
1021 </div>
1022 </div>
1023 </body>
1024 </html>