doc/source/en/TortoiseGit/git_doc/git-rebase.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">\r
   3 \r
   4 <sect2 lang="en" id="git-rebase(1)">\r
   5     <title>git-rebase(1)</title>\r
   6 <indexterm>\r
   7 <primary>git-rebase(1)</primary>\r
   8 </indexterm>\r
   9 <simplesect id="git-rebase(1)__name">\r
  10 <title>NAME</title>\r
  11 <simpara>git-rebase - Reapply commits on top of another base tip</simpara>\r
  12 </simplesect>\r
  13 <simplesect id="git-rebase(1)__synopsis">\r
  14 <title>SYNOPSIS</title>\r
  15 <blockquote>\r
  16 <literallayout><emphasis>git rebase</emphasis> [-i | --interactive] [&lt;options&gt;] [--exec &lt;cmd&gt;]\r
  17         [--onto &lt;newbase&gt; | --keep-base] [&lt;upstream&gt; [&lt;branch&gt;]]\r
  18 <emphasis>git rebase</emphasis> [-i | --interactive] [&lt;options&gt;] [--exec &lt;cmd&gt;] [--onto &lt;newbase&gt;]\r
  19         --root [&lt;branch&gt;]\r
  20 <emphasis>git rebase</emphasis> (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)</literallayout>\r
  21 </blockquote>\r
  22 </simplesect>\r
  23 <simplesect id="git-rebase(1)__description">\r
  24 <title>DESCRIPTION</title>\r
  25 <simpara>If &lt;branch&gt; is specified, <emphasis>git rebase</emphasis> will perform an automatic\r
  26 <emphasis>git switch &lt;branch&gt;</emphasis> before doing anything else.  Otherwise\r
  27 it remains on the current branch.</simpara>\r
  28 <simpara>If &lt;upstream&gt; is not specified, the upstream configured in\r
  29 branch.&lt;name&gt;.remote and branch.&lt;name&gt;.merge options will be used (see\r
  30 <xref linkend="git-config(1)" /> for details) and the <emphasis>--fork-point</emphasis> option is\r
  31 assumed.  If you are currently not on any branch or if the current\r
  32 branch does not have a configured upstream, the rebase will abort.</simpara>\r
  33 <simpara>All changes made by commits in the current branch but that are not\r
  34 in &lt;upstream&gt; are saved to a temporary area.  This is the same set\r
  35 of commits that would be shown by <emphasis>git log &lt;upstream&gt;..HEAD</emphasis>; or by\r
  36 <emphasis>git log 'fork_point'..HEAD</emphasis>, if <emphasis>--fork-point</emphasis> is active (see the\r
  37 description on <emphasis>--fork-point</emphasis> below); or by <emphasis>git log HEAD</emphasis>, if the\r
  38 <emphasis>--root</emphasis> option is specified.</simpara>\r
  39 <simpara>The current branch is reset to &lt;upstream&gt;, or &lt;newbase&gt; if the\r
  40 --onto option was supplied.  This has the exact same effect as\r
  41 <emphasis>git reset --hard &lt;upstream&gt;</emphasis> (or &lt;newbase&gt;).  ORIG_HEAD is set\r
  42 to point at the tip of the branch before the reset.</simpara>\r
  43 <simpara>The commits that were previously saved into the temporary area are\r
  44 then reapplied to the current branch, one by one, in order. Note that\r
  45 any commits in HEAD which introduce the same textual changes as a commit\r
  46 in HEAD..&lt;upstream&gt; are omitted (i.e., a patch already accepted upstream\r
  47 with a different commit message or timestamp will be skipped).</simpara>\r
  48 <simpara>It is possible that a merge failure will prevent this process from being\r
  49 completely automatic.  You will have to resolve any such merge failure\r
  50 and run <emphasis>git rebase --continue</emphasis>.  Another option is to bypass the commit\r
  51 that caused the merge failure with <emphasis>git rebase --skip</emphasis>.  To check out the\r
  52 original &lt;branch&gt; and remove the .git/rebase-apply working files, use the\r
  53 command <emphasis>git rebase --abort</emphasis> instead.</simpara>\r
  54 <simpara>Assume the following history exists and the current branch is "topic":</simpara>\r
  55 <screen>          A---B---C topic\r
  56          /\r
  57     D---E---F---G master</screen>\r
  58 <simpara>From this point, the result of either of the following commands:</simpara>\r
  59 <literallayout class="monospaced">git rebase master\r
  60 git rebase master topic</literallayout>\r
  61 <simpara>would be:</simpara>\r
  62 <screen>                  A'--B'--C' topic\r
  63                  /\r
  64     D---E---F---G master</screen>\r
  65 <simpara><emphasis role="strong">NOTE:</emphasis> The latter form is just a short-hand of <emphasis>git checkout topic</emphasis>\r
  66 followed by <emphasis>git rebase master</emphasis>. When rebase exits <emphasis>topic</emphasis> will\r
  67 remain the checked-out branch.</simpara>\r
  68 <simpara>If the upstream branch already contains a change you have made (e.g.,\r
  69 because you mailed a patch which was applied upstream), then that commit\r
  70 will be skipped. For example, running <emphasis>git rebase master</emphasis> on the\r
  71 following history (in which <emphasis>A'</emphasis> and <emphasis>A</emphasis> introduce the same set of changes,\r
  72 but have different committer information):</simpara>\r
  73 <screen>          A---B---C topic\r
  74          /\r
  75     D---E---A'---F master</screen>\r
  76 <simpara>will result in:</simpara>\r
  77 <screen>                   B'---C' topic\r
  78                   /\r
  79     D---E---A'---F master</screen>\r
  80 <simpara>Here is how you would transplant a topic branch based on one\r
  81 branch to another, to pretend that you forked the topic branch\r
  82 from the latter branch, using <emphasis>rebase --onto</emphasis>.</simpara>\r
  83 <simpara>First let's assume your <emphasis>topic</emphasis> is based on branch <emphasis>next</emphasis>.\r
  84 For example, a feature developed in <emphasis>topic</emphasis> depends on some\r
  85 functionality which is found in <emphasis>next</emphasis>.</simpara>\r
  86 <screen>    o---o---o---o---o  master\r
  87          \\r
  88           o---o---o---o---o  next\r
  89                            \\r
  90                             o---o---o  topic</screen>\r
  91 <simpara>We want to make <emphasis>topic</emphasis> forked from branch <emphasis>master</emphasis>; for example,\r
  92 because the functionality on which <emphasis>topic</emphasis> depends was merged into the\r
  93 more stable <emphasis>master</emphasis> branch. We want our tree to look like this:</simpara>\r
  94 <screen>    o---o---o---o---o  master\r
  95         |            \\r
  96         |             o'--o'--o'  topic\r
  97          \\r
  98           o---o---o---o---o  next</screen>\r
  99 <simpara>We can get this using the following command:</simpara>\r
 100 <literallayout class="monospaced">git rebase --onto master next topic</literallayout>\r
 101 <simpara>Another example of --onto option is to rebase part of a\r
 102 branch.  If we have the following situation:</simpara>\r
 103 <screen>                            H---I---J topicB\r
 104                            /\r
 105                   E---F---G  topicA\r
 106                  /\r
 107     A---B---C---D  master</screen>\r
 108 <simpara>then the command</simpara>\r
 109 <literallayout class="monospaced">git rebase --onto master topicA topicB</literallayout>\r
 110 <simpara>would result in:</simpara>\r
 111 <screen>                 H'--I'--J'  topicB\r
 112                 /\r
 113                 | E---F---G  topicA\r
 114                 |/\r
 115     A---B---C---D  master</screen>\r
 116 <simpara>This is useful when topicB does not depend on topicA.</simpara>\r
 117 <simpara>A range of commits could also be removed with rebase.  If we have\r
 118 the following situation:</simpara>\r
 119 <screen>    E---F---G---H---I---J  topicA</screen>\r
 120 <simpara>then the command</simpara>\r
 121 <literallayout class="monospaced">git rebase --onto topicA~5 topicA~3 topicA</literallayout>\r
 122 <simpara>would result in the removal of commits F and G:</simpara>\r
 123 <screen>    E---H'---I'---J'  topicA</screen>\r
 124 <simpara>This is useful if F and G were flawed in some way, or should not be\r
 125 part of topicA.  Note that the argument to --onto and the &lt;upstream&gt;\r
 126 parameter can be any valid commit-ish.</simpara>\r
 127 <simpara>In case of conflict, <emphasis>git rebase</emphasis> will stop at the first problematic commit\r
 128 and leave conflict markers in the tree.  You can use <emphasis>git diff</emphasis> to locate\r
 129 the markers (&lt;&lt;&lt;&lt;&lt;&lt;) and make edits to resolve the conflict.  For each\r
 130 file you edit, you need to tell Git that the conflict has been resolved,\r
 131 typically this would be done with</simpara>\r
 132 <literallayout class="monospaced">git add &lt;filename&gt;</literallayout>\r
 133 <simpara>After resolving the conflict manually and updating the index with the\r
 134 desired resolution, you can continue the rebasing process with</simpara>\r
 135 <literallayout class="monospaced">git rebase --continue</literallayout>\r
 136 <simpara>Alternatively, you can undo the <emphasis>git rebase</emphasis> with</simpara>\r
 137 <literallayout class="monospaced">git rebase --abort</literallayout>\r
 138 </simplesect>\r
 139 <simplesect id="git-rebase(1)__configuration">\r
 140 <title>CONFIGURATION</title>\r
 141 <variablelist>\r
 142 <varlistentry>\r
 143 <term>\r
 144 rebase.useBuiltin\r
 145 </term>\r
 146 <listitem>\r
 147 <simpara>\r
 148         Unused configuration variable. Used in Git versions 2.20 and\r
 149         2.21 as an escape hatch to enable the legacy shellscript\r
 150         implementation of rebase. Now the built-in rewrite of it in C\r
 151         is always used. Setting this will emit a warning, to alert any\r
 152         remaining users that setting this now does nothing.\r
 153 </simpara>\r
 154 </listitem>\r
 155 </varlistentry>\r
 156 <varlistentry>\r
 157 <term>\r
 158 rebase.backend\r
 159 </term>\r
 160 <listitem>\r
 161 <simpara>\r
 162         Default backend to use for rebasing.  Possible choices are\r
 163         <emphasis>apply</emphasis> or <emphasis>merge</emphasis>.  In the future, if the merge backend gains\r
 164         all remaining capabilities of the apply backend, this setting\r
 165         may become unused.\r
 166 </simpara>\r
 167 </listitem>\r
 168 </varlistentry>\r
 169 <varlistentry>\r
 170 <term>\r
 171 rebase.stat\r
 172 </term>\r
 173 <listitem>\r
 174 <simpara>\r
 175         Whether to show a diffstat of what changed upstream since the last\r
 176         rebase. False by default.\r
 177 </simpara>\r
 178 </listitem>\r
 179 </varlistentry>\r
 180 <varlistentry>\r
 181 <term>\r
 182 rebase.autoSquash\r
 183 </term>\r
 184 <listitem>\r
 185 <simpara>\r
 186         If set to true enable <emphasis>--autosquash</emphasis> option by default.\r
 187 </simpara>\r
 188 </listitem>\r
 189 </varlistentry>\r
 190 <varlistentry>\r
 191 <term>\r
 192 rebase.autoStash\r
 193 </term>\r
 194 <listitem>\r
 195 <simpara>\r
 196         When set to true, automatically create a temporary stash entry\r
 197         before the operation begins, and apply it after the operation\r
 198         ends.  This means that you can run rebase on a dirty worktree.\r
 199         However, use with care: the final stash application after a\r
 200         successful rebase might result in non-trivial conflicts.\r
 201         This option can be overridden by the <emphasis>--no-autostash</emphasis> and\r
 202         <emphasis>--autostash</emphasis> options of <xref linkend="git-rebase(1)" />.\r
 203         Defaults to false.\r
 204 </simpara>\r
 205 </listitem>\r
 206 </varlistentry>\r
 207 <varlistentry>\r
 208 <term>\r
 209 rebase.missingCommitsCheck\r
 210 </term>\r
 211 <listitem>\r
 212 <simpara>\r
 213         If set to "warn", git rebase -i will print a warning if some\r
 214         commits are removed (e.g. a line was deleted), however the\r
 215         rebase will still proceed. If set to "error", it will print\r
 216         the previous warning and stop the rebase, <emphasis>git rebase\r
 217         --edit-todo</emphasis> can then be used to correct the error. If set to\r
 218         "ignore", no checking is done.\r
 219         To drop a commit without warning or error, use the <emphasis>drop</emphasis>\r
 220         command in the todo list.\r
 221         Defaults to "ignore".\r
 222 </simpara>\r
 223 </listitem>\r
 224 </varlistentry>\r
 225 <varlistentry>\r
 226 <term>\r
 227 rebase.instructionFormat\r
 228 </term>\r
 229 <listitem>\r
 230 <simpara>\r
 231         A format string, as specified in <xref linkend="git-log(1)" />, to be used for the\r
 232         todo list during an interactive rebase.  The format will\r
 233         automatically have the long commit hash prepended to the format.\r
 234 </simpara>\r
 235 </listitem>\r
 236 </varlistentry>\r
 237 <varlistentry>\r
 238 <term>\r
 239 rebase.abbreviateCommands\r
 240 </term>\r
 241 <listitem>\r
 242 <simpara>\r
 243         If set to true, <emphasis>git rebase</emphasis> will use abbreviated command names in the\r
 244         todo list resulting in something like this:\r
 245 </simpara>\r
 246 <screen>        p deadbee The oneline of the commit\r
 247         p fa1afe1 The oneline of the next commit\r
 248         ...</screen>\r
 249 <simpara>instead of:</simpara>\r
 250 <screen>        pick deadbee The oneline of the commit\r
 251         pick fa1afe1 The oneline of the next commit\r
 252         ...</screen>\r
 253 <simpara>Defaults to false.</simpara>\r
 254 </listitem>\r
 255 </varlistentry>\r
 256 <varlistentry>\r
 257 <term>\r
 258 rebase.rescheduleFailedExec\r
 259 </term>\r
 260 <listitem>\r
 261 <simpara>\r
 262         Automatically reschedule <emphasis>exec</emphasis> commands that failed. This only makes\r
 263         sense in interactive mode (or when an <emphasis>--exec</emphasis> option was provided).\r
 264         This is the same as specifying the <emphasis>--reschedule-failed-exec</emphasis> option.\r
 265 </simpara>\r
 266 </listitem>\r
 267 </varlistentry>\r
 268 </variablelist>\r
 269 </simplesect>\r
 270 <simplesect id="git-rebase(1)__options">\r
 271 <title>OPTIONS</title>\r
 272 <variablelist>\r
 273 <varlistentry>\r
 274 <term>\r
 275 --onto &lt;newbase&gt;\r
 276 </term>\r
 277 <listitem>\r
 278 <simpara>\r
 279         Starting point at which to create the new commits. If the\r
 280         --onto option is not specified, the starting point is\r
 281         &lt;upstream&gt;.  May be any valid commit, and not just an\r
 282         existing branch name.\r
 283 </simpara>\r
 284 <simpara>As a special case, you may use "A...B" as a shortcut for the\r
 285 merge base of A and B if there is exactly one merge base. You can\r
 286 leave out at most one of A and B, in which case it defaults to HEAD.</simpara>\r
 287 </listitem>\r
 288 </varlistentry>\r
 289 <varlistentry>\r
 290 <term>\r
 291 --keep-base\r
 292 </term>\r
 293 <listitem>\r
 294 <simpara>\r
 295         Set the starting point at which to create the new commits to the\r
 296         merge base of &lt;upstream&gt; &lt;branch&gt;. Running\r
 297         <emphasis>git rebase --keep-base &lt;upstream&gt; &lt;branch&gt;</emphasis> is equivalent to\r
 298         running <emphasis>git rebase --onto &lt;upstream&gt;&#8230; &lt;upstream&gt;</emphasis>.\r
 299 </simpara>\r
 300 <simpara>This option is useful in the case where one is developing a feature on\r
 301 top of an upstream branch. While the feature is being worked on, the\r
 302 upstream branch may advance and it may not be the best idea to keep\r
 303 rebasing on top of the upstream but to keep the base commit as-is.</simpara>\r
 304 <simpara>Although both this option and --fork-point find the merge base between\r
 305 &lt;upstream&gt; and &lt;branch&gt;, this option uses the merge base as the <emphasis>starting\r
 306 point</emphasis> on which new commits will be created, whereas --fork-point uses\r
 307 the merge base to determine the <emphasis>set of commits</emphasis> which will be rebased.</simpara>\r
 308 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 309 </listitem>\r
 310 </varlistentry>\r
 311 <varlistentry>\r
 312 <term>\r
 313 &lt;upstream&gt;\r
 314 </term>\r
 315 <listitem>\r
 316 <simpara>\r
 317         Upstream branch to compare against.  May be any valid commit,\r
 318         not just an existing branch name. Defaults to the configured\r
 319         upstream for the current branch.\r
 320 </simpara>\r
 321 </listitem>\r
 322 </varlistentry>\r
 323 <varlistentry>\r
 324 <term>\r
 325 &lt;branch&gt;\r
 326 </term>\r
 327 <listitem>\r
 328 <simpara>\r
 329         Working branch; defaults to HEAD.\r
 330 </simpara>\r
 331 </listitem>\r
 332 </varlistentry>\r
 333 <varlistentry>\r
 334 <term>\r
 335 --continue\r
 336 </term>\r
 337 <listitem>\r
 338 <simpara>\r
 339         Restart the rebasing process after having resolved a merge conflict.\r
 340 </simpara>\r
 341 </listitem>\r
 342 </varlistentry>\r
 343 <varlistentry>\r
 344 <term>\r
 345 --abort\r
 346 </term>\r
 347 <listitem>\r
 348 <simpara>\r
 349         Abort the rebase operation and reset HEAD to the original\r
 350         branch. If &lt;branch&gt; was provided when the rebase operation was\r
 351         started, then HEAD will be reset to &lt;branch&gt;. Otherwise HEAD\r
 352         will be reset to where it was when the rebase operation was\r
 353         started.\r
 354 </simpara>\r
 355 </listitem>\r
 356 </varlistentry>\r
 357 <varlistentry>\r
 358 <term>\r
 359 --quit\r
 360 </term>\r
 361 <listitem>\r
 362 <simpara>\r
 363         Abort the rebase operation but HEAD is not reset back to the\r
 364         original branch. The index and working tree are also left\r
 365         unchanged as a result. If a temporary stash entry was created\r
 366         using --autostash, it will be saved to the stash list.\r
 367 </simpara>\r
 368 </listitem>\r
 369 </varlistentry>\r
 370 <varlistentry>\r
 371 <term>\r
 372 --apply\r
 373 </term>\r
 374 <listitem>\r
 375 <simpara>\r
 376         Use applying strategies to rebase (calling <emphasis>git-am</emphasis>\r
 377         internally).  This option may become a no-op in the future\r
 378         once the merge backend handles everything the apply one does.\r
 379 </simpara>\r
 380 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 381 </listitem>\r
 382 </varlistentry>\r
 383 <varlistentry>\r
 384 <term>\r
 385 --empty={drop,keep,ask}\r
 386 </term>\r
 387 <listitem>\r
 388 <simpara>\r
 389         How to handle commits that are not empty to start and are not\r
 390         clean cherry-picks of any upstream commit, but which become\r
 391         empty after rebasing (because they contain a subset of already\r
 392         upstream changes).  With drop (the default), commits that\r
 393         become empty are dropped.  With keep, such commits are kept.\r
 394         With ask (implied by --interactive), the rebase will halt when\r
 395         an empty commit is applied allowing you to choose whether to\r
 396         drop it, edit files more, or just commit the empty changes.\r
 397         Other options, like --exec, will use the default of drop unless\r
 398         -i/--interactive is explicitly specified.\r
 399 </simpara>\r
 400 <simpara>Note that commits which start empty are kept (unless --no-keep-empty\r
 401 is specified), and commits which are clean cherry-picks (as determined\r
 402 by <emphasis>git log --cherry-mark ...</emphasis>) are detected and dropped as a\r
 403 preliminary step (unless --reapply-cherry-picks is passed).</simpara>\r
 404 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 405 </listitem>\r
 406 </varlistentry>\r
 407 <varlistentry>\r
 408 <term>\r
 409 --no-keep-empty\r
 410 </term>\r
 411 <term>\r
 412 --keep-empty\r
 413 </term>\r
 414 <listitem>\r
 415 <simpara>\r
 416         Do not keep commits that start empty before the rebase\r
 417         (i.e. that do not change anything from its parent) in the\r
 418         result.  The default is to keep commits which start empty,\r
 419         since creating such commits requires passing the --allow-empty\r
 420         override flag to <emphasis>git commit</emphasis>, signifying that a user is very\r
 421         intentionally creating such a commit and thus wants to keep\r
 422         it.\r
 423 </simpara>\r
 424 <simpara>Usage of this flag will probably be rare, since you can get rid of\r
 425 commits that start empty by just firing up an interactive rebase and\r
 426 removing the lines corresponding to the commits you don't want.  This\r
 427 flag exists as a convenient shortcut, such as for cases where external\r
 428 tools generate many empty commits and you want them all removed.</simpara>\r
 429 <simpara>For commits which do not start empty but become empty after rebasing,\r
 430 see the --empty flag.</simpara>\r
 431 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 432 </listitem>\r
 433 </varlistentry>\r
 434 <varlistentry>\r
 435 <term>\r
 436 --reapply-cherry-picks\r
 437 </term>\r
 438 <term>\r
 439 --no-reapply-cherry-picks\r
 440 </term>\r
 441 <listitem>\r
 442 <simpara>\r
 443         Reapply all clean cherry-picks of any upstream commit instead\r
 444         of preemptively dropping them. (If these commits then become\r
 445         empty after rebasing, because they contain a subset of already\r
 446         upstream changes, the behavior towards them is controlled by\r
 447         the <emphasis>--empty</emphasis> flag.)\r
 448 </simpara>\r
 449 <simpara>By default (or if <emphasis>--no-reapply-cherry-picks</emphasis> is given), these commits\r
 450 will be automatically dropped.  Because this necessitates reading all\r
 451 upstream commits, this can be expensive in repos with a large number\r
 452 of upstream commits that need to be read.</simpara>\r
 453 <simpara><emphasis>--reapply-cherry-picks</emphasis> allows rebase to forgo reading all upstream\r
 454 commits, potentially improving performance.</simpara>\r
 455 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 456 </listitem>\r
 457 </varlistentry>\r
 458 <varlistentry>\r
 459 <term>\r
 460 --allow-empty-message\r
 461 </term>\r
 462 <listitem>\r
 463 <simpara>\r
 464         No-op.  Rebasing commits with an empty message used to fail\r
 465         and this option would override that behavior, allowing commits\r
 466         with empty messages to be rebased.  Now commits with an empty\r
 467         message do not cause rebasing to halt.\r
 468 </simpara>\r
 469 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 470 </listitem>\r
 471 </varlistentry>\r
 472 <varlistentry>\r
 473 <term>\r
 474 --skip\r
 475 </term>\r
 476 <listitem>\r
 477 <simpara>\r
 478         Restart the rebasing process by skipping the current patch.\r
 479 </simpara>\r
 480 </listitem>\r
 481 </varlistentry>\r
 482 <varlistentry>\r
 483 <term>\r
 484 --edit-todo\r
 485 </term>\r
 486 <listitem>\r
 487 <simpara>\r
 488         Edit the todo list during an interactive rebase.\r
 489 </simpara>\r
 490 </listitem>\r
 491 </varlistentry>\r
 492 <varlistentry>\r
 493 <term>\r
 494 --show-current-patch\r
 495 </term>\r
 496 <listitem>\r
 497 <simpara>\r
 498         Show the current patch in an interactive rebase or when rebase\r
 499         is stopped because of conflicts. This is the equivalent of\r
 500         <emphasis>git show REBASE_HEAD</emphasis>.\r
 501 </simpara>\r
 502 </listitem>\r
 503 </varlistentry>\r
 504 <varlistentry>\r
 505 <term>\r
 506 -m\r
 507 </term>\r
 508 <term>\r
 509 --merge\r
 510 </term>\r
 511 <listitem>\r
 512 <simpara>\r
 513         Use merging strategies to rebase.  When the recursive (default) merge\r
 514         strategy is used, this allows rebase to be aware of renames on the\r
 515         upstream side.  This is the default.\r
 516 </simpara>\r
 517 <simpara>Note that a rebase merge works by replaying each commit from the working\r
 518 branch on top of the &lt;upstream&gt; branch.  Because of this, when a merge\r
 519 conflict happens, the side reported as <emphasis>ours</emphasis> is the so-far rebased\r
 520 series, starting with &lt;upstream&gt;, and <emphasis>theirs</emphasis> is the working branch.  In\r
 521 other words, the sides are swapped.</simpara>\r
 522 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 523 </listitem>\r
 524 </varlistentry>\r
 525 <varlistentry>\r
 526 <term>\r
 527 -s &lt;strategy&gt;\r
 528 </term>\r
 529 <term>\r
 530 --strategy=&lt;strategy&gt;\r
 531 </term>\r
 532 <listitem>\r
 533 <simpara>\r
 534         Use the given merge strategy.\r
 535         If there is no <emphasis>-s</emphasis> option <emphasis>git merge-recursive</emphasis> is used\r
 536         instead.  This implies --merge.\r
 537 </simpara>\r
 538 <simpara>Because <emphasis>git rebase</emphasis> replays each commit from the working branch\r
 539 on top of the &lt;upstream&gt; branch using the given strategy, using\r
 540 the <emphasis>ours</emphasis> strategy simply empties all patches from the &lt;branch&gt;,\r
 541 which makes little sense.</simpara>\r
 542 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 543 </listitem>\r
 544 </varlistentry>\r
 545 <varlistentry>\r
 546 <term>\r
 547 -X &lt;strategy-option&gt;\r
 548 </term>\r
 549 <term>\r
 550 --strategy-option=&lt;strategy-option&gt;\r
 551 </term>\r
 552 <listitem>\r
 553 <simpara>\r
 554         Pass the &lt;strategy-option&gt; through to the merge strategy.\r
 555         This implies <emphasis>--merge</emphasis> and, if no strategy has been\r
 556         specified, <emphasis>-s recursive</emphasis>.  Note the reversal of <emphasis>ours</emphasis> and\r
 557         <emphasis>theirs</emphasis> as noted above for the <emphasis>-m</emphasis> option.\r
 558 </simpara>\r
 559 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 560 </listitem>\r
 561 </varlistentry>\r
 562 <varlistentry>\r
 563 <term>\r
 564 --rerere-autoupdate\r
 565 </term>\r
 566 <term>\r
 567 --no-rerere-autoupdate\r
 568 </term>\r
 569 <listitem>\r
 570 <simpara>\r
 571         Allow the rerere mechanism to update the index with the\r
 572         result of auto-conflict resolution if possible.\r
 573 </simpara>\r
 574 </listitem>\r
 575 </varlistentry>\r
 576 <varlistentry>\r
 577 <term>\r
 578 -S[&lt;keyid&gt;]\r
 579 </term>\r
 580 <term>\r
 581 --gpg-sign[=&lt;keyid&gt;]\r
 582 </term>\r
 583 <term>\r
 584 --no-gpg-sign\r
 585 </term>\r
 586 <listitem>\r
 587 <simpara>\r
 588         GPG-sign commits. The <emphasis>keyid</emphasis> argument is optional and\r
 589         defaults to the committer identity; if specified, it must be\r
 590         stuck to the option without a space. <emphasis>--no-gpg-sign</emphasis> is useful to\r
 591         countermand both <emphasis>commit.gpgSign</emphasis> configuration variable, and\r
 592         earlier <emphasis>--gpg-sign</emphasis>.\r
 593 </simpara>\r
 594 </listitem>\r
 595 </varlistentry>\r
 596 <varlistentry>\r
 597 <term>\r
 598 -q\r
 599 </term>\r
 600 <term>\r
 601 --quiet\r
 602 </term>\r
 603 <listitem>\r
 604 <simpara>\r
 605         Be quiet. Implies --no-stat.\r
 606 </simpara>\r
 607 </listitem>\r
 608 </varlistentry>\r
 609 <varlistentry>\r
 610 <term>\r
 611 -v\r
 612 </term>\r
 613 <term>\r
 614 --verbose\r
 615 </term>\r
 616 <listitem>\r
 617 <simpara>\r
 618         Be verbose. Implies --stat.\r
 619 </simpara>\r
 620 </listitem>\r
 621 </varlistentry>\r
 622 <varlistentry>\r
 623 <term>\r
 624 --stat\r
 625 </term>\r
 626 <listitem>\r
 627 <simpara>\r
 628         Show a diffstat of what changed upstream since the last rebase. The\r
 629         diffstat is also controlled by the configuration option rebase.stat.\r
 630 </simpara>\r
 631 </listitem>\r
 632 </varlistentry>\r
 633 <varlistentry>\r
 634 <term>\r
 635 -n\r
 636 </term>\r
 637 <term>\r
 638 --no-stat\r
 639 </term>\r
 640 <listitem>\r
 641 <simpara>\r
 642         Do not show a diffstat as part of the rebase process.\r
 643 </simpara>\r
 644 </listitem>\r
 645 </varlistentry>\r
 646 <varlistentry>\r
 647 <term>\r
 648 --no-verify\r
 649 </term>\r
 650 <listitem>\r
 651 <simpara>\r
 652         This option bypasses the pre-rebase hook.  See also <xref linkend="githooks(5)" />.\r
 653 </simpara>\r
 654 </listitem>\r
 655 </varlistentry>\r
 656 <varlistentry>\r
 657 <term>\r
 658 --verify\r
 659 </term>\r
 660 <listitem>\r
 661 <simpara>\r
 662         Allows the pre-rebase hook to run, which is the default.  This option can\r
 663         be used to override --no-verify.  See also <xref linkend="githooks(5)" />.\r
 664 </simpara>\r
 665 </listitem>\r
 666 </varlistentry>\r
 667 <varlistentry>\r
 668 <term>\r
 669 -C&lt;n&gt;\r
 670 </term>\r
 671 <listitem>\r
 672 <simpara>\r
 673         Ensure at least &lt;n&gt; lines of surrounding context match before\r
 674         and after each change.  When fewer lines of surrounding\r
 675         context exist they all must match.  By default no context is\r
 676         ever ignored.  Implies --apply.\r
 677 </simpara>\r
 678 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 679 </listitem>\r
 680 </varlistentry>\r
 681 <varlistentry>\r
 682 <term>\r
 683 --no-ff\r
 684 </term>\r
 685 <term>\r
 686 --force-rebase\r
 687 </term>\r
 688 <term>\r
 689 -f\r
 690 </term>\r
 691 <listitem>\r
 692 <simpara>\r
 693         Individually replay all rebased commits instead of fast-forwarding\r
 694         over the unchanged ones.  This ensures that the entire history of\r
 695         the rebased branch is composed of new commits.\r
 696 </simpara>\r
 697 <simpara>You may find this helpful after reverting a topic branch merge, as this option\r
 698 recreates the topic branch with fresh commits so it can be remerged\r
 699 successfully without needing to "revert the reversion" (see the\r
 700 <ulink url="https://www.kernel.org/pub/software/scm/git/docs/howto/revert-a-faulty-merge.html"><citetitle>revert-a-faulty-merge How-To</citetitle></ulink> for\r
 701 details).</simpara>\r
 702 </listitem>\r
 703 </varlistentry>\r
 704 <varlistentry>\r
 705 <term>\r
 706 --fork-point\r
 707 </term>\r
 708 <term>\r
 709 --no-fork-point\r
 710 </term>\r
 711 <listitem>\r
 712 <simpara>\r
 713         Use reflog to find a better common ancestor between &lt;upstream&gt;\r
 714         and &lt;branch&gt; when calculating which commits have been\r
 715         introduced by &lt;branch&gt;.\r
 716 </simpara>\r
 717 <simpara>When --fork-point is active, <emphasis>fork_point</emphasis> will be used instead of\r
 718 &lt;upstream&gt; to calculate the set of commits to rebase, where\r
 719 <emphasis>fork_point</emphasis> is the result of <emphasis>git merge-base --fork-point &lt;upstream&gt;\r
 720 &lt;branch&gt;</emphasis> command (see <xref linkend="git-merge-base(1)" />).  If <emphasis>fork_point</emphasis>\r
 721 ends up being empty, the &lt;upstream&gt; will be used as a fallback.</simpara>\r
 722 <simpara>If &lt;upstream&gt; is given on the command line, then the default is\r
 723 <emphasis>--no-fork-point</emphasis>, otherwise the default is <emphasis>--fork-point</emphasis>.</simpara>\r
 724 <simpara>If your branch was based on &lt;upstream&gt; but &lt;upstream&gt; was rewound and\r
 725 your branch contains commits which were dropped, this option can be used\r
 726 with <emphasis>--keep-base</emphasis> in order to drop those commits from your branch.</simpara>\r
 727 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 728 </listitem>\r
 729 </varlistentry>\r
 730 <varlistentry>\r
 731 <term>\r
 732 --ignore-whitespace\r
 733 </term>\r
 734 <term>\r
 735 --whitespace=&lt;option&gt;\r
 736 </term>\r
 737 <listitem>\r
 738 <simpara>\r
 739         These flags are passed to the <emphasis>git apply</emphasis> program\r
 740         (see <xref linkend="git-apply(1)" />) that applies the patch.\r
 741         Implies --apply.\r
 742 </simpara>\r
 743 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 744 </listitem>\r
 745 </varlistentry>\r
 746 <varlistentry>\r
 747 <term>\r
 748 --committer-date-is-author-date\r
 749 </term>\r
 750 <term>\r
 751 --ignore-date\r
 752 </term>\r
 753 <listitem>\r
 754 <simpara>\r
 755         These flags are passed to <emphasis>git am</emphasis> to easily change the dates\r
 756         of the rebased commits (see <xref linkend="git-am(1)" />).\r
 757 </simpara>\r
 758 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 759 </listitem>\r
 760 </varlistentry>\r
 761 <varlistentry>\r
 762 <term>\r
 763 --signoff\r
 764 </term>\r
 765 <listitem>\r
 766 <simpara>\r
 767         Add a Signed-off-by: trailer to all the rebased commits. Note\r
 768         that if <emphasis>--interactive</emphasis> is given then only commits marked to be\r
 769         picked, edited or reworded will have the trailer added.\r
 770 </simpara>\r
 771 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 772 </listitem>\r
 773 </varlistentry>\r
 774 <varlistentry>\r
 775 <term>\r
 776 -i\r
 777 </term>\r
 778 <term>\r
 779 --interactive\r
 780 </term>\r
 781 <listitem>\r
 782 <simpara>\r
 783         Make a list of the commits which are about to be rebased.  Let the\r
 784         user edit that list before rebasing.  This mode can also be used to\r
 785         split commits (see SPLITTING COMMITS below).\r
 786 </simpara>\r
 787 <simpara>The commit list format can be changed by setting the configuration option\r
 788 rebase.instructionFormat.  A customized instruction format will automatically\r
 789 have the long commit hash prepended to the format.</simpara>\r
 790 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 791 </listitem>\r
 792 </varlistentry>\r
 793 <varlistentry>\r
 794 <term>\r
 795 -r\r
 796 </term>\r
 797 <term>\r
 798 --rebase-merges[=(rebase-cousins|no-rebase-cousins)]\r
 799 </term>\r
 800 <listitem>\r
 801 <simpara>\r
 802         By default, a rebase will simply drop merge commits from the todo\r
 803         list, and put the rebased commits into a single, linear branch.\r
 804         With <emphasis>--rebase-merges</emphasis>, the rebase will instead try to preserve\r
 805         the branching structure within the commits that are to be rebased,\r
 806         by recreating the merge commits. Any resolved merge conflicts or\r
 807         manual amendments in these merge commits will have to be\r
 808         resolved/re-applied manually.\r
 809 </simpara>\r
 810 <simpara>By default, or when <emphasis>no-rebase-cousins</emphasis> was specified, commits which do not\r
 811 have <emphasis>&lt;upstream&gt;</emphasis> as direct ancestor will keep their original branch point,\r
 812 i.e. commits that would be excluded by <xref linkend="git-log(1)" />'s\r
 813 <emphasis>--ancestry-path</emphasis> option will keep their original ancestry by default. If\r
 814 the <emphasis>rebase-cousins</emphasis> mode is turned on, such commits are instead rebased\r
 815 onto <emphasis>&lt;upstream&gt;</emphasis> (or <emphasis>&lt;onto&gt;</emphasis>, if specified).</simpara>\r
 816 <simpara>The <emphasis>--rebase-merges</emphasis> mode is similar in spirit to the deprecated\r
 817 <emphasis>--preserve-merges</emphasis> but works with interactive rebases,\r
 818 where commits can be reordered, inserted and dropped at will.</simpara>\r
 819 <simpara>It is currently only possible to recreate the merge commits using the\r
 820 <emphasis>recursive</emphasis> merge strategy; Different merge strategies can be used only via\r
 821 explicit <emphasis>exec git merge -s &lt;strategy&gt; [...]</emphasis> commands.</simpara>\r
 822 <simpara>See also REBASING MERGES and INCOMPATIBLE OPTIONS below.</simpara>\r
 823 </listitem>\r
 824 </varlistentry>\r
 825 <varlistentry>\r
 826 <term>\r
 827 -p\r
 828 </term>\r
 829 <term>\r
 830 --preserve-merges\r
 831 </term>\r
 832 <listitem>\r
 833 <simpara>\r
 834         [DEPRECATED: use <emphasis>--rebase-merges</emphasis> instead] Recreate merge commits\r
 835         instead of flattening the history by replaying commits a merge commit\r
 836         introduces. Merge conflict resolutions or manual amendments to merge\r
 837         commits are not preserved.\r
 838 </simpara>\r
 839 <simpara>This uses the <emphasis>--interactive</emphasis> machinery internally, but combining it\r
 840 with the <emphasis>--interactive</emphasis> option explicitly is generally not a good\r
 841 idea unless you know what you are doing (see BUGS below).</simpara>\r
 842 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 843 </listitem>\r
 844 </varlistentry>\r
 845 <varlistentry>\r
 846 <term>\r
 847 -x &lt;cmd&gt;\r
 848 </term>\r
 849 <term>\r
 850 --exec &lt;cmd&gt;\r
 851 </term>\r
 852 <listitem>\r
 853 <simpara>\r
 854         Append "exec &lt;cmd&gt;" after each line creating a commit in the\r
 855         final history. &lt;cmd&gt; will be interpreted as one or more shell\r
 856         commands. Any command that fails will interrupt the rebase,\r
 857         with exit code 1.\r
 858 </simpara>\r
 859 <simpara>You may execute several commands by either using one instance of <emphasis>--exec</emphasis>\r
 860 with several commands:</simpara>\r
 861 <literallayout class="monospaced">git rebase -i --exec "cmd1 &amp;&amp; cmd2 &amp;&amp; ..."</literallayout>\r
 862 <simpara>or by giving more than one <emphasis>--exec</emphasis>:</simpara>\r
 863 <literallayout class="monospaced">git rebase -i --exec "cmd1" --exec "cmd2" --exec ...</literallayout>\r
 864 <simpara>If <emphasis>--autosquash</emphasis> is used, "exec" lines will not be appended for\r
 865 the intermediate commits, and will only appear at the end of each\r
 866 squash/fixup series.</simpara>\r
 867 <simpara>This uses the <emphasis>--interactive</emphasis> machinery internally, but it can be run\r
 868 without an explicit <emphasis>--interactive</emphasis>.</simpara>\r
 869 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 870 </listitem>\r
 871 </varlistentry>\r
 872 <varlistentry>\r
 873 <term>\r
 874 --root\r
 875 </term>\r
 876 <listitem>\r
 877 <simpara>\r
 878         Rebase all commits reachable from &lt;branch&gt;, instead of\r
 879         limiting them with an &lt;upstream&gt;.  This allows you to rebase\r
 880         the root commit(s) on a branch.  When used with --onto, it\r
 881         will skip changes already contained in &lt;newbase&gt; (instead of\r
 882         &lt;upstream&gt;) whereas without --onto it will operate on every change.\r
 883         When used together with both --onto and --preserve-merges,\r
 884         <emphasis>all</emphasis> root commits will be rewritten to have &lt;newbase&gt; as parent\r
 885         instead.\r
 886 </simpara>\r
 887 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 888 </listitem>\r
 889 </varlistentry>\r
 890 <varlistentry>\r
 891 <term>\r
 892 --autosquash\r
 893 </term>\r
 894 <term>\r
 895 --no-autosquash\r
 896 </term>\r
 897 <listitem>\r
 898 <simpara>\r
 899         When the commit log message begins with "squash! &#8230;" (or\r
 900         "fixup! &#8230;"), and there is already a commit in the todo list that\r
 901         matches the same <emphasis>...</emphasis>, automatically modify the todo list of rebase\r
 902         -i so that the commit marked for squashing comes right after the\r
 903         commit to be modified, and change the action of the moved commit\r
 904         from <emphasis>pick</emphasis> to <emphasis>squash</emphasis> (or <emphasis>fixup</emphasis>).  A commit matches the <emphasis>...</emphasis> if\r
 905         the commit subject matches, or if the <emphasis>...</emphasis> refers to the commit's\r
 906         hash. As a fall-back, partial matches of the commit subject work,\r
 907         too.  The recommended way to create fixup/squash commits is by using\r
 908         the <emphasis>--fixup</emphasis>/<emphasis>--squash</emphasis> options of <xref linkend="git-commit(1)" />.\r
 909 </simpara>\r
 910 <simpara>If the <emphasis>--autosquash</emphasis> option is enabled by default using the\r
 911 configuration variable <emphasis>rebase.autoSquash</emphasis>, this option can be\r
 912 used to override and disable this setting.</simpara>\r
 913 <simpara>See also INCOMPATIBLE OPTIONS below.</simpara>\r
 914 </listitem>\r
 915 </varlistentry>\r
 916 <varlistentry>\r
 917 <term>\r
 918 --autostash\r
 919 </term>\r
 920 <term>\r
 921 --no-autostash\r
 922 </term>\r
 923 <listitem>\r
 924 <simpara>\r
 925         Automatically create a temporary stash entry before the operation\r
 926         begins, and apply it after the operation ends.  This means\r
 927         that you can run rebase on a dirty worktree.  However, use\r
 928         with care: the final stash application after a successful\r
 929         rebase might result in non-trivial conflicts.\r
 930 </simpara>\r
 931 </listitem>\r
 932 </varlistentry>\r
 933 <varlistentry>\r
 934 <term>\r
 935 --reschedule-failed-exec\r
 936 </term>\r
 937 <term>\r
 938 --no-reschedule-failed-exec\r
 939 </term>\r
 940 <listitem>\r
 941 <simpara>\r
 942         Automatically reschedule <emphasis>exec</emphasis> commands that failed. This only makes\r
 943         sense in interactive mode (or when an <emphasis>--exec</emphasis> option was provided).\r
 944 </simpara>\r
 945 </listitem>\r
 946 </varlistentry>\r
 947 </variablelist>\r
 948 </simplesect>\r
 949 <simplesect id="git-rebase(1)__incompatible_options">\r
 950 <title>INCOMPATIBLE OPTIONS</title>\r
 951 <simpara>The following options:</simpara>\r
 952 <itemizedlist>\r
 953 <listitem>\r
 954 <simpara>\r
 955 --apply\r
 956 </simpara>\r
 957 </listitem>\r
 958 <listitem>\r
 959 <simpara>\r
 960 --committer-date-is-author-date\r
 961 </simpara>\r
 962 </listitem>\r
 963 <listitem>\r
 964 <simpara>\r
 965 --ignore-date\r
 966 </simpara>\r
 967 </listitem>\r
 968 <listitem>\r
 969 <simpara>\r
 970 --ignore-whitespace\r
 971 </simpara>\r
 972 </listitem>\r
 973 <listitem>\r
 974 <simpara>\r
 975 --whitespace\r
 976 </simpara>\r
 977 </listitem>\r
 978 <listitem>\r
 979 <simpara>\r
 980 -C\r
 981 </simpara>\r
 982 </listitem>\r
 983 </itemizedlist>\r
 984 <simpara>are incompatible with the following options:</simpara>\r
 985 <itemizedlist>\r
 986 <listitem>\r
 987 <simpara>\r
 988 --merge\r
 989 </simpara>\r
 990 </listitem>\r
 991 <listitem>\r
 992 <simpara>\r
 993 --strategy\r
 994 </simpara>\r
 995 </listitem>\r
 996 <listitem>\r
 997 <simpara>\r
 998 --strategy-option\r
 999 </simpara>\r
1000 </listitem>\r
1001 <listitem>\r
1002 <simpara>\r
1003 --allow-empty-message\r
1004 </simpara>\r
1005 </listitem>\r
1006 <listitem>\r
1007 <simpara>\r
1008 --[no-]autosquash\r
1009 </simpara>\r
1010 </listitem>\r
1011 <listitem>\r
1012 <simpara>\r
1013 --rebase-merges\r
1014 </simpara>\r
1015 </listitem>\r
1016 <listitem>\r
1017 <simpara>\r
1018 --preserve-merges\r
1019 </simpara>\r
1020 </listitem>\r
1021 <listitem>\r
1022 <simpara>\r
1023 --interactive\r
1024 </simpara>\r
1025 </listitem>\r
1026 <listitem>\r
1027 <simpara>\r
1028 --exec\r
1029 </simpara>\r
1030 </listitem>\r
1031 <listitem>\r
1032 <simpara>\r
1033 --no-keep-empty\r
1034 </simpara>\r
1035 </listitem>\r
1036 <listitem>\r
1037 <simpara>\r
1038 --empty=\r
1039 </simpara>\r
1040 </listitem>\r
1041 <listitem>\r
1042 <simpara>\r
1043 --reapply-cherry-picks\r
1044 </simpara>\r
1045 </listitem>\r
1046 <listitem>\r
1047 <simpara>\r
1048 --edit-todo\r
1049 </simpara>\r
1050 </listitem>\r
1051 <listitem>\r
1052 <simpara>\r
1053 --root when used in combination with --onto\r
1054 </simpara>\r
1055 </listitem>\r
1056 </itemizedlist>\r
1057 <simpara>In addition, the following pairs of options are incompatible:</simpara>\r
1058 <itemizedlist>\r
1059 <listitem>\r
1060 <simpara>\r
1061 --preserve-merges and --interactive\r
1062 </simpara>\r
1063 </listitem>\r
1064 <listitem>\r
1065 <simpara>\r
1066 --preserve-merges and --signoff\r
1067 </simpara>\r
1068 </listitem>\r
1069 <listitem>\r
1070 <simpara>\r
1071 --preserve-merges and --rebase-merges\r
1072 </simpara>\r
1073 </listitem>\r
1074 <listitem>\r
1075 <simpara>\r
1076 --preserve-merges and --empty=\r
1077 </simpara>\r
1078 </listitem>\r
1079 <listitem>\r
1080 <simpara>\r
1081 --keep-base and --onto\r
1082 </simpara>\r
1083 </listitem>\r
1084 <listitem>\r
1085 <simpara>\r
1086 --keep-base and --root\r
1087 </simpara>\r
1088 </listitem>\r
1089 <listitem>\r
1090 <simpara>\r
1091 --fork-point and --root\r
1092 </simpara>\r
1093 </listitem>\r
1094 </itemizedlist>\r
1095 </simplesect>\r
1096 <simplesect id="git-rebase(1)__behavioral_differences">\r
1097 <title>BEHAVIORAL DIFFERENCES</title>\r
1098 <simpara>git rebase has two primary backends: apply and merge.  (The apply\r
1099 backend used to be known as the <emphasis>am</emphasis> backend, but the name led to\r
1100 confusion as it looks like a verb instead of a noun.  Also, the merge\r
1101 backend used to be known as the interactive backend, but it is now\r
1102 used for non-interactive cases as well.  Both were renamed based on\r
1103 lower-level functionality that underpinned each.) There are some\r
1104 subtle differences in how these two backends behave:</simpara>\r
1105 <section id="git-rebase(1)__empty_commits">\r
1106 <title>Empty commits</title>\r
1107 <simpara>The apply backend unfortunately drops intentionally empty commits, i.e.\r
1108 commits that started empty, though these are rare in practice.  It\r
1109 also drops commits that become empty and has no option for controlling\r
1110 this behavior.</simpara>\r
1111 <simpara>The merge backend keeps intentionally empty commits by default (though\r
1112 with -i they are marked as empty in the todo list editor, or they can\r
1113 be dropped automatically with --no-keep-empty).</simpara>\r
1114 <simpara>Similar to the apply backend, by default the merge backend drops\r
1115 commits that become empty unless -i/--interactive is specified (in\r
1116 which case it stops and asks the user what to do).  The merge backend\r
1117 also has an --empty={drop,keep,ask} option for changing the behavior\r
1118 of handling commits that become empty.</simpara>\r
1119 </section>\r
1120 <section id="git-rebase(1)__directory_rename_detection">\r
1121 <title>Directory rename detection</title>\r
1122 <simpara>Due to the lack of accurate tree information (arising from\r
1123 constructing fake ancestors with the limited information available in\r
1124 patches), directory rename detection is disabled in the apply backend.\r
1125 Disabled directory rename detection means that if one side of history\r
1126 renames a directory and the other adds new files to the old directory,\r
1127 then the new files will be left behind in the old directory without\r
1128 any warning at the time of rebasing that you may want to move these\r
1129 files into the new directory.</simpara>\r
1130 <simpara>Directory rename detection works with the merge backend to provide you\r
1131 warnings in such cases.</simpara>\r
1132 </section>\r
1133 <section id="git-rebase(1)__context">\r
1134 <title>Context</title>\r
1135 <simpara>The apply backend works by creating a sequence of patches (by calling\r
1136 <emphasis>format-patch</emphasis> internally), and then applying the patches in sequence\r
1137 (calling <emphasis>am</emphasis> internally).  Patches are composed of multiple hunks,\r
1138 each with line numbers, a context region, and the actual changes.  The\r
1139 line numbers have to be taken with some fuzz, since the other side\r
1140 will likely have inserted or deleted lines earlier in the file.  The\r
1141 context region is meant to help find how to adjust the line numbers in\r
1142 order to apply the changes to the right lines.  However, if multiple\r
1143 areas of the code have the same surrounding lines of context, the\r
1144 wrong one can be picked.  There are real-world cases where this has\r
1145 caused commits to be reapplied incorrectly with no conflicts reported.\r
1146 Setting diff.context to a larger value may prevent such types of\r
1147 problems, but increases the chance of spurious conflicts (since it\r
1148 will require more lines of matching context to apply).</simpara>\r
1149 <simpara>The merge backend works with a full copy of each relevant file,\r
1150 insulating it from these types of problems.</simpara>\r
1151 </section>\r
1152 <section id="git-rebase(1)__labelling_of_conflicts_markers">\r
1153 <title>Labelling of conflicts markers</title>\r
1154 <simpara>When there are content conflicts, the merge machinery tries to\r
1155 annotate each side's conflict markers with the commits where the\r
1156 content came from.  Since the apply backend drops the original\r
1157 information about the rebased commits and their parents (and instead\r
1158 generates new fake commits based off limited information in the\r
1159 generated patches), those commits cannot be identified; instead it has\r
1160 to fall back to a commit summary.  Also, when merge.conflictStyle is\r
1161 set to diff3, the apply backend will use "constructed merge base" to\r
1162 label the content from the merge base, and thus provide no information\r
1163 about the merge base commit whatsoever.</simpara>\r
1164 <simpara>The merge backend works with the full commits on both sides of history\r
1165 and thus has no such limitations.</simpara>\r
1166 </section>\r
1167 <section id="git-rebase(1)__hooks">\r
1168 <title>Hooks</title>\r
1169 <simpara>The apply backend has not traditionally called the post-commit hook,\r
1170 while the merge backend has.  Both have called the post-checkout hook,\r
1171 though the merge backend has squelched its output.  Further, both\r
1172 backends only call the post-checkout hook with the starting point\r
1173 commit of the rebase, not the intermediate commits nor the final\r
1174 commit.  In each case, the calling of these hooks was by accident of\r
1175 implementation rather than by design (both backends were originally\r
1176 implemented as shell scripts and happened to invoke other commands\r
1177 like <emphasis>git checkout</emphasis> or <emphasis>git commit</emphasis> that would call the hooks).  Both\r
1178 backends should have the same behavior, though it is not entirely\r
1179 clear which, if any, is correct.  We will likely make rebase stop\r
1180 calling either of these hooks in the future.</simpara>\r
1181 </section>\r
1182 <section id="git-rebase(1)__interruptability">\r
1183 <title>Interruptability</title>\r
1184 <simpara>The apply backend has safety problems with an ill-timed interrupt; if\r
1185 the user presses Ctrl-C at the wrong time to try to abort the rebase,\r
1186 the rebase can enter a state where it cannot be aborted with a\r
1187 subsequent <emphasis>git rebase --abort</emphasis>.  The merge backend does not appear to\r
1188 suffer from the same shortcoming.  (See\r
1189 <ulink url="https://lore.kernel.org/git/20200207132152.GC2868@szeder.dev/">https://lore.kernel.org/git/20200207132152.GC2868@szeder.dev/</ulink> for\r
1190 details.)</simpara>\r
1191 </section>\r
1192 <section id="git-rebase(1)__commit_rewording">\r
1193 <title>Commit Rewording</title>\r
1194 <simpara>When a conflict occurs while rebasing, rebase stops and asks the user\r
1195 to resolve.  Since the user may need to make notable changes while\r
1196 resolving conflicts, after conflicts are resolved and the user has run\r
1197 <emphasis>git rebase --continue</emphasis>, the rebase should open an editor and ask the\r
1198 user to update the commit message.  The merge backend does this, while\r
1199 the apply backend blindly applies the original commit message.</simpara>\r
1200 </section>\r
1201 <section id="git-rebase(1)__miscellaneous_differences">\r
1202 <title>Miscellaneous differences</title>\r
1203 <simpara>There are a few more behavioral differences that most folks would\r
1204 probably consider inconsequential but which are mentioned for\r
1205 completeness:</simpara>\r
1206 <itemizedlist>\r
1207 <listitem>\r
1208 <simpara>\r
1209 Reflog: The two backends will use different wording when describing\r
1210   the changes made in the reflog, though both will make use of the\r
1211   word "rebase".\r
1212 </simpara>\r
1213 </listitem>\r
1214 <listitem>\r
1215 <simpara>\r
1216 Progress, informational, and error messages: The two backends\r
1217   provide slightly different progress and informational messages.\r
1218   Also, the apply backend writes error messages (such as "Your files\r
1219   would be overwritten&#8230;") to stdout, while the merge backend writes\r
1220   them to stderr.\r
1221 </simpara>\r
1222 </listitem>\r
1223 <listitem>\r
1224 <simpara>\r
1225 State directories: The two backends keep their state in different\r
1226   directories under .git/\r
1227 </simpara>\r
1228 </listitem>\r
1229 </itemizedlist>\r
1230 </section>\r
1231 </simplesect>\r
1232 <simplesect id="git-rebase(1)__merge_strategies">\r
1233 <title>MERGE STRATEGIES</title>\r
1234 <simpara>The merge mechanism (<emphasis>git merge</emphasis> and <emphasis>git pull</emphasis> commands) allows the\r
1235 backend <emphasis>merge strategies</emphasis> to be chosen with <emphasis>-s</emphasis> option.  Some strategies\r
1236 can also take their own options, which can be passed by giving <emphasis>-X&lt;option&gt;</emphasis>\r
1237 arguments to <emphasis>git merge</emphasis> and/or <emphasis>git pull</emphasis>.</simpara>\r
1238 <variablelist>\r
1239 <varlistentry>\r
1240 <term>\r
1241 resolve\r
1242 </term>\r
1243 <listitem>\r
1244 <simpara>\r
1245         This can only resolve two heads (i.e. the current branch\r
1246         and another branch you pulled from) using a 3-way merge\r
1247         algorithm.  It tries to carefully detect criss-cross\r
1248         merge ambiguities and is considered generally safe and\r
1249         fast.\r
1250 </simpara>\r
1251 </listitem>\r
1252 </varlistentry>\r
1253 <varlistentry>\r
1254 <term>\r
1255 recursive\r
1256 </term>\r
1257 <listitem>\r
1258 <simpara>\r
1259         This can only resolve two heads using a 3-way merge\r
1260         algorithm.  When there is more than one common\r
1261         ancestor that can be used for 3-way merge, it creates a\r
1262         merged tree of the common ancestors and uses that as\r
1263         the reference tree for the 3-way merge.  This has been\r
1264         reported to result in fewer merge conflicts without\r
1265         causing mismerges by tests done on actual merge commits\r
1266         taken from Linux 2.6 kernel development history.\r
1267         Additionally this can detect and handle merges involving\r
1268         renames, but currently cannot make use of detected\r
1269         copies.  This is the default merge strategy when pulling\r
1270         or merging one branch.\r
1271 </simpara>\r
1272 <simpara>The <emphasis>recursive</emphasis> strategy can take the following options:</simpara>\r
1273 <variablelist>\r
1274 <varlistentry>\r
1275 <term>\r
1276 ours\r
1277 </term>\r
1278 <listitem>\r
1279 <simpara>\r
1280         This option forces conflicting hunks to be auto-resolved cleanly by\r
1281         favoring <emphasis>our</emphasis> version.  Changes from the other tree that do not\r
1282         conflict with our side are reflected in the merge result.\r
1283         For a binary file, the entire contents are taken from our side.\r
1284 </simpara>\r
1285 <simpara>This should not be confused with the <emphasis>ours</emphasis> merge strategy, which does not\r
1286 even look at what the other tree contains at all.  It discards everything\r
1287 the other tree did, declaring <emphasis>our</emphasis> history contains all that happened in it.</simpara>\r
1288 </listitem>\r
1289 </varlistentry>\r
1290 <varlistentry>\r
1291 <term>\r
1292 theirs\r
1293 </term>\r
1294 <listitem>\r
1295 <simpara>\r
1296         This is the opposite of <emphasis>ours</emphasis>; note that, unlike <emphasis>ours</emphasis>, there is\r
1297         no <emphasis>theirs</emphasis> merge strategy to confuse this merge option with.\r
1298 </simpara>\r
1299 </listitem>\r
1300 </varlistentry>\r
1301 <varlistentry>\r
1302 <term>\r
1303 patience\r
1304 </term>\r
1305 <listitem>\r
1306 <simpara>\r
1307         With this option, <emphasis>merge-recursive</emphasis> spends a little extra time\r
1308         to avoid mismerges that sometimes occur due to unimportant\r
1309         matching lines (e.g., braces from distinct functions).  Use\r
1310         this when the branches to be merged have diverged wildly.\r
1311         See also <xref linkend="git-diff(1)" /> <emphasis>--patience</emphasis>.\r
1312 </simpara>\r
1313 </listitem>\r
1314 </varlistentry>\r
1315 <varlistentry>\r
1316 <term>\r
1317 diff-algorithm=[patience|minimal|histogram|myers]\r
1318 </term>\r
1319 <listitem>\r
1320 <simpara>\r
1321         Tells <emphasis>merge-recursive</emphasis> to use a different diff algorithm, which\r
1322         can help avoid mismerges that occur due to unimportant matching\r
1323         lines (such as braces from distinct functions).  See also\r
1324         <xref linkend="git-diff(1)" /> <emphasis>--diff-algorithm</emphasis>.\r
1325 </simpara>\r
1326 </listitem>\r
1327 </varlistentry>\r
1328 <varlistentry>\r
1329 <term>\r
1330 ignore-space-change\r
1331 </term>\r
1332 <term>\r
1333 ignore-all-space\r
1334 </term>\r
1335 <term>\r
1336 ignore-space-at-eol\r
1337 </term>\r
1338 <term>\r
1339 ignore-cr-at-eol\r
1340 </term>\r
1341 <listitem>\r
1342 <simpara>\r
1343         Treats lines with the indicated type of whitespace change as\r
1344         unchanged for the sake of a three-way merge.  Whitespace\r
1345         changes mixed with other changes to a line are not ignored.\r
1346         See also <xref linkend="git-diff(1)" /> <emphasis>-b</emphasis>, <emphasis>-w</emphasis>,\r
1347         <emphasis>--ignore-space-at-eol</emphasis>, and <emphasis>--ignore-cr-at-eol</emphasis>.\r
1348 </simpara>\r
1349 <itemizedlist>\r
1350 <listitem>\r
1351 <simpara>\r
1352 If <emphasis>their</emphasis> version only introduces whitespace changes to a line,\r
1353   <emphasis>our</emphasis> version is used;\r
1354 </simpara>\r
1355 </listitem>\r
1356 <listitem>\r
1357 <simpara>\r
1358 If <emphasis>our</emphasis> version introduces whitespace changes but <emphasis>their</emphasis>\r
1359   version includes a substantial change, <emphasis>their</emphasis> version is used;\r
1360 </simpara>\r
1361 </listitem>\r
1362 <listitem>\r
1363 <simpara>\r
1364 Otherwise, the merge proceeds in the usual way.\r
1365 </simpara>\r
1366 </listitem>\r
1367 </itemizedlist>\r
1368 </listitem>\r
1369 </varlistentry>\r
1370 <varlistentry>\r
1371 <term>\r
1372 renormalize\r
1373 </term>\r
1374 <listitem>\r
1375 <simpara>\r
1376         This runs a virtual check-out and check-in of all three stages\r
1377         of a file when resolving a three-way merge.  This option is\r
1378         meant to be used when merging branches with different clean\r
1379         filters or end-of-line normalization rules.  See "Merging\r
1380         branches with differing checkin/checkout attributes" in\r
1381         <xref linkend="gitattributes(5)" /> for details.\r
1382 </simpara>\r
1383 </listitem>\r
1384 </varlistentry>\r
1385 <varlistentry>\r
1386 <term>\r
1387 no-renormalize\r
1388 </term>\r
1389 <listitem>\r
1390 <simpara>\r
1391         Disables the <emphasis>renormalize</emphasis> option.  This overrides the\r
1392         <emphasis>merge.renormalize</emphasis> configuration variable.\r
1393 </simpara>\r
1394 </listitem>\r
1395 </varlistentry>\r
1396 <varlistentry>\r
1397 <term>\r
1398 no-renames\r
1399 </term>\r
1400 <listitem>\r
1401 <simpara>\r
1402         Turn off rename detection. This overrides the <emphasis>merge.renames</emphasis>\r
1403         configuration variable.\r
1404         See also <xref linkend="git-diff(1)" /> <emphasis>--no-renames</emphasis>.\r
1405 </simpara>\r
1406 </listitem>\r
1407 </varlistentry>\r
1408 <varlistentry>\r
1409 <term>\r
1410 find-renames[=&lt;n&gt;]\r
1411 </term>\r
1412 <listitem>\r
1413 <simpara>\r
1414         Turn on rename detection, optionally setting the similarity\r
1415         threshold.  This is the default. This overrides the\r
1416         <emphasis>merge.renames</emphasis> configuration variable.\r
1417         See also <xref linkend="git-diff(1)" /> <emphasis>--find-renames</emphasis>.\r
1418 </simpara>\r
1419 </listitem>\r
1420 </varlistentry>\r
1421 <varlistentry>\r
1422 <term>\r
1423 rename-threshold=&lt;n&gt;\r
1424 </term>\r
1425 <listitem>\r
1426 <simpara>\r
1427         Deprecated synonym for <emphasis>find-renames=&lt;n&gt;</emphasis>.\r
1428 </simpara>\r
1429 </listitem>\r
1430 </varlistentry>\r
1431 <varlistentry>\r
1432 <term>\r
1433 subtree[=&lt;path&gt;]\r
1434 </term>\r
1435 <listitem>\r
1436 <simpara>\r
1437         This option is a more advanced form of <emphasis>subtree</emphasis> strategy, where\r
1438         the strategy makes a guess on how two trees must be shifted to\r
1439         match with each other when merging.  Instead, the specified path\r
1440         is prefixed (or stripped from the beginning) to make the shape of\r
1441         two trees to match.\r
1442 </simpara>\r
1443 </listitem>\r
1444 </varlistentry>\r
1445 </variablelist>\r
1446 </listitem>\r
1447 </varlistentry>\r
1448 <varlistentry>\r
1449 <term>\r
1450 octopus\r
1451 </term>\r
1452 <listitem>\r
1453 <simpara>\r
1454         This resolves cases with more than two heads, but refuses to do\r
1455         a complex merge that needs manual resolution.  It is\r
1456         primarily meant to be used for bundling topic branch\r
1457         heads together.  This is the default merge strategy when\r
1458         pulling or merging more than one branch.\r
1459 </simpara>\r
1460 </listitem>\r
1461 </varlistentry>\r
1462 <varlistentry>\r
1463 <term>\r
1464 ours\r
1465 </term>\r
1466 <listitem>\r
1467 <simpara>\r
1468         This resolves any number of heads, but the resulting tree of the\r
1469         merge is always that of the current branch head, effectively\r
1470         ignoring all changes from all other branches.  It is meant to\r
1471         be used to supersede old development history of side\r
1472         branches.  Note that this is different from the -Xours option to\r
1473         the <emphasis>recursive</emphasis> merge strategy.\r
1474 </simpara>\r
1475 </listitem>\r
1476 </varlistentry>\r
1477 <varlistentry>\r
1478 <term>\r
1479 subtree\r
1480 </term>\r
1481 <listitem>\r
1482 <simpara>\r
1483         This is a modified recursive strategy. When merging trees A and\r
1484         B, if B corresponds to a subtree of A, B is first adjusted to\r
1485         match the tree structure of A, instead of reading the trees at\r
1486         the same level. This adjustment is also done to the common\r
1487         ancestor tree.\r
1488 </simpara>\r
1489 </listitem>\r
1490 </varlistentry>\r
1491 </variablelist>\r
1492 <simpara>With the strategies that use 3-way merge (including the default, <emphasis>recursive</emphasis>),\r
1493 if a change is made on both branches, but later reverted on one of the\r
1494 branches, that change will be present in the merged result; some people find\r
1495 this behavior confusing.  It occurs because only the heads and the merge base\r
1496 are considered when performing a merge, not the individual commits.  The merge\r
1497 algorithm therefore considers the reverted change as no change at all, and\r
1498 substitutes the changed version instead.</simpara>\r
1499 </simplesect>\r
1500 <simplesect id="git-rebase(1)__notes">\r
1501 <title>NOTES</title>\r
1502 <simpara>You should understand the implications of using <emphasis>git rebase</emphasis> on a\r
1503 repository that you share.  See also RECOVERING FROM UPSTREAM REBASE\r
1504 below.</simpara>\r
1505 <simpara>When the git-rebase command is run, it will first execute a "pre-rebase"\r
1506 hook if one exists.  You can use this hook to do sanity checks and\r
1507 reject the rebase if it isn't appropriate.  Please see the template\r
1508 pre-rebase hook script for an example.</simpara>\r
1509 <simpara>Upon completion, &lt;branch&gt; will be the current branch.</simpara>\r
1510 </simplesect>\r
1511 <simplesect id="git-rebase(1)__interactive_mode">\r
1512 <title>INTERACTIVE MODE</title>\r
1513 <simpara>Rebasing interactively means that you have a chance to edit the commits\r
1514 which are rebased.  You can reorder the commits, and you can\r
1515 remove them (weeding out bad or otherwise unwanted patches).</simpara>\r
1516 <simpara>The interactive mode is meant for this type of workflow:</simpara>\r
1517 <orderedlist numeration="arabic">\r
1518 <listitem>\r
1519 <simpara>\r
1520 have a wonderful idea\r
1521 </simpara>\r
1522 </listitem>\r
1523 <listitem>\r
1524 <simpara>\r
1525 hack on the code\r
1526 </simpara>\r
1527 </listitem>\r
1528 <listitem>\r
1529 <simpara>\r
1530 prepare a series for submission\r
1531 </simpara>\r
1532 </listitem>\r
1533 <listitem>\r
1534 <simpara>\r
1535 submit\r
1536 </simpara>\r
1537 </listitem>\r
1538 </orderedlist>\r
1539 <simpara>where point 2. consists of several instances of</simpara>\r
1540 <simpara>a) regular use</simpara>\r
1541 <orderedlist numeration="arabic">\r
1542 <listitem>\r
1543 <simpara>\r
1544 finish something worthy of a commit\r
1545 </simpara>\r
1546 </listitem>\r
1547 <listitem>\r
1548 <simpara>\r
1549 commit\r
1550 </simpara>\r
1551 </listitem>\r
1552 </orderedlist>\r
1553 <simpara>b) independent fixup</simpara>\r
1554 <orderedlist numeration="arabic">\r
1555 <listitem>\r
1556 <simpara>\r
1557 realize that something does not work\r
1558 </simpara>\r
1559 </listitem>\r
1560 <listitem>\r
1561 <simpara>\r
1562 fix that\r
1563 </simpara>\r
1564 </listitem>\r
1565 <listitem>\r
1566 <simpara>\r
1567 commit it\r
1568 </simpara>\r
1569 </listitem>\r
1570 </orderedlist>\r
1571 <simpara>Sometimes the thing fixed in b.2. cannot be amended to the not-quite\r
1572 perfect commit it fixes, because that commit is buried deeply in a\r
1573 patch series.  That is exactly what interactive rebase is for: use it\r
1574 after plenty of "a"s and "b"s, by rearranging and editing\r
1575 commits, and squashing multiple commits into one.</simpara>\r
1576 <simpara>Start it with the last commit you want to retain as-is:</simpara>\r
1577 <literallayout class="monospaced">git rebase -i &lt;after-this-commit&gt;</literallayout>\r
1578 <simpara>An editor will be fired up with all the commits in your current branch\r
1579 (ignoring merge commits), which come after the given commit.  You can\r
1580 reorder the commits in this list to your heart's content, and you can\r
1581 remove them.  The list looks more or less like this:</simpara>\r
1582 <screen>pick deadbee The oneline of this commit\r
1583 pick fa1afe1 The oneline of the next commit\r
1584 ...</screen>\r
1585 <simpara>The oneline descriptions are purely for your pleasure; <emphasis>git rebase</emphasis> will\r
1586 not look at them but at the commit names ("deadbee" and "fa1afe1" in this\r
1587 example), so do not delete or edit the names.</simpara>\r
1588 <simpara>By replacing the command "pick" with the command "edit", you can tell\r
1589 <emphasis>git rebase</emphasis> to stop after applying that commit, so that you can edit\r
1590 the files and/or the commit message, amend the commit, and continue\r
1591 rebasing.</simpara>\r
1592 <simpara>To interrupt the rebase (just like an "edit" command would do, but without\r
1593 cherry-picking any commit first), use the "break" command.</simpara>\r
1594 <simpara>If you just want to edit the commit message for a commit, replace the\r
1595 command "pick" with the command "reword".</simpara>\r
1596 <simpara>To drop a commit, replace the command "pick" with "drop", or just\r
1597 delete the matching line.</simpara>\r
1598 <simpara>If you want to fold two or more commits into one, replace the command\r
1599 "pick" for the second and subsequent commits with "squash" or "fixup".\r
1600 If the commits had different authors, the folded commit will be\r
1601 attributed to the author of the first commit.  The suggested commit\r
1602 message for the folded commit is the concatenation of the commit\r
1603 messages of the first commit and of those with the "squash" command,\r
1604 but omits the commit messages of commits with the "fixup" command.</simpara>\r
1605 <simpara><emphasis>git rebase</emphasis> will stop when "pick" has been replaced with "edit" or\r
1606 when a command fails due to merge errors. When you are done editing\r
1607 and/or resolving conflicts you can continue with <emphasis>git rebase --continue</emphasis>.</simpara>\r
1608 <simpara>For example, if you want to reorder the last 5 commits, such that what\r
1609 was HEAD~4 becomes the new HEAD. To achieve that, you would call\r
1610 <emphasis>git rebase</emphasis> like this:</simpara>\r
1611 <screen>$ git rebase -i HEAD~5</screen>\r
1612 <simpara>And move the first patch to the end of the list.</simpara>\r
1613 <simpara>You might want to recreate merge commits, e.g. if you have a history\r
1614 like this:</simpara>\r
1615 <screen>           X\r
1616             \\r
1617          A---M---B\r
1618         /\r
1619 ---o---O---P---Q</screen>\r
1620 <simpara>Suppose you want to rebase the side branch starting at "A" to "Q". Make\r
1621 sure that the current HEAD is "B", and call</simpara>\r
1622 <screen>$ git rebase -i -r --onto Q O</screen>\r
1623 <simpara>Reordering and editing commits usually creates untested intermediate\r
1624 steps.  You may want to check that your history editing did not break\r
1625 anything by running a test, or at least recompiling at intermediate\r
1626 points in history by using the "exec" command (shortcut "x").  You may\r
1627 do so by creating a todo list like this one:</simpara>\r
1628 <screen>pick deadbee Implement feature XXX\r
1629 fixup f1a5c00 Fix to feature XXX\r
1630 exec make\r
1631 pick c0ffeee The oneline of the next commit\r
1632 edit deadbab The oneline of the commit after\r
1633 exec cd subdir; make test\r
1634 ...</screen>\r
1635 <simpara>The interactive rebase will stop when a command fails (i.e. exits with\r
1636 non-0 status) to give you an opportunity to fix the problem. You can\r
1637 continue with <emphasis>git rebase --continue</emphasis>.</simpara>\r
1638 <simpara>The "exec" command launches the command in a shell (the one specified\r
1639 in <emphasis>$SHELL</emphasis>, or the default shell if <emphasis>$SHELL</emphasis> is not set), so you can\r
1640 use shell features (like "cd", "&gt;", ";" &#8230;). The command is run from\r
1641 the root of the working tree.</simpara>\r
1642 <screen>$ git rebase -i --exec "make test"</screen>\r
1643 <simpara>This command lets you check that intermediate commits are compilable.\r
1644 The todo list becomes like that:</simpara>\r
1645 <screen>pick 5928aea one\r
1646 exec make test\r
1647 pick 04d0fda two\r
1648 exec make test\r
1649 pick ba46169 three\r
1650 exec make test\r
1651 pick f4593f9 four\r
1652 exec make test</screen>\r
1653 </simplesect>\r
1654 <simplesect id="git-rebase(1)__splitting_commits">\r
1655 <title>SPLITTING COMMITS</title>\r
1656 <simpara>In interactive mode, you can mark commits with the action "edit".  However,\r
1657 this does not necessarily mean that <emphasis>git rebase</emphasis> expects the result of this\r
1658 edit to be exactly one commit.  Indeed, you can undo the commit, or you can\r
1659 add other commits.  This can be used to split a commit into two:</simpara>\r
1660 <itemizedlist>\r
1661 <listitem>\r
1662 <simpara>\r
1663 Start an interactive rebase with <emphasis>git rebase -i &lt;commit&gt;^</emphasis>, where\r
1664   &lt;commit&gt; is the commit you want to split.  In fact, any commit range\r
1665   will do, as long as it contains that commit.\r
1666 </simpara>\r
1667 </listitem>\r
1668 <listitem>\r
1669 <simpara>\r
1670 Mark the commit you want to split with the action "edit".\r
1671 </simpara>\r
1672 </listitem>\r
1673 <listitem>\r
1674 <simpara>\r
1675 When it comes to editing that commit, execute <emphasis>git reset HEAD^</emphasis>.  The\r
1676   effect is that the HEAD is rewound by one, and the index follows suit.\r
1677   However, the working tree stays the same.\r
1678 </simpara>\r
1679 </listitem>\r
1680 <listitem>\r
1681 <simpara>\r
1682 Now add the changes to the index that you want to have in the first\r
1683   commit.  You can use <emphasis>git add</emphasis> (possibly interactively) or\r
1684   <emphasis>git gui</emphasis> (or both) to do that.\r
1685 </simpara>\r
1686 </listitem>\r
1687 <listitem>\r
1688 <simpara>\r
1689 Commit the now-current index with whatever commit message is appropriate\r
1690   now.\r
1691 </simpara>\r
1692 </listitem>\r
1693 <listitem>\r
1694 <simpara>\r
1695 Repeat the last two steps until your working tree is clean.\r
1696 </simpara>\r
1697 </listitem>\r
1698 <listitem>\r
1699 <simpara>\r
1700 Continue the rebase with <emphasis>git rebase --continue</emphasis>.\r
1701 </simpara>\r
1702 </listitem>\r
1703 </itemizedlist>\r
1704 <simpara>If you are not absolutely sure that the intermediate revisions are\r
1705 consistent (they compile, pass the testsuite, etc.) you should use\r
1706 <emphasis>git stash</emphasis> to stash away the not-yet-committed changes\r
1707 after each commit, test, and amend the commit if fixes are necessary.</simpara>\r
1708 </simplesect>\r
1709 <simplesect id="git-rebase(1)__recovering_from_upstream_rebase">\r
1710 <title>RECOVERING FROM UPSTREAM REBASE</title>\r
1711 <simpara>Rebasing (or any other form of rewriting) a branch that others have\r
1712 based work on is a bad idea: anyone downstream of it is forced to\r
1713 manually fix their history.  This section explains how to do the fix\r
1714 from the downstream's point of view.  The real fix, however, would be\r
1715 to avoid rebasing the upstream in the first place.</simpara>\r
1716 <simpara>To illustrate, suppose you are in a situation where someone develops a\r
1717 <emphasis>subsystem</emphasis> branch, and you are working on a <emphasis>topic</emphasis> that is dependent\r
1718 on this <emphasis>subsystem</emphasis>.  You might end up with a history like the\r
1719 following:</simpara>\r
1720 <screen>    o---o---o---o---o---o---o---o  master\r
1721          \\r
1722           o---o---o---o---o  subsystem\r
1723                            \\r
1724                             *---*---*  topic</screen>\r
1725 <simpara>If <emphasis>subsystem</emphasis> is rebased against <emphasis>master</emphasis>, the following happens:</simpara>\r
1726 <screen>    o---o---o---o---o---o---o---o  master\r
1727          \                       \\r
1728           o---o---o---o---o       o'--o'--o'--o'--o'  subsystem\r
1729                            \\r
1730                             *---*---*  topic</screen>\r
1731 <simpara>If you now continue development as usual, and eventually merge <emphasis>topic</emphasis>\r
1732 to <emphasis>subsystem</emphasis>, the commits from <emphasis>subsystem</emphasis> will remain duplicated forever:</simpara>\r
1733 <screen>    o---o---o---o---o---o---o---o  master\r
1734          \                       \\r
1735           o---o---o---o---o       o'--o'--o'--o'--o'--M  subsystem\r
1736                            \                         /\r
1737                             *---*---*-..........-*--*  topic</screen>\r
1738 <simpara>Such duplicates are generally frowned upon because they clutter up\r
1739 history, making it harder to follow.  To clean things up, you need to\r
1740 transplant the commits on <emphasis>topic</emphasis> to the new <emphasis>subsystem</emphasis> tip, i.e.,\r
1741 rebase <emphasis>topic</emphasis>.  This becomes a ripple effect: anyone downstream from\r
1742 <emphasis>topic</emphasis> is forced to rebase too, and so on!</simpara>\r
1743 <simpara>There are two kinds of fixes, discussed in the following subsections:</simpara>\r
1744 <variablelist>\r
1745 <varlistentry>\r
1746 <term>\r
1747 Easy case: The changes are literally the same.\r
1748 </term>\r
1749 <listitem>\r
1750 <simpara>\r
1751         This happens if the <emphasis>subsystem</emphasis> rebase was a simple rebase and\r
1752         had no conflicts.\r
1753 </simpara>\r
1754 </listitem>\r
1755 </varlistentry>\r
1756 <varlistentry>\r
1757 <term>\r
1758 Hard case: The changes are not the same.\r
1759 </term>\r
1760 <listitem>\r
1761 <simpara>\r
1762         This happens if the <emphasis>subsystem</emphasis> rebase had conflicts, or used\r
1763         <emphasis>--interactive</emphasis> to omit, edit, squash, or fixup commits; or\r
1764         if the upstream used one of <emphasis>commit --amend</emphasis>, <emphasis>reset</emphasis>, or\r
1765         a full history rewriting command like\r
1766         <ulink url="https://github.com/newren/git-filter-repo"><emphasis>filter-repo</emphasis></ulink>.\r
1767 </simpara>\r
1768 </listitem>\r
1769 </varlistentry>\r
1770 </variablelist>\r
1771 <section id="git-rebase(1)__the_easy_case">\r
1772 <title>The easy case</title>\r
1773 <simpara>Only works if the changes (patch IDs based on the diff contents) on\r
1774 <emphasis>subsystem</emphasis> are literally the same before and after the rebase\r
1775 <emphasis>subsystem</emphasis> did.</simpara>\r
1776 <simpara>In that case, the fix is easy because <emphasis>git rebase</emphasis> knows to skip\r
1777 changes that are already present in the new upstream (unless\r
1778 <emphasis>--reapply-cherry-picks</emphasis> is given). So if you say\r
1779 (assuming you're on <emphasis>topic</emphasis>)</simpara>\r
1780 <screen>    $ git rebase subsystem</screen>\r
1781 <simpara>you will end up with the fixed history</simpara>\r
1782 <screen>    o---o---o---o---o---o---o---o  master\r
1783                                  \\r
1784                                   o'--o'--o'--o'--o'  subsystem\r
1785                                                    \\r
1786                                                     *---*---*  topic</screen>\r
1787 </section>\r
1788 <section id="git-rebase(1)__the_hard_case">\r
1789 <title>The hard case</title>\r
1790 <simpara>Things get more complicated if the <emphasis>subsystem</emphasis> changes do not exactly\r
1791 correspond to the ones before the rebase.</simpara>\r
1792 <note><simpara>While an "easy case recovery" sometimes appears to be successful\r
1793       even in the hard case, it may have unintended consequences.  For\r
1794       example, a commit that was removed via <emphasis>git rebase\r
1795       --interactive</emphasis> will be <emphasis role="strong">resurrected</emphasis>!</simpara></note>\r
1796 <simpara>The idea is to manually tell <emphasis>git rebase</emphasis> "where the old <emphasis>subsystem</emphasis>\r
1797 ended and your <emphasis>topic</emphasis> began", that is, what the old merge base\r
1798 between them was.  You will have to find a way to name the last commit\r
1799 of the old <emphasis>subsystem</emphasis>, for example:</simpara>\r
1800 <itemizedlist>\r
1801 <listitem>\r
1802 <simpara>\r
1803 With the <emphasis>subsystem</emphasis> reflog: after <emphasis>git fetch</emphasis>, the old tip of\r
1804   <emphasis>subsystem</emphasis> is at <emphasis>subsystem@{1}</emphasis>.  Subsequent fetches will\r
1805   increase the number.  (See <xref linkend="git-reflog(1)" />.)\r
1806 </simpara>\r
1807 </listitem>\r
1808 <listitem>\r
1809 <simpara>\r
1810 Relative to the tip of <emphasis>topic</emphasis>: knowing that your <emphasis>topic</emphasis> has three\r
1811   commits, the old tip of <emphasis>subsystem</emphasis> must be <emphasis>topic~3</emphasis>.\r
1812 </simpara>\r
1813 </listitem>\r
1814 </itemizedlist>\r
1815 <simpara>You can then transplant the old <emphasis>subsystem..topic</emphasis> to the new tip by\r
1816 saying (for the reflog case, and assuming you are on <emphasis>topic</emphasis> already):</simpara>\r
1817 <screen>    $ git rebase --onto subsystem subsystem@{1}</screen>\r
1818 <simpara>The ripple effect of a "hard case" recovery is especially bad:\r
1819 <emphasis>everyone</emphasis> downstream from <emphasis>topic</emphasis> will now have to perform a "hard\r
1820 case" recovery too!</simpara>\r
1821 </section>\r
1822 </simplesect>\r
1823 <simplesect id="git-rebase(1)__rebasing_merges">\r
1824 <title>REBASING MERGES</title>\r
1825 <simpara>The interactive rebase command was originally designed to handle\r
1826 individual patch series. As such, it makes sense to exclude merge\r
1827 commits from the todo list, as the developer may have merged the\r
1828 then-current <emphasis>master</emphasis> while working on the branch, only to rebase\r
1829 all the commits onto <emphasis>master</emphasis> eventually (skipping the merge\r
1830 commits).</simpara>\r
1831 <simpara>However, there are legitimate reasons why a developer may want to\r
1832 recreate merge commits: to keep the branch structure (or "commit\r
1833 topology") when working on multiple, inter-related branches.</simpara>\r
1834 <simpara>In the following example, the developer works on a topic branch that\r
1835 refactors the way buttons are defined, and on another topic branch\r
1836 that uses that refactoring to implement a "Report a bug" button. The\r
1837 output of <emphasis>git log --graph --format=%s -5</emphasis> may look like this:</simpara>\r
1838 <screen>*   Merge branch 'report-a-bug'\r
1839 |\\r
1840 | * Add the feedback button\r
1841 * | Merge branch 'refactor-button'\r
1842 |\ \\r
1843 | |/\r
1844 | * Use the Button class for all buttons\r
1845 | * Extract a generic Button class from the DownloadButton one</screen>\r
1846 <simpara>The developer might want to rebase those commits to a newer <emphasis>master</emphasis>\r
1847 while keeping the branch topology, for example when the first topic\r
1848 branch is expected to be integrated into <emphasis>master</emphasis> much earlier than the\r
1849 second one, say, to resolve merge conflicts with changes to the\r
1850 DownloadButton class that made it into <emphasis>master</emphasis>.</simpara>\r
1851 <simpara>This rebase can be performed using the <emphasis>--rebase-merges</emphasis> option.\r
1852 It will generate a todo list looking like this:</simpara>\r
1853 <screen>label onto\r
1854 \r
1855 # Branch: refactor-button\r
1856 reset onto\r
1857 pick 123456 Extract a generic Button class from the DownloadButton one\r
1858 pick 654321 Use the Button class for all buttons\r
1859 label refactor-button\r
1860 \r
1861 # Branch: report-a-bug\r
1862 reset refactor-button # Use the Button class for all buttons\r
1863 pick abcdef Add the feedback button\r
1864 label report-a-bug\r
1865 \r
1866 reset onto\r
1867 merge -C a1b2c3 refactor-button # Merge 'refactor-button'\r
1868 merge -C 6f5e4d report-a-bug # Merge 'report-a-bug'</screen>\r
1869 <simpara>In contrast to a regular interactive rebase, there are <emphasis>label</emphasis>, <emphasis>reset</emphasis>\r
1870 and <emphasis>merge</emphasis> commands in addition to <emphasis>pick</emphasis> ones.</simpara>\r
1871 <simpara>The <emphasis>label</emphasis> command associates a label with the current HEAD when that\r
1872 command is executed. These labels are created as worktree-local refs\r
1873 (<emphasis>refs/rewritten/&lt;label&gt;</emphasis>) that will be deleted when the rebase\r
1874 finishes. That way, rebase operations in multiple worktrees linked to\r
1875 the same repository do not interfere with one another. If the <emphasis>label</emphasis>\r
1876 command fails, it is rescheduled immediately, with a helpful message how\r
1877 to proceed.</simpara>\r
1878 <simpara>The <emphasis>reset</emphasis> command resets the HEAD, index and worktree to the specified\r
1879 revision. It is similar to an <emphasis>exec git reset --hard &lt;label&gt;</emphasis>, but\r
1880 refuses to overwrite untracked files. If the <emphasis>reset</emphasis> command fails, it is\r
1881 rescheduled immediately, with a helpful message how to edit the todo list\r
1882 (this typically happens when a <emphasis>reset</emphasis> command was inserted into the todo\r
1883 list manually and contains a typo).</simpara>\r
1884 <simpara>The <emphasis>merge</emphasis> command will merge the specified revision(s) into whatever\r
1885 is HEAD at that time. With <emphasis>-C &lt;original-commit&gt;</emphasis>, the commit message of\r
1886 the specified merge commit will be used. When the <emphasis>-C</emphasis> is changed to\r
1887 a lower-case <emphasis>-c</emphasis>, the message will be opened in an editor after a\r
1888 successful merge so that the user can edit the message.</simpara>\r
1889 <simpara>If a <emphasis>merge</emphasis> command fails for any reason other than merge conflicts (i.e.\r
1890 when the merge operation did not even start), it is rescheduled immediately.</simpara>\r
1891 <simpara>At this time, the <emphasis>merge</emphasis> command will <emphasis role="strong">always</emphasis> use the <emphasis>recursive</emphasis>\r
1892 merge strategy for regular merges, and <emphasis>octopus</emphasis> for octopus merges,\r
1893 with no way to choose a different one. To work around\r
1894 this, an <emphasis>exec</emphasis> command can be used to call <emphasis>git merge</emphasis> explicitly,\r
1895 using the fact that the labels are worktree-local refs (the ref\r
1896 <emphasis>refs/rewritten/onto</emphasis> would correspond to the label <emphasis>onto</emphasis>, for example).</simpara>\r
1897 <simpara>Note: the first command (<emphasis>label onto</emphasis>) labels the revision onto which\r
1898 the commits are rebased; The name <emphasis>onto</emphasis> is just a convention, as a nod\r
1899 to the <emphasis>--onto</emphasis> option.</simpara>\r
1900 <simpara>It is also possible to introduce completely new merge commits from scratch\r
1901 by adding a command of the form <emphasis>merge &lt;merge-head&gt;</emphasis>. This form will\r
1902 generate a tentative commit message and always open an editor to let the\r
1903 user edit it. This can be useful e.g. when a topic branch turns out to\r
1904 address more than a single concern and wants to be split into two or\r
1905 even more topic branches. Consider this todo list:</simpara>\r
1906 <screen>pick 192837 Switch from GNU Makefiles to CMake\r
1907 pick 5a6c7e Document the switch to CMake\r
1908 pick 918273 Fix detection of OpenSSL in CMake\r
1909 pick afbecd http: add support for TLS v1.3\r
1910 pick fdbaec Fix detection of cURL in CMake on Windows</screen>\r
1911 <simpara>The one commit in this list that is not related to CMake may very well\r
1912 have been motivated by working on fixing all those bugs introduced by\r
1913 switching to CMake, but it addresses a different concern. To split this\r
1914 branch into two topic branches, the todo list could be edited like this:</simpara>\r
1915 <screen>label onto\r
1916 \r
1917 pick afbecd http: add support for TLS v1.3\r
1918 label tlsv1.3\r
1919 \r
1920 reset onto\r
1921 pick 192837 Switch from GNU Makefiles to CMake\r
1922 pick 918273 Fix detection of OpenSSL in CMake\r
1923 pick fdbaec Fix detection of cURL in CMake on Windows\r
1924 pick 5a6c7e Document the switch to CMake\r
1925 label cmake\r
1926 \r
1927 reset onto\r
1928 merge tlsv1.3\r
1929 merge cmake</screen>\r
1930 </simplesect>\r
1931 <simplesect id="git-rebase(1)__bugs">\r
1932 <title>BUGS</title>\r
1933 <simpara>The todo list presented by the deprecated <emphasis>--preserve-merges --interactive</emphasis>\r
1934 does not represent the topology of the revision graph (use <emphasis>--rebase-merges</emphasis>\r
1935 instead).  Editing commits and rewording their commit messages should work\r
1936 fine, but attempts to reorder commits tend to produce counterintuitive results.\r
1937 Use <emphasis>--rebase-merges</emphasis> in such scenarios instead.</simpara>\r
1938 <simpara>For example, an attempt to rearrange</simpara>\r
1939 <screen>1 --- 2 --- 3 --- 4 --- 5</screen>\r
1940 <simpara>to</simpara>\r
1941 <screen>1 --- 2 --- 4 --- 3 --- 5</screen>\r
1942 <simpara>by moving the "pick 4" line will result in the following history:</simpara>\r
1943 <screen>        3\r
1944        /\r
1945 1 --- 2 --- 4 --- 5</screen>\r
1946 </simplesect>\r
1947 <simplesect id="git-rebase(1)__git">\r
1948 <title>GIT</title>\r
1949 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
1950 </simplesect>\r
1951 </sect2>\r