git-rebase.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-rebase(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-rebase(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-rebase -\r
 269    Rebase local commits to a new head\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <p><em>git-rebase</em> [--onto &lt;newbase&gt;] &lt;upstream&gt; [&lt;branch&gt;]</p>\r
 276 <p><em>git-rebase</em> --continue</p>\r
 277 <p><em>git-rebase</em> --abort</p>\r
 278 </div>\r
 279 <h2>DESCRIPTION</h2>\r
 280 <div class="sectionbody">\r
 281 <p>git-rebase replaces &lt;branch&gt; with a new branch of the same name.  When\r
 282 the --onto option is provided the new branch starts out with a HEAD equal\r
 283 to &lt;newbase&gt;, otherwise it is equal to &lt;upstream&gt;.  It then attempts to\r
 284 create a new commit for each commit from the original &lt;branch&gt; that does\r
 285 not exist in the &lt;upstream&gt; branch.</p>\r
 286 <p>It is possible that a merge failure will prevent this process from being\r
 287 completely automatic.  You will have to resolve any such merge failure\r
 288 and run <tt>git rebase --continue</tt>.  If you can not resolve the merge\r
 289 failure, running <tt>git rebase --abort</tt> will restore the original &lt;branch&gt;\r
 290 and remove the working files found in the .dotest directory.</p>\r
 291 <p>Note that if &lt;branch&gt; is not specified on the command line, the currently\r
 292 checked out branch is used.</p>\r
 293 <p>Assume the following history exists and the current branch is "topic":</p>\r
 294 <div class="listingblock">\r
 295 <div class="content">\r
 296 <pre><tt>          A---B---C topic\r
 297          /\r
 298     D---E---F---G master</tt></pre>\r
 299 </div></div>\r
 300 <p>From this point, the result of either of the following commands:</p>\r
 301 <div class="literalblock">\r
 302 <div class="content">\r
 303 <pre><tt>git-rebase master\r
 304 git-rebase master topic</tt></pre>\r
 305 </div></div>\r
 306 <p>would be:</p>\r
 307 <div class="listingblock">\r
 308 <div class="content">\r
 309 <pre><tt>                  A'--B'--C' topic\r
 310                  /\r
 311     D---E---F---G master</tt></pre>\r
 312 </div></div>\r
 313 <p>While, starting from the same point, the result of either of the following\r
 314 commands:</p>\r
 315 <div class="literalblock">\r
 316 <div class="content">\r
 317 <pre><tt>git-rebase --onto master~1 master\r
 318 git-rebase --onto master~1 master topic</tt></pre>\r
 319 </div></div>\r
 320 <p>would be:</p>\r
 321 <div class="listingblock">\r
 322 <div class="content">\r
 323 <pre><tt>              A'--B'--C' topic\r
 324              /\r
 325     D---E---F---G master</tt></pre>\r
 326 </div></div>\r
 327 <p>In case of conflict, git-rebase will stop at the first problematic commit\r
 328 and leave conflict markers in the tree.  You can use git diff to locate\r
 329 the markers (&lt;&lt;&lt;&lt;&lt;&lt;) and make edits to resolve the conflict.  For each\r
 330 file you edit, you need to tell git that the conflict has been resolved,\r
 331 typically this would be done with</p>\r
 332 <div class="literalblock">\r
 333 <div class="content">\r
 334 <pre><tt>git update-index &lt;filename&gt;</tt></pre>\r
 335 </div></div>\r
 336 <p>After resolving the conflict manually and updating the index with the\r
 337 desired resolution, you can continue the rebasing process with</p>\r
 338 <div class="literalblock">\r
 339 <div class="content">\r
 340 <pre><tt>git rebase --continue</tt></pre>\r
 341 </div></div>\r
 342 <p>Alternatively, you can undo the git-rebase with</p>\r
 343 <div class="literalblock">\r
 344 <div class="content">\r
 345 <pre><tt>git rebase --abort</tt></pre>\r
 346 </div></div>\r
 347 </div>\r
 348 <h2>OPTIONS</h2>\r
 349 <div class="sectionbody">\r
 350 <dl>\r
 351 <dt>\r
 352 &lt;newbase&gt;\r
 353 </dt>\r
 354 <dd>\r
 355 <p>\r
 356         Starting point at which to create the new commits. If the\r
 357         --onto option is not specified, the starting point is\r
 358         &lt;upstream&gt;.\r
 359 </p>\r
 360 </dd>\r
 361 <dt>\r
 362 &lt;upstream&gt;\r
 363 </dt>\r
 364 <dd>\r
 365 <p>\r
 366         Upstream branch to compare against.\r
 367 </p>\r
 368 </dd>\r
 369 <dt>\r
 370 &lt;branch&gt;\r
 371 </dt>\r
 372 <dd>\r
 373 <p>\r
 374         Working branch; defaults to HEAD.\r
 375 </p>\r
 376 </dd>\r
 377 <dt>\r
 378 --continue\r
 379 </dt>\r
 380 <dd>\r
 381 <p>\r
 382         Restart the rebasing process after having resolved a merge conflict.\r
 383 </p>\r
 384 </dd>\r
 385 <dt>\r
 386 --abort\r
 387 </dt>\r
 388 <dd>\r
 389 <p>\r
 390         Restore the original branch and abort the rebase operation.\r
 391 </p>\r
 392 </dd>\r
 393 </dl>\r
 394 </div>\r
 395 <h2>NOTES</h2>\r
 396 <div class="sectionbody">\r
 397 <p>When you rebase a branch, you are changing its history in a way that\r
 398 will cause problems for anyone who already has a copy of the branch\r
 399 in their repository and tries to pull updates from you.  You should\r
 400 understand the implications of using <em>git rebase</em> on a repository that\r
 401 you share.</p>\r
 402 <p>When the git rebase command is run, it will first execute a "pre-rebase"\r
 403 hook if one exists.  You can use this hook to do sanity checks and\r
 404 reject the rebase if it isn't appropriate.  Please see the template\r
 405 pre-rebase hook script for an example.</p>\r
 406 <p>You must be in the top directory of your project to start (or continue)\r
 407 a rebase.  Upon completion, &lt;branch&gt; will be the current branch.</p>\r
 408 </div>\r
 409 <h2>Author</h2>\r
 410 <div class="sectionbody">\r
 411 <p>Written by Junio C Hamano &lt;junkio@cox.net&gt;</p>\r
 412 </div>\r
 413 <h2>Documentation</h2>\r
 414 <div class="sectionbody">\r
 415 <p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
 416 </div>\r
 417 <h2>GIT</h2>\r
 418 <div class="sectionbody">\r
 419 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 420 </div>\r
 421 <div id="footer">\r
 422 <div id="footer-text">\r
 423 Last updated 02-May-2006 07:27:57 UTC\r
 424 </div>\r
 425 </div>\r
 426 </body>\r
 427 </html>\r