rebase -i: add exec command to launch a shell command
[git.git] / Documentation / git-rebase.txt
blob9c68b667e9133b808ad422b8435173aa96d90e01
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] [--onto <newbase>]
12         <upstream> [<branch>]
13 'git rebase' [-i | --interactive] [options] --onto <newbase>
14         --root [<branch>]
16 'git rebase' --continue | --skip | --abort
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.
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).
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.
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).
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.
47 Assume the following history exists and the current branch is "topic":
49 ------------
50           A---B---C topic
51          /
52     D---E---F---G master
53 ------------
55 From this point, the result of either of the following commands:
58     git rebase master
59     git rebase master topic
61 would be:
63 ------------
64                   A'--B'--C' topic
65                  /
66     D---E---F---G master
67 ------------
69 The latter form is just a short-hand of `git checkout topic`
70 followed by `git rebase master`.
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):
78 ------------
79           A---B---C topic
80          /
81     D---E---A'---F master
82 ------------
84 will result in:
86 ------------
87                    B'---C' topic
88                   /
89     D---E---A'---F master
90 ------------
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`.
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'.
100 ------------
101     o---o---o---o---o  master
102          \
103           o---o---o---o---o  next
104                            \
105                             o---o---o  topic
106 ------------
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:
112 ------------
113     o---o---o---o---o  master
114         |            \
115         |             o'--o'--o'  topic
116          \
117           o---o---o---o---o  next
118 ------------
120 We can get this using the following command:
122     git rebase --onto master next topic
125 Another example of --onto option is to rebase part of a
126 branch.  If we have the following situation:
128 ------------
129                             H---I---J topicB
130                            /
131                   E---F---G  topicA
132                  /
133     A---B---C---D  master
134 ------------
136 then the command
138     git rebase --onto master topicA topicB
140 would result in:
142 ------------
143                  H'--I'--J'  topicB
144                 /
145                 | E---F---G  topicA
146                 |/
147     A---B---C---D  master
148 ------------
150 This is useful when topicB does not depend on topicA.
152 A range of commits could also be removed with rebase.  If we have
153 the following situation:
155 ------------
156     E---F---G---H---I---J  topicA
157 ------------
159 then the command
161     git rebase --onto topicA~5 topicA~3 topicA
163 would result in the removal of commits F and G:
165 ------------
166     E---H'---I'---J'  topicA
167 ------------
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.
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
180     git add <filename>
183 After resolving the conflict manually and updating the index with the
184 desired resolution, you can continue the rebasing process with
187     git rebase --continue
190 Alternatively, you can undo the 'git rebase' with
193     git rebase --abort
195 CONFIGURATION
196 -------------
198 rebase.stat::
199         Whether to show a diffstat of what changed upstream since the last
200         rebase. False by default.
202 OPTIONS
203 -------
204 <newbase>::
205         Starting point at which to create the new commits. If the
206         --onto option is not specified, the starting point is
207         <upstream>.  May be any valid commit, and not just an
208         existing branch name.
210 As a special case, you may use "A...B" as a shortcut for the
211 merge base of A and B if there is exactly one merge base. You can
212 leave out at most one of A and B, in which case it defaults to HEAD.
214 <upstream>::
215         Upstream branch to compare against.  May be any valid commit,
216         not just an existing branch name.
218 <branch>::
219         Working branch; defaults to HEAD.
221 --continue::
222         Restart the rebasing process after having resolved a merge conflict.
224 --abort::
225         Restore the original branch and abort the rebase operation.
227 --skip::
228         Restart the rebasing process by skipping the current patch.
230 -m::
231 --merge::
232         Use merging strategies to rebase.  When the recursive (default) merge
233         strategy is used, this allows rebase to be aware of renames on the
234         upstream side.
236 Note that a rebase merge works by replaying each commit from the working
237 branch on top of the <upstream> branch.  Because of this, when a merge
238 conflict happens, the side reported as 'ours' is the so-far rebased
239 series, starting with <upstream>, and 'theirs' is the working branch.  In
240 other words, the sides are swapped.
242 -s <strategy>::
243 --strategy=<strategy>::
244         Use the given merge strategy.
245         If there is no `-s` option 'git merge-recursive' is used
246         instead.  This implies --merge.
248 Because 'git rebase' replays each commit from the working branch
249 on top of the <upstream> branch using the given strategy, using
250 the 'ours' strategy simply discards all patches from the <branch>,
251 which makes little sense.
253 -q::
254 --quiet::
255         Be quiet. Implies --no-stat.
257 -v::
258 --verbose::
259         Be verbose. Implies --stat.
261 --stat::
262         Show a diffstat of what changed upstream since the last rebase. The
263         diffstat is also controlled by the configuration option rebase.stat.
265 -n::
266 --no-stat::
267         Do not show a diffstat as part of the rebase process.
269 --no-verify::
270         This option bypasses the pre-rebase hook.  See also linkgit:githooks[5].
272 -C<n>::
273         Ensure at least <n> lines of surrounding context match before
274         and after each change.  When fewer lines of surrounding
275         context exist they all must match.  By default no context is
276         ever ignored.
278 -f::
279 --force-rebase::
280         Force the rebase even if the current branch is a descendant
281         of the commit you are rebasing onto.  Normally non-interactive rebase will
282         exit with the message "Current branch is up to date" in such a
283         situation.
284         Incompatible with the --interactive option.
286 You may find this (or --no-ff with an interactive rebase) helpful after
287 reverting a topic branch merge, as this option recreates the topic branch with
288 fresh commits so it can be remerged successfully without needing to "revert
289 the reversion" (see the
290 link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details).
292 --ignore-whitespace::
293 --whitespace=<option>::
294         These flag are passed to the 'git apply' program
295         (see linkgit:git-apply[1]) that applies the patch.
296         Incompatible with the --interactive option.
298 --committer-date-is-author-date::
299 --ignore-date::
300         These flags are passed to 'git am' to easily change the dates
301         of the rebased commits (see linkgit:git-am[1]).
302         Incompatible with the --interactive option.
304 -i::
305 --interactive::
306         Make a list of the commits which are about to be rebased.  Let the
307         user edit that list before rebasing.  This mode can also be used to
308         split commits (see SPLITTING COMMITS below).
310 -p::
311 --preserve-merges::
312         Instead of ignoring merges, try to recreate them.
314 This uses the `--interactive` machinery internally, but combining it
315 with the `--interactive` option explicitly is generally not a good
316 idea unless you know what you are doing (see BUGS below).
319 --root::
320         Rebase all commits reachable from <branch>, instead of
321         limiting them with an <upstream>.  This allows you to rebase
322         the root commit(s) on a branch.  Must be used with --onto, and
323         will skip changes already contained in <newbase> (instead of
324         <upstream>).  When used together with --preserve-merges, 'all'
325         root commits will be rewritten to have <newbase> as parent
326         instead.
328 --autosquash::
329         When the commit log message begins with "squash! ..." (or
330         "fixup! ..."), and there is a commit whose title begins with
331         the same ..., automatically modify the todo list of rebase -i
332         so that the commit marked for squashing comes right after the
333         commit to be modified, and change the action of the moved
334         commit from `pick` to `squash` (or `fixup`).
336 This option is only valid when the '--interactive' option is used.
338 --no-ff::
339         With --interactive, cherry-pick all rebased commits instead of
340         fast-forwarding over the unchanged ones.  This ensures that the
341         entire history of the rebased branch is composed of new commits.
343 Without --interactive, this is a synonym for --force-rebase.
345 You may find this helpful after reverting a topic branch merge, as this option
346 recreates the topic branch with fresh commits so it can be remerged
347 successfully without needing to "revert the reversion" (see the
348 link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details).
350 include::merge-strategies.txt[]
352 NOTES
353 -----
355 You should understand the implications of using 'git rebase' on a
356 repository that you share.  See also RECOVERING FROM UPSTREAM REBASE
357 below.
359 When the git-rebase command is run, it will first execute a "pre-rebase"
360 hook if one exists.  You can use this hook to do sanity checks and
361 reject the rebase if it isn't appropriate.  Please see the template
362 pre-rebase hook script for an example.
364 Upon completion, <branch> will be the current branch.
366 INTERACTIVE MODE
367 ----------------
369 Rebasing interactively means that you have a chance to edit the commits
370 which are rebased.  You can reorder the commits, and you can
371 remove them (weeding out bad or otherwise unwanted patches).
373 The interactive mode is meant for this type of workflow:
375 1. have a wonderful idea
376 2. hack on the code
377 3. prepare a series for submission
378 4. submit
380 where point 2. consists of several instances of
382 a. regular use
383  1. finish something worthy of a commit
384  2. commit
385 b. independent fixup
386  1. realize that something does not work
387  2. fix that
388  3. commit it
390 Sometimes the thing fixed in b.2. cannot be amended to the not-quite
391 perfect commit it fixes, because that commit is buried deeply in a
392 patch series.  That is exactly what interactive rebase is for: use it
393 after plenty of "a"s and "b"s, by rearranging and editing
394 commits, and squashing multiple commits into one.
396 Start it with the last commit you want to retain as-is:
398         git rebase -i <after-this-commit>
400 An editor will be fired up with all the commits in your current branch
401 (ignoring merge commits), which come after the given commit.  You can
402 reorder the commits in this list to your heart's content, and you can
403 remove them.  The list looks more or less like this:
405 -------------------------------------------
406 pick deadbee The oneline of this commit
407 pick fa1afe1 The oneline of the next commit
409 -------------------------------------------
411 The oneline descriptions are purely for your pleasure; 'git rebase' will
412 not look at them but at the commit names ("deadbee" and "fa1afe1" in this
413 example), so do not delete or edit the names.
415 By replacing the command "pick" with the command "edit", you can tell
416 'git rebase' to stop after applying that commit, so that you can edit
417 the files and/or the commit message, amend the commit, and continue
418 rebasing.
420 If you just want to edit the commit message for a commit, replace the
421 command "pick" with the command "reword".
423 If you want to fold two or more commits into one, replace the command
424 "pick" for the second and subsequent commits with "squash" or "fixup".
425 If the commits had different authors, the folded commit will be
426 attributed to the author of the first commit.  The suggested commit
427 message for the folded commit is the concatenation of the commit
428 messages of the first commit and of those with the "squash" command,
429 but omits the commit messages of commits with the "fixup" command.
431 'git rebase' will stop when "pick" has been replaced with "edit" or
432 when a command fails due to merge errors. When you are done editing
433 and/or resolving conflicts you can continue with `git rebase --continue`.
435 For example, if you want to reorder the last 5 commits, such that what
436 was HEAD~4 becomes the new HEAD. To achieve that, you would call
437 'git rebase' like this:
439 ----------------------
440 $ git rebase -i HEAD~5
441 ----------------------
443 And move the first patch to the end of the list.
445 You might want to preserve merges, if you have a history like this:
447 ------------------
448            X
449             \
450          A---M---B
451         /
452 ---o---O---P---Q
453 ------------------
455 Suppose you want to rebase the side branch starting at "A" to "Q". Make
456 sure that the current HEAD is "B", and call
458 -----------------------------
459 $ git rebase -i -p --onto Q O
460 -----------------------------
462 Reordering and editing commits usually creates untested intermediate
463 steps.  You may want to check that your history editing did not break
464 anything by running a test, or at least recompiling at intermediate
465 points in history by using the "exec" command (shortcut "x").  You may
466 do so by creating a todo list like this one:
468 -------------------------------------------
469 pick deadbee Implement feature XXX
470 fixup f1a5c00 Fix to feature XXX
471 exec make
472 pick c0ffeee The oneline of the next commit
473 edit deadbab The oneline of the commit after
474 exec cd subdir; make test
476 -------------------------------------------
478 The interactive rebase will stop when a command fails (i.e. exits with
479 non-0 status) to give you an opportunity to fix the problem. You can
480 continue with `git rebase --continue`.
482 The "exec" command launches the command in a shell (the one specified
483 in `$SHELL`, or the default shell if `$SHELL` is not set), so you can
484 use shell features (like "cd", ">", ";" ...). The command is run from
485 the root of the working tree.
487 SPLITTING COMMITS
488 -----------------
490 In interactive mode, you can mark commits with the action "edit".  However,
491 this does not necessarily mean that 'git rebase' expects the result of this
492 edit to be exactly one commit.  Indeed, you can undo the commit, or you can
493 add other commits.  This can be used to split a commit into two:
495 - Start an interactive rebase with `git rebase -i <commit>^`, where
496   <commit> is the commit you want to split.  In fact, any commit range
497   will do, as long as it contains that commit.
499 - Mark the commit you want to split with the action "edit".
501 - When it comes to editing that commit, execute `git reset HEAD^`.  The
502   effect is that the HEAD is rewound by one, and the index follows suit.
503   However, the working tree stays the same.
505 - Now add the changes to the index that you want to have in the first
506   commit.  You can use `git add` (possibly interactively) or
507   'git gui' (or both) to do that.
509 - Commit the now-current index with whatever commit message is appropriate
510   now.
512 - Repeat the last two steps until your working tree is clean.
514 - Continue the rebase with `git rebase --continue`.
516 If you are not absolutely sure that the intermediate revisions are
517 consistent (they compile, pass the testsuite, etc.) you should use
518 'git stash' to stash away the not-yet-committed changes
519 after each commit, test, and amend the commit if fixes are necessary.
522 RECOVERING FROM UPSTREAM REBASE
523 -------------------------------
525 Rebasing (or any other form of rewriting) a branch that others have
526 based work on is a bad idea: anyone downstream of it is forced to
527 manually fix their history.  This section explains how to do the fix
528 from the downstream's point of view.  The real fix, however, would be
529 to avoid rebasing the upstream in the first place.
531 To illustrate, suppose you are in a situation where someone develops a
532 'subsystem' branch, and you are working on a 'topic' that is dependent
533 on this 'subsystem'.  You might end up with a history like the
534 following:
536 ------------
537     o---o---o---o---o---o---o---o---o  master
538          \
539           o---o---o---o---o  subsystem
540                            \
541                             *---*---*  topic
542 ------------
544 If 'subsystem' is rebased against 'master', the following happens:
546 ------------
547     o---o---o---o---o---o---o---o  master
548          \                       \
549           o---o---o---o---o       o'--o'--o'--o'--o'  subsystem
550                            \
551                             *---*---*  topic
552 ------------
554 If you now continue development as usual, and eventually merge 'topic'
555 to 'subsystem', the commits from 'subsystem' will remain duplicated forever:
557 ------------
558     o---o---o---o---o---o---o---o  master
559          \                       \
560           o---o---o---o---o       o'--o'--o'--o'--o'--M  subsystem
561                            \                         /
562                             *---*---*-..........-*--*  topic
563 ------------
565 Such duplicates are generally frowned upon because they clutter up
566 history, making it harder to follow.  To clean things up, you need to
567 transplant the commits on 'topic' to the new 'subsystem' tip, i.e.,
568 rebase 'topic'.  This becomes a ripple effect: anyone downstream from
569 'topic' is forced to rebase too, and so on!
571 There are two kinds of fixes, discussed in the following subsections:
573 Easy case: The changes are literally the same.::
575         This happens if the 'subsystem' rebase was a simple rebase and
576         had no conflicts.
578 Hard case: The changes are not the same.::
580         This happens if the 'subsystem' rebase had conflicts, or used
581         `\--interactive` to omit, edit, squash, or fixup commits; or
582         if the upstream used one of `commit \--amend`, `reset`, or
583         `filter-branch`.
586 The easy case
587 ~~~~~~~~~~~~~
589 Only works if the changes (patch IDs based on the diff contents) on
590 'subsystem' are literally the same before and after the rebase
591 'subsystem' did.
593 In that case, the fix is easy because 'git rebase' knows to skip
594 changes that are already present in the new upstream.  So if you say
595 (assuming you're on 'topic')
596 ------------
597     $ git rebase subsystem
598 ------------
599 you will end up with the fixed history
600 ------------
601     o---o---o---o---o---o---o---o  master
602                                  \
603                                   o'--o'--o'--o'--o'  subsystem
604                                                    \
605                                                     *---*---*  topic
606 ------------
609 The hard case
610 ~~~~~~~~~~~~~
612 Things get more complicated if the 'subsystem' changes do not exactly
613 correspond to the ones before the rebase.
615 NOTE: While an "easy case recovery" sometimes appears to be successful
616       even in the hard case, it may have unintended consequences.  For
617       example, a commit that was removed via `git rebase
618       \--interactive` will be **resurrected**!
620 The idea is to manually tell 'git rebase' "where the old 'subsystem'
621 ended and your 'topic' began", that is, what the old merge-base
622 between them was.  You will have to find a way to name the last commit
623 of the old 'subsystem', for example:
625 * With the 'subsystem' reflog: after 'git fetch', the old tip of
626   'subsystem' is at `subsystem@\{1}`.  Subsequent fetches will
627   increase the number.  (See linkgit:git-reflog[1].)
629 * Relative to the tip of 'topic': knowing that your 'topic' has three
630   commits, the old tip of 'subsystem' must be `topic~3`.
632 You can then transplant the old `subsystem..topic` to the new tip by
633 saying (for the reflog case, and assuming you are on 'topic' already):
634 ------------
635     $ git rebase --onto subsystem subsystem@{1}
636 ------------
638 The ripple effect of a "hard case" recovery is especially bad:
639 'everyone' downstream from 'topic' will now have to perform a "hard
640 case" recovery too!
643 BUGS
644 ----
645 The todo list presented by `--preserve-merges --interactive` does not
646 represent the topology of the revision graph.  Editing commits and
647 rewording their commit messages should work fine, but attempts to
648 reorder commits tend to produce counterintuitive results.
650 For example, an attempt to rearrange
651 ------------
652 1 --- 2 --- 3 --- 4 --- 5
653 ------------
655 ------------
656 1 --- 2 --- 4 --- 3 --- 5
657 ------------
658 by moving the "pick 4" line will result in the following history:
659 ------------
660         3
661        /
662 1 --- 2 --- 4 --- 5
663 ------------
665 Authors
666 ------
667 Written by Junio C Hamano <gitster@pobox.com> and
668 Johannes E. Schindelin <johannes.schindelin@gmx.de>
670 Documentation
671 --------------
672 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
676 Part of the linkgit:git[1] suite