| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" | |
| "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> | |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> | |
| <head> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> | |
| <meta name="generator" content="AsciiDoc 8.4.5" /> | |
| <title>git-rerere(1)</title> | |
| <style type="text/css"> | |
| /* Debug borders */ | |
| p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { | |
| /* | |
| border: 1px solid red; | |
| */ | |
| } | |
| body { | |
| margin: 1em 5% 1em 5%; | |
| } | |
| a { | |
| color: blue; | |
| text-decoration: underline; | |
| } | |
| a:visited { | |
| color: fuchsia; | |
| } | |
| em { | |
| font-style: italic; | |
| color: navy; | |
| } | |
| strong { | |
| font-weight: bold; | |
| color: #083194; | |
| } | |
| tt { | |
| color: navy; | |
| } | |
| h1, h2, h3, h4, h5, h6 { | |
| color: #527bbd; | |
| font-family: sans-serif; | |
| margin-top: 1.2em; | |
| margin-bottom: 0.5em; | |
| line-height: 1.3; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: 2px solid silver; | |
| } | |
| h2 { | |
| padding-top: 0.5em; | |
| } | |
| h3 { | |
| float: left; | |
| } | |
| h3 + * { | |
| clear: left; | |
| } | |
| div.sectionbody { | |
| font-family: serif; | |
| margin-left: 0; | |
| } | |
| hr { | |
| border: 1px solid silver; | |
| } | |
| p { | |
| margin-top: 0.5em; | |
| margin-bottom: 0.5em; | |
| } | |
| ul, ol, li > p { | |
| margin-top: 0; | |
| } | |
| pre { | |
| padding: 0; | |
| margin: 0; | |
| } | |
| span#author { | |
| color: #527bbd; | |
| font-family: sans-serif; | |
| font-weight: bold; | |
| font-size: 1.1em; | |
| } | |
| span#email { | |
| } | |
| span#revnumber, span#revdate, span#revremark { | |
| font-family: sans-serif; | |
| } | |
| div#footer { | |
| font-family: sans-serif; | |
| font-size: small; | |
| border-top: 2px solid silver; | |
| padding-top: 0.5em; | |
| margin-top: 4.0em; | |
| } | |
| div#footer-text { | |
| float: left; | |
| padding-bottom: 0.5em; | |
| } | |
| div#footer-badges { | |
| float: right; | |
| padding-bottom: 0.5em; | |
| } | |
| div#preamble { | |
| margin-top: 1.5em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.tableblock, div.imageblock, div.exampleblock, div.verseblock, | |
| div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, | |
| div.admonitionblock { | |
| margin-top: 1.5em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.admonitionblock { | |
| margin-top: 2.5em; | |
| margin-bottom: 2.5em; | |
| } | |
| div.content { /* Block element content. */ | |
| padding: 0; | |
| } | |
| /* Block element titles. */ | |
| div.title, caption.title { | |
| color: #527bbd; | |
| font-family: sans-serif; | |
| font-weight: bold; | |
| text-align: left; | |
| margin-top: 1.0em; | |
| margin-bottom: 0.5em; | |
| } | |
| div.title + * { | |
| margin-top: 0; | |
| } | |
| td div.title:first-child { | |
| margin-top: 0.0em; | |
| } | |
| div.content div.title:first-child { | |
| margin-top: 0.0em; | |
| } | |
| div.content + div.title { | |
| margin-top: 0.0em; | |
| } | |
| div.sidebarblock > div.content { | |
| background: #ffffee; | |
| border: 1px solid silver; | |
| padding: 0.5em; | |
| } | |
| div.listingblock > div.content { | |
| border: 1px solid silver; | |
| background: #f4f4f4; | |
| padding: 0.5em; | |
| } | |
| div.quoteblock { | |
| padding-left: 2.0em; | |
| margin-right: 10%; | |
| } | |
| div.quoteblock > div.attribution { | |
| padding-top: 0.5em; | |
| text-align: right; | |
| } | |
| div.verseblock { | |
| padding-left: 2.0em; | |
| margin-right: 10%; | |
| } | |
| div.verseblock > div.content { | |
| white-space: pre; | |
| } | |
| div.verseblock > div.attribution { | |
| padding-top: 0.75em; | |
| text-align: left; | |
| } | |
| /* DEPRECATED: Pre version 8.2.7 verse style literal block. */ | |
| div.verseblock + div.attribution { | |
| text-align: left; | |
| } | |
| div.admonitionblock .icon { | |
| vertical-align: top; | |
| font-size: 1.1em; | |
| font-weight: bold; | |
| text-decoration: underline; | |
| color: #527bbd; | |
| padding-right: 0.5em; | |
| } | |
| div.admonitionblock td.content { | |
| padding-left: 0.5em; | |
| border-left: 2px solid silver; | |
| } | |
| div.exampleblock > div.content { | |
| border-left: 2px solid silver; | |
| padding: 0.5em; | |
| } | |
| div.imageblock div.content { padding-left: 0; } | |
| span.image img { border-style: none; } | |
| a.image:visited { color: white; } | |
| dl { | |
| margin-top: 0.8em; | |
| margin-bottom: 0.8em; | |
| } | |
| dt { | |
| margin-top: 0.5em; | |
| margin-bottom: 0; | |
| font-style: normal; | |
| color: navy; | |
| } | |
| dd > *:first-child { | |
| margin-top: 0.1em; | |
| } | |
| ul, ol { | |
| list-style-position: outside; | |
| } | |
| ol.arabic { | |
| list-style-type: decimal; | |
| } | |
| ol.loweralpha { | |
| list-style-type: lower-alpha; | |
| } | |
| ol.upperalpha { | |
| list-style-type: upper-alpha; | |
| } | |
| ol.lowerroman { | |
| list-style-type: lower-roman; | |
| } | |
| ol.upperroman { | |
| list-style-type: upper-roman; | |
| } | |
| div.compact ul, div.compact ol, | |
| div.compact p, div.compact p, | |
| div.compact div, div.compact div { | |
| margin-top: 0.1em; | |
| margin-bottom: 0.1em; | |
| } | |
| div.tableblock > table { | |
| border: 3px solid #527bbd; | |
| } | |
| thead { | |
| font-family: sans-serif; | |
| font-weight: bold; | |
| } | |
| tfoot { | |
| font-weight: bold; | |
| } | |
| td > div.verse { | |
| white-space: pre; | |
| } | |
| p.table { | |
| margin-top: 0; | |
| } | |
| /* Because the table frame attribute is overriden by CSS in most browsers. */ | |
| div.tableblock > table[frame="void"] { | |
| border-style: none; | |
| } | |
| div.tableblock > table[frame="hsides"] { | |
| border-left-style: none; | |
| border-right-style: none; | |
| } | |
| div.tableblock > table[frame="vsides"] { | |
| border-top-style: none; | |
| border-bottom-style: none; | |
| } | |
| div.hdlist { | |
| margin-top: 0.8em; | |
| margin-bottom: 0.8em; | |
| } | |
| div.hdlist tr { | |
| padding-bottom: 15px; | |
| } | |
| dt.hdlist1.strong, td.hdlist1.strong { | |
| font-weight: bold; | |
| } | |
| td.hdlist1 { | |
| vertical-align: top; | |
| font-style: normal; | |
| padding-right: 0.8em; | |
| color: navy; | |
| } | |
| td.hdlist2 { | |
| vertical-align: top; | |
| } | |
| div.hdlist.compact tr { | |
| margin: 0; | |
| padding-bottom: 0; | |
| } | |
| .comment { | |
| background: yellow; | |
| } | |
| @media print { | |
| div#footer-badges { display: none; } | |
| } | |
| div#toctitle { | |
| color: #527bbd; | |
| font-family: sans-serif; | |
| font-size: 1.1em; | |
| font-weight: bold; | |
| margin-top: 1.0em; | |
| margin-bottom: 0.1em; | |
| } | |
| div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { | |
| margin-top: 0; | |
| margin-bottom: 0; | |
| } | |
| div.toclevel2 { | |
| margin-left: 2em; | |
| font-size: 0.9em; | |
| } | |
| div.toclevel3 { | |
| margin-left: 4em; | |
| font-size: 0.9em; | |
| } | |
| div.toclevel4 { | |
| margin-left: 6em; | |
| font-size: 0.9em; | |
| } | |
| /* Overrides for manpage documents */ | |
| h1 { | |
| padding-top: 0.5em; | |
| padding-bottom: 0.5em; | |
| border-top: 2px solid silver; | |
| border-bottom: 2px solid silver; | |
| } | |
| h2 { | |
| border-style: none; | |
| } | |
| div.sectionbody { | |
| margin-left: 5%; | |
| } | |
| @media print { | |
| div#toc { display: none; } | |
| } | |
| /* Workarounds for IE6's broken and incomplete CSS2. */ | |
| div.sidebar-content { | |
| background: #ffffee; | |
| border: 1px solid silver; | |
| padding: 0.5em; | |
| } | |
| div.sidebar-title, div.image-title { | |
| color: #527bbd; | |
| font-family: sans-serif; | |
| font-weight: bold; | |
| margin-top: 0.0em; | |
| margin-bottom: 0.5em; | |
| } | |
| div.listingblock div.content { | |
| border: 1px solid silver; | |
| background: #f4f4f4; | |
| padding: 0.5em; | |
| } | |
| div.quoteblock-attribution { | |
| padding-top: 0.5em; | |
| text-align: right; | |
| } | |
| div.verseblock-content { | |
| white-space: pre; | |
| } | |
| div.verseblock-attribution { | |
| padding-top: 0.75em; | |
| text-align: left; | |
| } | |
| div.exampleblock-content { | |
| border-left: 2px solid silver; | |
| padding-left: 0.5em; | |
| } | |
| /* IE6 sets dynamically generated links as visited. */ | |
| div#toc a:visited { color: blue; } | |
| </style> | |
| </head> | |
| <body> | |
| <div id="header"> | |
| <h1> | |
| git-rerere(1) Manual Page | |
| </h1> | |
| <h2>NAME</h2> | |
| <div class="sectionbody"> | |
| <p>git-rerere - | |
| Reuse recorded resolution of conflicted merges | |
| </p> | |
| </div> | |
| </div> | |
| <h2 id="_synopsis">SYNOPSIS</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p><em>git rerere</em> [<em>clear</em>|<em>forget</em> [<pathspec>]|<em>diff</em>|<em>status</em>|<em>gc</em>]</p></div> | |
| </div> | |
| <h2 id="_description">DESCRIPTION</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>In a workflow employing relatively long lived topic branches, | |
| the developer sometimes needs to resolve the same conflicts over | |
| and over again until the topic branches are done (either merged | |
| to the "release" branch, or sent out and accepted upstream).</p></div> | |
| <div class="paragraph"><p>This command assists the developer in this process by recording | |
| conflicted automerge results and corresponding hand resolve results | |
| on the initial manual merge, and applying previously recorded | |
| hand resolutions to their corresponding automerge results.</p></div> | |
| <div class="admonitionblock"> | |
| <table><tr> | |
| <td class="icon"> | |
| <div class="title">Note</div> | |
| </td> | |
| <td class="content">You need to set the configuration variable rerere.enabled in order to | |
| enable this command.</td> | |
| </tr></table> | |
| </div> | |
| </div> | |
| <h2 id="_commands">COMMANDS</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>Normally, <em>git rerere</em> is run without arguments or user-intervention. | |
| However, it has several commands that allow it to interact with | |
| its working state.</p></div> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| <em>clear</em> | |
| </dt> | |
| <dd> | |
| <p> | |
| This resets the metadata used by rerere if a merge resolution is to be | |
| aborted. Calling <em>git am [--skip|--abort]</em> or <em>git rebase [--skip|--abort]</em> | |
| will automatically invoke this command. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <em>forget</em> <pathspec> | |
| </dt> | |
| <dd> | |
| <p> | |
| This resets the conflict resolutions which rerere has recorded for the current | |
| conflict in <pathspec>. The <pathspec> is optional. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <em>diff</em> | |
| </dt> | |
| <dd> | |
| <p> | |
| This displays diffs for the current state of the resolution. It is | |
| useful for tracking what has changed while the user is resolving | |
| conflicts. Additional arguments are passed directly to the system | |
| <em>diff</em> command installed in PATH. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <em>status</em> | |
| </dt> | |
| <dd> | |
| <p> | |
| Like <em>diff</em>, but this only prints the filenames that will be tracked | |
| for resolutions. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <em>gc</em> | |
| </dt> | |
| <dd> | |
| <p> | |
| This prunes records of conflicted merges that | |
| occurred a long time ago. By default, unresolved conflicts older | |
| than 15 days and resolved conflicts older than 60 | |
| days are pruned. These defaults are controlled via the | |
| <tt>gc.rerereunresolved</tt> and <tt>gc.rerereresolved</tt> configuration | |
| variables respectively. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </div> | |
| <h2 id="_discussion">DISCUSSION</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>When your topic branch modifies an overlapping area that your | |
| master branch (or upstream) touched since your topic branch | |
| forked from it, you may want to test it with the latest master, | |
| even before your topic branch is ready to be pushed upstream:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt> o---*---o topic | |
| / | |
| o---o---o---*---o---o master</tt></pre> | |
| </div></div> | |
| <div class="paragraph"><p>For such a test, you need to merge master and topic somehow. | |
| One way to do it is to pull master into the topic branch:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt> $ git checkout topic | |
| $ git merge master | |
| o---*---o---+ topic | |
| / / | |
| o---o---o---*---o---o master</tt></pre> | |
| </div></div> | |
| <div class="paragraph"><p>The commits marked with <tt>*</tt> touch the same area in the same | |
| file; you need to resolve the conflicts when creating the commit | |
| marked with <tt>+</tt>. Then you can test the result to make sure your | |
| work-in-progress still works with what is in the latest master.</p></div> | |
| <div class="paragraph"><p>After this test merge, there are two ways to continue your work | |
| on the topic. The easiest is to build on top of the test merge | |
| commit <tt>+</tt>, and when your work in the topic branch is finally | |
| ready, pull the topic branch into master, and/or ask the | |
| upstream to pull from you. By that time, however, the master or | |
| the upstream might have been advanced since the test merge <tt>+</tt>, | |
| in which case the final commit graph would look like this:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt> $ git checkout topic | |
| $ git merge master | |
| $ ... work on both topic and master branches | |
| $ git checkout master | |
| $ git merge topic | |
| o---*---o---+---o---o topic | |
| / / \ | |
| o---o---o---*---o---o---o---o---+ master</tt></pre> | |
| </div></div> | |
| <div class="paragraph"><p>When your topic branch is long-lived, however, your topic branch | |
| would end up having many such "Merge from master" commits on it, | |
| which would unnecessarily clutter the development history. | |
| Readers of the Linux kernel mailing list may remember that Linus | |
| complained about such too frequent test merges when a subsystem | |
| maintainer asked to pull from a branch full of "useless merges".</p></div> | |
| <div class="paragraph"><p>As an alternative, to keep the topic branch clean of test | |
| merges, you could blow away the test merge, and keep building on | |
| top of the tip before the test merge:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt> $ git checkout topic | |
| $ git merge master | |
| $ git reset --hard HEAD^ ;# rewind the test merge | |
| $ ... work on both topic and master branches | |
| $ git checkout master | |
| $ git merge topic | |
| o---*---o-------o---o topic | |
| / \ | |
| o---o---o---*---o---o---o---o---+ master</tt></pre> | |
| </div></div> | |
| <div class="paragraph"><p>This would leave only one merge commit when your topic branch is | |
| finally ready and merged into the master branch. This merge | |
| would require you to resolve the conflict, introduced by the | |
| commits marked with <tt>*</tt>. However, this conflict is often the | |
| same conflict you resolved when you created the test merge you | |
| blew away. <em>git rerere</em> helps you resolve this final | |
| conflicted merge using the information from your earlier hand | |
| resolve.</p></div> | |
| <div class="paragraph"><p>Running the <em>git rerere</em> command immediately after a conflicted | |
| automerge records the conflicted working tree files, with the | |
| usual conflict markers <tt><<<<<<<</tt>, <tt>=======</tt>, and <tt>>>>>>>></tt> in | |
| them. Later, after you are done resolving the conflicts, | |
| running <em>git rerere</em> again will record the resolved state of these | |
| files. Suppose you did this when you created the test merge of | |
| master into the topic branch.</p></div> | |
| <div class="paragraph"><p>Next time, after seeing the same conflicted automerge, | |
| running <em>git rerere</em> will perform a three-way merge between the | |
| earlier conflicted automerge, the earlier manual resolution, and | |
| the current conflicted automerge. | |
| If this three-way merge resolves cleanly, the result is written | |
| out to your working tree file, so you do not have to manually | |
| resolve it. Note that <em>git rerere</em> leaves the index file alone, | |
| so you still need to do the final sanity checks with <tt>git diff</tt> | |
| (or <tt>git diff -c</tt>) and <em>git add</em> when you are satisfied.</p></div> | |
| <div class="paragraph"><p>As a convenience measure, <em>git merge</em> automatically invokes | |
| <em>git rerere</em> upon exiting with a failed automerge and <em>git rerere</em> | |
| records the hand resolve when it is a new conflict, or reuses the earlier hand | |
| resolve when it is not. <em>git commit</em> also invokes <em>git rerere</em> | |
| when committing a merge result. What this means is that you do | |
| not have to do anything special yourself (besides enabling | |
| the rerere.enabled config variable).</p></div> | |
| <div class="paragraph"><p>In our example, when you do the test merge, the manual | |
| resolution is recorded, and it will be reused when you do the | |
| actual merge later with the updated master and topic branch, as long | |
| as the recorded resolution is still applicable.</p></div> | |
| <div class="paragraph"><p>The information <em>git rerere</em> records is also used when running | |
| <em>git rebase</em>. After blowing away the test merge and continuing | |
| development on the topic branch:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt> o---*---o-------o---o topic | |
| / | |
| o---o---o---*---o---o---o---o master | |
| $ git rebase master topic | |
| o---*---o-------o---o topic | |
| / | |
| o---o---o---*---o---o---o---o master</tt></pre> | |
| </div></div> | |
| <div class="paragraph"><p>you could run <tt>git rebase master topic</tt>, to bring yourself | |
| up-to-date before your topic is ready to be sent upstream. | |
| This would result in falling back to a three-way merge, and it | |
| would conflict the same way as the test merge you resolved earlier. | |
| <em>git rerere</em> will be run by <em>git rebase</em> to help you resolve this | |
| conflict.</p></div> | |
| </div> | |
| <h2 id="_git">GIT</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> | |
| </div> | |
| <div id="footer"> | |
| <div id="footer-text"> | |
| Last updated 2011-03-15 23:30:14 UTC | |
| </div> | |
| </div> | |
| </body> | |
| </html> |