git-rerere.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 7.0.2" />\r
   7 <style type="text/css">\r
   8 /* Debug borders */\r
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
  10 /*\r
  11   border: 1px solid red;\r
  12 */\r
  13 }\r
  14 \r
  15 body {\r
  16   margin: 1em 5% 1em 5%;\r
  17 }\r
  18 \r
  19 a { color: blue; }\r
  20 a:visited { color: fuchsia; }\r
  21 \r
  22 em {\r
  23   font-style: italic;\r
  24 }\r
  25 \r
  26 strong {\r
  27   font-weight: bold;\r
  28 }\r
  29 \r
  30 tt {\r
  31   color: navy;\r
  32 }\r
  33 \r
  34 h1, h2, h3, h4, h5, h6 {\r
  35   color: #527bbd;\r
  36   font-family: sans-serif;\r
  37   margin-top: 1.2em;\r
  38   margin-bottom: 0.5em;\r
  39   line-height: 1.3;\r
  40 }\r
  41 \r
  42 h1 {\r
  43   border-bottom: 2px solid silver;\r
  44 }\r
  45 h2 {\r
  46   border-bottom: 2px solid silver;\r
  47   padding-top: 0.5em;\r
  48 }\r
  49 \r
  50 div.sectionbody {\r
  51   font-family: serif;\r
  52   margin-left: 0;\r
  53 }\r
  54 \r
  55 hr {\r
  56   border: 1px solid silver;\r
  57 }\r
  58 \r
  59 p {\r
  60   margin-top: 0.5em;\r
  61   margin-bottom: 0.5em;\r
  62 }\r
  63 \r
  64 pre {\r
  65   padding: 0;\r
  66   margin: 0;\r
  67 }\r
  68 \r
  69 span#author {\r
  70   color: #527bbd;\r
  71   font-family: sans-serif;\r
  72   font-weight: bold;\r
  73   font-size: 1.2em;\r
  74 }\r
  75 span#email {\r
  76 }\r
  77 span#revision {\r
  78   font-family: sans-serif;\r
  79 }\r
  80 \r
  81 div#footer {\r
  82   font-family: sans-serif;\r
  83   font-size: small;\r
  84   border-top: 2px solid silver;\r
  85   padding-top: 0.5em;\r
  86   margin-top: 4.0em;\r
  87 }\r
  88 div#footer-text {\r
  89   float: left;\r
  90   padding-bottom: 0.5em;\r
  91 }\r
  92 div#footer-badges {\r
  93   float: right;\r
  94   padding-bottom: 0.5em;\r
  95 }\r
  96 \r
  97 div#preamble,\r
  98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
  99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 100 div.admonitionblock {\r
 101   margin-right: 10%;\r
 102   margin-top: 1.5em;\r
 103   margin-bottom: 1.5em;\r
 104 }\r
 105 div.admonitionblock {\r
 106   margin-top: 2.5em;\r
 107   margin-bottom: 2.5em;\r
 108 }\r
 109 \r
 110 div.content { /* Block element content. */\r
 111   padding: 0;\r
 112 }\r
 113 \r
 114 /* Block element titles. */\r
 115 div.title, caption.title {\r
 116   font-family: sans-serif;\r
 117   font-weight: bold;\r
 118   text-align: left;\r
 119   margin-top: 1.0em;\r
 120   margin-bottom: 0.5em;\r
 121 }\r
 122 div.title + * {\r
 123   margin-top: 0;\r
 124 }\r
 125 \r
 126 td div.title:first-child {\r
 127   margin-top: 0.0em;\r
 128 }\r
 129 div.content div.title:first-child {\r
 130   margin-top: 0.0em;\r
 131 }\r
 132 div.content + div.title {\r
 133   margin-top: 0.0em;\r
 134 }\r
 135 \r
 136 div.sidebarblock > div.content {\r
 137   background: #ffffee;\r
 138   border: 1px solid silver;\r
 139   padding: 0.5em;\r
 140 }\r
 141 \r
 142 div.listingblock > div.content {\r
 143   border: 1px solid silver;\r
 144   background: #f4f4f4;\r
 145   padding: 0.5em;\r
 146 }\r
 147 \r
 148 div.quoteblock > div.content {\r
 149   padding-left: 2.0em;\r
 150 }\r
 151 div.quoteblock .attribution {\r
 152   text-align: right;\r
 153 }\r
 154 \r
 155 div.admonitionblock .icon {\r
 156   vertical-align: top;\r
 157   font-size: 1.1em;\r
 158   font-weight: bold;\r
 159   text-decoration: underline;\r
 160   color: #527bbd;\r
 161   padding-right: 0.5em;\r
 162 }\r
 163 div.admonitionblock td.content {\r
 164   padding-left: 0.5em;\r
 165   border-left: 2px solid silver;\r
 166 }\r
 167 \r
 168 div.exampleblock > div.content {\r
 169   border-left: 2px solid silver;\r
 170   padding: 0.5em;\r
 171 }\r
 172 \r
 173 div.verseblock div.content {\r
 174   white-space: pre;\r
 175 }\r
 176 \r
 177 div.imageblock div.content { padding-left: 0; }\r
 178 div.imageblock img { border: 1px solid silver; }\r
 179 span.image img { border-style: none; }\r
 180 \r
 181 dl {\r
 182   margin-top: 0.8em;\r
 183   margin-bottom: 0.8em;\r
 184 }\r
 185 dt {\r
 186   margin-top: 0.5em;\r
 187   margin-bottom: 0;\r
 188   font-style: italic;\r
 189 }\r
 190 dd > *:first-child {\r
 191   margin-top: 0;\r
 192 }\r
 193 \r
 194 ul, ol {\r
 195     list-style-position: outside;\r
 196 }\r
 197 ol.olist2 {\r
 198   list-style-type: lower-alpha;\r
 199 }\r
 200 \r
 201 div.tableblock > table {\r
 202   border-color: #527bbd;\r
 203   border-width: 3px;\r
 204 }\r
 205 thead {\r
 206   font-family: sans-serif;\r
 207   font-weight: bold;\r
 208 }\r
 209 tfoot {\r
 210   font-weight: bold;\r
 211 }\r
 212 \r
 213 div.hlist {\r
 214   margin-top: 0.8em;\r
 215   margin-bottom: 0.8em;\r
 216 }\r
 217 td.hlist1 {\r
 218   vertical-align: top;\r
 219   font-style: italic;\r
 220   padding-right: 0.8em;\r
 221 }\r
 222 td.hlist2 {\r
 223   vertical-align: top;\r
 224 }\r
 225 \r
 226 @media print {\r
 227   div#footer-badges { display: none; }\r
 228 }\r
 229 include::./stylesheets/xhtml11-manpage.css[]\r
 230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
 231 \r
 232 div.sidebar-content {\r
 233   background: #ffffee;\r
 234   border: 1px solid silver;\r
 235   padding: 0.5em;\r
 236 }\r
 237 div.sidebar-title, div.image-title {\r
 238   font-family: sans-serif;\r
 239   font-weight: bold;\r
 240   margin-top: 0.0em;\r
 241   margin-bottom: 0.5em;\r
 242 }\r
 243 \r
 244 div.listingblock div.content {\r
 245   border: 1px solid silver;\r
 246   background: #f4f4f4;\r
 247   padding: 0.5em;\r
 248 }\r
 249 \r
 250 div.quoteblock-content {\r
 251   padding-left: 2.0em;\r
 252 }\r
 253 \r
 254 div.exampleblock-content {\r
 255   border-left: 2px solid silver;\r
 256   padding-left: 0.5em;\r
 257 }\r
 258 </style>\r
 259 <title>git-rerere(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-rerere(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-rerere -\r
 269    Reuse recorded resolve\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <p><em>git-rerere</em></p>\r
 276 </div>\r
 277 <h2>DESCRIPTION</h2>\r
 278 <div class="sectionbody">\r
 279 <p>In a workflow that employs relatively long lived topic branches,\r
 280 the developer sometimes needs to resolve the same conflict over\r
 281 and over again until the topic branches are done (either merged\r
 282 to the "release" branch, or sent out and accepted upstream).</p>\r
 283 <p>This command helps this process by recording conflicted\r
 284 automerge results and corresponding hand-resolve results on the\r
 285 initial manual merge, and later by noticing the same automerge\r
 286 results and applying the previously recorded hand resolution.</p>\r
 287 <div class="admonitionblock">\r
 288 <table><tr>\r
 289 <td class="icon">\r
 290 <div class="title">Note</div>\r
 291 </td>\r
 292 <td class="content">You need to create <tt>$GIT_DIR/rr-cache</tt> directory to enable this\r
 293 command.</td>\r
 294 </tr></table>\r
 295 </div>\r
 296 </div>\r
 297 <h2>DISCUSSION</h2>\r
 298 <div class="sectionbody">\r
 299 <p>When your topic branch modifies overlapping area that your\r
 300 master branch (or upstream) touched since your topic branch\r
 301 forked from it, you may want to test it with the latest master,\r
 302 even before your topic branch is ready to be pushed upstream:</p>\r
 303 <div class="listingblock">\r
 304 <div class="content">\r
 305 <pre><tt>              o---*---o topic\r
 306              /\r
 307     o---o---o---*---o---o master</tt></pre>\r
 308 </div></div>\r
 309 <p>For such a test, you need to merge master and topic somehow.\r
 310 One way to do it is to pull master into the topic branch:</p>\r
 311 <div class="listingblock">\r
 312 <div class="content">\r
 313 <pre><tt>        $ git checkout topic\r
 314         $ git pull . master\r
 315 \r
 316               o---*---o---+ topic\r
 317              /           /\r
 318     o---o---o---*---o---o master</tt></pre>\r
 319 </div></div>\r
 320 <p>The commits marked with <tt>*</tt> touch the same area in the same\r
 321 file; you need to resolve the conflicts when creating the commit\r
 322 marked with <tt>+</tt>.  Then you can test the result to make sure your\r
 323 work-in-progress still works with what is in the latest master.</p>\r
 324 <p>After this test merge, there are two ways to continue your work\r
 325 on the topic.  The easiest is to build on top of the test merge\r
 326 commit <tt>+</tt>, and when your work in the topic branch is finally\r
 327 ready, pull the topic branch into master, and/or ask the\r
 328 upstream to pull from you.  By that time, however, the master or\r
 329 the upstream might have been advanced since the test merge <tt>+</tt>,\r
 330 in which case the final commit graph would look like this:</p>\r
 331 <div class="listingblock">\r
 332 <div class="content">\r
 333 <pre><tt>        $ git checkout topic\r
 334         $ git pull . master\r
 335         $ ... work on both topic and master branches\r
 336         $ git checkout master\r
 337         $ git pull . topic\r
 338 \r
 339               o---*---o---+---o---o topic\r
 340              /           /         \\r
 341     o---o---o---*---o---o---o---o---+ master</tt></pre>\r
 342 </div></div>\r
 343 <p>When your topic branch is long-lived, however, your topic branch\r
 344 would end up having many such "Merge from master" commits on it,\r
 345 which would unnecessarily clutter the development history.\r
 346 Readers of the Linux kernel mailing list may remember that Linus\r
 347 complained about such too frequent test merges when a subsystem\r
 348 maintainer asked to pull from a branch full of "useless merges".</p>\r
 349 <p>As an alternative, to keep the topic branch clean of test\r
 350 merges, you could blow away the test merge, and keep building on\r
 351 top of the tip before the test merge:</p>\r
 352 <div class="listingblock">\r
 353 <div class="content">\r
 354 <pre><tt>        $ git checkout topic\r
 355         $ git pull . master\r
 356         $ git reset --hard HEAD^ ;# rewind the test merge\r
 357         $ ... work on both topic and master branches\r
 358         $ git checkout master\r
 359         $ git pull . topic\r
 360 \r
 361               o---*---o-------o---o topic\r
 362              /                     \\r
 363     o---o---o---*---o---o---o---o---+ master</tt></pre>\r
 364 </div></div>\r
 365 <p>This would leave only one merge commit when your topic branch is\r
 366 finally ready and merged into the master branch.  This merge\r
 367 would require you to resolve the conflict, introduced by the\r
 368 commits marked with <tt>*</tt>.  However, often this conflict is the\r
 369 same conflict you resolved when you created the test merge you\r
 370 blew away.  <tt>git-rerere</tt> command helps you to resolve this final\r
 371 conflicted merge using the information from your earlier hand\r
 372 resolve.</p>\r
 373 <p>Running <tt>git-rerere</tt> command immediately after a conflicted\r
 374 automerge records the conflicted working tree files, with the\r
 375 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\r
 376 them.  Later, after you are done resolving the conflicts,\r
 377 running <tt>git-rerere</tt> again records the resolved state of these\r
 378 files.  Suppose you did this when you created the test merge of\r
 379 master into the topic branch.</p>\r
 380 <p>Next time, running <tt>git-rerere</tt> after seeing a conflicted\r
 381 automerge, if the conflict is the same as the earlier one\r
 382 recorded, it is noticed and a three-way merge between the\r
 383 earlier conflicted automerge, the earlier manual resolution, and\r
 384 the current conflicted automerge is performed by the command.\r
 385 If this three-way merge resolves cleanly, the result is written\r
 386 out to your working tree file, so you would not have to manually\r
 387 resolve it.  Note that <tt>git-rerere</tt> leaves the index file alone,\r
 388 so you still need to do the final sanity checks with <tt>git diff</tt>\r
 389 (or <tt>git diff -c</tt>) and <tt>git update-index</tt> when you are\r
 390 satisfied.</p>\r
 391 <p>As a convenience measure, <tt>git-merge</tt> automatically invokes\r
 392 <tt>git-rerere</tt> when it exits with a failed automerge, which\r
 393 records it if it is a new conflict, or reuses the earlier hand\r
 394 resolve when it is not.  <tt>git-commit</tt> also invokes <tt>git-rerere</tt>\r
 395 when recording a merge result.  What this means is that you do\r
 396 not have to do anything special yourself (Note: you still have\r
 397 to create <tt>$GIT_DIR/rr-cache</tt> directory to enable this command).</p>\r
 398 <p>In our example, when you did the test merge, the manual\r
 399 resolution is recorded, and it will be reused when you do the\r
 400 actual merge later with updated master and topic branch, as long\r
 401 as the earlier resolution is still applicable.</p>\r
 402 <p>The information <tt>git-rerere</tt> records is also used when running\r
 403 <tt>git-rebase</tt>.  After blowing away the test merge and continuing\r
 404 development on the topic branch:</p>\r
 405 <div class="listingblock">\r
 406 <div class="content">\r
 407 <pre><tt>              o---*---o-------o---o topic\r
 408              /\r
 409     o---o---o---*---o---o---o---o   master\r
 410 \r
 411         $ git rebase master topic\r
 412 \r
 413                                   o---*---o-------o---o topic\r
 414                                  /\r
 415     o---o---o---*---o---o---o---o   master</tt></pre>\r
 416 </div></div>\r
 417 <p>you could run <tt>git rebase master topic</tt>, to keep yourself\r
 418 up-to-date even before your topic is ready to be sent upstream.\r
 419 This would result in falling back to three-way merge, and it\r
 420 would conflict the same way the test merge you resolved earlier.\r
 421 <tt>git-rerere</tt> is run by <tt>git rebase</tt> to help you resolve this\r
 422 conflict.</p>\r
 423 </div>\r
 424 <h2>Author</h2>\r
 425 <div class="sectionbody">\r
 426 <p>Written by Junio C Hamano &lt;junkio@cox.net&gt;</p>\r
 427 </div>\r
 428 <h2>GIT</h2>\r
 429 <div class="sectionbody">\r
 430 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 431 </div>\r
 432 <div id="footer">\r
 433 <div id="footer-text">\r
 434 Last updated 07-Feb-2006 08:04:31 UTC\r
 435 </div>\r
 436 </div>\r
 437 </body>\r
 438 </html>\r