Autogenerated HTML docs for v1.7.5.2-315-g11bc3
[git/jnareb-git.git] / git-rerere.html
blob23293d0f4e7efc06600bb9d860fac66412e9217a
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.4.5" />
7 <title>git-rerere(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 git-rerere(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-rerere -
411 Reuse recorded resolution of conflicted merges
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="paragraph"><p><em>git rerere</em> [<em>clear</em>|<em>forget</em> &lt;pathspec&gt;|<em>diff</em>|<em>status</em>|<em>gc</em>]</p></div>
418 </div>
419 <h2 id="_description">DESCRIPTION</h2>
420 <div class="sectionbody">
421 <div class="paragraph"><p>In a workflow employing relatively long lived topic branches,
422 the developer sometimes needs to resolve the same conflicts over
423 and over again until the topic branches are done (either merged
424 to the "release" branch, or sent out and accepted upstream).</p></div>
425 <div class="paragraph"><p>This command assists the developer in this process by recording
426 conflicted automerge results and corresponding hand resolve results
427 on the initial manual merge, and applying previously recorded
428 hand resolutions to their corresponding automerge results.</p></div>
429 <div class="admonitionblock">
430 <table><tr>
431 <td class="icon">
432 <div class="title">Note</div>
433 </td>
434 <td class="content">You need to set the configuration variable rerere.enabled in order to
435 enable this command.</td>
436 </tr></table>
437 </div>
438 </div>
439 <h2 id="_commands">COMMANDS</h2>
440 <div class="sectionbody">
441 <div class="paragraph"><p>Normally, <em>git rerere</em> is run without arguments or user-intervention.
442 However, it has several commands that allow it to interact with
443 its working state.</p></div>
444 <div class="dlist"><dl>
445 <dt class="hdlist1">
446 <em>clear</em>
447 </dt>
448 <dd>
450 This resets the metadata used by rerere if a merge resolution is to be
451 aborted. Calling <em>git am [--skip|--abort]</em> or <em>git rebase [--skip|--abort]</em>
452 will automatically invoke this command.
453 </p>
454 </dd>
455 <dt class="hdlist1">
456 <em>forget</em> &lt;pathspec&gt;
457 </dt>
458 <dd>
460 This resets the conflict resolutions which rerere has recorded for the current
461 conflict in &lt;pathspec&gt;.
462 </p>
463 </dd>
464 <dt class="hdlist1">
465 <em>diff</em>
466 </dt>
467 <dd>
469 This displays diffs for the current state of the resolution. It is
470 useful for tracking what has changed while the user is resolving
471 conflicts. Additional arguments are passed directly to the system
472 <em>diff</em> command installed in PATH.
473 </p>
474 </dd>
475 <dt class="hdlist1">
476 <em>status</em>
477 </dt>
478 <dd>
480 Like <em>diff</em>, but this only prints the filenames that will be tracked
481 for resolutions.
482 </p>
483 </dd>
484 <dt class="hdlist1">
485 <em>gc</em>
486 </dt>
487 <dd>
489 This prunes records of conflicted merges that
490 occurred a long time ago. By default, unresolved conflicts older
491 than 15 days and resolved conflicts older than 60
492 days are pruned. These defaults are controlled via the
493 <tt>gc.rerereunresolved</tt> and <tt>gc.rerereresolved</tt> configuration
494 variables respectively.
495 </p>
496 </dd>
497 </dl></div>
498 </div>
499 <h2 id="_discussion">DISCUSSION</h2>
500 <div class="sectionbody">
501 <div class="paragraph"><p>When your topic branch modifies an overlapping area that your
502 master branch (or upstream) touched since your topic branch
503 forked from it, you may want to test it with the latest master,
504 even before your topic branch is ready to be pushed upstream:</p></div>
505 <div class="listingblock">
506 <div class="content">
507 <pre><tt> o---*---o topic
509 o---o---o---*---o---o master</tt></pre>
510 </div></div>
511 <div class="paragraph"><p>For such a test, you need to merge master and topic somehow.
512 One way to do it is to pull master into the topic branch:</p></div>
513 <div class="listingblock">
514 <div class="content">
515 <pre><tt> $ git checkout topic
516 $ git merge master
518 o---*---o---+ topic
520 o---o---o---*---o---o master</tt></pre>
521 </div></div>
522 <div class="paragraph"><p>The commits marked with <tt>*</tt> touch the same area in the same
523 file; you need to resolve the conflicts when creating the commit
524 marked with <tt>&#43;</tt>. Then you can test the result to make sure your
525 work-in-progress still works with what is in the latest master.</p></div>
526 <div class="paragraph"><p>After this test merge, there are two ways to continue your work
527 on the topic. The easiest is to build on top of the test merge
528 commit <tt>&#43;</tt>, and when your work in the topic branch is finally
529 ready, pull the topic branch into master, and/or ask the
530 upstream to pull from you. By that time, however, the master or
531 the upstream might have been advanced since the test merge <tt>&#43;</tt>,
532 in which case the final commit graph would look like this:</p></div>
533 <div class="listingblock">
534 <div class="content">
535 <pre><tt> $ git checkout topic
536 $ git merge master
537 $ ... work on both topic and master branches
538 $ git checkout master
539 $ git merge topic
541 o---*---o---+---o---o topic
542 / / \
543 o---o---o---*---o---o---o---o---+ master</tt></pre>
544 </div></div>
545 <div class="paragraph"><p>When your topic branch is long-lived, however, your topic branch
546 would end up having many such "Merge from master" commits on it,
547 which would unnecessarily clutter the development history.
548 Readers of the Linux kernel mailing list may remember that Linus
549 complained about such too frequent test merges when a subsystem
550 maintainer asked to pull from a branch full of "useless merges".</p></div>
551 <div class="paragraph"><p>As an alternative, to keep the topic branch clean of test
552 merges, you could blow away the test merge, and keep building on
553 top of the tip before the test merge:</p></div>
554 <div class="listingblock">
555 <div class="content">
556 <pre><tt> $ git checkout topic
557 $ git merge master
558 $ git reset --hard HEAD^ ;# rewind the test merge
559 $ ... work on both topic and master branches
560 $ git checkout master
561 $ git merge topic
563 o---*---o-------o---o topic
565 o---o---o---*---o---o---o---o---+ master</tt></pre>
566 </div></div>
567 <div class="paragraph"><p>This would leave only one merge commit when your topic branch is
568 finally ready and merged into the master branch. This merge
569 would require you to resolve the conflict, introduced by the
570 commits marked with <tt>*</tt>. However, this conflict is often the
571 same conflict you resolved when you created the test merge you
572 blew away. <em>git rerere</em> helps you resolve this final
573 conflicted merge using the information from your earlier hand
574 resolve.</p></div>
575 <div class="paragraph"><p>Running the <em>git rerere</em> command immediately after a conflicted
576 automerge records the conflicted working tree files, with the
577 usual conflict markers <tt>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</tt>, <tt>=======</tt>, and <tt>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</tt> in
578 them. Later, after you are done resolving the conflicts,
579 running <em>git rerere</em> again will record the resolved state of these
580 files. Suppose you did this when you created the test merge of
581 master into the topic branch.</p></div>
582 <div class="paragraph"><p>Next time, after seeing the same conflicted automerge,
583 running <em>git rerere</em> will perform a three-way merge between the
584 earlier conflicted automerge, the earlier manual resolution, and
585 the current conflicted automerge.
586 If this three-way merge resolves cleanly, the result is written
587 out to your working tree file, so you do not have to manually
588 resolve it. Note that <em>git rerere</em> leaves the index file alone,
589 so you still need to do the final sanity checks with <tt>git diff</tt>
590 (or <tt>git diff -c</tt>) and <em>git add</em> when you are satisfied.</p></div>
591 <div class="paragraph"><p>As a convenience measure, <em>git merge</em> automatically invokes
592 <em>git rerere</em> upon exiting with a failed automerge and <em>git rerere</em>
593 records the hand resolve when it is a new conflict, or reuses the earlier hand
594 resolve when it is not. <em>git commit</em> also invokes <em>git rerere</em>
595 when committing a merge result. What this means is that you do
596 not have to do anything special yourself (besides enabling
597 the rerere.enabled config variable).</p></div>
598 <div class="paragraph"><p>In our example, when you do the test merge, the manual
599 resolution is recorded, and it will be reused when you do the
600 actual merge later with the updated master and topic branch, as long
601 as the recorded resolution is still applicable.</p></div>
602 <div class="paragraph"><p>The information <em>git rerere</em> records is also used when running
603 <em>git rebase</em>. After blowing away the test merge and continuing
604 development on the topic branch:</p></div>
605 <div class="listingblock">
606 <div class="content">
607 <pre><tt> o---*---o-------o---o topic
609 o---o---o---*---o---o---o---o master
611 $ git rebase master topic
613 o---*---o-------o---o topic
615 o---o---o---*---o---o---o---o master</tt></pre>
616 </div></div>
617 <div class="paragraph"><p>you could run <tt>git rebase master topic</tt>, to bring yourself
618 up-to-date before your topic is ready to be sent upstream.
619 This would result in falling back to a three-way merge, and it
620 would conflict the same way as the test merge you resolved earlier.
621 <em>git rerere</em> will be run by <em>git rebase</em> to help you resolve this
622 conflict.</p></div>
623 </div>
624 <h2 id="_git">GIT</h2>
625 <div class="sectionbody">
626 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
627 </div>
628 <div id="footer">
629 <div id="footer-text">
630 Last updated 2011-03-20 19:41:42 UTC
631 </div>
632 </div>
633 </body>
634 </html>