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">
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">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.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
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.5em;
129 div
.content
{ /* Block element content. */
133 /* Block element titles. */
134 div
.title
, caption
.title
{
136 font-family: sans-serif
;
140 margin-bottom: 0.5em;
146 td div
.title:first-child
{
149 div
.content div
.title:first-child
{
152 div
.content
+ div
.title
{
156 div
.sidebarblock
> div
.content
{
158 border: 1px solid silver
;
162 div
.listingblock
> div
.content
{
163 border: 1px solid silver
;
172 div
.quoteblock
> div
.attribution
{
181 div
.verseblock
> div
.content
{
184 div
.verseblock
> div
.attribution
{
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div
.verseblock
+ div
.attribution
{
193 div
.admonitionblock
.icon
{
197 text-decoration: underline
;
199 padding-right: 0.5em;
201 div
.admonitionblock td
.content
{
203 border-left: 2px solid silver
;
206 div
.exampleblock
> div
.content
{
207 border-left: 2px solid silver
;
211 div
.imageblock div
.content
{ padding-left: 0; }
212 span
.image img
{ border-style: none
; }
213 a
.image:visited
{ color: white
; }
217 margin-bottom: 0.8em;
230 list-style-position: outside
;
233 list-style-type: decimal
;
236 list-style-type: lower-alpha
;
239 list-style-type: upper-alpha
;
242 list-style-type: lower-roman
;
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
{
252 margin-bottom: 0.1em;
255 div
.tableblock
> table
{
256 border: 3px solid
#527bbd;
259 font-family: sans-serif
;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div
.tableblock
> table
[frame
="void"] {
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
;
287 margin-bottom: 0.8em;
290 padding-bottom: 15px;
292 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
298 padding-right: 0.8em;
304 div
.hdlist
.compact tr
{
314 div#footer-badges
{ display: none
; }
319 font-family: sans-serif
;
323 margin-bottom: 0.1em;
326 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
342 /* Overrides for manpage documents */
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver
;
347 border-bottom: 2px solid silver
;
357 div#toc
{ display: none
; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div
.sidebar-content
{
364 border: 1px solid silver
;
367 div
.sidebar-title
, div
.image-title
{
369 font-family: sans-serif
;
372 margin-bottom: 0.5em;
375 div
.listingblock div
.content
{
376 border: 1px solid silver
;
381 div
.quoteblock-attribution
{
386 div
.verseblock-content
{
389 div
.verseblock-attribution
{
394 div
.exampleblock-content
{
395 border-left: 2px solid silver
;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc
a:visited
{ color: blue
; }
406 git-rerere(
1) Manual Page
409 <div class=
"sectionbody">
411 Reuse recorded resolution of conflicted merges
415 <h2 id=
"_synopsis">SYNOPSIS
</h2>
416 <div class=
"sectionbody">
417 <div class=
"verseblock">
418 <div class=
"verseblock-content"><em>git rerere
</em> [
<em>clear
</em>|
<em>forget
</em> <pathspec
>|
<em>diff
</em>|
<em>status
</em>|
<em>gc
</em>]
</div>
419 <div class=
"verseblock-attribution">
422 <h2 id=
"_description">DESCRIPTION
</h2>
423 <div class=
"sectionbody">
424 <div class=
"paragraph"><p>In a workflow employing relatively long lived topic branches,
425 the developer sometimes needs to resolve the same conflicts over
426 and over again until the topic branches are done (either merged
427 to the
"release" branch, or sent out and accepted upstream).
</p></div>
428 <div class=
"paragraph"><p>This command assists the developer in this process by recording
429 conflicted automerge results and corresponding hand resolve results
430 on the initial manual merge, and applying previously recorded
431 hand resolutions to their corresponding automerge results.
</p></div>
432 <div class=
"admonitionblock">
435 <div class=
"title">Note
</div>
437 <td class=
"content">You need to set the configuration variable rerere.enabled in order to
438 enable this command.
</td>
442 <h2 id=
"_commands">COMMANDS
</h2>
443 <div class=
"sectionbody">
444 <div class=
"paragraph"><p>Normally,
<em>git rerere
</em> is run without arguments or user-intervention.
445 However, it has several commands that allow it to interact with
446 its working state.
</p></div>
447 <div class=
"dlist"><dl>
453 This resets the metadata used by rerere if a merge resolution is to be
454 aborted. Calling
<em>git am [--skip|--abort]
</em> or
<em>git rebase [--skip|--abort]
</em>
455 will automatically invoke this command.
459 <em>forget
</em> <pathspec
>
463 This resets the conflict resolutions which rerere has recorded for the current
464 conflict in
<pathspec
>.
472 This displays diffs for the current state of the resolution. It is
473 useful for tracking what has changed while the user is resolving
474 conflicts. Additional arguments are passed directly to the system
475 <em>diff
</em> command installed in PATH.
483 Like
<em>diff
</em>, but this only prints the filenames that will be tracked
492 This prunes records of conflicted merges that
493 occurred a long time ago. By default, unresolved conflicts older
494 than
15 days and resolved conflicts older than
60
495 days are pruned. These defaults are controlled via the
496 <tt>gc.rerereunresolved
</tt> and
<tt>gc.rerereresolved
</tt> configuration
497 variables respectively.
502 <h2 id=
"_discussion">DISCUSSION
</h2>
503 <div class=
"sectionbody">
504 <div class=
"paragraph"><p>When your topic branch modifies an overlapping area that your
505 master branch (or upstream) touched since your topic branch
506 forked from it, you may want to test it with the latest master,
507 even before your topic branch is ready to be pushed upstream:
</p></div>
508 <div class=
"listingblock">
509 <div class=
"content">
510 <pre><tt> o---*---o topic
512 o---o---o---*---o---o master
</tt></pre>
514 <div class=
"paragraph"><p>For such a test, you need to merge master and topic somehow.
515 One way to do it is to pull master into the topic branch:
</p></div>
516 <div class=
"listingblock">
517 <div class=
"content">
518 <pre><tt> $ git checkout topic
523 o---o---o---*---o---o master
</tt></pre>
525 <div class=
"paragraph"><p>The commits marked with
<tt>*
</tt> touch the same area in the same
526 file; you need to resolve the conflicts when creating the commit
527 marked with
<tt>+</tt>. Then you can test the result to make sure your
528 work-in-progress still works with what is in the latest master.
</p></div>
529 <div class=
"paragraph"><p>After this test merge, there are two ways to continue your work
530 on the topic. The easiest is to build on top of the test merge
531 commit
<tt>+</tt>, and when your work in the topic branch is finally
532 ready, pull the topic branch into master, and/or ask the
533 upstream to pull from you. By that time, however, the master or
534 the upstream might have been advanced since the test merge
<tt>+</tt>,
535 in which case the final commit graph would look like this:
</p></div>
536 <div class=
"listingblock">
537 <div class=
"content">
538 <pre><tt> $ git checkout topic
540 $ ... work on both topic and master branches
541 $ git checkout master
544 o---*---o---+---o---o topic
546 o---o---o---*---o---o---o---o---+ master
</tt></pre>
548 <div class=
"paragraph"><p>When your topic branch is long-lived, however, your topic branch
549 would end up having many such
"Merge from master" commits on it,
550 which would unnecessarily clutter the development history.
551 Readers of the Linux kernel mailing list may remember that Linus
552 complained about such too frequent test merges when a subsystem
553 maintainer asked to pull from a branch full of
"useless merges".
</p></div>
554 <div class=
"paragraph"><p>As an alternative, to keep the topic branch clean of test
555 merges, you could blow away the test merge, and keep building on
556 top of the tip before the test merge:
</p></div>
557 <div class=
"listingblock">
558 <div class=
"content">
559 <pre><tt> $ git checkout topic
561 $ git reset --hard HEAD^ ;# rewind the test merge
562 $ ... work on both topic and master branches
563 $ git checkout master
566 o---*---o-------o---o topic
568 o---o---o---*---o---o---o---o---+ master
</tt></pre>
570 <div class=
"paragraph"><p>This would leave only one merge commit when your topic branch is
571 finally ready and merged into the master branch. This merge
572 would require you to resolve the conflict, introduced by the
573 commits marked with
<tt>*
</tt>. However, this conflict is often the
574 same conflict you resolved when you created the test merge you
575 blew away.
<em>git rerere
</em> helps you resolve this final
576 conflicted merge using the information from your earlier hand
578 <div class=
"paragraph"><p>Running the
<em>git rerere
</em> command immediately after a conflicted
579 automerge records the conflicted working tree files, with the
580 usual conflict markers
<tt><<<<<<<</tt>,
<tt>=======
</tt>, and
<tt>>>>>>>></tt> in
581 them. Later, after you are done resolving the conflicts,
582 running
<em>git rerere
</em> again will record the resolved state of these
583 files. Suppose you did this when you created the test merge of
584 master into the topic branch.
</p></div>
585 <div class=
"paragraph"><p>Next time, after seeing the same conflicted automerge,
586 running
<em>git rerere
</em> will perform a three-way merge between the
587 earlier conflicted automerge, the earlier manual resolution, and
588 the current conflicted automerge.
589 If this three-way merge resolves cleanly, the result is written
590 out to your working tree file, so you do not have to manually
591 resolve it. Note that
<em>git rerere
</em> leaves the index file alone,
592 so you still need to do the final sanity checks with
<tt>git diff
</tt>
593 (or
<tt>git diff -c
</tt>) and
<em>git add
</em> when you are satisfied.
</p></div>
594 <div class=
"paragraph"><p>As a convenience measure,
<em>git merge
</em> automatically invokes
595 <em>git rerere
</em> upon exiting with a failed automerge and
<em>git rerere
</em>
596 records the hand resolve when it is a new conflict, or reuses the earlier hand
597 resolve when it is not.
<em>git commit
</em> also invokes
<em>git rerere
</em>
598 when committing a merge result. What this means is that you do
599 not have to do anything special yourself (besides enabling
600 the rerere.enabled config variable).
</p></div>
601 <div class=
"paragraph"><p>In our example, when you do the test merge, the manual
602 resolution is recorded, and it will be reused when you do the
603 actual merge later with the updated master and topic branch, as long
604 as the recorded resolution is still applicable.
</p></div>
605 <div class=
"paragraph"><p>The information
<em>git rerere
</em> records is also used when running
606 <em>git rebase
</em>. After blowing away the test merge and continuing
607 development on the topic branch:
</p></div>
608 <div class=
"listingblock">
609 <div class=
"content">
610 <pre><tt> o---*---o-------o---o topic
612 o---o---o---*---o---o---o---o master
614 $ git rebase master topic
616 o---*---o-------o---o topic
618 o---o---o---*---o---o---o---o master
</tt></pre>
620 <div class=
"paragraph"><p>you could run
<tt>git rebase master topic
</tt>, to bring yourself
621 up-to-date before your topic is ready to be sent upstream.
622 This would result in falling back to a three-way merge, and it
623 would conflict the same way as the test merge you resolved earlier.
624 <em>git rerere
</em> will be run by
<em>git rebase
</em> to help you resolve this
627 <h2 id=
"_git">GIT
</h2>
628 <div class=
"sectionbody">
629 <div class=
"paragraph"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
632 <div id=
"footer-text">
633 Last updated
2011-
07-
23 00:
49:
30 UTC