doc: A few minor copy edits.
[git/jnareb-git.git] / Documentation / git-rebase.txt
1 git-rebase(1)
2 =============
5 ----
6 git-rebase - Forward-port local commits to the updated upstream head
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 'git rebase' --continue | --skip | --abort
18 -----------
19 If <branch> is specified, 'git rebase' will perform an automatic
20 `git checkout <branch>` before doing anything else.  Otherwise
21 it remains on the current branch.
23 If <upstream> is not specified, the upstream configured in
24 branch.<name>.remote and branch.<name>.merge options will be used; see
25 linkgit:git-config[1] for details.  If you are currently not on any
26 branch or if the current branch does not have a configured upstream,
27 the rebase will abort.
29 All changes made by commits in the current branch but that are not
30 in <upstream> are saved to a temporary area.  This is the same set
31 of commits that would be shown by `git log <upstream>..HEAD` (or
32 `git log HEAD`, if --root is specified).
34 The current branch is reset to <upstream>, or <newbase> if the
35 --onto option was supplied.  This has the exact same effect as
36 `git reset --hard <upstream>` (or <newbase>).  ORIG_HEAD is set
37 to point at the tip of the branch before the reset.
39 The commits that were previously saved into the temporary area are
40 then reapplied to the current branch, one by one, in order. Note that
41 any commits in HEAD which introduce the same textual changes as a commit
42 in HEAD..<upstream> are omitted (i.e., a patch already accepted upstream
43 with a different commit message or timestamp will be skipped).
45 It is possible that a merge failure will prevent this process from being
46 completely automatic.  You will have to resolve any such merge failure
47 and run `git rebase --continue`.  Another option is to bypass the commit
48 that caused the merge failure with `git rebase --skip`.  To check out the
49 original <branch> and remove the .git/rebase-apply working files, use the
50 command `git rebase --abort` instead.
52 Assume the following history exists and the current branch is "topic":
54 ------------
55           A---B---C topic
56          /
57     D---E---F---G master
58 ------------
60 From this point, the result of either of the following commands:
63     git rebase master
64     git rebase master topic
66 would be:
68 ------------
69                   A'--B'--C' topic
70                  /
71     D---E---F---G master
72 ------------
74 *NOTE:* The latter form is just a short-hand of `git checkout topic`
75 followed by `git rebase master`. When rebase exits `topic` will
76 remain the checked-out branch.
78 If the upstream branch already contains a change you have made (e.g.,
79 because you mailed a patch which was applied upstream), then that commit
80 will be skipped. For example, running `git rebase master` on the
81 following history (in which A' and A introduce the same set of changes,
82 but have different committer information):
84 ------------
85           A---B---C topic
86          /
87     D---E---A'---F master
88 ------------
90 will result in:
92 ------------
93                    B'---C' topic
94                   /
95     D---E---A'---F master
96 ------------
98 Here is how you would transplant a topic branch based on one
99 branch to another, to pretend that you forked the topic branch
100 from the latter branch, using `rebase --onto`.
102 First let's assume your 'topic' is based on branch 'next'.
103 For example, a feature developed in 'topic' depends on some
104 functionality which is found in 'next'.
106 ------------
107     o---o---o---o---o  master
108          \
109           o---o---o---o---o  next
110                            \
111                             o---o---o  topic
112 ------------
114 We want to make 'topic' forked from branch 'master'; for example,
115 because the functionality on which 'topic' depends was merged into the
116 more stable 'master' branch. We want our tree to look like this:
118 ------------
119     o---o---o---o---o  master
120         |            \
121         |             o'--o'--o'  topic
122          \
123           o---o---o---o---o  next
124 ------------
126 We can get this using the following command:
128     git rebase --onto master next topic
131 Another example of --onto option is to rebase part of a
132 branch.  If we have the following situation:
134 ------------
135                             H---I---J topicB
136                            /
137                   E---F---G  topicA
138                  /
139     A---B---C---D  master
140 ------------
142 then the command
144     git rebase --onto master topicA topicB
146 would result in:
148 ------------
149                  H'--I'--J'  topicB
150                 /
151                 | E---F---G  topicA
152                 |/
153     A---B---C---D  master
154 ------------
156 This is useful when topicB does not depend on topicA.
158 A range of commits could also be removed with rebase.  If we have
159 the following situation:
161 ------------
162     E---F---G---H---I---J  topicA
163 ------------
165 then the command
167     git rebase --onto topicA~5 topicA~3 topicA
169 would result in the removal of commits F and G:
171 ------------
172     E---H'---I'---J'  topicA
173 ------------
175 This is useful if F and G were flawed in some way, or should not be
176 part of topicA.  Note that the argument to --onto and the <upstream>
177 parameter can be any valid commit-ish.
179 In case of conflict, 'git rebase' will stop at the first problematic commit
180 and leave conflict markers in the tree.  You can use 'git diff' to locate
181 the markers (<<<<<<) and make edits to resolve the conflict.  For each
182 file you edit, you need to tell git that the conflict has been resolved,
183 typically this would be done with
186     git add <filename>
189 After resolving the conflict manually and updating the index with the
190 desired resolution, you can continue the rebasing process with
193     git rebase --continue
196 Alternatively, you can undo the 'git rebase' with
199     git rebase --abort
202 -------------
204 rebase.stat::
205         Whether to show a diffstat of what changed upstream since the last
206         rebase. False by default.
208 rebase.autosquash::
209         If set to true enable '--autosquash' option by default.
212 -------
213 <newbase>::
214         Starting point at which to create the new commits. If the
215         --onto option is not specified, the starting point is
216         <upstream>.  May be any valid commit, and not just an
217         existing branch name.
219 As a special case, you may use "A\...B" as a shortcut for the
220 merge base of A and B if there is exactly one merge base. You can
221 leave out at most one of A and B, in which case it defaults to HEAD.
223 <upstream>::
224         Upstream branch to compare against.  May be any valid commit,
225         not just an existing branch name. Defaults to the configured
226         upstream for the current branch.
228 <branch>::
229         Working branch; defaults to HEAD.
231 --continue::
232         Restart the rebasing process after having resolved a merge conflict.
234 --abort::
235         Abort the rebase operation and reset HEAD to the original
236         branch. If <branch> was provided when the rebase operation was
237         started, then HEAD will be reset to <branch>. Otherwise HEAD
238         will be reset to where it was when the rebase operation was
239         started.
241 --keep-empty::
242         Keep the commits that do not change anything from its
243         parents in the result.
245 --skip::
246         Restart the rebasing process by skipping the current patch.
248 -m::
249 --merge::
250         Use merging strategies to rebase.  When the recursive (default) merge
251         strategy is used, this allows rebase to be aware of renames on the
252         upstream side.
254 Note that a rebase merge works by replaying each commit from the working
255 branch on top of the <upstream> branch.  Because of this, when a merge
256 conflict happens, the side reported as 'ours' is the so-far rebased
257 series, starting with <upstream>, and 'theirs' is the working branch.  In
258 other words, the sides are swapped.
260 -s <strategy>::
261 --strategy=<strategy>::
262         Use the given merge strategy.
263         If there is no `-s` option 'git merge-recursive' is used
264         instead.  This implies --merge.
266 Because 'git rebase' replays each commit from the working branch
267 on top of the <upstream> branch using the given strategy, using
268 the 'ours' strategy simply discards all patches from the <branch>,
269 which makes little sense.
271 -X <strategy-option>::
272 --strategy-option=<strategy-option>::
273         Pass the <strategy-option> through to the merge strategy.
274         This implies `--merge` and, if no strategy has been
275         specified, `-s recursive`.  Note the reversal of 'ours' and
276         'theirs' as noted above for the `-m` option.
278 -q::
279 --quiet::
280         Be quiet. Implies --no-stat.
282 -v::
283 --verbose::
284         Be verbose. Implies --stat.
286 --stat::
287         Show a diffstat of what changed upstream since the last rebase. The
288         diffstat is also controlled by the configuration option rebase.stat.
290 -n::
291 --no-stat::
292         Do not show a diffstat as part of the rebase process.
294 --no-verify::
295         This option bypasses the pre-rebase hook.  See also linkgit:githooks[5].
297 --verify::
298         Allows the pre-rebase hook to run, which is the default.  This option can
299         be used to override --no-verify.  See also linkgit:githooks[5].
301 -C<n>::
302         Ensure at least <n> lines of surrounding context match before
303         and after each change.  When fewer lines of surrounding
304         context exist they all must match.  By default no context is
305         ever ignored.
307 -f::
308 --force-rebase::
309         Force the rebase even if the current branch is a descendant
310         of the commit you are rebasing onto.  Normally non-interactive rebase will
311         exit with the message "Current branch is up to date" in such a
312         situation.
313         Incompatible with the --interactive option.
315 You may find this (or --no-ff with an interactive rebase) helpful after
316 reverting a topic branch merge, as this option recreates the topic branch with
317 fresh commits so it can be remerged successfully without needing to "revert
318 the reversion" (see the
319 link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details).
321 --ignore-whitespace::
322 --whitespace=<option>::
323         These flag are passed to the 'git apply' program
324         (see linkgit:git-apply[1]) that applies the patch.
325         Incompatible with the --interactive option.
327 --committer-date-is-author-date::
328 --ignore-date::
329         These flags are passed to 'git am' to easily change the dates
330         of the rebased commits (see linkgit:git-am[1]).
331         Incompatible with the --interactive option.
333 -i::
334 --interactive::
335         Make a list of the commits which are about to be rebased.  Let the
336         user edit that list before rebasing.  This mode can also be used to
337         split commits (see SPLITTING COMMITS below).
339 -p::
340 --preserve-merges::
341         Instead of ignoring merges, try to recreate them.
343 This uses the `--interactive` machinery internally, but combining it
344 with the `--interactive` option explicitly is generally not a good
345 idea unless you know what you are doing (see BUGS below).
348 --root::
349         Rebase all commits reachable from <branch>, instead of
350         limiting them with an <upstream>.  This allows you to rebase
351         the root commit(s) on a branch.  Must be used with --onto, and
352         will skip changes already contained in <newbase> (instead of
353         <upstream>).  When used together with --preserve-merges, 'all'
354         root commits will be rewritten to have <newbase> as parent
355         instead.
357 --autosquash::
358 --no-autosquash::
359         When the commit log message begins with "squash! ..." (or
360         "fixup! ..."), and there is a commit whose title begins with
361         the same ..., automatically modify the todo list of rebase -i
362         so that the commit marked for squashing comes right after the
363         commit to be modified, and change the action of the moved
364         commit from `pick` to `squash` (or `fixup`).
366 This option is only valid when the '--interactive' option is used.
368 If the '--autosquash' option is enabled by default using the
369 configuration variable `rebase.autosquash`, this option can be
370 used to override and disable this setting.
372 --no-ff::
373         With --interactive, cherry-pick all rebased commits instead of
374         fast-forwarding over the unchanged ones.  This ensures that the
375         entire history of the rebased branch is composed of new commits.
377 Without --interactive, this is a synonym for --force-rebase.
379 You may find this helpful after reverting a topic branch merge, as this option
380 recreates the topic branch with fresh commits so it can be remerged
381 successfully without needing to "revert the reversion" (see the
382 link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details).
384 include::merge-strategies.txt[]
387 -----
389 You should understand the implications of using 'git rebase' on a
390 repository that you share.  See also RECOVERING FROM UPSTREAM REBASE
391 below.
393 When the git-rebase command is run, it will first execute a "pre-rebase"
394 hook if one exists.  You can use this hook to do sanity checks and
395 reject the rebase if it isn't appropriate.  Please see the template
396 pre-rebase hook script for an example.
398 Upon completion, <branch> will be the current branch.
401 ----------------
403 Rebasing interactively means that you have a chance to edit the commits
404 which are rebased.  You can reorder the commits, and you can
405 remove them (weeding out bad or otherwise unwanted patches).
407 The interactive mode is meant for this type of workflow:
409 1. have a wonderful idea
410 2. hack on the code
411 3. prepare a series for submission
412 4. submit
414 where point 2. consists of several instances of
416 a) regular use
418  1. finish something worthy of a commit
419  2. commit
421 b) independent fixup
423  1. realize that something does not work
424  2. fix that
425  3. commit it
427 Sometimes the thing fixed in b.2. cannot be amended to the not-quite
428 perfect commit it fixes, because that commit is buried deeply in a
429 patch series.  That is exactly what interactive rebase is for: use it
430 after plenty of "a"s and "b"s, by rearranging and editing
431 commits, and squashing multiple commits into one.
433 Start it with the last commit you want to retain as-is:
435         git rebase -i <after-this-commit>
437 An editor will be fired up with all the commits in your current branch
438 (ignoring merge commits), which come after the given commit.  You can
439 reorder the commits in this list to your heart's content, and you can
440 remove them.  The list looks more or less like this:
442 -------------------------------------------
443 pick deadbee The oneline of this commit
444 pick fa1afe1 The oneline of the next commit
446 -------------------------------------------
448 The oneline descriptions are purely for your pleasure; 'git rebase' will
449 not look at them but at the commit names ("deadbee" and "fa1afe1" in this
450 example), so do not delete or edit the names.
452 By replacing the command "pick" with the command "edit", you can tell
453 'git rebase' to stop after applying that commit, so that you can edit
454 the files and/or the commit message, amend the commit, and continue
455 rebasing.
457 If you just want to edit the commit message for a commit, replace the
458 command "pick" with the command "reword".
460 If you want to fold two or more commits into one, replace the command
461 "pick" for the second and subsequent commits with "squash" or "fixup".
462 If the commits had different authors, the folded commit will be
463 attributed to the author of the first commit.  The suggested commit
464 message for the folded commit is the concatenation of the commit
465 messages of the first commit and of those with the "squash" command,
466 but omits the commit messages of commits with the "fixup" command.
468 'git rebase' will stop when "pick" has been replaced with "edit" or
469 when a command fails due to merge errors. When you are done editing
470 and/or resolving conflicts you can continue with `git rebase --continue`.
472 For example, if you want to reorder the last 5 commits, such that what
473 was HEAD~4 becomes the new HEAD. To achieve that, you would call
474 'git rebase' like this:
476 ----------------------
477 $ git rebase -i HEAD~5
478 ----------------------
480 And move the first patch to the end of the list.
482 You might want to preserve merges, if you have a history like this:
484 ------------------
485            X
486             \
487          A---M---B
488         /
489 ---o---O---P---Q
490 ------------------
492 Suppose you want to rebase the side branch starting at "A" to "Q". Make
493 sure that the current HEAD is "B", and call
495 -----------------------------
496 $ git rebase -i -p --onto Q O
497 -----------------------------
499 Reordering and editing commits usually creates untested intermediate
500 steps.  You may want to check that your history editing did not break
501 anything by running a test, or at least recompiling at intermediate
502 points in history by using the "exec" command (shortcut "x").  You may
503 do so by creating a todo list like this one:
505 -------------------------------------------
506 pick deadbee Implement feature XXX
507 fixup f1a5c00 Fix to feature XXX
508 exec make
509 pick c0ffeee The oneline of the next commit
510 edit deadbab The oneline of the commit after
511 exec cd subdir; make test
513 -------------------------------------------
515 The interactive rebase will stop when a command fails (i.e. exits with
516 non-0 status) to give you an opportunity to fix the problem. You can
517 continue with `git rebase --continue`.
519 The "exec" command launches the command in a shell (the one specified
520 in `$SHELL`, or the default shell if `$SHELL` is not set), so you can
521 use shell features (like "cd", ">", ";" ...). The command is run from
522 the root of the working tree.
525 -----------------
527 In interactive mode, you can mark commits with the action "edit".  However,
528 this does not necessarily mean that 'git rebase' expects the result of this
529 edit to be exactly one commit.  Indeed, you can undo the commit, or you can
530 add other commits.  This can be used to split a commit into two:
532 - Start an interactive rebase with `git rebase -i <commit>^`, where
533   <commit> is the commit you want to split.  In fact, any commit range
534   will do, as long as it contains that commit.
536 - Mark the commit you want to split with the action "edit".
538 - When it comes to editing that commit, execute `git reset HEAD^`.  The
539   effect is that the HEAD is rewound by one, and the index follows suit.
540   However, the working tree stays the same.
542 - Now add the changes to the index that you want to have in the first
543   commit.  You can use `git add` (possibly interactively) or
544   'git gui' (or both) to do that.
546 - Commit the now-current index with whatever commit message is appropriate
547   now.
549 - Repeat the last two steps until your working tree is clean.
551 - Continue the rebase with `git rebase --continue`.
553 If you are not absolutely sure that the intermediate revisions are
554 consistent (they compile, pass the testsuite, etc.) you should use
555 'git stash' to stash away the not-yet-committed changes
556 after each commit, test, and amend the commit if fixes are necessary.
560 -------------------------------
562 Rebasing (or any other form of rewriting) a branch that others have
563 based work on is a bad idea: anyone downstream of it is forced to
564 manually fix their history.  This section explains how to do the fix
565 from the downstream's point of view.  The real fix, however, would be
566 to avoid rebasing the upstream in the first place.
568 To illustrate, suppose you are in a situation where someone develops a
569 'subsystem' branch, and you are working on a 'topic' that is dependent
570 on this 'subsystem'.  You might end up with a history like the
571 following:
573 ------------
574     o---o---o---o---o---o---o---o---o  master
575          \
576           o---o---o---o---o  subsystem
577                            \
578                             *---*---*  topic
579 ------------
581 If 'subsystem' is rebased against 'master', the following happens:
583 ------------
584     o---o---o---o---o---o---o---o  master
585          \                       \
586           o---o---o---o---o       o'--o'--o'--o'--o'  subsystem
587                            \
588                             *---*---*  topic
589 ------------
591 If you now continue development as usual, and eventually merge 'topic'
592 to 'subsystem', the commits from 'subsystem' will remain duplicated forever:
594 ------------
595     o---o---o---o---o---o---o---o  master
596          \                       \
597           o---o---o---o---o       o'--o'--o'--o'--o'--M  subsystem
598                            \                         /
599                             *---*---*-..........-*--*  topic
600 ------------
602 Such duplicates are generally frowned upon because they clutter up
603 history, making it harder to follow.  To clean things up, you need to
604 transplant the commits on 'topic' to the new 'subsystem' tip, i.e.,
605 rebase 'topic'.  This becomes a ripple effect: anyone downstream from
606 'topic' is forced to rebase too, and so on!
608 There are two kinds of fixes, discussed in the following subsections:
610 Easy case: The changes are literally the same.::
612         This happens if the 'subsystem' rebase was a simple rebase and
613         had no conflicts.
615 Hard case: The changes are not the same.::
617         This happens if the 'subsystem' rebase had conflicts, or used
618         `--interactive` to omit, edit, squash, or fixup commits; or
619         if the upstream used one of `commit --amend`, `reset`, or
620         `filter-branch`.
623 The easy case
624 ~~~~~~~~~~~~~
626 Only works if the changes (patch IDs based on the diff contents) on
627 'subsystem' are literally the same before and after the rebase
628 'subsystem' did.
630 In that case, the fix is easy because 'git rebase' knows to skip
631 changes that are already present in the new upstream.  So if you say
632 (assuming you're on 'topic')
633 ------------
634     $ git rebase subsystem
635 ------------
636 you will end up with the fixed history
637 ------------
638     o---o---o---o---o---o---o---o  master
639                                  \
640                                   o'--o'--o'--o'--o'  subsystem
641                                                    \
642                                                     *---*---*  topic
643 ------------
646 The hard case
647 ~~~~~~~~~~~~~
649 Things get more complicated if the 'subsystem' changes do not exactly
650 correspond to the ones before the rebase.
652 NOTE: While an "easy case recovery" sometimes appears to be successful
653       even in the hard case, it may have unintended consequences.  For
654       example, a commit that was removed via `git rebase
655       --interactive` will be **resurrected**!
657 The idea is to manually tell 'git rebase' "where the old 'subsystem'
658 ended and your 'topic' began", that is, what the old merge-base
659 between them was.  You will have to find a way to name the last commit
660 of the old 'subsystem', for example:
662 * With the 'subsystem' reflog: after 'git fetch', the old tip of
663   'subsystem' is at `subsystem@{1}`.  Subsequent fetches will
664   increase the number.  (See linkgit:git-reflog[1].)
666 * Relative to the tip of 'topic': knowing that your 'topic' has three
667   commits, the old tip of 'subsystem' must be `topic~3`.
669 You can then transplant the old `subsystem..topic` to the new tip by
670 saying (for the reflog case, and assuming you are on 'topic' already):
671 ------------
672     $ git rebase --onto subsystem subsystem@{1}
673 ------------
675 The ripple effect of a "hard case" recovery is especially bad:
676 'everyone' downstream from 'topic' will now have to perform a "hard
677 case" recovery too!
679 BUGS
680 ----
681 The todo list presented by `--preserve-merges --interactive` does not
682 represent the topology of the revision graph.  Editing commits and
683 rewording their commit messages should work fine, but attempts to
684 reorder commits tend to produce counterintuitive results.
686 For example, an attempt to rearrange
687 ------------
688 1 --- 2 --- 3 --- 4 --- 5
689 ------------
691 ------------
692 1 --- 2 --- 4 --- 3 --- 5
693 ------------
694 by moving the "pick 4" line will result in the following history:
695 ------------
696         3
697        /
698 1 --- 2 --- 4 --- 5
699 ------------
703 Part of the linkgit:git[1] suite