Autogenerated HTML docs for v2.43.0-334-gd4dbc
[git-htmldocs.git] / git-merge-tree.html
bloba429f6aeae38cad04c66db2d65c6f3df9de769aa
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-tree(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-tree(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-merge-tree -
743 Perform merge without touching index or working tree
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-tree</em> [--write-tree] [&lt;options&gt;] &lt;branch1&gt; &lt;branch2&gt;
753 <em>git merge-tree</em> [--trivial-merge] &lt;base-tree&gt; &lt;branch1&gt; &lt;branch2&gt; (deprecated)</pre>
754 <div class="attribution">
755 </div></div>
756 </div>
757 </div>
758 <div class="sect1">
759 <h2 id="NEWMERGE">DESCRIPTION</h2>
760 <div class="sectionbody">
761 <div class="paragraph"><p>This command has a modern <code>--write-tree</code> mode and a deprecated
762 <code>--trivial-merge</code> mode. With the exception of the
763 <a href="#DEPMERGE">DEPRECATED DESCRIPTION</a> section at the end, the rest of
764 this documentation describes the modern <code>--write-tree</code> mode.</p></div>
765 <div class="paragraph"><p>Performs a merge, but does not make any new commits and does not read
766 from or write to either the working tree or index.</p></div>
767 <div class="paragraph"><p>The performed merge will use the same features as the "real"
768 <a href="git-merge.html">git-merge(1)</a>, including:</p></div>
769 <div class="ulist"><ul>
770 <li>
772 three way content merges of individual files
773 </p>
774 </li>
775 <li>
777 rename detection
778 </p>
779 </li>
780 <li>
782 proper directory/file conflict handling
783 </p>
784 </li>
785 <li>
787 recursive ancestor consolidation (i.e. when there is more than one
788 merge base, creating a virtual merge base by merging the merge bases)
789 </p>
790 </li>
791 <li>
793 etc.
794 </p>
795 </li>
796 </ul></div>
797 <div class="paragraph"><p>After the merge completes, a new toplevel tree object is created. See
798 <code>OUTPUT</code> below for details.</p></div>
799 </div>
800 </div>
801 <div class="sect1">
802 <h2 id="_options">OPTIONS</h2>
803 <div class="sectionbody">
804 <div class="dlist"><dl>
805 <dt class="hdlist1">
807 </dt>
808 <dd>
810 Do not quote filenames in the &lt;Conflicted file info&gt; section,
811 and end each filename with a NUL character rather than
812 newline. Also begin the messages section with a NUL character
813 instead of a newline. See <a href="#OUTPUT">[OUTPUT]</a> below for more information.
814 </p>
815 </dd>
816 <dt class="hdlist1">
817 --name-only
818 </dt>
819 <dd>
821 In the Conflicted file info section, instead of writing a list
822 of (mode, oid, stage, path) tuples to output for conflicted
823 files, just provide a list of filenames with conflicts (and
824 do not list filenames multiple times if they have multiple
825 conflicting stages).
826 </p>
827 </dd>
828 <dt class="hdlist1">
829 --[no-]messages
830 </dt>
831 <dd>
833 Write any informational messages such as "Auto-merging &lt;path&gt;"
834 or CONFLICT notices to the end of stdout. If unspecified, the
835 default is to include these messages if there are merge
836 conflicts, and to omit them otherwise.
837 </p>
838 </dd>
839 <dt class="hdlist1">
840 --allow-unrelated-histories
841 </dt>
842 <dd>
844 merge-tree will by default error out if the two branches specified
845 share no common history. This flag can be given to override that
846 check and make the merge proceed anyway.
847 </p>
848 </dd>
849 <dt class="hdlist1">
850 --merge-base=&lt;commit&gt;
851 </dt>
852 <dd>
854 Instead of finding the merge-bases for &lt;branch1&gt; and &lt;branch2&gt;,
855 specify a merge-base for the merge, and specifying multiple bases is
856 currently not supported. This option is incompatible with <code>--stdin</code>.
857 </p>
858 </dd>
859 </dl></div>
860 </div>
861 </div>
862 <div class="sect1">
863 <h2 id="OUTPUT">OUTPUT</h2>
864 <div class="sectionbody">
865 <div class="paragraph"><p>For a successful merge, the output from git-merge-tree is simply one
866 line:</p></div>
867 <div class="literalblock">
868 <div class="content">
869 <pre><code>&lt;OID of toplevel tree&gt;</code></pre>
870 </div></div>
871 <div class="paragraph"><p>Whereas for a conflicted merge, the output is by default of the form:</p></div>
872 <div class="literalblock">
873 <div class="content">
874 <pre><code>&lt;OID of toplevel tree&gt;
875 &lt;Conflicted file info&gt;
876 &lt;Informational messages&gt;</code></pre>
877 </div></div>
878 <div class="paragraph"><p>These are discussed individually below.</p></div>
879 <div class="paragraph"><p>However, there is an exception. If <code>--stdin</code> is passed, then there is
880 an extra section at the beginning, a NUL character at the end, and then
881 all the sections repeat for each line of input. Thus, if the first merge
882 is conflicted and the second is clean, the output would be of the form:</p></div>
883 <div class="literalblock">
884 <div class="content">
885 <pre><code>&lt;Merge status&gt;
886 &lt;OID of toplevel tree&gt;
887 &lt;Conflicted file info&gt;
888 &lt;Informational messages&gt;
890 &lt;Merge status&gt;
891 &lt;OID of toplevel tree&gt;
892 NUL</code></pre>
893 </div></div>
894 <div class="sect2">
895 <h3 id="MS">Merge status</h3>
896 <div class="paragraph"><p>This is an integer status followed by a NUL character. The integer status is:</p></div>
897 <div class="literalblock">
898 <div class="content">
899 <pre><code>0: merge had conflicts
900 1: merge was clean
901 &lt;0: something prevented the merge from running (e.g. access to repository
902 objects denied by filesystem)</code></pre>
903 </div></div>
904 </div>
905 <div class="sect2">
906 <h3 id="OIDTLT">OID of toplevel tree</h3>
907 <div class="paragraph"><p>This is a tree object that represents what would be checked out in the
908 working tree at the end of <code>git merge</code>. If there were conflicts, then
909 files within this tree may have embedded conflict markers. This section
910 is always followed by a newline (or NUL if <code>-z</code> is passed).</p></div>
911 </div>
912 <div class="sect2">
913 <h3 id="CFI">Conflicted file info</h3>
914 <div class="paragraph"><p>This is a sequence of lines with the format</p></div>
915 <div class="literalblock">
916 <div class="content">
917 <pre><code>&lt;mode&gt; &lt;object&gt; &lt;stage&gt; &lt;filename&gt;</code></pre>
918 </div></div>
919 <div class="paragraph"><p>The filename will be quoted as explained for the configuration
920 variable <code>core.quotePath</code> (see <a href="git-config.html">git-config(1)</a>). However, if
921 the <code>--name-only</code> option is passed, the mode, object, and stage will
922 be omitted. If <code>-z</code> is passed, the "lines" are terminated by a NUL
923 character instead of a newline character.</p></div>
924 </div>
925 <div class="sect2">
926 <h3 id="IM">Informational messages</h3>
927 <div class="paragraph"><p>This section provides informational messages, typically about
928 conflicts. The format of the section varies significantly depending
929 on whether <code>-z</code> is passed.</p></div>
930 <div class="paragraph"><p>If <code>-z</code> is passed:</p></div>
931 <div class="paragraph"><p>The output format is zero or more conflict informational records, each
932 of the form:</p></div>
933 <div class="literalblock">
934 <div class="content">
935 <pre><code>&lt;list-of-paths&gt;&lt;conflict-type&gt;NUL&lt;conflict-message&gt;NUL</code></pre>
936 </div></div>
937 <div class="paragraph"><p>where &lt;list-of-paths&gt; is of the form</p></div>
938 <div class="literalblock">
939 <div class="content">
940 <pre><code>&lt;number-of-paths&gt;NUL&lt;path1&gt;NUL&lt;path2&gt;NUL...&lt;pathN&gt;NUL</code></pre>
941 </div></div>
942 <div class="paragraph"><p>and includes paths (or branch names) affected by the conflict or
943 informational message in &lt;conflict-message&gt;. Also, &lt;conflict-type&gt; is a
944 stable string explaining the type of conflict, such as</p></div>
945 <div class="ulist"><ul>
946 <li>
948 "Auto-merging"
949 </p>
950 </li>
951 <li>
953 "CONFLICT (rename/delete)"
954 </p>
955 </li>
956 <li>
958 "CONFLICT (submodule lacks merge base)"
959 </p>
960 </li>
961 <li>
963 "CONFLICT (binary)"
964 </p>
965 </li>
966 </ul></div>
967 <div class="paragraph"><p>and &lt;conflict-message&gt; is a more detailed message about the conflict which often
968 (but not always) embeds the &lt;stable-short-type-description&gt; within it. These
969 strings may change in future Git versions. Some examples:</p></div>
970 <div class="ulist"><ul>
971 <li>
973 "Auto-merging &lt;file&gt;"
974 </p>
975 </li>
976 <li>
978 "CONFLICT (rename/delete): &lt;oldfile&gt; renamed&#8230;but deleted in&#8230;"
979 </p>
980 </li>
981 <li>
983 "Failed to merge submodule &lt;submodule&gt; (no merge base)"
984 </p>
985 </li>
986 <li>
988 "Warning: cannot merge binary files: &lt;filename&gt;"
989 </p>
990 </li>
991 </ul></div>
992 <div class="paragraph"><p>If <code>-z</code> is NOT passed:</p></div>
993 <div class="paragraph"><p>This section starts with a blank line to separate it from the previous
994 sections, and then only contains the &lt;conflict-message&gt; information
995 from the previous section (separated by newlines). These are
996 non-stable strings that should not be parsed by scripts, and are just
997 meant for human consumption. Also, note that while &lt;conflict-message&gt;
998 strings usually do not contain embedded newlines, they sometimes do.
999 (However, the free-form messages will never have an embedded NUL
1000 character). So, the entire block of information is meant for human
1001 readers as an agglomeration of all conflict messages.</p></div>
1002 </div>
1003 </div>
1004 </div>
1005 <div class="sect1">
1006 <h2 id="_exit_status">EXIT STATUS</h2>
1007 <div class="sectionbody">
1008 <div class="paragraph"><p>For a successful, non-conflicted merge, the exit status is 0. When the
1009 merge has conflicts, the exit status is 1. If the merge is not able to
1010 complete (or start) due to some kind of error, the exit status is
1011 something other than 0 or 1 (and the output is unspecified). When
1012 --stdin is passed, the return status is 0 for both successful and
1013 conflicted merges, and something other than 0 or 1 if it cannot complete
1014 all the requested merges.</p></div>
1015 </div>
1016 </div>
1017 <div class="sect1">
1018 <h2 id="_usage_notes">USAGE NOTES</h2>
1019 <div class="sectionbody">
1020 <div class="paragraph"><p>This command is intended as low-level plumbing, similar to
1021 <a href="git-hash-object.html">git-hash-object(1)</a>, <a href="git-mktree.html">git-mktree(1)</a>,
1022 <a href="git-commit-tree.html">git-commit-tree(1)</a>, <a href="git-write-tree.html">git-write-tree(1)</a>,
1023 <a href="git-update-ref.html">git-update-ref(1)</a>, and <a href="git-mktag.html">git-mktag(1)</a>. Thus, it can be
1024 used as a part of a series of steps such as:</p></div>
1025 <div class="literalblock">
1026 <div class="content">
1027 <pre><code>NEWTREE=$(git merge-tree --write-tree $BRANCH1 $BRANCH2)
1028 test $? -eq 0 || die "There were conflicts..."
1029 NEWCOMMIT=$(git commit-tree $NEWTREE -p $BRANCH1 -p $BRANCH2)
1030 git update-ref $BRANCH1 $NEWCOMMIT</code></pre>
1031 </div></div>
1032 <div class="paragraph"><p>Note that when the exit status is non-zero, <code>NEWTREE</code> in this sequence
1033 will contain a lot more output than just a tree.</p></div>
1034 <div class="paragraph"><p>For conflicts, the output includes the same information that you&#8217;d get
1035 with <a href="git-merge.html">git-merge(1)</a>:</p></div>
1036 <div class="ulist"><ul>
1037 <li>
1039 what would be written to the working tree (the
1040 <a href="#OIDTLT">OID of toplevel tree</a>)
1041 </p>
1042 </li>
1043 <li>
1045 the higher order stages that would be written to the index (the
1046 <a href="#CFI">Conflicted file info</a>)
1047 </p>
1048 </li>
1049 <li>
1051 any messages that would have been printed to stdout (the
1052 <a href="#IM">Informational messages</a>)
1053 </p>
1054 </li>
1055 </ul></div>
1056 </div>
1057 </div>
1058 <div class="sect1">
1059 <h2 id="_input_format">INPUT FORMAT</h2>
1060 <div class="sectionbody">
1061 <div class="paragraph"><p><em>git merge-tree --stdin</em> input format is fully text based. Each line
1062 has this format:</p></div>
1063 <div class="literalblock">
1064 <div class="content">
1065 <pre><code>[&lt;base-commit&gt; -- ]&lt;branch1&gt; &lt;branch2&gt;</code></pre>
1066 </div></div>
1067 <div class="paragraph"><p>If one line is separated by <code>--</code>, the string before the separator is
1068 used for specifying a merge-base for the merge and the string after
1069 the separator describes the branches to be merged.</p></div>
1070 </div>
1071 </div>
1072 <div class="sect1">
1073 <h2 id="_mistakes_to_avoid">MISTAKES TO AVOID</h2>
1074 <div class="sectionbody">
1075 <div class="paragraph"><p>Do NOT look through the resulting toplevel tree to try to find which
1076 files conflict; parse the <a href="#CFI">Conflicted file info</a> section instead.
1077 Not only would parsing an entire tree be horrendously slow in large
1078 repositories, there are numerous types of conflicts not representable by
1079 conflict markers (modify/delete, mode conflict, binary file changed on
1080 both sides, file/directory conflicts, various rename conflict
1081 permutations, etc.)</p></div>
1082 <div class="paragraph"><p>Do NOT interpret an empty <a href="#CFI">Conflicted file info</a> list as a clean
1083 merge; check the exit status. A merge can have conflicts without having
1084 individual files conflict (there are a few types of directory rename
1085 conflicts that fall into this category, and others might also be added
1086 in the future).</p></div>
1087 <div class="paragraph"><p>Do NOT attempt to guess or make the user guess the conflict types from
1088 the <a href="#CFI">Conflicted file info</a> list. The information there is
1089 insufficient to do so. For example: Rename/rename(1to2) conflicts (both
1090 sides renamed the same file differently) will result in three different
1091 files having higher order stages (but each only has one higher order
1092 stage), with no way (short of the <a href="#IM">Informational messages</a> section)
1093 to determine which three files are related. File/directory conflicts
1094 also result in a file with exactly one higher order stage.
1095 Possibly-involved-in-directory-rename conflicts (when
1096 "merge.directoryRenames" is unset or set to "conflicts") also result in
1097 a file with exactly one higher order stage. In all cases, the
1098 <a href="#IM">Informational messages</a> section has the necessary info, though it
1099 is not designed to be machine parseable.</p></div>
1100 <div class="paragraph"><p>Do NOT assume that each path from <a href="#CFI">Conflicted file info</a>, and
1101 the logical conflicts in the <a href="#IM">Informational messages</a> have a
1102 one-to-one mapping, nor that there is a one-to-many mapping, nor a
1103 many-to-one mapping. Many-to-many mappings exist, meaning that each
1104 path can have many logical conflict types in a single merge, and each
1105 logical conflict type can affect many paths.</p></div>
1106 <div class="paragraph"><p>Do NOT assume all filenames listed in the <a href="#IM">Informational messages</a>
1107 section had conflicts. Messages can be included for files that have no
1108 conflicts, such as "Auto-merging &lt;file&gt;".</p></div>
1109 <div class="paragraph"><p>AVOID taking the OIDS from the <a href="#CFI">Conflicted file info</a> and
1110 re-merging them to present the conflicts to the user. This will lose
1111 information. Instead, look up the version of the file found within the
1112 <a href="#OIDTLT">OID of toplevel tree</a> and show that instead. In particular,
1113 the latter will have conflict markers annotated with the original
1114 branch/commit being merged and, if renames were involved, the original
1115 filename. While you could include the original branch/commit in the
1116 conflict marker annotations when re-merging, the original filename is
1117 not available from the <a href="#CFI">Conflicted file info</a> and thus you would
1118 be losing information that might help the user resolve the conflict.</p></div>
1119 </div>
1120 </div>
1121 <div class="sect1">
1122 <h2 id="DEPMERGE">DEPRECATED DESCRIPTION</h2>
1123 <div class="sectionbody">
1124 <div class="paragraph"><p>Per the <a href="#NEWMERGE">DESCRIPTION</a> and unlike the rest of this
1125 documentation, this section describes the deprecated <code>--trivial-merge</code>
1126 mode.</p></div>
1127 <div class="paragraph"><p>Other than the optional <code>--trivial-merge</code>, this mode accepts no
1128 options.</p></div>
1129 <div class="paragraph"><p>This mode reads three tree-ish, and outputs trivial merge results and
1130 conflicting stages to the standard output in a semi-diff format.
1131 Since this was designed for higher level scripts to consume and merge
1132 the results back into the index, it omits entries that match
1133 &lt;branch1&gt;. The result of this second form is similar to what
1134 three-way <em>git read-tree -m</em> does, but instead of storing the results
1135 in the index, the command outputs the entries to the standard output.</p></div>
1136 <div class="paragraph"><p>This form not only has limited applicability (a trivial merge cannot
1137 handle content merges of individual files, rename detection, proper
1138 directory/file conflict handling, etc.), the output format is also
1139 difficult to work with, and it will generally be less performant than
1140 the first form even on successful merges (especially if working in
1141 large repositories).</p></div>
1142 </div>
1143 </div>
1144 <div class="sect1">
1145 <h2 id="_git">GIT</h2>
1146 <div class="sectionbody">
1147 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1148 </div>
1149 </div>
1150 </div>
1151 <div id="footnotes"><hr /></div>
1152 <div id="footer">
1153 <div id="footer-text">
1154 Last updated
1155 2023-10-23 14:43:46 PDT
1156 </div>
1157 </div>
1158 </body>
1159 </html>