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 OPTIONS
 196 -------
 197 <newbase>::
 198         Starting point at which to create the new commits. If the
 199         --onto option is not specified, the starting point is
 200         <upstream>.  May be any valid commit, and not just an
 201         existing branch name.
 202
 203 <upstream>::
 204         Upstream branch to compare against.  May be any valid commit,
 205         not just an existing branch name.
 206
 207 <branch>::
 208         Working branch; defaults to HEAD.
 209
 210 --continue::
 211         Restart the rebasing process after having resolved a merge conflict.
 212
 213 --abort::
 214         Restore the original branch and abort the rebase operation.
 215
 216 --skip::
 217         Restart the rebasing process by skipping the current patch.
 218
 219 -m::
 220 --merge::
 221         Use merging strategies to rebase.  When the recursive (default) merge
 222         strategy is used, this allows rebase to be aware of renames on the
 223         upstream side.
 224
 225 -s <strategy>::
 226 --strategy=<strategy>::
 227         Use the given merge strategy; can be supplied more than
 228         once to specify them in the order they should be tried.
 229         If there is no `-s` option, a built-in list of strategies
 230         is used instead ('git-merge-recursive' when merging a single
 231         head, 'git-merge-octopus' otherwise).  This implies --merge.
 232
 233 -v::
 234 --verbose::
 235         Display a diffstat of what changed upstream since the last rebase.
 236
 237 --no-verify::
 238         This option bypasses the pre-rebase hook.  See also linkgit:githooks[5].
 239
 240 -C<n>::
 241         Ensure at least <n> lines of surrounding context match before
 242         and after each change.  When fewer lines of surrounding
 243         context exist they all must match.  By default no context is
 244         ever ignored.
 245
 246 --whitespace=<nowarn|warn|error|error-all|strip>::
 247         This flag is passed to the 'git-apply' program
 248         (see linkgit:git-apply[1]) that applies the patch.
 249
 250 -i::
 251 --interactive::
 252         Make a list of the commits which are about to be rebased.  Let the
 253         user edit that list before rebasing.  This mode can also be used to
 254         split commits (see SPLITTING COMMITS below).
 255
 256 -p::
 257 --preserve-merges::
 258         Instead of ignoring merges, try to recreate them.
 259
 260 --root::
 261         Rebase all commits reachable from <branch>, instead of
 262         limiting them with an <upstream>.  This allows you to rebase
 263         the root commit(s) on a branch.  Must be used with --onto, and
 264         will skip changes already contained in <newbase> (instead of
 265         <upstream>).  When used together with --preserve-merges, 'all'
 266         root commits will be rewritten to have <newbase> as parent
 267         instead.
 268
 269 include::merge-strategies.txt[]
 270
 271 NOTES
 272 -----
 273
 274 You should understand the implications of using 'git-rebase' on a
 275 repository that you share.  See also RECOVERING FROM UPSTREAM REBASE
 276 below.
 277
 278 When the git-rebase command is run, it will first execute a "pre-rebase"
 279 hook if one exists.  You can use this hook to do sanity checks and
 280 reject the rebase if it isn't appropriate.  Please see the template
 281 pre-rebase hook script for an example.
 282
 283 Upon completion, <branch> will be the current branch.
 284
 285 INTERACTIVE MODE
 286 ----------------
 287
 288 Rebasing interactively means that you have a chance to edit the commits
 289 which are rebased.  You can reorder the commits, and you can
 290 remove them (weeding out bad or otherwise unwanted patches).
 291
 292 The interactive mode is meant for this type of workflow:
 293
 294 1. have a wonderful idea
 295 2. hack on the code
 296 3. prepare a series for submission
 297 4. submit
 298
 299 where point 2. consists of several instances of
 300
 301 a. regular use
 302  1. finish something worthy of a commit
 303  2. commit
 304 b. independent fixup
 305  1. realize that something does not work
 306  2. fix that
 307  3. commit it
 308
 309 Sometimes the thing fixed in b.2. cannot be amended to the not-quite
 310 perfect commit it fixes, because that commit is buried deeply in a
 311 patch series.  That is exactly what interactive rebase is for: use it
 312 after plenty of "a"s and "b"s, by rearranging and editing
 313 commits, and squashing multiple commits into one.
 314
 315 Start it with the last commit you want to retain as-is:
 316
 317         git rebase -i <after-this-commit>
 318
 319 An editor will be fired up with all the commits in your current branch
 320 (ignoring merge commits), which come after the given commit.  You can
 321 reorder the commits in this list to your heart's content, and you can
 322 remove them.  The list looks more or less like this:
 323
 324 -------------------------------------------
 325 pick deadbee The oneline of this commit
 326 pick fa1afe1 The oneline of the next commit
 327 ...
 328 -------------------------------------------
 329
 330 The oneline descriptions are purely for your pleasure; 'git-rebase' will
 331 not look at them but at the commit names ("deadbee" and "fa1afe1" in this
 332 example), so do not delete or edit the names.
 333
 334 By replacing the command "pick" with the command "edit", you can tell
 335 'git-rebase' to stop after applying that commit, so that you can edit
 336 the files and/or the commit message, amend the commit, and continue
 337 rebasing.
 338
 339 If you want to fold two or more commits into one, replace the command
 340 "pick" with "squash" for the second and subsequent commit.  If the
 341 commits had different authors, it will attribute the squashed commit to
 342 the author of the first commit.
 343
 344 In both cases, or when a "pick" does not succeed (because of merge
 345 errors), the loop will stop to let you fix things, and you can continue
 346 the loop with `git rebase --continue`.
 347
 348 For example, if you want to reorder the last 5 commits, such that what
 349 was HEAD~4 becomes the new HEAD. To achieve that, you would call
 350 'git-rebase' like this:
 351
 352 ----------------------
 353 $ git rebase -i HEAD~5
 354 ----------------------
 355
 356 And move the first patch to the end of the list.
 357
 358 You might want to preserve merges, if you have a history like this:
 359
 360 ------------------
 361            X
 362             \
 363          A---M---B
 364         /
 365 ---o---O---P---Q
 366 ------------------
 367
 368 Suppose you want to rebase the side branch starting at "A" to "Q". Make
 369 sure that the current HEAD is "B", and call
 370
 371 -----------------------------
 372 $ git rebase -i -p --onto Q O
 373 -----------------------------
 374
 375
 376 SPLITTING COMMITS
 377 -----------------
 378
 379 In interactive mode, you can mark commits with the action "edit".  However,
 380 this does not necessarily mean that 'git-rebase' expects the result of this
 381 edit to be exactly one commit.  Indeed, you can undo the commit, or you can
 382 add other commits.  This can be used to split a commit into two:
 383
 384 - Start an interactive rebase with `git rebase -i <commit>^`, where
 385   <commit> is the commit you want to split.  In fact, any commit range
 386   will do, as long as it contains that commit.
 387
 388 - Mark the commit you want to split with the action "edit".
 389
 390 - When it comes to editing that commit, execute `git reset HEAD^`.  The
 391   effect is that the HEAD is rewound by one, and the index follows suit.
 392   However, the working tree stays the same.
 393
 394 - Now add the changes to the index that you want to have in the first
 395   commit.  You can use `git add` (possibly interactively) or
 396   'git-gui' (or both) to do that.
 397
 398 - Commit the now-current index with whatever commit message is appropriate
 399   now.
 400
 401 - Repeat the last two steps until your working tree is clean.
 402
 403 - Continue the rebase with `git rebase --continue`.
 404
 405 If you are not absolutely sure that the intermediate revisions are
 406 consistent (they compile, pass the testsuite, etc.) you should use
 407 'git-stash' to stash away the not-yet-committed changes
 408 after each commit, test, and amend the commit if fixes are necessary.
 409
 410
 411 RECOVERING FROM UPSTREAM REBASE
 412 -------------------------------
 413
 414 Rebasing (or any other form of rewriting) a branch that others have
 415 based work on is a bad idea: anyone downstream of it is forced to
 416 manually fix their history.  This section explains how to do the fix
 417 from the downstream's point of view.  The real fix, however, would be
 418 to avoid rebasing the upstream in the first place.
 419
 420 To illustrate, suppose you are in a situation where someone develops a
 421 'subsystem' branch, and you are working on a 'topic' that is dependent
 422 on this 'subsystem'.  You might end up with a history like the
 423 following:
 424
 425 ------------
 426     o---o---o---o---o---o---o---o---o  master
 427          \
 428           o---o---o---o---o  subsystem
 429                            \
 430                             *---*---*  topic
 431 ------------
 432
 433 If 'subsystem' is rebased against 'master', the following happens:
 434
 435 ------------
 436     o---o---o---o---o---o---o---o  master
 437          \                       \
 438           o---o---o---o---o       o'--o'--o'--o'--o'  subsystem
 439                            \
 440                             *---*---*  topic
 441 ------------
 442
 443 If you now continue development as usual, and eventually merge 'topic'
 444 to 'subsystem', the commits from 'subsystem' will remain duplicated forever:
 445
 446 ------------
 447     o---o---o---o---o---o---o---o  master
 448          \                       \
 449           o---o---o---o---o       o'--o'--o'--o'--o'--M  subsystem
 450                            \                         /
 451                             *---*---*-..........-*--*  topic
 452 ------------
 453
 454 Such duplicates are generally frowned upon because they clutter up
 455 history, making it harder to follow.  To clean things up, you need to
 456 transplant the commits on 'topic' to the new 'subsystem' tip, i.e.,
 457 rebase 'topic'.  This becomes a ripple effect: anyone downstream from
 458 'topic' is forced to rebase too, and so on!
 459
 460 There are two kinds of fixes, discussed in the following subsections:
 461
 462 Easy case: The changes are literally the same.::
 463
 464         This happens if the 'subsystem' rebase was a simple rebase and
 465         had no conflicts.
 466
 467 Hard case: The changes are not the same.::
 468
 469         This happens if the 'subsystem' rebase had conflicts, or used
 470         `\--interactive` to omit, edit, or squash commits; or if the
 471         upstream used one of `commit \--amend`, `reset`, or
 472         `filter-branch`.
 473
 474
 475 The easy case
 476 ~~~~~~~~~~~~~
 477
 478 Only works if the changes (patch IDs based on the diff contents) on
 479 'subsystem' are literally the same before and after the rebase
 480 'subsystem' did.
 481
 482 In that case, the fix is easy because 'git-rebase' knows to skip
 483 changes that are already present in the new upstream.  So if you say
 484 (assuming you're on 'topic')
 485 ------------
 486     $ git rebase subsystem
 487 ------------
 488 you will end up with the fixed history
 489 ------------
 490     o---o---o---o---o---o---o---o  master
 491                                  \
 492                                   o'--o'--o'--o'--o'  subsystem
 493                                                    \
 494                                                     *---*---*  topic
 495 ------------
 496
 497
 498 The hard case
 499 ~~~~~~~~~~~~~
 500
 501 Things get more complicated if the 'subsystem' changes do not exactly
 502 correspond to the ones before the rebase.
 503
 504 NOTE: While an "easy case recovery" sometimes appears to be successful
 505       even in the hard case, it may have unintended consequences.  For
 506       example, a commit that was removed via `git rebase
 507       \--interactive` will be **resurrected**!
 508
 509 The idea is to manually tell 'git-rebase' "where the old 'subsystem'
 510 ended and your 'topic' began", that is, what the old merge-base
 511 between them was.  You will have to find a way to name the last commit
 512 of the old 'subsystem', for example:
 513
 514 * With the 'subsystem' reflog: after 'git-fetch', the old tip of
 515   'subsystem' is at `subsystem@\{1}`.  Subsequent fetches will
 516   increase the number.  (See linkgit:git-reflog[1].)
 517
 518 * Relative to the tip of 'topic': knowing that your 'topic' has three
 519   commits, the old tip of 'subsystem' must be `topic~3`.
 520
 521 You can then transplant the old `subsystem..topic` to the new tip by
 522 saying (for the reflog case, and assuming you are on 'topic' already):
 523 ------------
 524     $ git rebase --onto subsystem subsystem@{1}
 525 ------------
 526
 527 The ripple effect of a "hard case" recovery is especially bad:
 528 'everyone' downstream from 'topic' will now have to perform a "hard
 529 case" recovery too!
 530
 531
 532 Authors
 533 ------
 534 Written by Junio C Hamano <gitster@pobox.com> and
 535 Johannes E. Schindelin <johannes.schindelin@gmx.de>
 536
 537 Documentation
 538 --------------
 539 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 540
 541 GIT
 542 ---
 543 Part of the linkgit:git[1] suite