Code

Merge branch 'maint'
[git.git] / Documentation / git-rebase.txt
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 -s <strategy>::
233 --strategy=<strategy>::
234         Use the given merge strategy; can be supplied more than
235         once to specify them in the order they should be tried.
236         If there is no `-s` option, a built-in list of strategies
237         is used instead ('git-merge-recursive' when merging a single
238         head, 'git-merge-octopus' otherwise).  This implies --merge.
240 -v::
241 --verbose::
242         Be verbose. Implies --stat.
244 --stat::
245         Show a diffstat of what changed upstream since the last rebase. The
246         diffstat is also controlled by the configuration option rebase.stat.
248 -n::
249 --no-stat::
250         Do not show a diffstat as part of the rebase process.
252 --no-verify::
253         This option bypasses the pre-rebase hook.  See also linkgit:githooks[5].
255 -C<n>::
256         Ensure at least <n> lines of surrounding context match before
257         and after each change.  When fewer lines of surrounding
258         context exist they all must match.  By default no context is
259         ever ignored.
261 -f::
262 --force-rebase::
263         Force the rebase even if the current branch is a descendant
264         of the commit you are rebasing onto.  Normally the command will
265         exit with the message "Current branch is up to date" in such a
266         situation.
268 --whitespace=<option>::
269         This flag is passed to the 'git-apply' program
270         (see linkgit:git-apply[1]) that applies the patch.
271         Incompatible with the --interactive option.
273 --committer-date-is-author-date::
274 --ignore-date::
275         These flags are passed to 'git-am' to easily change the dates
276         of the rebased commits (see linkgit:git-am[1]).
278 -i::
279 --interactive::
280         Make a list of the commits which are about to be rebased.  Let the
281         user edit that list before rebasing.  This mode can also be used to
282         split commits (see SPLITTING COMMITS below).
284 -p::
285 --preserve-merges::
286         Instead of ignoring merges, try to recreate them.
288 --root::
289         Rebase all commits reachable from <branch>, instead of
290         limiting them with an <upstream>.  This allows you to rebase
291         the root commit(s) on a branch.  Must be used with --onto, and
292         will skip changes already contained in <newbase> (instead of
293         <upstream>).  When used together with --preserve-merges, 'all'
294         root commits will be rewritten to have <newbase> as parent
295         instead.
297 include::merge-strategies.txt[]
299 NOTES
300 -----
302 You should understand the implications of using 'git-rebase' on a
303 repository that you share.  See also RECOVERING FROM UPSTREAM REBASE
304 below.
306 When the git-rebase command is run, it will first execute a "pre-rebase"
307 hook if one exists.  You can use this hook to do sanity checks and
308 reject the rebase if it isn't appropriate.  Please see the template
309 pre-rebase hook script for an example.
311 Upon completion, <branch> will be the current branch.
313 INTERACTIVE MODE
314 ----------------
316 Rebasing interactively means that you have a chance to edit the commits
317 which are rebased.  You can reorder the commits, and you can
318 remove them (weeding out bad or otherwise unwanted patches).
320 The interactive mode is meant for this type of workflow:
322 1. have a wonderful idea
323 2. hack on the code
324 3. prepare a series for submission
325 4. submit
327 where point 2. consists of several instances of
329 a. regular use
330  1. finish something worthy of a commit
331  2. commit
332 b. independent fixup
333  1. realize that something does not work
334  2. fix that
335  3. commit it
337 Sometimes the thing fixed in b.2. cannot be amended to the not-quite
338 perfect commit it fixes, because that commit is buried deeply in a
339 patch series.  That is exactly what interactive rebase is for: use it
340 after plenty of "a"s and "b"s, by rearranging and editing
341 commits, and squashing multiple commits into one.
343 Start it with the last commit you want to retain as-is:
345         git rebase -i <after-this-commit>
347 An editor will be fired up with all the commits in your current branch
348 (ignoring merge commits), which come after the given commit.  You can
349 reorder the commits in this list to your heart's content, and you can
350 remove them.  The list looks more or less like this:
352 -------------------------------------------
353 pick deadbee The oneline of this commit
354 pick fa1afe1 The oneline of the next commit
355 ...
356 -------------------------------------------
358 The oneline descriptions are purely for your pleasure; 'git-rebase' will
359 not look at them but at the commit names ("deadbee" and "fa1afe1" in this
360 example), so do not delete or edit the names.
362 By replacing the command "pick" with the command "edit", you can tell
363 'git-rebase' to stop after applying that commit, so that you can edit
364 the files and/or the commit message, amend the commit, and continue
365 rebasing.
367 If you want to fold two or more commits into one, replace the command
368 "pick" with "squash" for the second and subsequent commit.  If the
369 commits had different authors, it will attribute the squashed commit to
370 the author of the first commit.
372 In both cases, or when a "pick" does not succeed (because of merge
373 errors), the loop will stop to let you fix things, and you can continue
374 the loop with `git rebase --continue`.
376 For example, if you want to reorder the last 5 commits, such that what
377 was HEAD~4 becomes the new HEAD. To achieve that, you would call
378 'git-rebase' like this:
380 ----------------------
381 $ git rebase -i HEAD~5
382 ----------------------
384 And move the first patch to the end of the list.
386 You might want to preserve merges, if you have a history like this:
388 ------------------
389            X
390             \
391          A---M---B
392         /
393 ---o---O---P---Q
394 ------------------
396 Suppose you want to rebase the side branch starting at "A" to "Q". Make
397 sure that the current HEAD is "B", and call
399 -----------------------------
400 $ git rebase -i -p --onto Q O
401 -----------------------------
404 SPLITTING COMMITS
405 -----------------
407 In interactive mode, you can mark commits with the action "edit".  However,
408 this does not necessarily mean that 'git-rebase' expects the result of this
409 edit to be exactly one commit.  Indeed, you can undo the commit, or you can
410 add other commits.  This can be used to split a commit into two:
412 - Start an interactive rebase with `git rebase -i <commit>^`, where
413   <commit> is the commit you want to split.  In fact, any commit range
414   will do, as long as it contains that commit.
416 - Mark the commit you want to split with the action "edit".
418 - When it comes to editing that commit, execute `git reset HEAD^`.  The
419   effect is that the HEAD is rewound by one, and the index follows suit.
420   However, the working tree stays the same.
422 - Now add the changes to the index that you want to have in the first
423   commit.  You can use `git add` (possibly interactively) or
424   'git-gui' (or both) to do that.
426 - Commit the now-current index with whatever commit message is appropriate
427   now.
429 - Repeat the last two steps until your working tree is clean.
431 - Continue the rebase with `git rebase --continue`.
433 If you are not absolutely sure that the intermediate revisions are
434 consistent (they compile, pass the testsuite, etc.) you should use
435 'git-stash' to stash away the not-yet-committed changes
436 after each commit, test, and amend the commit if fixes are necessary.
439 RECOVERING FROM UPSTREAM REBASE
440 -------------------------------
442 Rebasing (or any other form of rewriting) a branch that others have
443 based work on is a bad idea: anyone downstream of it is forced to
444 manually fix their history.  This section explains how to do the fix
445 from the downstream's point of view.  The real fix, however, would be
446 to avoid rebasing the upstream in the first place.
448 To illustrate, suppose you are in a situation where someone develops a
449 'subsystem' branch, and you are working on a 'topic' that is dependent
450 on this 'subsystem'.  You might end up with a history like the
451 following:
453 ------------
454     o---o---o---o---o---o---o---o---o  master
455          \
456           o---o---o---o---o  subsystem
457                            \
458                             *---*---*  topic
459 ------------
461 If 'subsystem' is rebased against 'master', the following happens:
463 ------------
464     o---o---o---o---o---o---o---o  master
465          \                       \
466           o---o---o---o---o       o'--o'--o'--o'--o'  subsystem
467                            \
468                             *---*---*  topic
469 ------------
471 If you now continue development as usual, and eventually merge 'topic'
472 to 'subsystem', the commits from 'subsystem' will remain duplicated forever:
474 ------------
475     o---o---o---o---o---o---o---o  master
476          \                       \
477           o---o---o---o---o       o'--o'--o'--o'--o'--M  subsystem
478                            \                         /
479                             *---*---*-..........-*--*  topic
480 ------------
482 Such duplicates are generally frowned upon because they clutter up
483 history, making it harder to follow.  To clean things up, you need to
484 transplant the commits on 'topic' to the new 'subsystem' tip, i.e.,
485 rebase 'topic'.  This becomes a ripple effect: anyone downstream from
486 'topic' is forced to rebase too, and so on!
488 There are two kinds of fixes, discussed in the following subsections:
490 Easy case: The changes are literally the same.::
492         This happens if the 'subsystem' rebase was a simple rebase and
493         had no conflicts.
495 Hard case: The changes are not the same.::
497         This happens if the 'subsystem' rebase had conflicts, or used
498         `\--interactive` to omit, edit, or squash commits; or if the
499         upstream used one of `commit \--amend`, `reset`, or
500         `filter-branch`.
503 The easy case
504 ~~~~~~~~~~~~~
506 Only works if the changes (patch IDs based on the diff contents) on
507 'subsystem' are literally the same before and after the rebase
508 'subsystem' did.
510 In that case, the fix is easy because 'git-rebase' knows to skip
511 changes that are already present in the new upstream.  So if you say
512 (assuming you're on 'topic')
513 ------------
514     $ git rebase subsystem
515 ------------
516 you will end up with the fixed history
517 ------------
518     o---o---o---o---o---o---o---o  master
519                                  \
520                                   o'--o'--o'--o'--o'  subsystem
521                                                    \
522                                                     *---*---*  topic
523 ------------
526 The hard case
527 ~~~~~~~~~~~~~
529 Things get more complicated if the 'subsystem' changes do not exactly
530 correspond to the ones before the rebase.
532 NOTE: While an "easy case recovery" sometimes appears to be successful
533       even in the hard case, it may have unintended consequences.  For
534       example, a commit that was removed via `git rebase
535       \--interactive` will be **resurrected**!
537 The idea is to manually tell 'git-rebase' "where the old 'subsystem'
538 ended and your 'topic' began", that is, what the old merge-base
539 between them was.  You will have to find a way to name the last commit
540 of the old 'subsystem', for example:
542 * With the 'subsystem' reflog: after 'git-fetch', the old tip of
543   'subsystem' is at `subsystem@\{1}`.  Subsequent fetches will
544   increase the number.  (See linkgit:git-reflog[1].)
546 * Relative to the tip of 'topic': knowing that your 'topic' has three
547   commits, the old tip of 'subsystem' must be `topic~3`.
549 You can then transplant the old `subsystem..topic` to the new tip by
550 saying (for the reflog case, and assuming you are on 'topic' already):
551 ------------
552     $ git rebase --onto subsystem subsystem@{1}
553 ------------
555 The ripple effect of a "hard case" recovery is especially bad:
556 'everyone' downstream from 'topic' will now have to perform a "hard
557 case" recovery too!
560 Authors
561 ------
562 Written by Junio C Hamano <gitster@pobox.com> and
563 Johannes E. Schindelin <johannes.schindelin@gmx.de>
565 Documentation
566 --------------
567 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
569 GIT
570 ---
571 Part of the linkgit:git[1] suite