show-ref: make --head always show the HEAD ref
[git/mingw.git] / Documentation / git-rebase.txt
blobaca840525eee7bb3743baf7f72d8c0f240ff1b60
1 git-rebase(1)
2 =============
4 NAME
5 ----
6 git-rebase - Forward-port local commits to the updated upstream head
8 SYNOPSIS
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
17 DESCRIPTION
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
201 CONFIGURATION
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 OPTIONS
212 -------
213 --onto <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 --edit-todo::
249         Edit the todo list during an interactive rebase.
251 -m::
252 --merge::
253         Use merging strategies to rebase.  When the recursive (default) merge
254         strategy is used, this allows rebase to be aware of renames on the
255         upstream side.
257 Note that a rebase merge works by replaying each commit from the working
258 branch on top of the <upstream> branch.  Because of this, when a merge
259 conflict happens, the side reported as 'ours' is the so-far rebased
260 series, starting with <upstream>, and 'theirs' is the working branch.  In
261 other words, the sides are swapped.
263 -s <strategy>::
264 --strategy=<strategy>::
265         Use the given merge strategy.
266         If there is no `-s` option 'git merge-recursive' is used
267         instead.  This implies --merge.
269 Because 'git rebase' replays each commit from the working branch
270 on top of the <upstream> branch using the given strategy, using
271 the 'ours' strategy simply discards all patches from the <branch>,
272 which makes little sense.
274 -X <strategy-option>::
275 --strategy-option=<strategy-option>::
276         Pass the <strategy-option> through to the merge strategy.
277         This implies `--merge` and, if no strategy has been
278         specified, `-s recursive`.  Note the reversal of 'ours' and
279         'theirs' as noted above for the `-m` option.
281 -q::
282 --quiet::
283         Be quiet. Implies --no-stat.
285 -v::
286 --verbose::
287         Be verbose. Implies --stat.
289 --stat::
290         Show a diffstat of what changed upstream since the last rebase. The
291         diffstat is also controlled by the configuration option rebase.stat.
293 -n::
294 --no-stat::
295         Do not show a diffstat as part of the rebase process.
297 --no-verify::
298         This option bypasses the pre-rebase hook.  See also linkgit:githooks[5].
300 --verify::
301         Allows the pre-rebase hook to run, which is the default.  This option can
302         be used to override --no-verify.  See also linkgit:githooks[5].
304 -C<n>::
305         Ensure at least <n> lines of surrounding context match before
306         and after each change.  When fewer lines of surrounding
307         context exist they all must match.  By default no context is
308         ever ignored.
310 -f::
311 --force-rebase::
312         Force the rebase even if the current branch is a descendant
313         of the commit you are rebasing onto.  Normally non-interactive rebase will
314         exit with the message "Current branch is up to date" in such a
315         situation.
316         Incompatible with the --interactive option.
318 You may find this (or --no-ff with an interactive rebase) helpful after
319 reverting a topic branch merge, as this option recreates the topic branch with
320 fresh commits so it can be remerged successfully without needing to "revert
321 the reversion" (see the
322 link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details).
324 --ignore-whitespace::
325 --whitespace=<option>::
326         These flag are passed to the 'git apply' program
327         (see linkgit:git-apply[1]) that applies the patch.
328         Incompatible with the --interactive option.
330 --committer-date-is-author-date::
331 --ignore-date::
332         These flags are passed to 'git am' to easily change the dates
333         of the rebased commits (see linkgit:git-am[1]).
334         Incompatible with the --interactive option.
336 -i::
337 --interactive::
338         Make a list of the commits which are about to be rebased.  Let the
339         user edit that list before rebasing.  This mode can also be used to
340         split commits (see SPLITTING COMMITS below).
342 -p::
343 --preserve-merges::
344         Instead of ignoring merges, try to recreate them.
346 This uses the `--interactive` machinery internally, but combining it
347 with the `--interactive` option explicitly is generally not a good
348 idea unless you know what you are doing (see BUGS below).
350 -x <cmd>::
351 --exec <cmd>::
352         Append "exec <cmd>" after each line creating a commit in the
353         final history. <cmd> will be interpreted as one or more shell
354         commands.
356 This option can only be used with the `--interactive` option
357 (see INTERACTIVE MODE below).
359 You may execute several commands by either using one instance of `--exec`
360 with several commands:
362         git rebase -i --exec "cmd1 && cmd2 && ..."
364 or by giving more than one `--exec`:
366         git rebase -i --exec "cmd1" --exec "cmd2" --exec ...
368 If `--autosquash` is used, "exec" lines will not be appended for
369 the intermediate commits, and will only appear at the end of each
370 squash/fixup series.
372 --root::
373         Rebase all commits reachable from <branch>, instead of
374         limiting them with an <upstream>.  This allows you to rebase
375         the root commit(s) on a branch.  When used with --onto, it
376         will skip changes already contained in <newbase> (instead of
377         <upstream>) whereas without --onto it will operate on every change.
378         When used together with both --onto and --preserve-merges,
379         'all' root commits will be rewritten to have <newbase> as parent
380         instead.
382 --autosquash::
383 --no-autosquash::
384         When the commit log message begins with "squash! ..." (or
385         "fixup! ..."), and there is a commit whose title begins with
386         the same ..., automatically modify the todo list of rebase -i
387         so that the commit marked for squashing comes right after the
388         commit to be modified, and change the action of the moved
389         commit from `pick` to `squash` (or `fixup`).
391 This option is only valid when the '--interactive' option is used.
393 If the '--autosquash' option is enabled by default using the
394 configuration variable `rebase.autosquash`, this option can be
395 used to override and disable this setting.
397 --no-ff::
398         With --interactive, cherry-pick all rebased commits instead of
399         fast-forwarding over the unchanged ones.  This ensures that the
400         entire history of the rebased branch is composed of new commits.
402 Without --interactive, this is a synonym for --force-rebase.
404 You may find this helpful after reverting a topic branch merge, as this option
405 recreates the topic branch with fresh commits so it can be remerged
406 successfully without needing to "revert the reversion" (see the
407 link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details).
409 include::merge-strategies.txt[]
411 NOTES
412 -----
414 You should understand the implications of using 'git rebase' on a
415 repository that you share.  See also RECOVERING FROM UPSTREAM REBASE
416 below.
418 When the git-rebase command is run, it will first execute a "pre-rebase"
419 hook if one exists.  You can use this hook to do sanity checks and
420 reject the rebase if it isn't appropriate.  Please see the template
421 pre-rebase hook script for an example.
423 Upon completion, <branch> will be the current branch.
425 INTERACTIVE MODE
426 ----------------
428 Rebasing interactively means that you have a chance to edit the commits
429 which are rebased.  You can reorder the commits, and you can
430 remove them (weeding out bad or otherwise unwanted patches).
432 The interactive mode is meant for this type of workflow:
434 1. have a wonderful idea
435 2. hack on the code
436 3. prepare a series for submission
437 4. submit
439 where point 2. consists of several instances of
441 a) regular use
443  1. finish something worthy of a commit
444  2. commit
446 b) independent fixup
448  1. realize that something does not work
449  2. fix that
450  3. commit it
452 Sometimes the thing fixed in b.2. cannot be amended to the not-quite
453 perfect commit it fixes, because that commit is buried deeply in a
454 patch series.  That is exactly what interactive rebase is for: use it
455 after plenty of "a"s and "b"s, by rearranging and editing
456 commits, and squashing multiple commits into one.
458 Start it with the last commit you want to retain as-is:
460         git rebase -i <after-this-commit>
462 An editor will be fired up with all the commits in your current branch
463 (ignoring merge commits), which come after the given commit.  You can
464 reorder the commits in this list to your heart's content, and you can
465 remove them.  The list looks more or less like this:
467 -------------------------------------------
468 pick deadbee The oneline of this commit
469 pick fa1afe1 The oneline of the next commit
471 -------------------------------------------
473 The oneline descriptions are purely for your pleasure; 'git rebase' will
474 not look at them but at the commit names ("deadbee" and "fa1afe1" in this
475 example), so do not delete or edit the names.
477 By replacing the command "pick" with the command "edit", you can tell
478 'git rebase' to stop after applying that commit, so that you can edit
479 the files and/or the commit message, amend the commit, and continue
480 rebasing.
482 If you just want to edit the commit message for a commit, replace the
483 command "pick" with the command "reword".
485 If you want to fold two or more commits into one, replace the command
486 "pick" for the second and subsequent commits with "squash" or "fixup".
487 If the commits had different authors, the folded commit will be
488 attributed to the author of the first commit.  The suggested commit
489 message for the folded commit is the concatenation of the commit
490 messages of the first commit and of those with the "squash" command,
491 but omits the commit messages of commits with the "fixup" command.
493 'git rebase' will stop when "pick" has been replaced with "edit" or
494 when a command fails due to merge errors. When you are done editing
495 and/or resolving conflicts you can continue with `git rebase --continue`.
497 For example, if you want to reorder the last 5 commits, such that what
498 was HEAD~4 becomes the new HEAD. To achieve that, you would call
499 'git rebase' like this:
501 ----------------------
502 $ git rebase -i HEAD~5
503 ----------------------
505 And move the first patch to the end of the list.
507 You might want to preserve merges, if you have a history like this:
509 ------------------
510            X
511             \
512          A---M---B
513         /
514 ---o---O---P---Q
515 ------------------
517 Suppose you want to rebase the side branch starting at "A" to "Q". Make
518 sure that the current HEAD is "B", and call
520 -----------------------------
521 $ git rebase -i -p --onto Q O
522 -----------------------------
524 Reordering and editing commits usually creates untested intermediate
525 steps.  You may want to check that your history editing did not break
526 anything by running a test, or at least recompiling at intermediate
527 points in history by using the "exec" command (shortcut "x").  You may
528 do so by creating a todo list like this one:
530 -------------------------------------------
531 pick deadbee Implement feature XXX
532 fixup f1a5c00 Fix to feature XXX
533 exec make
534 pick c0ffeee The oneline of the next commit
535 edit deadbab The oneline of the commit after
536 exec cd subdir; make test
538 -------------------------------------------
540 The interactive rebase will stop when a command fails (i.e. exits with
541 non-0 status) to give you an opportunity to fix the problem. You can
542 continue with `git rebase --continue`.
544 The "exec" command launches the command in a shell (the one specified
545 in `$SHELL`, or the default shell if `$SHELL` is not set), so you can
546 use shell features (like "cd", ">", ";" ...). The command is run from
547 the root of the working tree.
549 ----------------------------------
550 $ git rebase -i --exec "make test"
551 ----------------------------------
553 This command lets you check that intermediate commits are compilable.
554 The todo list becomes like that:
556 --------------------
557 pick 5928aea one
558 exec make test
559 pick 04d0fda two
560 exec make test
561 pick ba46169 three
562 exec make test
563 pick f4593f9 four
564 exec make test
565 --------------------
567 SPLITTING COMMITS
568 -----------------
570 In interactive mode, you can mark commits with the action "edit".  However,
571 this does not necessarily mean that 'git rebase' expects the result of this
572 edit to be exactly one commit.  Indeed, you can undo the commit, or you can
573 add other commits.  This can be used to split a commit into two:
575 - Start an interactive rebase with `git rebase -i <commit>^`, where
576   <commit> is the commit you want to split.  In fact, any commit range
577   will do, as long as it contains that commit.
579 - Mark the commit you want to split with the action "edit".
581 - When it comes to editing that commit, execute `git reset HEAD^`.  The
582   effect is that the HEAD is rewound by one, and the index follows suit.
583   However, the working tree stays the same.
585 - Now add the changes to the index that you want to have in the first
586   commit.  You can use `git add` (possibly interactively) or
587   'git gui' (or both) to do that.
589 - Commit the now-current index with whatever commit message is appropriate
590   now.
592 - Repeat the last two steps until your working tree is clean.
594 - Continue the rebase with `git rebase --continue`.
596 If you are not absolutely sure that the intermediate revisions are
597 consistent (they compile, pass the testsuite, etc.) you should use
598 'git stash' to stash away the not-yet-committed changes
599 after each commit, test, and amend the commit if fixes are necessary.
602 RECOVERING FROM UPSTREAM REBASE
603 -------------------------------
605 Rebasing (or any other form of rewriting) a branch that others have
606 based work on is a bad idea: anyone downstream of it is forced to
607 manually fix their history.  This section explains how to do the fix
608 from the downstream's point of view.  The real fix, however, would be
609 to avoid rebasing the upstream in the first place.
611 To illustrate, suppose you are in a situation where someone develops a
612 'subsystem' branch, and you are working on a 'topic' that is dependent
613 on this 'subsystem'.  You might end up with a history like the
614 following:
616 ------------
617     o---o---o---o---o---o---o---o---o  master
618          \
619           o---o---o---o---o  subsystem
620                            \
621                             *---*---*  topic
622 ------------
624 If 'subsystem' is rebased against 'master', the following happens:
626 ------------
627     o---o---o---o---o---o---o---o  master
628          \                       \
629           o---o---o---o---o       o'--o'--o'--o'--o'  subsystem
630                            \
631                             *---*---*  topic
632 ------------
634 If you now continue development as usual, and eventually merge 'topic'
635 to 'subsystem', the commits from 'subsystem' will remain duplicated forever:
637 ------------
638     o---o---o---o---o---o---o---o  master
639          \                       \
640           o---o---o---o---o       o'--o'--o'--o'--o'--M  subsystem
641                            \                         /
642                             *---*---*-..........-*--*  topic
643 ------------
645 Such duplicates are generally frowned upon because they clutter up
646 history, making it harder to follow.  To clean things up, you need to
647 transplant the commits on 'topic' to the new 'subsystem' tip, i.e.,
648 rebase 'topic'.  This becomes a ripple effect: anyone downstream from
649 'topic' is forced to rebase too, and so on!
651 There are two kinds of fixes, discussed in the following subsections:
653 Easy case: The changes are literally the same.::
655         This happens if the 'subsystem' rebase was a simple rebase and
656         had no conflicts.
658 Hard case: The changes are not the same.::
660         This happens if the 'subsystem' rebase had conflicts, or used
661         `--interactive` to omit, edit, squash, or fixup commits; or
662         if the upstream used one of `commit --amend`, `reset`, or
663         `filter-branch`.
666 The easy case
667 ~~~~~~~~~~~~~
669 Only works if the changes (patch IDs based on the diff contents) on
670 'subsystem' are literally the same before and after the rebase
671 'subsystem' did.
673 In that case, the fix is easy because 'git rebase' knows to skip
674 changes that are already present in the new upstream.  So if you say
675 (assuming you're on 'topic')
676 ------------
677     $ git rebase subsystem
678 ------------
679 you will end up with the fixed history
680 ------------
681     o---o---o---o---o---o---o---o  master
682                                  \
683                                   o'--o'--o'--o'--o'  subsystem
684                                                    \
685                                                     *---*---*  topic
686 ------------
689 The hard case
690 ~~~~~~~~~~~~~
692 Things get more complicated if the 'subsystem' changes do not exactly
693 correspond to the ones before the rebase.
695 NOTE: While an "easy case recovery" sometimes appears to be successful
696       even in the hard case, it may have unintended consequences.  For
697       example, a commit that was removed via `git rebase
698       --interactive` will be **resurrected**!
700 The idea is to manually tell 'git rebase' "where the old 'subsystem'
701 ended and your 'topic' began", that is, what the old merge-base
702 between them was.  You will have to find a way to name the last commit
703 of the old 'subsystem', for example:
705 * With the 'subsystem' reflog: after 'git fetch', the old tip of
706   'subsystem' is at `subsystem@{1}`.  Subsequent fetches will
707   increase the number.  (See linkgit:git-reflog[1].)
709 * Relative to the tip of 'topic': knowing that your 'topic' has three
710   commits, the old tip of 'subsystem' must be `topic~3`.
712 You can then transplant the old `subsystem..topic` to the new tip by
713 saying (for the reflog case, and assuming you are on 'topic' already):
714 ------------
715     $ git rebase --onto subsystem subsystem@{1}
716 ------------
718 The ripple effect of a "hard case" recovery is especially bad:
719 'everyone' downstream from 'topic' will now have to perform a "hard
720 case" recovery too!
722 BUGS
723 ----
724 The todo list presented by `--preserve-merges --interactive` does not
725 represent the topology of the revision graph.  Editing commits and
726 rewording their commit messages should work fine, but attempts to
727 reorder commits tend to produce counterintuitive results.
729 For example, an attempt to rearrange
730 ------------
731 1 --- 2 --- 3 --- 4 --- 5
732 ------------
734 ------------
735 1 --- 2 --- 4 --- 3 --- 5
736 ------------
737 by moving the "pick 4" line will result in the following history:
738 ------------
739         3
740        /
741 1 --- 2 --- 4 --- 5
742 ------------
746 Part of the linkgit:git[1] suite