Autogenerated HTML docs for v1.7.4-rc2-20-g8c0db6
[git/jnareb-git.git] / git-rerere.html
blob23e3980059ee06cf67c262b247d48a5d49fc103c
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.2.5" />
7 <style type="text/css">
8 /* Debug borders */
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11 border: 1px solid red;
15 body {
16 margin: 1em 5% 1em 5%;
19 a {
20 color: blue;
21 text-decoration: underline;
23 a:visited {
24 color: fuchsia;
27 em {
28 font-style: italic;
31 strong {
32 font-weight: bold;
35 tt {
36 color: navy;
39 h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
47 h1, h2, h3 {
48 border-bottom: 2px solid silver;
50 h2 {
51 padding-top: 0.5em;
53 h3 {
54 float: left;
56 h3 + * {
57 clear: left;
60 div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
65 hr {
66 border: 1px solid silver;
69 p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
74 pre {
75 padding: 0;
76 margin: 0;
79 span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
83 font-size: 1.1em;
85 span#email {
87 span#revision {
88 font-family: sans-serif;
91 div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
98 div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
102 div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
107 div#preamble,
108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110 div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
115 div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
120 div.content { /* Block element content. */
121 padding: 0;
124 /* Block element titles. */
125 div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
132 div.title + * {
133 margin-top: 0;
136 td div.title:first-child {
137 margin-top: 0.0em;
139 div.content div.title:first-child {
140 margin-top: 0.0em;
142 div.content + div.title {
143 margin-top: 0.0em;
146 div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
152 div.listingblock {
153 margin-right: 0%;
155 div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
161 div.quoteblock > div.content {
162 padding-left: 2.0em;
165 div.attribution {
166 text-align: right;
168 div.verseblock + div.attribution {
169 text-align: left;
172 div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
180 div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
185 div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
190 div.verseblock div.content {
191 white-space: pre;
194 div.imageblock div.content { padding-left: 0; }
195 div.imageblock img { border: 1px solid silver; }
196 span.image img { border-style: none; }
198 dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
202 dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
207 dd > *:first-child {
208 margin-top: 0;
211 ul, ol {
212 list-style-position: outside;
214 div.olist2 ol {
215 list-style-type: lower-alpha;
218 div.tableblock > table {
219 border: 3px solid #527bbd;
221 thead {
222 font-family: sans-serif;
223 font-weight: bold;
225 tfoot {
226 font-weight: bold;
229 div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
233 div.hlist td {
234 padding-bottom: 5px;
236 td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
241 td.hlist2 {
242 vertical-align: top;
245 @media print {
246 div#footer-badges { display: none; }
249 div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
262 div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
266 div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
270 div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
274 include1::./stylesheets/xhtml11-manpage.css[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
282 div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
289 div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
295 div.quoteblock-content {
296 padding-left: 2.0em;
299 div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc a:visited { color: blue; }
306 </style>
307 <title>git-rerere(1)</title>
308 </head>
309 <body>
310 <div id="header">
311 <h1>
312 git-rerere(1) Manual Page
313 </h1>
314 <h2>NAME</h2>
315 <div class="sectionbody">
316 <p>git-rerere -
317 Reuse recorded resolution of conflicted merges
318 </p>
319 </div>
320 </div>
321 <h2>SYNOPSIS</h2>
322 <div class="sectionbody">
323 <div class="para"><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>
324 </div>
325 <h2 id="_description">DESCRIPTION</h2>
326 <div class="sectionbody">
327 <div class="para"><p>In a workflow employing relatively long lived topic branches,
328 the developer sometimes needs to resolve the same conflicts over
329 and over again until the topic branches are done (either merged
330 to the "release" branch, or sent out and accepted upstream).</p></div>
331 <div class="para"><p>This command assists the developer in this process by recording
332 conflicted automerge results and corresponding hand resolve results
333 on the initial manual merge, and applying previously recorded
334 hand resolutions to their corresponding automerge results.</p></div>
335 <div class="admonitionblock">
336 <table><tr>
337 <td class="icon">
338 <div class="title">Note</div>
339 </td>
340 <td class="content">You need to set the configuration variable rerere.enabled in order to
341 enable this command.</td>
342 </tr></table>
343 </div>
344 </div>
345 <h2 id="_commands">COMMANDS</h2>
346 <div class="sectionbody">
347 <div class="para"><p>Normally, <em>git rerere</em> is run without arguments or user-intervention.
348 However, it has several commands that allow it to interact with
349 its working state.</p></div>
350 <div class="vlist"><dl>
351 <dt>
352 <em>clear</em>
353 </dt>
354 <dd>
356 This resets the metadata used by rerere if a merge resolution is to be
357 aborted. Calling <em>git am [--skip|--abort]</em> or <em>git rebase [--skip|--abort]</em>
358 will automatically invoke this command.
359 </p>
360 </dd>
361 <dt>
362 <em>forget</em> &lt;pathspec&gt;
363 </dt>
364 <dd>
366 This resets the conflict resolutions which rerere has recorded for the current
367 conflict in &lt;pathspec&gt;. The &lt;pathspec&gt; is optional.
368 </p>
369 </dd>
370 <dt>
371 <em>diff</em>
372 </dt>
373 <dd>
375 This displays diffs for the current state of the resolution. It is
376 useful for tracking what has changed while the user is resolving
377 conflicts. Additional arguments are passed directly to the system
378 <em>diff</em> command installed in PATH.
379 </p>
380 </dd>
381 <dt>
382 <em>status</em>
383 </dt>
384 <dd>
386 Like <em>diff</em>, but this only prints the filenames that will be tracked
387 for resolutions.
388 </p>
389 </dd>
390 <dt>
391 <em>gc</em>
392 </dt>
393 <dd>
395 This prunes records of conflicted merges that
396 occurred a long time ago. By default, unresolved conflicts older
397 than 15 days and resolved conflicts older than 60
398 days are pruned. These defaults are controlled via the
399 <tt>gc.rerereunresolved</tt> and <tt>gc.rerereresolved</tt> configuration
400 variables respectively.
401 </p>
402 </dd>
403 </dl></div>
404 </div>
405 <h2 id="_discussion">DISCUSSION</h2>
406 <div class="sectionbody">
407 <div class="para"><p>When your topic branch modifies an overlapping area that your
408 master branch (or upstream) touched since your topic branch
409 forked from it, you may want to test it with the latest master,
410 even before your topic branch is ready to be pushed upstream:</p></div>
411 <div class="listingblock">
412 <div class="content">
413 <pre><tt> o---*---o topic
415 o---o---o---*---o---o master</tt></pre>
416 </div></div>
417 <div class="para"><p>For such a test, you need to merge master and topic somehow.
418 One way to do it is to pull master into the topic branch:</p></div>
419 <div class="listingblock">
420 <div class="content">
421 <pre><tt> $ git checkout topic
422 $ git merge master
424 o---*---o---+ topic
426 o---o---o---*---o---o master</tt></pre>
427 </div></div>
428 <div class="para"><p>The commits marked with <tt>*</tt> touch the same area in the same
429 file; you need to resolve the conflicts when creating the commit
430 marked with <tt>&#43;</tt>. Then you can test the result to make sure your
431 work-in-progress still works with what is in the latest master.</p></div>
432 <div class="para"><p>After this test merge, there are two ways to continue your work
433 on the topic. The easiest is to build on top of the test merge
434 commit <tt>&#43;</tt>, and when your work in the topic branch is finally
435 ready, pull the topic branch into master, and/or ask the
436 upstream to pull from you. By that time, however, the master or
437 the upstream might have been advanced since the test merge <tt>&#43;</tt>,
438 in which case the final commit graph would look like this:</p></div>
439 <div class="listingblock">
440 <div class="content">
441 <pre><tt> $ git checkout topic
442 $ git merge master
443 $ ... work on both topic and master branches
444 $ git checkout master
445 $ git merge topic
447 o---*---o---+---o---o topic
448 / / \
449 o---o---o---*---o---o---o---o---+ master</tt></pre>
450 </div></div>
451 <div class="para"><p>When your topic branch is long-lived, however, your topic branch
452 would end up having many such "Merge from master" commits on it,
453 which would unnecessarily clutter the development history.
454 Readers of the Linux kernel mailing list may remember that Linus
455 complained about such too frequent test merges when a subsystem
456 maintainer asked to pull from a branch full of "useless merges".</p></div>
457 <div class="para"><p>As an alternative, to keep the topic branch clean of test
458 merges, you could blow away the test merge, and keep building on
459 top of the tip before the test merge:</p></div>
460 <div class="listingblock">
461 <div class="content">
462 <pre><tt> $ git checkout topic
463 $ git merge master
464 $ git reset --hard HEAD^ ;# rewind the test merge
465 $ ... work on both topic and master branches
466 $ git checkout master
467 $ git merge topic
469 o---*---o-------o---o topic
471 o---o---o---*---o---o---o---o---+ master</tt></pre>
472 </div></div>
473 <div class="para"><p>This would leave only one merge commit when your topic branch is
474 finally ready and merged into the master branch. This merge
475 would require you to resolve the conflict, introduced by the
476 commits marked with <tt>*</tt>. However, this conflict is often the
477 same conflict you resolved when you created the test merge you
478 blew away. <em>git rerere</em> helps you resolve this final
479 conflicted merge using the information from your earlier hand
480 resolve.</p></div>
481 <div class="para"><p>Running the <em>git rerere</em> command immediately after a conflicted
482 automerge records the conflicted working tree files, with the
483 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
484 them. Later, after you are done resolving the conflicts,
485 running <em>git rerere</em> again will record the resolved state of these
486 files. Suppose you did this when you created the test merge of
487 master into the topic branch.</p></div>
488 <div class="para"><p>Next time, after seeing the same conflicted automerge,
489 running <em>git rerere</em> will perform a three-way merge between the
490 earlier conflicted automerge, the earlier manual resolution, and
491 the current conflicted automerge.
492 If this three-way merge resolves cleanly, the result is written
493 out to your working tree file, so you do not have to manually
494 resolve it. Note that <em>git rerere</em> leaves the index file alone,
495 so you still need to do the final sanity checks with <tt>git diff</tt>
496 (or <tt>git diff -c</tt>) and <em>git add</em> when you are satisfied.</p></div>
497 <div class="para"><p>As a convenience measure, <em>git merge</em> automatically invokes
498 <em>git rerere</em> upon exiting with a failed automerge and <em>git rerere</em>
499 records the hand resolve when it is a new conflict, or reuses the earlier hand
500 resolve when it is not. <em>git commit</em> also invokes <em>git rerere</em>
501 when committing a merge result. What this means is that you do
502 not have to do anything special yourself (besides enabling
503 the rerere.enabled config variable).</p></div>
504 <div class="para"><p>In our example, when you do the test merge, the manual
505 resolution is recorded, and it will be reused when you do the
506 actual merge later with the updated master and topic branch, as long
507 as the recorded resolution is still applicable.</p></div>
508 <div class="para"><p>The information <em>git rerere</em> records is also used when running
509 <em>git rebase</em>. After blowing away the test merge and continuing
510 development on the topic branch:</p></div>
511 <div class="listingblock">
512 <div class="content">
513 <pre><tt> o---*---o-------o---o topic
515 o---o---o---*---o---o---o---o master
517 $ git rebase master topic
519 o---*---o-------o---o topic
521 o---o---o---*---o---o---o---o master</tt></pre>
522 </div></div>
523 <div class="para"><p>you could run <tt>git rebase master topic</tt>, to bring yourself
524 up-to-date before your topic is ready to be sent upstream.
525 This would result in falling back to a three-way merge, and it
526 would conflict the same way as the test merge you resolved earlier.
527 <em>git rerere</em> will be run by <em>git rebase</em> to help you resolve this
528 conflict.</p></div>
529 </div>
530 <h2 id="_author">Author</h2>
531 <div class="sectionbody">
532 <div class="para"><p>Written by Junio C Hamano &lt;gitster@pobox.com&gt;</p></div>
533 </div>
534 <h2 id="_git">GIT</h2>
535 <div class="sectionbody">
536 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
537 </div>
538 <div id="footer">
539 <div id="footer-text">
540 Last updated 2010-09-18 23:56:55 UTC
541 </div>
542 </div>
543 </body>
544 </html>