Documentation/git-rebase.txt

   1 git-rebase(1)
   2 =============
   3
   4 NAME
   5 ----
   6 git-rebase - Forward-port local commits to the updated upstream head
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'git rebase' [-i | --interactive] [options] [--onto <newbase>]
  12         <upstream> [<branch>]
  13 'git rebase' [-i | --interactive] [options] --onto <newbase>
  14         --root [<branch>]
  15
  16 'git rebase' --continue | --skip | --abort
  17
  18 DESCRIPTION
  19 -----------
  20 If <branch> is specified, 'git rebase' will perform an automatic
  21 `git checkout <branch>` before doing anything else.  Otherwise
  22 it remains on the current branch.
  23
  24 All changes made by commits in the current branch but that are not
  25 in <upstream> are saved to a temporary area.  This is the same set
  26 of commits that would be shown by `git log <upstream>..HEAD` (or
  27 `git log HEAD`, if --root is specified).
  28
  29 The current branch is reset to <upstream>, or <newbase> if the
  30 --onto option was supplied.  This has the exact same effect as
  31 `git reset --hard <upstream>` (or <newbase>).  ORIG_HEAD is set
  32 to point at the tip of the branch before the reset.
  33
  34 The commits that were previously saved into the temporary area are
  35 then reapplied to the current branch, one by one, in order. Note that
  36 any commits in HEAD which introduce the same textual changes as a commit
  37 in HEAD..<upstream> are omitted (i.e., a patch already accepted upstream
  38 with a different commit message or timestamp will be skipped).
  39
  40 It is possible that a merge failure will prevent this process from being
  41 completely automatic.  You will have to resolve any such merge failure
  42 and run `git rebase --continue`.  Another option is to bypass the commit
  43 that caused the merge failure with `git rebase --skip`.  To restore the
  44 original <branch> and remove the .git/rebase-apply working files, use the
  45 command `git rebase --abort` instead.
  46
  47 Assume the following history exists and the current branch is "topic":
  48
  49 ------------
  50           A---B---C topic
  51          /
  52     D---E---F---G master
  53 ------------
  54
  55 From this point, the result of either of the following commands:
  56
  57
  58     git rebase master
  59     git rebase master topic
  60
  61 would be:
  62
  63 ------------
  64                   A'--B'--C' topic
  65                  /
  66     D---E---F---G master
  67 ------------
  68
  69 The latter form is just a short-hand of `git checkout topic`
  70 followed by `git rebase master`.
  71
  72 If the upstream branch already contains a change you have made (e.g.,
  73 because you mailed a patch which was applied upstream), then that commit
  74 will be skipped. For example, running `git rebase master` on the
  75 following history (in which A' and A introduce the same set of changes,
  76 but have different committer information):
  77
  78 ------------
  79           A---B---C topic
  80          /
  81     D---E---A'---F master
  82 ------------
  83
  84 will result in:
  85
  86 ------------
  87                    B'---C' topic
  88                   /
  89     D---E---A'---F master
  90 ------------
  91
  92 Here is how you would transplant a topic branch based on one
  93 branch to another, to pretend that you forked the topic branch
  94 from the latter branch, using `rebase --onto`.
  95
  96 First let's assume your 'topic' is based on branch 'next'.
  97 For example, a feature developed in 'topic' depends on some
  98 functionality which is found in 'next'.
  99
 100 ------------
 101     o---o---o---o---o  master
 102          \
 103           o---o---o---o---o  next
 104                            \
 105                             o---o---o  topic
 106 ------------
 107
 108 We want to make 'topic' forked from branch 'master'; for example,
 109 because the functionality on which 'topic' depends was merged into the
 110 more stable 'master' branch. We want our tree to look like this:
 111
 112 ------------
 113     o---o---o---o---o  master
 114         |            \
 115         |             o'--o'--o'  topic
 116          \
 117           o---o---o---o---o  next
 118 ------------
 119
 120 We can get this using the following command:
 121
 122     git rebase --onto master next topic
 123
 124
 125 Another example of --onto option is to rebase part of a
 126 branch.  If we have the following situation:
 127
 128 ------------
 129                             H---I---J topicB
 130                            /
 131                   E---F---G  topicA
 132                  /
 133     A---B---C---D  master
 134 ------------
 135
 136 then the command
 137
 138     git rebase --onto master topicA topicB
 139
 140 would result in:
 141
 142 ------------
 143                  H'--I'--J'  topicB
 144                 /
 145                 | E---F---G  topicA
 146                 |/
 147     A---B---C---D  master
 148 ------------
 149
 150 This is useful when topicB does not depend on topicA.
 151
 152 A range of commits could also be removed with rebase.  If we have
 153 the following situation:
 154
 155 ------------
 156     E---F---G---H---I---J  topicA
 157 ------------
 158
 159 then the command
 160
 161     git rebase --onto topicA~5 topicA~3 topicA
 162
 163 would result in the removal of commits F and G:
 164
 165 ------------
 166     E---H'---I'---J'  topicA
 167 ------------
 168
 169 This is useful if F and G were flawed in some way, or should not be
 170 part of topicA.  Note that the argument to --onto and the <upstream>
 171 parameter can be any valid commit-ish.
 172
 173 In case of conflict, 'git rebase' will stop at the first problematic commit
 174 and leave conflict markers in the tree.  You can use 'git diff' to locate
 175 the markers (<<<<<<) and make edits to resolve the conflict.  For each
 176 file you edit, you need to tell git that the conflict has been resolved,
 177 typically this would be done with
 178
 179
 180     git add <filename>
 181
 182
 183 After resolving the conflict manually and updating the index with the
 184 desired resolution, you can continue the rebasing process with
 185
 186
 187     git rebase --continue
 188
 189
 190 Alternatively, you can undo the 'git rebase' with
 191
 192
 193     git rebase --abort
 194
 195 CONFIGURATION
 196 -------------
 197
 198 rebase.stat::
 199         Whether to show a diffstat of what changed upstream since the last
 200         rebase. False by default.
 201
 202 OPTIONS
 203 -------
 204 <newbase>::
 205         Starting point at which to create the new commits. If the
 206         --onto option is not specified, the starting point is
 207         <upstream>.  May be any valid commit, and not just an
 208         existing branch name.
 209 +
 210 As a special case, you may use "A...B" as a shortcut for the
 211 merge base of A and B if there is exactly one merge base. You can
 212 leave out at most one of A and B, in which case it defaults to HEAD.
 213
 214 <upstream>::
 215         Upstream branch to compare against.  May be any valid commit,
 216         not just an existing branch name.
 217
 218 <branch>::
 219         Working branch; defaults to HEAD.
 220
 221 --continue::
 222         Restart the rebasing process after having resolved a merge conflict.
 223
 224 --abort::
 225         Restore the original branch and abort the rebase operation.
 226
 227 --skip::
 228         Restart the rebasing process by skipping the current patch.
 229
 230 -m::
 231 --merge::
 232         Use merging strategies to rebase.  When the recursive (default) merge
 233         strategy is used, this allows rebase to be aware of renames on the
 234         upstream side.
 235 +
 236 Note that a rebase merge works by replaying each commit from the working
 237 branch on top of the <upstream> branch.  Because of this, when a merge
 238 conflict happens, the side reported as 'ours' is the so-far rebased
 239 series, starting with <upstream>, and 'theirs' is the working branch.  In
 240 other words, the sides are swapped.
 241
 242 -s <strategy>::
 243 --strategy=<strategy>::
 244         Use the given merge strategy.
 245         If there is no `-s` option 'git merge-recursive' is used
 246         instead.  This implies --merge.
 247 +
 248 Because 'git rebase' replays each commit from the working branch
 249 on top of the <upstream> branch using the given strategy, using
 250 the 'ours' strategy simply discards all patches from the <branch>,
 251 which makes little sense.
 252
 253 -q::
 254 --quiet::
 255         Be quiet. Implies --no-stat.
 256
 257 -v::
 258 --verbose::
 259         Be verbose. Implies --stat.
 260
 261 --stat::
 262         Show a diffstat of what changed upstream since the last rebase. The
 263         diffstat is also controlled by the configuration option rebase.stat.
 264
 265 -n::
 266 --no-stat::
 267         Do not show a diffstat as part of the rebase process.
 268
 269 --no-verify::
 270         This option bypasses the pre-rebase hook.  See also linkgit:githooks[5].
 271
 272 -C<n>::
 273         Ensure at least <n> lines of surrounding context match before
 274         and after each change.  When fewer lines of surrounding
 275         context exist they all must match.  By default no context is
 276         ever ignored.
 277
 278 -f::
 279 --force-rebase::
 280         Force the rebase even if the current branch is a descendant
 281         of the commit you are rebasing onto.  Normally non-interactive rebase will
 282         exit with the message "Current branch is up to date" in such a
 283         situation.
 284         Incompatible with the --interactive option.
 285 +
 286 You may find this (or --no-ff with an interactive rebase) helpful after
 287 reverting a topic branch merge, as this option recreates the topic branch with
 288 fresh commits so it can be remerged successfully without needing to "revert
 289 the reversion" (see the
 290 link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details).
 291
 292 --ignore-whitespace::
 293 --whitespace=<option>::
 294         These flag are passed to the 'git apply' program
 295         (see linkgit:git-apply[1]) that applies the patch.
 296         Incompatible with the --interactive option.
 297
 298 --committer-date-is-author-date::
 299 --ignore-date::
 300         These flags are passed to 'git am' to easily change the dates
 301         of the rebased commits (see linkgit:git-am[1]).
 302         Incompatible with the --interactive option.
 303
 304 -i::
 305 --interactive::
 306         Make a list of the commits which are about to be rebased.  Let the
 307         user edit that list before rebasing.  This mode can also be used to
 308         split commits (see SPLITTING COMMITS below).
 309
 310 -p::
 311 --preserve-merges::
 312         Instead of ignoring merges, try to recreate them.
 313
 314 --root::
 315         Rebase all commits reachable from <branch>, instead of
 316         limiting them with an <upstream>.  This allows you to rebase
 317         the root commit(s) on a branch.  Must be used with --onto, and
 318         will skip changes already contained in <newbase> (instead of
 319         <upstream>).  When used together with --preserve-merges, 'all'
 320         root commits will be rewritten to have <newbase> as parent
 321         instead.
 322
 323 --autosquash::
 324         When the commit log message begins with "squash! ..." (or
 325         "fixup! ..."), and there is a commit whose title begins with
 326         the same ..., automatically modify the todo list of rebase -i
 327         so that the commit marked for squashing comes right after the
 328         commit to be modified, and change the action of the moved
 329         commit from `pick` to `squash` (or `fixup`).
 330 +
 331 This option is only valid when the '--interactive' option is used.
 332
 333 --no-ff::
 334         With --interactive, cherry-pick all rebased commits instead of
 335         fast-forwarding over the unchanged ones.  This ensures that the
 336         entire history of the rebased branch is composed of new commits.
 337 +
 338 Without --interactive, this is a synonym for --force-rebase.
 339 +
 340 You may find this helpful after reverting a topic branch merge, as this option
 341 recreates the topic branch with fresh commits so it can be remerged
 342 successfully without needing to "revert the reversion" (see the
 343 link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details).
 344
 345 include::merge-strategies.txt[]
 346
 347 NOTES
 348 -----
 349
 350 You should understand the implications of using 'git rebase' on a
 351 repository that you share.  See also RECOVERING FROM UPSTREAM REBASE
 352 below.
 353
 354 When the git-rebase command is run, it will first execute a "pre-rebase"
 355 hook if one exists.  You can use this hook to do sanity checks and
 356 reject the rebase if it isn't appropriate.  Please see the template
 357 pre-rebase hook script for an example.
 358
 359 Upon completion, <branch> will be the current branch.
 360
 361 INTERACTIVE MODE
 362 ----------------
 363
 364 Rebasing interactively means that you have a chance to edit the commits
 365 which are rebased.  You can reorder the commits, and you can
 366 remove them (weeding out bad or otherwise unwanted patches).
 367
 368 The interactive mode is meant for this type of workflow:
 369
 370 1. have a wonderful idea
 371 2. hack on the code
 372 3. prepare a series for submission
 373 4. submit
 374
 375 where point 2. consists of several instances of
 376
 377 a. regular use
 378  1. finish something worthy of a commit
 379  2. commit
 380 b. independent fixup
 381  1. realize that something does not work
 382  2. fix that
 383  3. commit it
 384
 385 Sometimes the thing fixed in b.2. cannot be amended to the not-quite
 386 perfect commit it fixes, because that commit is buried deeply in a
 387 patch series.  That is exactly what interactive rebase is for: use it
 388 after plenty of "a"s and "b"s, by rearranging and editing
 389 commits, and squashing multiple commits into one.
 390
 391 Start it with the last commit you want to retain as-is:
 392
 393         git rebase -i <after-this-commit>
 394
 395 An editor will be fired up with all the commits in your current branch
 396 (ignoring merge commits), which come after the given commit.  You can
 397 reorder the commits in this list to your heart's content, and you can
 398 remove them.  The list looks more or less like this:
 399
 400 -------------------------------------------
 401 pick deadbee The oneline of this commit
 402 pick fa1afe1 The oneline of the next commit
 403 ...
 404 -------------------------------------------
 405
 406 The oneline descriptions are purely for your pleasure; 'git rebase' will
 407 not look at them but at the commit names ("deadbee" and "fa1afe1" in this
 408 example), so do not delete or edit the names.
 409
 410 By replacing the command "pick" with the command "edit", you can tell
 411 'git rebase' to stop after applying that commit, so that you can edit
 412 the files and/or the commit message, amend the commit, and continue
 413 rebasing.
 414
 415 If you just want to edit the commit message for a commit, replace the
 416 command "pick" with the command "reword".
 417
 418 If you want to fold two or more commits into one, replace the command
 419 "pick" for the second and subsequent commits with "squash" or "fixup".
 420 If the commits had different authors, the folded commit will be
 421 attributed to the author of the first commit.  The suggested commit
 422 message for the folded commit is the concatenation of the commit
 423 messages of the first commit and of those with the "squash" command,
 424 but omits the commit messages of commits with the "fixup" command.
 425
 426 'git rebase' will stop when "pick" has been replaced with "edit" or
 427 when a command fails due to merge errors. When you are done editing
 428 and/or resolving conflicts you can continue with `git rebase --continue`.
 429
 430 For example, if you want to reorder the last 5 commits, such that what
 431 was HEAD~4 becomes the new HEAD. To achieve that, you would call
 432 'git rebase' like this:
 433
 434 ----------------------
 435 $ git rebase -i HEAD~5
 436 ----------------------
 437
 438 And move the first patch to the end of the list.
 439
 440 You might want to preserve merges, if you have a history like this:
 441
 442 ------------------
 443            X
 444             \
 445          A---M---B
 446         /
 447 ---o---O---P---Q
 448 ------------------
 449
 450 Suppose you want to rebase the side branch starting at "A" to "Q". Make
 451 sure that the current HEAD is "B", and call
 452
 453 -----------------------------
 454 $ git rebase -i -p --onto Q O
 455 -----------------------------
 456
 457
 458 SPLITTING COMMITS
 459 -----------------
 460
 461 In interactive mode, you can mark commits with the action "edit".  However,
 462 this does not necessarily mean that 'git rebase' expects the result of this
 463 edit to be exactly one commit.  Indeed, you can undo the commit, or you can
 464 add other commits.  This can be used to split a commit into two:
 465
 466 - Start an interactive rebase with `git rebase -i <commit>^`, where
 467   <commit> is the commit you want to split.  In fact, any commit range
 468   will do, as long as it contains that commit.
 469
 470 - Mark the commit you want to split with the action "edit".
 471
 472 - When it comes to editing that commit, execute `git reset HEAD^`.  The
 473   effect is that the HEAD is rewound by one, and the index follows suit.
 474   However, the working tree stays the same.
 475
 476 - Now add the changes to the index that you want to have in the first
 477   commit.  You can use `git add` (possibly interactively) or
 478   'git gui' (or both) to do that.
 479
 480 - Commit the now-current index with whatever commit message is appropriate
 481   now.
 482
 483 - Repeat the last two steps until your working tree is clean.
 484
 485 - Continue the rebase with `git rebase --continue`.
 486
 487 If you are not absolutely sure that the intermediate revisions are
 488 consistent (they compile, pass the testsuite, etc.) you should use
 489 'git stash' to stash away the not-yet-committed changes
 490 after each commit, test, and amend the commit if fixes are necessary.
 491
 492
 493 RECOVERING FROM UPSTREAM REBASE
 494 -------------------------------
 495
 496 Rebasing (or any other form of rewriting) a branch that others have
 497 based work on is a bad idea: anyone downstream of it is forced to
 498 manually fix their history.  This section explains how to do the fix
 499 from the downstream's point of view.  The real fix, however, would be
 500 to avoid rebasing the upstream in the first place.
 501
 502 To illustrate, suppose you are in a situation where someone develops a
 503 'subsystem' branch, and you are working on a 'topic' that is dependent
 504 on this 'subsystem'.  You might end up with a history like the
 505 following:
 506
 507 ------------
 508     o---o---o---o---o---o---o---o---o  master
 509          \
 510           o---o---o---o---o  subsystem
 511                            \
 512                             *---*---*  topic
 513 ------------
 514
 515 If 'subsystem' is rebased against 'master', the following happens:
 516
 517 ------------
 518     o---o---o---o---o---o---o---o  master
 519          \                       \
 520           o---o---o---o---o       o'--o'--o'--o'--o'  subsystem
 521                            \
 522                             *---*---*  topic
 523 ------------
 524
 525 If you now continue development as usual, and eventually merge 'topic'
 526 to 'subsystem', the commits from 'subsystem' will remain duplicated forever:
 527
 528 ------------
 529     o---o---o---o---o---o---o---o  master
 530          \                       \
 531           o---o---o---o---o       o'--o'--o'--o'--o'--M  subsystem
 532                            \                         /
 533                             *---*---*-..........-*--*  topic
 534 ------------
 535
 536 Such duplicates are generally frowned upon because they clutter up
 537 history, making it harder to follow.  To clean things up, you need to
 538 transplant the commits on 'topic' to the new 'subsystem' tip, i.e.,
 539 rebase 'topic'.  This becomes a ripple effect: anyone downstream from
 540 'topic' is forced to rebase too, and so on!
 541
 542 There are two kinds of fixes, discussed in the following subsections:
 543
 544 Easy case: The changes are literally the same.::
 545
 546         This happens if the 'subsystem' rebase was a simple rebase and
 547         had no conflicts.
 548
 549 Hard case: The changes are not the same.::
 550
 551         This happens if the 'subsystem' rebase had conflicts, or used
 552         `\--interactive` to omit, edit, squash, or fixup commits; or
 553         if the upstream used one of `commit \--amend`, `reset`, or
 554         `filter-branch`.
 555
 556
 557 The easy case
 558 ~~~~~~~~~~~~~
 559
 560 Only works if the changes (patch IDs based on the diff contents) on
 561 'subsystem' are literally the same before and after the rebase
 562 'subsystem' did.
 563
 564 In that case, the fix is easy because 'git rebase' knows to skip
 565 changes that are already present in the new upstream.  So if you say
 566 (assuming you're on 'topic')
 567 ------------
 568     $ git rebase subsystem
 569 ------------
 570 you will end up with the fixed history
 571 ------------
 572     o---o---o---o---o---o---o---o  master
 573                                  \
 574                                   o'--o'--o'--o'--o'  subsystem
 575                                                    \
 576                                                     *---*---*  topic
 577 ------------
 578
 579
 580 The hard case
 581 ~~~~~~~~~~~~~
 582
 583 Things get more complicated if the 'subsystem' changes do not exactly
 584 correspond to the ones before the rebase.
 585
 586 NOTE: While an "easy case recovery" sometimes appears to be successful
 587       even in the hard case, it may have unintended consequences.  For
 588       example, a commit that was removed via `git rebase
 589       \--interactive` will be **resurrected**!
 590
 591 The idea is to manually tell 'git rebase' "where the old 'subsystem'
 592 ended and your 'topic' began", that is, what the old merge-base
 593 between them was.  You will have to find a way to name the last commit
 594 of the old 'subsystem', for example:
 595
 596 * With the 'subsystem' reflog: after 'git fetch', the old tip of
 597   'subsystem' is at `subsystem@\{1}`.  Subsequent fetches will
 598   increase the number.  (See linkgit:git-reflog[1].)
 599
 600 * Relative to the tip of 'topic': knowing that your 'topic' has three
 601   commits, the old tip of 'subsystem' must be `topic~3`.
 602
 603 You can then transplant the old `subsystem..topic` to the new tip by
 604 saying (for the reflog case, and assuming you are on 'topic' already):
 605 ------------
 606     $ git rebase --onto subsystem subsystem@{1}
 607 ------------
 608
 609 The ripple effect of a "hard case" recovery is especially bad:
 610 'everyone' downstream from 'topic' will now have to perform a "hard
 611 case" recovery too!
 612
 613
 614 Authors
 615 ------
 616 Written by Junio C Hamano <gitster@pobox.com> and
 617 Johannes E. Schindelin <johannes.schindelin@gmx.de>
 618
 619 Documentation
 620 --------------
 621 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 622
 623 GIT
 624 ---
 625 Part of the linkgit:git[1] suite