pack-objects: turn off bitmaps when we split packs
[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] [--exec <cmd>] [--onto <newbase>]
12         [<upstream>] [<branch>]
13 'git rebase' [-i | --interactive] [options] [--exec <cmd>] [--onto <newbase>]
14         --root [<branch>]
15 'git rebase' --continue | --skip | --abort | --edit-todo
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.
211 rebase.autostash::
212         If set to true enable '--autostash' option by default.
215 -------
216 --onto <newbase>::
217         Starting point at which to create the new commits. If the
218         --onto option is not specified, the starting point is
219         <upstream>.  May be any valid commit, and not just an
220         existing branch name.
222 As a special case, you may use "A\...B" as a shortcut for the
223 merge base of A and B if there is exactly one merge base. You can
224 leave out at most one of A and B, in which case it defaults to HEAD.
226 <upstream>::
227         Upstream branch to compare against.  May be any valid commit,
228         not just an existing branch name. Defaults to the configured
229         upstream for the current branch.
231 <branch>::
232         Working branch; defaults to HEAD.
234 --continue::
235         Restart the rebasing process after having resolved a merge conflict.
237 --abort::
238         Abort the rebase operation and reset HEAD to the original
239         branch. If <branch> was provided when the rebase operation was
240         started, then HEAD will be reset to <branch>. Otherwise HEAD
241         will be reset to where it was when the rebase operation was
242         started.
244 --keep-empty::
245         Keep the commits that do not change anything from its
246         parents in the result.
248 --skip::
249         Restart the rebasing process by skipping the current patch.
251 --edit-todo::
252         Edit the todo list during an interactive rebase.
254 -m::
255 --merge::
256         Use merging strategies to rebase.  When the recursive (default) merge
257         strategy is used, this allows rebase to be aware of renames on the
258         upstream side.
260 Note that a rebase merge works by replaying each commit from the working
261 branch on top of the <upstream> branch.  Because of this, when a merge
262 conflict happens, the side reported as 'ours' is the so-far rebased
263 series, starting with <upstream>, and 'theirs' is the working branch.  In
264 other words, the sides are swapped.
266 -s <strategy>::
267 --strategy=<strategy>::
268         Use the given merge strategy.
269         If there is no `-s` option 'git merge-recursive' is used
270         instead.  This implies --merge.
272 Because 'git rebase' replays each commit from the working branch
273 on top of the <upstream> branch using the given strategy, using
274 the 'ours' strategy simply discards all patches from the <branch>,
275 which makes little sense.
277 -X <strategy-option>::
278 --strategy-option=<strategy-option>::
279         Pass the <strategy-option> through to the merge strategy.
280         This implies `--merge` and, if no strategy has been
281         specified, `-s recursive`.  Note the reversal of 'ours' and
282         'theirs' as noted above for the `-m` option.
284 -S[<keyid>]::
285 --gpg-sign[=<keyid>]::
286         GPG-sign commits.
288 -q::
289 --quiet::
290         Be quiet. Implies --no-stat.
292 -v::
293 --verbose::
294         Be verbose. Implies --stat.
296 --stat::
297         Show a diffstat of what changed upstream since the last rebase. The
298         diffstat is also controlled by the configuration option rebase.stat.
300 -n::
301 --no-stat::
302         Do not show a diffstat as part of the rebase process.
304 --no-verify::
305         This option bypasses the pre-rebase hook.  See also linkgit:githooks[5].
307 --verify::
308         Allows the pre-rebase hook to run, which is the default.  This option can
309         be used to override --no-verify.  See also linkgit:githooks[5].
311 -C<n>::
312         Ensure at least <n> lines of surrounding context match before
313         and after each change.  When fewer lines of surrounding
314         context exist they all must match.  By default no context is
315         ever ignored.
317 -f::
318 --force-rebase::
319         Force the rebase even if the current branch is a descendant
320         of the commit you are rebasing onto.  Normally non-interactive rebase will
321         exit with the message "Current branch is up to date" in such a
322         situation.
323         Incompatible with the --interactive option.
325 You may find this (or --no-ff with an interactive rebase) helpful after
326 reverting a topic branch merge, as this option recreates the topic branch with
327 fresh commits so it can be remerged successfully without needing to "revert
328 the reversion" (see the
329 link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for details).
331 --fork-point::
332 --no-fork-point::
333         Use 'git merge-base --fork-point' to find a better common ancestor
334         between `upstream` and `branch` when calculating which commits have
335         have been introduced by `branch` (see linkgit:git-merge-base[1]).
337 If no non-option arguments are given on the command line, then the default is
338 `--fork-point @{u}` otherwise the `upstream` argument is interpreted literally
339 unless the `--fork-point` option is specified.
341 --ignore-whitespace::
342 --whitespace=<option>::
343         These flag are passed to the 'git apply' program
344         (see linkgit:git-apply[1]) that applies the patch.
345         Incompatible with the --interactive option.
347 --committer-date-is-author-date::
348 --ignore-date::
349         These flags are passed to 'git am' to easily change the dates
350         of the rebased commits (see linkgit:git-am[1]).
351         Incompatible with the --interactive option.
353 -i::
354 --interactive::
355         Make a list of the commits which are about to be rebased.  Let the
356         user edit that list before rebasing.  This mode can also be used to
357         split commits (see SPLITTING COMMITS below).
359 -p::
360 --preserve-merges::
361         Instead of ignoring merges, try to recreate them.
363 This uses the `--interactive` machinery internally, but combining it
364 with the `--interactive` option explicitly is generally not a good
365 idea unless you know what you are doing (see BUGS below).
367 -x <cmd>::
368 --exec <cmd>::
369         Append "exec <cmd>" after each line creating a commit in the
370         final history. <cmd> will be interpreted as one or more shell
371         commands.
373 This option can only be used with the `--interactive` option
374 (see INTERACTIVE MODE below).
376 You may execute several commands by either using one instance of `--exec`
377 with several commands:
379         git rebase -i --exec "cmd1 && cmd2 && ..."
381 or by giving more than one `--exec`:
383         git rebase -i --exec "cmd1" --exec "cmd2" --exec ...
385 If `--autosquash` is used, "exec" lines will not be appended for
386 the intermediate commits, and will only appear at the end of each
387 squash/fixup series.
389 --root::
390         Rebase all commits reachable from <branch>, instead of
391         limiting them with an <upstream>.  This allows you to rebase
392         the root commit(s) on a branch.  When used with --onto, it
393         will skip changes already contained in <newbase> (instead of
394         <upstream>) whereas without --onto it will operate on every change.
395         When used together with both --onto and --preserve-merges,
396         'all' root commits will be rewritten to have <newbase> as parent
397         instead.
399 --autosquash::
400 --no-autosquash::
401         When the commit log message begins with "squash! ..." (or
402         "fixup! ..."), and there is a commit whose title begins with
403         the same ..., automatically modify the todo list of rebase -i
404         so that the commit marked for squashing comes right after the
405         commit to be modified, and change the action of the moved
406         commit from `pick` to `squash` (or `fixup`).  Ignores subsequent
407         "fixup! " or "squash! " after the first, in case you referred to an
408         earlier fixup/squash with `git commit --fixup/--squash`.
410 This option is only valid when the '--interactive' option is used.
412 If the '--autosquash' option is enabled by default using the
413 configuration variable `rebase.autosquash`, this option can be
414 used to override and disable this setting.
416 --[no-]autostash::
417         Automatically create a temporary stash before the operation
418         begins, and apply it after the operation ends.  This means
419         that you can run rebase on a dirty worktree.  However, use
420         with care: the final stash application after a successful
421         rebase might result in non-trivial conflicts.
423 --no-ff::
424         With --interactive, cherry-pick all rebased commits instead of
425         fast-forwarding over the unchanged ones.  This ensures that the
426         entire history of the rebased branch is composed of new commits.
428 Without --interactive, this is a synonym for --force-rebase.
430 You may find this helpful after reverting a topic branch merge, as this option
431 recreates the topic branch with fresh commits so it can be remerged
432 successfully without needing to "revert the reversion" (see the
433 link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for details).
435 include::merge-strategies.txt[]
438 -----
440 You should understand the implications of using 'git rebase' on a
441 repository that you share.  See also RECOVERING FROM UPSTREAM REBASE
442 below.
444 When the git-rebase command is run, it will first execute a "pre-rebase"
445 hook if one exists.  You can use this hook to do sanity checks and
446 reject the rebase if it isn't appropriate.  Please see the template
447 pre-rebase hook script for an example.
449 Upon completion, <branch> will be the current branch.
452 ----------------
454 Rebasing interactively means that you have a chance to edit the commits
455 which are rebased.  You can reorder the commits, and you can
456 remove them (weeding out bad or otherwise unwanted patches).
458 The interactive mode is meant for this type of workflow:
460 1. have a wonderful idea
461 2. hack on the code
462 3. prepare a series for submission
463 4. submit
465 where point 2. consists of several instances of
467 a) regular use
469  1. finish something worthy of a commit
470  2. commit
472 b) independent fixup
474  1. realize that something does not work
475  2. fix that
476  3. commit it
478 Sometimes the thing fixed in b.2. cannot be amended to the not-quite
479 perfect commit it fixes, because that commit is buried deeply in a
480 patch series.  That is exactly what interactive rebase is for: use it
481 after plenty of "a"s and "b"s, by rearranging and editing
482 commits, and squashing multiple commits into one.
484 Start it with the last commit you want to retain as-is:
486         git rebase -i <after-this-commit>
488 An editor will be fired up with all the commits in your current branch
489 (ignoring merge commits), which come after the given commit.  You can
490 reorder the commits in this list to your heart's content, and you can
491 remove them.  The list looks more or less like this:
493 -------------------------------------------
494 pick deadbee The oneline of this commit
495 pick fa1afe1 The oneline of the next commit
497 -------------------------------------------
499 The oneline descriptions are purely for your pleasure; 'git rebase' will
500 not look at them but at the commit names ("deadbee" and "fa1afe1" in this
501 example), so do not delete or edit the names.
503 By replacing the command "pick" with the command "edit", you can tell
504 'git rebase' to stop after applying that commit, so that you can edit
505 the files and/or the commit message, amend the commit, and continue
506 rebasing.
508 If you just want to edit the commit message for a commit, replace the
509 command "pick" with the command "reword".
511 If you want to fold two or more commits into one, replace the command
512 "pick" for the second and subsequent commits with "squash" or "fixup".
513 If the commits had different authors, the folded commit will be
514 attributed to the author of the first commit.  The suggested commit
515 message for the folded commit is the concatenation of the commit
516 messages of the first commit and of those with the "squash" command,
517 but omits the commit messages of commits with the "fixup" command.
519 'git rebase' will stop when "pick" has been replaced with "edit" or
520 when a command fails due to merge errors. When you are done editing
521 and/or resolving conflicts you can continue with `git rebase --continue`.
523 For example, if you want to reorder the last 5 commits, such that what
524 was HEAD~4 becomes the new HEAD. To achieve that, you would call
525 'git rebase' like this:
527 ----------------------
528 $ git rebase -i HEAD~5
529 ----------------------
531 And move the first patch to the end of the list.
533 You might want to preserve merges, if you have a history like this:
535 ------------------
536            X
537             \
538          A---M---B
539         /
540 ---o---O---P---Q
541 ------------------
543 Suppose you want to rebase the side branch starting at "A" to "Q". Make
544 sure that the current HEAD is "B", and call
546 -----------------------------
547 $ git rebase -i -p --onto Q O
548 -----------------------------
550 Reordering and editing commits usually creates untested intermediate
551 steps.  You may want to check that your history editing did not break
552 anything by running a test, or at least recompiling at intermediate
553 points in history by using the "exec" command (shortcut "x").  You may
554 do so by creating a todo list like this one:
556 -------------------------------------------
557 pick deadbee Implement feature XXX
558 fixup f1a5c00 Fix to feature XXX
559 exec make
560 pick c0ffeee The oneline of the next commit
561 edit deadbab The oneline of the commit after
562 exec cd subdir; make test
564 -------------------------------------------
566 The interactive rebase will stop when a command fails (i.e. exits with
567 non-0 status) to give you an opportunity to fix the problem. You can
568 continue with `git rebase --continue`.
570 The "exec" command launches the command in a shell (the one specified
571 in `$SHELL`, or the default shell if `$SHELL` is not set), so you can
572 use shell features (like "cd", ">", ";" ...). The command is run from
573 the root of the working tree.
575 ----------------------------------
576 $ git rebase -i --exec "make test"
577 ----------------------------------
579 This command lets you check that intermediate commits are compilable.
580 The todo list becomes like that:
582 --------------------
583 pick 5928aea one
584 exec make test
585 pick 04d0fda two
586 exec make test
587 pick ba46169 three
588 exec make test
589 pick f4593f9 four
590 exec make test
591 --------------------
594 -----------------
596 In interactive mode, you can mark commits with the action "edit".  However,
597 this does not necessarily mean that 'git rebase' expects the result of this
598 edit to be exactly one commit.  Indeed, you can undo the commit, or you can
599 add other commits.  This can be used to split a commit into two:
601 - Start an interactive rebase with `git rebase -i <commit>^`, where
602   <commit> is the commit you want to split.  In fact, any commit range
603   will do, as long as it contains that commit.
605 - Mark the commit you want to split with the action "edit".
607 - When it comes to editing that commit, execute `git reset HEAD^`.  The
608   effect is that the HEAD is rewound by one, and the index follows suit.
609   However, the working tree stays the same.
611 - Now add the changes to the index that you want to have in the first
612   commit.  You can use `git add` (possibly interactively) or
613   'git gui' (or both) to do that.
615 - Commit the now-current index with whatever commit message is appropriate
616   now.
618 - Repeat the last two steps until your working tree is clean.
620 - Continue the rebase with `git rebase --continue`.
622 If you are not absolutely sure that the intermediate revisions are
623 consistent (they compile, pass the testsuite, etc.) you should use
624 'git stash' to stash away the not-yet-committed changes
625 after each commit, test, and amend the commit if fixes are necessary.
629 -------------------------------
631 Rebasing (or any other form of rewriting) a branch that others have
632 based work on is a bad idea: anyone downstream of it is forced to
633 manually fix their history.  This section explains how to do the fix
634 from the downstream's point of view.  The real fix, however, would be
635 to avoid rebasing the upstream in the first place.
637 To illustrate, suppose you are in a situation where someone develops a
638 'subsystem' branch, and you are working on a 'topic' that is dependent
639 on this 'subsystem'.  You might end up with a history like the
640 following:
642 ------------
643     o---o---o---o---o---o---o---o---o  master
644          \
645           o---o---o---o---o  subsystem
646                            \
647                             *---*---*  topic
648 ------------
650 If 'subsystem' is rebased against 'master', the following happens:
652 ------------
653     o---o---o---o---o---o---o---o  master
654          \                       \
655           o---o---o---o---o       o'--o'--o'--o'--o'  subsystem
656                            \
657                             *---*---*  topic
658 ------------
660 If you now continue development as usual, and eventually merge 'topic'
661 to 'subsystem', the commits from 'subsystem' will remain duplicated forever:
663 ------------
664     o---o---o---o---o---o---o---o  master
665          \                       \
666           o---o---o---o---o       o'--o'--o'--o'--o'--M  subsystem
667                            \                         /
668                             *---*---*-..........-*--*  topic
669 ------------
671 Such duplicates are generally frowned upon because they clutter up
672 history, making it harder to follow.  To clean things up, you need to
673 transplant the commits on 'topic' to the new 'subsystem' tip, i.e.,
674 rebase 'topic'.  This becomes a ripple effect: anyone downstream from
675 'topic' is forced to rebase too, and so on!
677 There are two kinds of fixes, discussed in the following subsections:
679 Easy case: The changes are literally the same.::
681         This happens if the 'subsystem' rebase was a simple rebase and
682         had no conflicts.
684 Hard case: The changes are not the same.::
686         This happens if the 'subsystem' rebase had conflicts, or used
687         `--interactive` to omit, edit, squash, or fixup commits; or
688         if the upstream used one of `commit --amend`, `reset`, or
689         `filter-branch`.
692 The easy case
693 ~~~~~~~~~~~~~
695 Only works if the changes (patch IDs based on the diff contents) on
696 'subsystem' are literally the same before and after the rebase
697 'subsystem' did.
699 In that case, the fix is easy because 'git rebase' knows to skip
700 changes that are already present in the new upstream.  So if you say
701 (assuming you're on 'topic')
702 ------------
703     $ git rebase subsystem
704 ------------
705 you will end up with the fixed history
706 ------------
707     o---o---o---o---o---o---o---o  master
708                                  \
709                                   o'--o'--o'--o'--o'  subsystem
710                                                    \
711                                                     *---*---*  topic
712 ------------
715 The hard case
716 ~~~~~~~~~~~~~
718 Things get more complicated if the 'subsystem' changes do not exactly
719 correspond to the ones before the rebase.
721 NOTE: While an "easy case recovery" sometimes appears to be successful
722       even in the hard case, it may have unintended consequences.  For
723       example, a commit that was removed via `git rebase
724       --interactive` will be **resurrected**!
726 The idea is to manually tell 'git rebase' "where the old 'subsystem'
727 ended and your 'topic' began", that is, what the old merge-base
728 between them was.  You will have to find a way to name the last commit
729 of the old 'subsystem', for example:
731 * With the 'subsystem' reflog: after 'git fetch', the old tip of
732   'subsystem' is at `subsystem@{1}`.  Subsequent fetches will
733   increase the number.  (See linkgit:git-reflog[1].)
735 * Relative to the tip of 'topic': knowing that your 'topic' has three
736   commits, the old tip of 'subsystem' must be `topic~3`.
738 You can then transplant the old `subsystem..topic` to the new tip by
739 saying (for the reflog case, and assuming you are on 'topic' already):
740 ------------
741     $ git rebase --onto subsystem subsystem@{1}
742 ------------
744 The ripple effect of a "hard case" recovery is especially bad:
745 'everyone' downstream from 'topic' will now have to perform a "hard
746 case" recovery too!
748 BUGS
749 ----
750 The todo list presented by `--preserve-merges --interactive` does not
751 represent the topology of the revision graph.  Editing commits and
752 rewording their commit messages should work fine, but attempts to
753 reorder commits tend to produce counterintuitive results.
755 For example, an attempt to rearrange
756 ------------
757 1 --- 2 --- 3 --- 4 --- 5
758 ------------
760 ------------
761 1 --- 2 --- 4 --- 3 --- 5
762 ------------
763 by moving the "pick 4" line will result in the following history:
764 ------------
765         3
766        /
767 1 --- 2 --- 4 --- 5
768 ------------
772 Part of the linkgit:git[1] suite