Autogenerated HTML docs for v2.43.0-386-ge02ecfc
[git-htmldocs.git] / git-rerere.html
blob335515835f0e18764759f66a075f808af89963c5
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-rerere(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-rerere(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-rerere -
743 Reuse recorded resolution of conflicted merges
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 rerere</em> [clear | forget &lt;pathspec&gt;&#8230; | diff | status | remaining | gc]</pre>
753 <div class="attribution">
754 </div></div>
755 </div>
756 </div>
757 <div class="sect1">
758 <h2 id="_description">DESCRIPTION</h2>
759 <div class="sectionbody">
760 <div class="paragraph"><p>In a workflow employing relatively long lived topic branches,
761 the developer sometimes needs to resolve the same conflicts over
762 and over again until the topic branches are done (either merged
763 to the "release" branch, or sent out and accepted upstream).</p></div>
764 <div class="paragraph"><p>This command assists the developer in this process by recording
765 conflicted automerge results and corresponding hand resolve results
766 on the initial manual merge, and applying previously recorded
767 hand resolutions to their corresponding automerge results.</p></div>
768 <div class="admonitionblock">
769 <table><tr>
770 <td class="icon">
771 <div class="title">Note</div>
772 </td>
773 <td class="content">You need to set the configuration variable <code>rerere.enabled</code> in order to
774 enable this command.</td>
775 </tr></table>
776 </div>
777 </div>
778 </div>
779 <div class="sect1">
780 <h2 id="_commands">COMMANDS</h2>
781 <div class="sectionbody">
782 <div class="paragraph"><p>Normally, <em>git rerere</em> is run without arguments or user-intervention.
783 However, it has several commands that allow it to interact with
784 its working state.</p></div>
785 <div class="dlist"><dl>
786 <dt class="hdlist1">
787 <em>clear</em>
788 </dt>
789 <dd>
791 Reset the metadata used by rerere if a merge resolution is to be
792 aborted. Calling <em>git am [--skip|--abort]</em> or <em>git rebase [--skip|--abort]</em>
793 will automatically invoke this command.
794 </p>
795 </dd>
796 <dt class="hdlist1">
797 <em>forget</em> &lt;pathspec&gt;
798 </dt>
799 <dd>
801 Reset the conflict resolutions which rerere has recorded for the current
802 conflict in &lt;pathspec&gt;.
803 </p>
804 </dd>
805 <dt class="hdlist1">
806 <em>diff</em>
807 </dt>
808 <dd>
810 Display diffs for the current state of the resolution. It is
811 useful for tracking what has changed while the user is resolving
812 conflicts. Additional arguments are passed directly to the system
813 <em>diff</em> command installed in PATH.
814 </p>
815 </dd>
816 <dt class="hdlist1">
817 <em>status</em>
818 </dt>
819 <dd>
821 Print paths with conflicts whose merge resolution rerere will record.
822 </p>
823 </dd>
824 <dt class="hdlist1">
825 <em>remaining</em>
826 </dt>
827 <dd>
829 Print paths with conflicts that have not been autoresolved by rerere.
830 This includes paths whose resolutions cannot be tracked by rerere,
831 such as conflicting submodules.
832 </p>
833 </dd>
834 <dt class="hdlist1">
835 <em>gc</em>
836 </dt>
837 <dd>
839 Prune records of conflicted merges that
840 occurred a long time ago. By default, unresolved conflicts older
841 than 15 days and resolved conflicts older than 60
842 days are pruned. These defaults are controlled via the
843 <code>gc.rerereUnresolved</code> and <code>gc.rerereResolved</code> configuration
844 variables respectively.
845 </p>
846 </dd>
847 </dl></div>
848 </div>
849 </div>
850 <div class="sect1">
851 <h2 id="_discussion">DISCUSSION</h2>
852 <div class="sectionbody">
853 <div class="paragraph"><p>When your topic branch modifies an overlapping area that your
854 master branch (or upstream) touched since your topic branch
855 forked from it, you may want to test it with the latest master,
856 even before your topic branch is ready to be pushed upstream:</p></div>
857 <div class="listingblock">
858 <div class="content">
859 <pre><code> o---*---o topic
861 o---o---o---*---o---o master</code></pre>
862 </div></div>
863 <div class="paragraph"><p>For such a test, you need to merge master and topic somehow.
864 One way to do it is to pull master into the topic branch:</p></div>
865 <div class="listingblock">
866 <div class="content">
867 <pre><code> $ git switch topic
868 $ git merge master
870 o---*---o---+ topic
872 o---o---o---*---o---o master</code></pre>
873 </div></div>
874 <div class="paragraph"><p>The commits marked with <code>*</code> touch the same area in the same
875 file; you need to resolve the conflicts when creating the commit
876 marked with <code>+</code>. Then you can test the result to make sure your
877 work-in-progress still works with what is in the latest master.</p></div>
878 <div class="paragraph"><p>After this test merge, there are two ways to continue your work
879 on the topic. The easiest is to build on top of the test merge
880 commit <code>+</code>, and when your work in the topic branch is finally
881 ready, pull the topic branch into master, and/or ask the
882 upstream to pull from you. By that time, however, the master or
883 the upstream might have been advanced since the test merge <code>+</code>,
884 in which case the final commit graph would look like this:</p></div>
885 <div class="listingblock">
886 <div class="content">
887 <pre><code> $ git switch topic
888 $ git merge master
889 $ ... work on both topic and master branches
890 $ git switch master
891 $ git merge topic
893 o---*---o---+---o---o topic
894 / / \
895 o---o---o---*---o---o---o---o---+ master</code></pre>
896 </div></div>
897 <div class="paragraph"><p>When your topic branch is long-lived, however, your topic branch
898 would end up having many such "Merge from master" commits on it,
899 which would unnecessarily clutter the development history.
900 Readers of the Linux kernel mailing list may remember that Linus
901 complained about such too frequent test merges when a subsystem
902 maintainer asked to pull from a branch full of "useless merges".</p></div>
903 <div class="paragraph"><p>As an alternative, to keep the topic branch clean of test
904 merges, you could blow away the test merge, and keep building on
905 top of the tip before the test merge:</p></div>
906 <div class="listingblock">
907 <div class="content">
908 <pre><code> $ git switch topic
909 $ git merge master
910 $ git reset --hard HEAD^ ;# rewind the test merge
911 $ ... work on both topic and master branches
912 $ git switch master
913 $ git merge topic
915 o---*---o-------o---o topic
917 o---o---o---*---o---o---o---o---+ master</code></pre>
918 </div></div>
919 <div class="paragraph"><p>This would leave only one merge commit when your topic branch is
920 finally ready and merged into the master branch. This merge
921 would require you to resolve the conflict, introduced by the
922 commits marked with <code>*</code>. However, this conflict is often the
923 same conflict you resolved when you created the test merge you
924 blew away. <em>git rerere</em> helps you resolve this final
925 conflicted merge using the information from your earlier hand
926 resolve.</p></div>
927 <div class="paragraph"><p>Running the <em>git rerere</em> command immediately after a conflicted
928 automerge records the conflicted working tree files, with the
929 usual conflict markers <code>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</code>, <code>=======</code>, and <code>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</code> in
930 them. Later, after you are done resolving the conflicts,
931 running <em>git rerere</em> again will record the resolved state of these
932 files. Suppose you did this when you created the test merge of
933 master into the topic branch.</p></div>
934 <div class="paragraph"><p>Next time, after seeing the same conflicted automerge,
935 running <em>git rerere</em> will perform a three-way merge between the
936 earlier conflicted automerge, the earlier manual resolution, and
937 the current conflicted automerge.
938 If this three-way merge resolves cleanly, the result is written
939 out to your working tree file, so you do not have to manually
940 resolve it. Note that <em>git rerere</em> leaves the index file alone,
941 so you still need to do the final sanity checks with <code>git diff</code>
942 (or <code>git diff -c</code>) and <em>git add</em> when you are satisfied.</p></div>
943 <div class="paragraph"><p>As a convenience measure, <em>git merge</em> automatically invokes
944 <em>git rerere</em> upon exiting with a failed automerge and <em>git rerere</em>
945 records the hand resolve when it is a new conflict, or reuses the earlier hand
946 resolve when it is not. <em>git commit</em> also invokes <em>git rerere</em>
947 when committing a merge result. What this means is that you do
948 not have to do anything special yourself (besides enabling
949 the rerere.enabled config variable).</p></div>
950 <div class="paragraph"><p>In our example, when you do the test merge, the manual
951 resolution is recorded, and it will be reused when you do the
952 actual merge later with the updated master and topic branch, as long
953 as the recorded resolution is still applicable.</p></div>
954 <div class="paragraph"><p>The information <em>git rerere</em> records is also used when running
955 <em>git rebase</em>. After blowing away the test merge and continuing
956 development on the topic branch:</p></div>
957 <div class="listingblock">
958 <div class="content">
959 <pre><code> o---*---o-------o---o topic
961 o---o---o---*---o---o---o---o master
963 $ git rebase master topic
965 o---*---o-------o---o topic
967 o---o---o---*---o---o---o---o master</code></pre>
968 </div></div>
969 <div class="paragraph"><p>you could run <code>git rebase master topic</code>, to bring yourself
970 up to date before your topic is ready to be sent upstream.
971 This would result in falling back to a three-way merge, and it
972 would conflict the same way as the test merge you resolved earlier.
973 <em>git rerere</em> will be run by <em>git rebase</em> to help you resolve this
974 conflict.</p></div>
975 <div class="paragraph"><p>[NOTE] <em>git rerere</em> relies on the conflict markers in the file to
976 detect the conflict. If the file already contains lines that look the
977 same as lines with conflict markers, <em>git rerere</em> may fail to record a
978 conflict resolution. To work around this, the <code>conflict-marker-size</code>
979 setting in <a href="gitattributes.html">gitattributes(5)</a> can be used.</p></div>
980 </div>
981 </div>
982 <div class="sect1">
983 <h2 id="_git">GIT</h2>
984 <div class="sectionbody">
985 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
986 </div>
987 </div>
988 </div>
989 <div id="footnotes"><hr /></div>
990 <div id="footer">
991 <div id="footer-text">
992 Last updated
993 2022-10-28 11:53:56 PDT
994 </div>
995 </div>
996 </body>
997 </html>