Merge branch 'master' into next
[git/wpalmer.git] / Documentation / git-rebase.txt
blob0d07b1b2077c62f1199c5ee96790e5a7121b4f00
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 <upstream>::
211         Upstream branch to compare against.  May be any valid commit,
212         not just an existing branch name.
214 <branch>::
215         Working branch; defaults to HEAD.
217 --continue::
218         Restart the rebasing process after having resolved a merge conflict.
220 --abort::
221         Restore the original branch and abort the rebase operation.
223 --skip::
224         Restart the rebasing process by skipping the current patch.
226 -m::
227 --merge::
228         Use merging strategies to rebase.  When the recursive (default) merge
229         strategy is used, this allows rebase to be aware of renames on the
230         upstream side.
232 Note that a rebase merge works by replaying each commit from the working
233 branch on top of the <upstream> branch.  Because of this, when a merge
234 conflict happens, the side reported as 'ours' is the so-far rebased
235 series, starting with <upstream>, and 'theirs' is the working branch.  In
236 other words, the sides are swapped.
238 -s <strategy>::
239 --strategy=<strategy>::
240         Use the given merge strategy.
241         If there is no `-s` option 'git merge-recursive' is used
242         instead.  This implies --merge.
244 Because 'git rebase' replays each commit from the working branch
245 on top of the <upstream> branch using the given strategy, using
246 the 'ours' strategy simply discards all patches from the <branch>,
247 which makes little sense.
249 -q::
250 --quiet::
251         Be quiet. Implies --no-stat.
253 -v::
254 --verbose::
255         Be verbose. Implies --stat.
257 --stat::
258         Show a diffstat of what changed upstream since the last rebase. The
259         diffstat is also controlled by the configuration option rebase.stat.
261 -n::
262 --no-stat::
263         Do not show a diffstat as part of the rebase process.
265 --no-verify::
266         This option bypasses the pre-rebase hook.  See also linkgit:githooks[5].
268 -C<n>::
269         Ensure at least <n> lines of surrounding context match before
270         and after each change.  When fewer lines of surrounding
271         context exist they all must match.  By default no context is
272         ever ignored.
274 -f::
275 --force-rebase::
276         Force the rebase even if the current branch is a descendant
277         of the commit you are rebasing onto.  Normally non-interactive rebase will
278         exit with the message "Current branch is up to date" in such a
279         situation.
280         Incompatible with the --interactive option.
282 You may find this (or --no-ff with an interactive rebase) helpful after
283 reverting a topic branch merge, as this option recreates the topic branch with
284 fresh commits so it can be remerged successfully without needing to "revert
285 the reversion" (see the
286 link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details).
288 --ignore-whitespace::
289 --whitespace=<option>::
290         These flag are passed to the 'git apply' program
291         (see linkgit:git-apply[1]) that applies the patch.
292         Incompatible with the --interactive option.
294 --committer-date-is-author-date::
295 --ignore-date::
296         These flags are passed to 'git am' to easily change the dates
297         of the rebased commits (see linkgit:git-am[1]).
299 -i::
300 --interactive::
301         Make a list of the commits which are about to be rebased.  Let the
302         user edit that list before rebasing.  This mode can also be used to
303         split commits (see SPLITTING COMMITS below).
305 -p::
306 --preserve-merges::
307         Instead of ignoring merges, try to recreate them.
309 --root::
310         Rebase all commits reachable from <branch>, instead of
311         limiting them with an <upstream>.  This allows you to rebase
312         the root commit(s) on a branch.  Must be used with --onto, and
313         will skip changes already contained in <newbase> (instead of
314         <upstream>).  When used together with --preserve-merges, 'all'
315         root commits will be rewritten to have <newbase> as parent
316         instead.
318 --autosquash::
319         When the commit log message begins with "squash! ..." (or
320         "fixup! ..."), and there is a commit whose title begins with
321         the same ..., automatically modify the todo list of rebase -i
322         so that the commit marked for squashing comes right after the
323         commit to be modified, and change the action of the moved
324         commit from `pick` to `squash` (or `fixup`).
326 This option is only valid when the '--interactive' option is used.
328 --no-ff::
329         With --interactive, cherry-pick all rebased commits instead of
330         fast-forwarding over the unchanged ones.  This ensures that the
331         entire history of the rebased branch is composed of new commits.
333 Without --interactive, this is a synonym for --force-rebase.
335 You may find this helpful after reverting a topic branch merge, as this option
336 recreates the topic branch with fresh commits so it can be remerged
337 successfully without needing to "revert the reversion" (see the
338 link:howto/revert-a-faulty-merge.txt[revert-a-faulty-merge How-To] for details).
340 include::merge-strategies.txt[]
342 NOTES
343 -----
345 You should understand the implications of using 'git rebase' on a
346 repository that you share.  See also RECOVERING FROM UPSTREAM REBASE
347 below.
349 When the git-rebase command is run, it will first execute a "pre-rebase"
350 hook if one exists.  You can use this hook to do sanity checks and
351 reject the rebase if it isn't appropriate.  Please see the template
352 pre-rebase hook script for an example.
354 Upon completion, <branch> will be the current branch.
356 INTERACTIVE MODE
357 ----------------
359 Rebasing interactively means that you have a chance to edit the commits
360 which are rebased.  You can reorder the commits, and you can
361 remove them (weeding out bad or otherwise unwanted patches).
363 The interactive mode is meant for this type of workflow:
365 1. have a wonderful idea
366 2. hack on the code
367 3. prepare a series for submission
368 4. submit
370 where point 2. consists of several instances of
372 a. regular use
373  1. finish something worthy of a commit
374  2. commit
375 b. independent fixup
376  1. realize that something does not work
377  2. fix that
378  3. commit it
380 Sometimes the thing fixed in b.2. cannot be amended to the not-quite
381 perfect commit it fixes, because that commit is buried deeply in a
382 patch series.  That is exactly what interactive rebase is for: use it
383 after plenty of "a"s and "b"s, by rearranging and editing
384 commits, and squashing multiple commits into one.
386 Start it with the last commit you want to retain as-is:
388         git rebase -i <after-this-commit>
390 An editor will be fired up with all the commits in your current branch
391 (ignoring merge commits), which come after the given commit.  You can
392 reorder the commits in this list to your heart's content, and you can
393 remove them.  The list looks more or less like this:
395 -------------------------------------------
396 pick deadbee The oneline of this commit
397 pick fa1afe1 The oneline of the next commit
399 -------------------------------------------
401 The oneline descriptions are purely for your pleasure; 'git rebase' will
402 not look at them but at the commit names ("deadbee" and "fa1afe1" in this
403 example), so do not delete or edit the names.
405 By replacing the command "pick" with the command "edit", you can tell
406 'git rebase' to stop after applying that commit, so that you can edit
407 the files and/or the commit message, amend the commit, and continue
408 rebasing.
410 If you just want to edit the commit message for a commit, replace the
411 command "pick" with the command "reword".
413 If you want to fold two or more commits into one, replace the command
414 "pick" for the second and subsequent commits with "squash" or "fixup".
415 If the commits had different authors, the folded commit will be
416 attributed to the author of the first commit.  The suggested commit
417 message for the folded commit is the concatenation of the commit
418 messages of the first commit and of those with the "squash" command,
419 but omits the commit messages of commits with the "fixup" command.
421 'git rebase' will stop when "pick" has been replaced with "edit" or
422 when a command fails due to merge errors. When you are done editing
423 and/or resolving conflicts you can continue with `git rebase --continue`.
425 For example, if you want to reorder the last 5 commits, such that what
426 was HEAD~4 becomes the new HEAD. To achieve that, you would call
427 'git rebase' like this:
429 ----------------------
430 $ git rebase -i HEAD~5
431 ----------------------
433 And move the first patch to the end of the list.
435 You might want to preserve merges, if you have a history like this:
437 ------------------
438            X
439             \
440          A---M---B
441         /
442 ---o---O---P---Q
443 ------------------
445 Suppose you want to rebase the side branch starting at "A" to "Q". Make
446 sure that the current HEAD is "B", and call
448 -----------------------------
449 $ git rebase -i -p --onto Q O
450 -----------------------------
453 SPLITTING COMMITS
454 -----------------
456 In interactive mode, you can mark commits with the action "edit".  However,
457 this does not necessarily mean that 'git rebase' expects the result of this
458 edit to be exactly one commit.  Indeed, you can undo the commit, or you can
459 add other commits.  This can be used to split a commit into two:
461 - Start an interactive rebase with `git rebase -i <commit>^`, where
462   <commit> is the commit you want to split.  In fact, any commit range
463   will do, as long as it contains that commit.
465 - Mark the commit you want to split with the action "edit".
467 - When it comes to editing that commit, execute `git reset HEAD^`.  The
468   effect is that the HEAD is rewound by one, and the index follows suit.
469   However, the working tree stays the same.
471 - Now add the changes to the index that you want to have in the first
472   commit.  You can use `git add` (possibly interactively) or
473   'git gui' (or both) to do that.
475 - Commit the now-current index with whatever commit message is appropriate
476   now.
478 - Repeat the last two steps until your working tree is clean.
480 - Continue the rebase with `git rebase --continue`.
482 If you are not absolutely sure that the intermediate revisions are
483 consistent (they compile, pass the testsuite, etc.) you should use
484 'git stash' to stash away the not-yet-committed changes
485 after each commit, test, and amend the commit if fixes are necessary.
488 RECOVERING FROM UPSTREAM REBASE
489 -------------------------------
491 Rebasing (or any other form of rewriting) a branch that others have
492 based work on is a bad idea: anyone downstream of it is forced to
493 manually fix their history.  This section explains how to do the fix
494 from the downstream's point of view.  The real fix, however, would be
495 to avoid rebasing the upstream in the first place.
497 To illustrate, suppose you are in a situation where someone develops a
498 'subsystem' branch, and you are working on a 'topic' that is dependent
499 on this 'subsystem'.  You might end up with a history like the
500 following:
502 ------------
503     o---o---o---o---o---o---o---o---o  master
504          \
505           o---o---o---o---o  subsystem
506                            \
507                             *---*---*  topic
508 ------------
510 If 'subsystem' is rebased against 'master', the following happens:
512 ------------
513     o---o---o---o---o---o---o---o  master
514          \                       \
515           o---o---o---o---o       o'--o'--o'--o'--o'  subsystem
516                            \
517                             *---*---*  topic
518 ------------
520 If you now continue development as usual, and eventually merge 'topic'
521 to 'subsystem', the commits from 'subsystem' will remain duplicated forever:
523 ------------
524     o---o---o---o---o---o---o---o  master
525          \                       \
526           o---o---o---o---o       o'--o'--o'--o'--o'--M  subsystem
527                            \                         /
528                             *---*---*-..........-*--*  topic
529 ------------
531 Such duplicates are generally frowned upon because they clutter up
532 history, making it harder to follow.  To clean things up, you need to
533 transplant the commits on 'topic' to the new 'subsystem' tip, i.e.,
534 rebase 'topic'.  This becomes a ripple effect: anyone downstream from
535 'topic' is forced to rebase too, and so on!
537 There are two kinds of fixes, discussed in the following subsections:
539 Easy case: The changes are literally the same.::
541         This happens if the 'subsystem' rebase was a simple rebase and
542         had no conflicts.
544 Hard case: The changes are not the same.::
546         This happens if the 'subsystem' rebase had conflicts, or used
547         `\--interactive` to omit, edit, squash, or fixup commits; or
548         if the upstream used one of `commit \--amend`, `reset`, or
549         `filter-branch`.
552 The easy case
553 ~~~~~~~~~~~~~
555 Only works if the changes (patch IDs based on the diff contents) on
556 'subsystem' are literally the same before and after the rebase
557 'subsystem' did.
559 In that case, the fix is easy because 'git rebase' knows to skip
560 changes that are already present in the new upstream.  So if you say
561 (assuming you're on 'topic')
562 ------------
563     $ git rebase subsystem
564 ------------
565 you will end up with the fixed history
566 ------------
567     o---o---o---o---o---o---o---o  master
568                                  \
569                                   o'--o'--o'--o'--o'  subsystem
570                                                    \
571                                                     *---*---*  topic
572 ------------
575 The hard case
576 ~~~~~~~~~~~~~
578 Things get more complicated if the 'subsystem' changes do not exactly
579 correspond to the ones before the rebase.
581 NOTE: While an "easy case recovery" sometimes appears to be successful
582       even in the hard case, it may have unintended consequences.  For
583       example, a commit that was removed via `git rebase
584       \--interactive` will be **resurrected**!
586 The idea is to manually tell 'git rebase' "where the old 'subsystem'
587 ended and your 'topic' began", that is, what the old merge-base
588 between them was.  You will have to find a way to name the last commit
589 of the old 'subsystem', for example:
591 * With the 'subsystem' reflog: after 'git fetch', the old tip of
592   'subsystem' is at `subsystem@\{1}`.  Subsequent fetches will
593   increase the number.  (See linkgit:git-reflog[1].)
595 * Relative to the tip of 'topic': knowing that your 'topic' has three
596   commits, the old tip of 'subsystem' must be `topic~3`.
598 You can then transplant the old `subsystem..topic` to the new tip by
599 saying (for the reflog case, and assuming you are on 'topic' already):
600 ------------
601     $ git rebase --onto subsystem subsystem@{1}
602 ------------
604 The ripple effect of a "hard case" recovery is especially bad:
605 'everyone' downstream from 'topic' will now have to perform a "hard
606 case" recovery too!
609 Authors
610 ------
611 Written by Junio C Hamano <gitster@pobox.com> and
612 Johannes E. Schindelin <johannes.schindelin@gmx.de>
614 Documentation
615 --------------
616 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
620 Part of the linkgit:git[1] suite