trace2: disable tr2_dst before warning on write errors
[git.git] / Documentation / git-rebase.txt
blob73d49ec8d911505dffd664392321e2f064327c34
1 git-rebase(1)
2 =============
4 NAME
5 ----
6 git-rebase - Reapply commits on top of another base tip
8 SYNOPSIS
9 --------
10 [verse]
11 'git rebase' [-i | --interactive] [<options>] [--exec <cmd>]
12         [--onto <newbase> | --keep-base] [<upstream> [<branch>]]
13 'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
14         --root [<branch>]
15 'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)
17 DESCRIPTION
18 -----------
19 If <branch> is specified, 'git rebase' will perform an automatic
20 `git switch <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) and the `--fork-point` option is
26 assumed.  If you are currently not on any branch or if the current
27 branch does not have a configured upstream, 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 by
32 `git log 'fork_point'..HEAD`, if `--fork-point` is active (see the
33 description on `--fork-point` below); or by `git log HEAD`, if the
34 `--root` option is specified.
36 The current branch is reset to <upstream>, or <newbase> if the
37 --onto option was supplied.  This has the exact same effect as
38 `git reset --hard <upstream>` (or <newbase>).  ORIG_HEAD is set
39 to point at the tip of the branch before the reset.
41 The commits that were previously saved into the temporary area are
42 then reapplied to the current branch, one by one, in order. Note that
43 any commits in HEAD which introduce the same textual changes as a commit
44 in HEAD..<upstream> are omitted (i.e., a patch already accepted upstream
45 with a different commit message or timestamp will be skipped).
47 It is possible that a merge failure will prevent this process from being
48 completely automatic.  You will have to resolve any such merge failure
49 and run `git rebase --continue`.  Another option is to bypass the commit
50 that caused the merge failure with `git rebase --skip`.  To check out the
51 original <branch> and remove the .git/rebase-apply working files, use the
52 command `git rebase --abort` instead.
54 Assume the following history exists and the current branch is "topic":
56 ------------
57           A---B---C topic
58          /
59     D---E---F---G master
60 ------------
62 From this point, the result of either of the following commands:
65     git rebase master
66     git rebase master topic
68 would be:
70 ------------
71                   A'--B'--C' topic
72                  /
73     D---E---F---G master
74 ------------
76 *NOTE:* The latter form is just a short-hand of `git checkout topic`
77 followed by `git rebase master`. When rebase exits `topic` will
78 remain the checked-out branch.
80 If the upstream branch already contains a change you have made (e.g.,
81 because you mailed a patch which was applied upstream), then that commit
82 will be skipped. For example, running `git rebase master` on the
83 following history (in which `A'` and `A` introduce the same set of changes,
84 but have different committer information):
86 ------------
87           A---B---C topic
88          /
89     D---E---A'---F master
90 ------------
92 will result in:
94 ------------
95                    B'---C' topic
96                   /
97     D---E---A'---F master
98 ------------
100 Here is how you would transplant a topic branch based on one
101 branch to another, to pretend that you forked the topic branch
102 from the latter branch, using `rebase --onto`.
104 First let's assume your 'topic' is based on branch 'next'.
105 For example, a feature developed in 'topic' depends on some
106 functionality which is found in 'next'.
108 ------------
109     o---o---o---o---o  master
110          \
111           o---o---o---o---o  next
112                            \
113                             o---o---o  topic
114 ------------
116 We want to make 'topic' forked from branch 'master'; for example,
117 because the functionality on which 'topic' depends was merged into the
118 more stable 'master' branch. We want our tree to look like this:
120 ------------
121     o---o---o---o---o  master
122         |            \
123         |             o'--o'--o'  topic
124          \
125           o---o---o---o---o  next
126 ------------
128 We can get this using the following command:
130     git rebase --onto master next topic
133 Another example of --onto option is to rebase part of a
134 branch.  If we have the following situation:
136 ------------
137                             H---I---J topicB
138                            /
139                   E---F---G  topicA
140                  /
141     A---B---C---D  master
142 ------------
144 then the command
146     git rebase --onto master topicA topicB
148 would result in:
150 ------------
151                  H'--I'--J'  topicB
152                 /
153                 | E---F---G  topicA
154                 |/
155     A---B---C---D  master
156 ------------
158 This is useful when topicB does not depend on topicA.
160 A range of commits could also be removed with rebase.  If we have
161 the following situation:
163 ------------
164     E---F---G---H---I---J  topicA
165 ------------
167 then the command
169     git rebase --onto topicA~5 topicA~3 topicA
171 would result in the removal of commits F and G:
173 ------------
174     E---H'---I'---J'  topicA
175 ------------
177 This is useful if F and G were flawed in some way, or should not be
178 part of topicA.  Note that the argument to --onto and the <upstream>
179 parameter can be any valid commit-ish.
181 In case of conflict, 'git rebase' will stop at the first problematic commit
182 and leave conflict markers in the tree.  You can use 'git diff' to locate
183 the markers (<<<<<<) and make edits to resolve the conflict.  For each
184 file you edit, you need to tell Git that the conflict has been resolved,
185 typically this would be done with
188     git add <filename>
191 After resolving the conflict manually and updating the index with the
192 desired resolution, you can continue the rebasing process with
195     git rebase --continue
198 Alternatively, you can undo the 'git rebase' with
201     git rebase --abort
203 OPTIONS
204 -------
205 --onto <newbase>::
206         Starting point at which to create the new commits. If the
207         --onto option is not specified, the starting point is
208         <upstream>.  May be any valid commit, and not just an
209         existing branch name.
211 As a special case, you may use "A\...B" as a shortcut for the
212 merge base of A and B if there is exactly one merge base. You can
213 leave out at most one of A and B, in which case it defaults to HEAD.
215 --keep-base::
216         Set the starting point at which to create the new commits to the
217         merge base of <upstream> <branch>. Running
218         'git rebase --keep-base <upstream> <branch>' is equivalent to
219         running 'git rebase --onto <upstream>... <upstream>'.
221 This option is useful in the case where one is developing a feature on
222 top of an upstream branch. While the feature is being worked on, the
223 upstream branch may advance and it may not be the best idea to keep
224 rebasing on top of the upstream but to keep the base commit as-is.
226 Although both this option and --fork-point find the merge base between
227 <upstream> and <branch>, this option uses the merge base as the _starting
228 point_ on which new commits will be created, whereas --fork-point uses
229 the merge base to determine the _set of commits_ which will be rebased.
231 See also INCOMPATIBLE OPTIONS below.
233 <upstream>::
234         Upstream branch to compare against.  May be any valid commit,
235         not just an existing branch name. Defaults to the configured
236         upstream for the current branch.
238 <branch>::
239         Working branch; defaults to HEAD.
241 --continue::
242         Restart the rebasing process after having resolved a merge conflict.
244 --abort::
245         Abort the rebase operation and reset HEAD to the original
246         branch. If <branch> was provided when the rebase operation was
247         started, then HEAD will be reset to <branch>. Otherwise HEAD
248         will be reset to where it was when the rebase operation was
249         started.
251 --quit::
252         Abort the rebase operation but HEAD is not reset back to the
253         original branch. The index and working tree are also left
254         unchanged as a result. If a temporary stash entry was created
255         using --autostash, it will be saved to the stash list.
257 --apply::
258         Use applying strategies to rebase (calling `git-am`
259         internally).  This option may become a no-op in the future
260         once the merge backend handles everything the apply one does.
262 See also INCOMPATIBLE OPTIONS below.
264 --empty={drop,keep,ask}::
265         How to handle commits that are not empty to start and are not
266         clean cherry-picks of any upstream commit, but which become
267         empty after rebasing (because they contain a subset of already
268         upstream changes).  With drop (the default), commits that
269         become empty are dropped.  With keep, such commits are kept.
270         With ask (implied by --interactive), the rebase will halt when
271         an empty commit is applied allowing you to choose whether to
272         drop it, edit files more, or just commit the empty changes.
273         Other options, like --exec, will use the default of drop unless
274         -i/--interactive is explicitly specified.
276 Note that commits which start empty are kept (unless --no-keep-empty
277 is specified), and commits which are clean cherry-picks (as determined
278 by `git log --cherry-mark ...`) are detected and dropped as a
279 preliminary step (unless --reapply-cherry-picks is passed).
281 See also INCOMPATIBLE OPTIONS below.
283 --no-keep-empty::
284 --keep-empty::
285         Do not keep commits that start empty before the rebase
286         (i.e. that do not change anything from its parent) in the
287         result.  The default is to keep commits which start empty,
288         since creating such commits requires passing the --allow-empty
289         override flag to `git commit`, signifying that a user is very
290         intentionally creating such a commit and thus wants to keep
291         it.
293 Usage of this flag will probably be rare, since you can get rid of
294 commits that start empty by just firing up an interactive rebase and
295 removing the lines corresponding to the commits you don't want.  This
296 flag exists as a convenient shortcut, such as for cases where external
297 tools generate many empty commits and you want them all removed.
299 For commits which do not start empty but become empty after rebasing,
300 see the --empty flag.
302 See also INCOMPATIBLE OPTIONS below.
304 --reapply-cherry-picks::
305 --no-reapply-cherry-picks::
306         Reapply all clean cherry-picks of any upstream commit instead
307         of preemptively dropping them. (If these commits then become
308         empty after rebasing, because they contain a subset of already
309         upstream changes, the behavior towards them is controlled by
310         the `--empty` flag.)
312 By default (or if `--no-reapply-cherry-picks` is given), these commits
313 will be automatically dropped.  Because this necessitates reading all
314 upstream commits, this can be expensive in repos with a large number
315 of upstream commits that need to be read.
317 `--reapply-cherry-picks` allows rebase to forgo reading all upstream
318 commits, potentially improving performance.
320 See also INCOMPATIBLE OPTIONS below.
322 --allow-empty-message::
323         No-op.  Rebasing commits with an empty message used to fail
324         and this option would override that behavior, allowing commits
325         with empty messages to be rebased.  Now commits with an empty
326         message do not cause rebasing to halt.
328 See also INCOMPATIBLE OPTIONS below.
330 --skip::
331         Restart the rebasing process by skipping the current patch.
333 --edit-todo::
334         Edit the todo list during an interactive rebase.
336 --show-current-patch::
337         Show the current patch in an interactive rebase or when rebase
338         is stopped because of conflicts. This is the equivalent of
339         `git show REBASE_HEAD`.
341 -m::
342 --merge::
343         Using merging strategies to rebase (default).
345 Note that a rebase merge works by replaying each commit from the working
346 branch on top of the <upstream> branch.  Because of this, when a merge
347 conflict happens, the side reported as 'ours' is the so-far rebased
348 series, starting with <upstream>, and 'theirs' is the working branch.  In
349 other words, the sides are swapped.
351 See also INCOMPATIBLE OPTIONS below.
353 -s <strategy>::
354 --strategy=<strategy>::
355         Use the given merge strategy, instead of the default
356         `recursive`.  This implies `--merge`.
358 Because 'git rebase' replays each commit from the working branch
359 on top of the <upstream> branch using the given strategy, using
360 the 'ours' strategy simply empties all patches from the <branch>,
361 which makes little sense.
363 See also INCOMPATIBLE OPTIONS below.
365 -X <strategy-option>::
366 --strategy-option=<strategy-option>::
367         Pass the <strategy-option> through to the merge strategy.
368         This implies `--merge` and, if no strategy has been
369         specified, `-s recursive`.  Note the reversal of 'ours' and
370         'theirs' as noted above for the `-m` option.
372 See also INCOMPATIBLE OPTIONS below.
374 --rerere-autoupdate::
375 --no-rerere-autoupdate::
376         Allow the rerere mechanism to update the index with the
377         result of auto-conflict resolution if possible.
379 -S[<keyid>]::
380 --gpg-sign[=<keyid>]::
381 --no-gpg-sign::
382         GPG-sign commits. The `keyid` argument is optional and
383         defaults to the committer identity; if specified, it must be
384         stuck to the option without a space. `--no-gpg-sign` is useful to
385         countermand both `commit.gpgSign` configuration variable, and
386         earlier `--gpg-sign`.
388 -q::
389 --quiet::
390         Be quiet. Implies --no-stat.
392 -v::
393 --verbose::
394         Be verbose. Implies --stat.
396 --stat::
397         Show a diffstat of what changed upstream since the last rebase. The
398         diffstat is also controlled by the configuration option rebase.stat.
400 -n::
401 --no-stat::
402         Do not show a diffstat as part of the rebase process.
404 --no-verify::
405         This option bypasses the pre-rebase hook.  See also linkgit:githooks[5].
407 --verify::
408         Allows the pre-rebase hook to run, which is the default.  This option can
409         be used to override --no-verify.  See also linkgit:githooks[5].
411 -C<n>::
412         Ensure at least <n> lines of surrounding context match before
413         and after each change.  When fewer lines of surrounding
414         context exist they all must match.  By default no context is
415         ever ignored.  Implies --apply.
417 See also INCOMPATIBLE OPTIONS below.
419 --no-ff::
420 --force-rebase::
421 -f::
422         Individually replay all rebased commits instead of fast-forwarding
423         over the unchanged ones.  This ensures that the entire history of
424         the rebased branch is composed of new commits.
426 You may find this helpful after reverting a topic branch merge, as this option
427 recreates the topic branch with fresh commits so it can be remerged
428 successfully without needing to "revert the reversion" (see the
429 link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for
430 details).
432 --fork-point::
433 --no-fork-point::
434         Use reflog to find a better common ancestor between <upstream>
435         and <branch> when calculating which commits have been
436         introduced by <branch>.
438 When --fork-point is active, 'fork_point' will be used instead of
439 <upstream> to calculate the set of commits to rebase, where
440 'fork_point' is the result of `git merge-base --fork-point <upstream>
441 <branch>` command (see linkgit:git-merge-base[1]).  If 'fork_point'
442 ends up being empty, the <upstream> will be used as a fallback.
444 If <upstream> is given on the command line, then the default is
445 `--no-fork-point`, otherwise the default is `--fork-point`.
447 If your branch was based on <upstream> but <upstream> was rewound and
448 your branch contains commits which were dropped, this option can be used
449 with `--keep-base` in order to drop those commits from your branch.
451 See also INCOMPATIBLE OPTIONS below.
453 --ignore-whitespace::
454         Ignore whitespace differences when trying to reconcile
455 differences. Currently, each backend implements an approximation of
456 this behavior:
458 apply backend: When applying a patch, ignore changes in whitespace in
459 context lines. Unfortunately, this means that if the "old" lines being
460 replaced by the patch differ only in whitespace from the existing
461 file, you will get a merge conflict instead of a successful patch
462 application.
464 merge backend: Treat lines with only whitespace changes as unchanged
465 when merging. Unfortunately, this means that any patch hunks that were
466 intended to modify whitespace and nothing else will be dropped, even
467 if the other side had no changes that conflicted.
469 --whitespace=<option>::
470         This flag is passed to the 'git apply' program
471         (see linkgit:git-apply[1]) that applies the patch.
472         Implies --apply.
474 See also INCOMPATIBLE OPTIONS below.
476 --committer-date-is-author-date::
477         Instead of using the current time as the committer date, use
478         the author date of the commit being rebased as the committer
479         date. This option implies `--force-rebase`.
481 --ignore-date::
482 --reset-author-date::
483         Instead of using the author date of the original commit, use
484         the current time as the author date of the rebased commit.  This
485         option implies `--force-rebase`.
487 See also INCOMPATIBLE OPTIONS below.
489 --signoff::
490         Add a `Signed-off-by` trailer to all the rebased commits. Note
491         that if `--interactive` is given then only commits marked to be
492         picked, edited or reworded will have the trailer added.
494 See also INCOMPATIBLE OPTIONS below.
496 -i::
497 --interactive::
498         Make a list of the commits which are about to be rebased.  Let the
499         user edit that list before rebasing.  This mode can also be used to
500         split commits (see SPLITTING COMMITS below).
502 The commit list format can be changed by setting the configuration option
503 rebase.instructionFormat.  A customized instruction format will automatically
504 have the long commit hash prepended to the format.
506 See also INCOMPATIBLE OPTIONS below.
508 -r::
509 --rebase-merges[=(rebase-cousins|no-rebase-cousins)]::
510         By default, a rebase will simply drop merge commits from the todo
511         list, and put the rebased commits into a single, linear branch.
512         With `--rebase-merges`, the rebase will instead try to preserve
513         the branching structure within the commits that are to be rebased,
514         by recreating the merge commits. Any resolved merge conflicts or
515         manual amendments in these merge commits will have to be
516         resolved/re-applied manually.
518 By default, or when `no-rebase-cousins` was specified, commits which do not
519 have `<upstream>` as direct ancestor will keep their original branch point,
520 i.e. commits that would be excluded by linkgit:git-log[1]'s
521 `--ancestry-path` option will keep their original ancestry by default. If
522 the `rebase-cousins` mode is turned on, such commits are instead rebased
523 onto `<upstream>` (or `<onto>`, if specified).
525 The `--rebase-merges` mode is similar in spirit to the deprecated
526 `--preserve-merges` but works with interactive rebases,
527 where commits can be reordered, inserted and dropped at will.
529 It is currently only possible to recreate the merge commits using the
530 `recursive` merge strategy; different merge strategies can be used only via
531 explicit `exec git merge -s <strategy> [...]` commands.
533 See also REBASING MERGES and INCOMPATIBLE OPTIONS below.
535 -p::
536 --preserve-merges::
537         [DEPRECATED: use `--rebase-merges` instead] Recreate merge commits
538         instead of flattening the history by replaying commits a merge commit
539         introduces. Merge conflict resolutions or manual amendments to merge
540         commits are not preserved.
542 This uses the `--interactive` machinery internally, but combining it
543 with the `--interactive` option explicitly is generally not a good
544 idea unless you know what you are doing (see BUGS below).
546 See also INCOMPATIBLE OPTIONS below.
548 -x <cmd>::
549 --exec <cmd>::
550         Append "exec <cmd>" after each line creating a commit in the
551         final history. <cmd> will be interpreted as one or more shell
552         commands. Any command that fails will interrupt the rebase,
553         with exit code 1.
555 You may execute several commands by either using one instance of `--exec`
556 with several commands:
558         git rebase -i --exec "cmd1 && cmd2 && ..."
560 or by giving more than one `--exec`:
562         git rebase -i --exec "cmd1" --exec "cmd2" --exec ...
564 If `--autosquash` is used, "exec" lines will not be appended for
565 the intermediate commits, and will only appear at the end of each
566 squash/fixup series.
568 This uses the `--interactive` machinery internally, but it can be run
569 without an explicit `--interactive`.
571 See also INCOMPATIBLE OPTIONS below.
573 --root::
574         Rebase all commits reachable from <branch>, instead of
575         limiting them with an <upstream>.  This allows you to rebase
576         the root commit(s) on a branch.  When used with --onto, it
577         will skip changes already contained in <newbase> (instead of
578         <upstream>) whereas without --onto it will operate on every change.
579         When used together with both --onto and --preserve-merges,
580         'all' root commits will be rewritten to have <newbase> as parent
581         instead.
583 See also INCOMPATIBLE OPTIONS below.
585 --autosquash::
586 --no-autosquash::
587         When the commit log message begins with "squash! ..." or "fixup! ..."
588         or "amend! ...", and there is already a commit in the todo list that
589         matches the same `...`, automatically modify the todo list of
590         `rebase -i`, so that the commit marked for squashing comes right after
591         the commit to be modified, and change the action of the moved commit
592         from `pick` to `squash` or `fixup` or `fixup -C` respectively. A commit
593         matches the `...` if the commit subject matches, or if the `...` refers
594         to the commit's hash. As a fall-back, partial matches of the commit
595         subject work, too. The recommended way to create fixup/amend/squash
596         commits is by using the `--fixup`, `--fixup=amend:` or `--fixup=reword:`
597         and `--squash` options respectively of linkgit:git-commit[1].
599 If the `--autosquash` option is enabled by default using the
600 configuration variable `rebase.autoSquash`, this option can be
601 used to override and disable this setting.
603 See also INCOMPATIBLE OPTIONS below.
605 --autostash::
606 --no-autostash::
607         Automatically create a temporary stash entry before the operation
608         begins, and apply it after the operation ends.  This means
609         that you can run rebase on a dirty worktree.  However, use
610         with care: the final stash application after a successful
611         rebase might result in non-trivial conflicts.
613 --reschedule-failed-exec::
614 --no-reschedule-failed-exec::
615         Automatically reschedule `exec` commands that failed. This only makes
616         sense in interactive mode (or when an `--exec` option was provided).
618 Even though this option applies once a rebase is started, it's set for
619 the whole rebase at the start based on either the
620 `rebase.rescheduleFailedExec` configuration (see linkgit:git-config[1]
621 or "CONFIGURATION" below) or whether this option is
622 provided. Otherwise an explicit `--no-reschedule-failed-exec` at the
623 start would be overridden by the presence of
624 `rebase.rescheduleFailedExec=true` configuration.
626 INCOMPATIBLE OPTIONS
627 --------------------
629 The following options:
631  * --apply
632  * --whitespace
633  * -C
635 are incompatible with the following options:
637  * --merge
638  * --strategy
639  * --strategy-option
640  * --allow-empty-message
641  * --[no-]autosquash
642  * --rebase-merges
643  * --preserve-merges
644  * --interactive
645  * --exec
646  * --no-keep-empty
647  * --empty=
648  * --reapply-cherry-picks
649  * --edit-todo
650  * --root when used in combination with --onto
652 In addition, the following pairs of options are incompatible:
654  * --preserve-merges and --interactive
655  * --preserve-merges and --signoff
656  * --preserve-merges and --rebase-merges
657  * --preserve-merges and --empty=
658  * --preserve-merges and --ignore-whitespace
659  * --preserve-merges and --committer-date-is-author-date
660  * --preserve-merges and --ignore-date
661  * --keep-base and --onto
662  * --keep-base and --root
663  * --fork-point and --root
665 BEHAVIORAL DIFFERENCES
666 -----------------------
668 git rebase has two primary backends: apply and merge.  (The apply
669 backend used to be known as the 'am' backend, but the name led to
670 confusion as it looks like a verb instead of a noun.  Also, the merge
671 backend used to be known as the interactive backend, but it is now
672 used for non-interactive cases as well.  Both were renamed based on
673 lower-level functionality that underpinned each.) There are some
674 subtle differences in how these two backends behave:
676 Empty commits
677 ~~~~~~~~~~~~~
679 The apply backend unfortunately drops intentionally empty commits, i.e.
680 commits that started empty, though these are rare in practice.  It
681 also drops commits that become empty and has no option for controlling
682 this behavior.
684 The merge backend keeps intentionally empty commits by default (though
685 with -i they are marked as empty in the todo list editor, or they can
686 be dropped automatically with --no-keep-empty).
688 Similar to the apply backend, by default the merge backend drops
689 commits that become empty unless -i/--interactive is specified (in
690 which case it stops and asks the user what to do).  The merge backend
691 also has an --empty={drop,keep,ask} option for changing the behavior
692 of handling commits that become empty.
694 Directory rename detection
695 ~~~~~~~~~~~~~~~~~~~~~~~~~~
697 Due to the lack of accurate tree information (arising from
698 constructing fake ancestors with the limited information available in
699 patches), directory rename detection is disabled in the apply backend.
700 Disabled directory rename detection means that if one side of history
701 renames a directory and the other adds new files to the old directory,
702 then the new files will be left behind in the old directory without
703 any warning at the time of rebasing that you may want to move these
704 files into the new directory.
706 Directory rename detection works with the merge backend to provide you
707 warnings in such cases.
709 Context
710 ~~~~~~~
712 The apply backend works by creating a sequence of patches (by calling
713 `format-patch` internally), and then applying the patches in sequence
714 (calling `am` internally).  Patches are composed of multiple hunks,
715 each with line numbers, a context region, and the actual changes.  The
716 line numbers have to be taken with some fuzz, since the other side
717 will likely have inserted or deleted lines earlier in the file.  The
718 context region is meant to help find how to adjust the line numbers in
719 order to apply the changes to the right lines.  However, if multiple
720 areas of the code have the same surrounding lines of context, the
721 wrong one can be picked.  There are real-world cases where this has
722 caused commits to be reapplied incorrectly with no conflicts reported.
723 Setting diff.context to a larger value may prevent such types of
724 problems, but increases the chance of spurious conflicts (since it
725 will require more lines of matching context to apply).
727 The merge backend works with a full copy of each relevant file,
728 insulating it from these types of problems.
730 Labelling of conflicts markers
731 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
733 When there are content conflicts, the merge machinery tries to
734 annotate each side's conflict markers with the commits where the
735 content came from.  Since the apply backend drops the original
736 information about the rebased commits and their parents (and instead
737 generates new fake commits based off limited information in the
738 generated patches), those commits cannot be identified; instead it has
739 to fall back to a commit summary.  Also, when merge.conflictStyle is
740 set to diff3, the apply backend will use "constructed merge base" to
741 label the content from the merge base, and thus provide no information
742 about the merge base commit whatsoever.
744 The merge backend works with the full commits on both sides of history
745 and thus has no such limitations.
747 Hooks
748 ~~~~~
750 The apply backend has not traditionally called the post-commit hook,
751 while the merge backend has.  Both have called the post-checkout hook,
752 though the merge backend has squelched its output.  Further, both
753 backends only call the post-checkout hook with the starting point
754 commit of the rebase, not the intermediate commits nor the final
755 commit.  In each case, the calling of these hooks was by accident of
756 implementation rather than by design (both backends were originally
757 implemented as shell scripts and happened to invoke other commands
758 like 'git checkout' or 'git commit' that would call the hooks).  Both
759 backends should have the same behavior, though it is not entirely
760 clear which, if any, is correct.  We will likely make rebase stop
761 calling either of these hooks in the future.
763 Interruptability
764 ~~~~~~~~~~~~~~~~
766 The apply backend has safety problems with an ill-timed interrupt; if
767 the user presses Ctrl-C at the wrong time to try to abort the rebase,
768 the rebase can enter a state where it cannot be aborted with a
769 subsequent `git rebase --abort`.  The merge backend does not appear to
770 suffer from the same shortcoming.  (See
771 https://lore.kernel.org/git/20200207132152.GC2868@szeder.dev/ for
772 details.)
774 Commit Rewording
775 ~~~~~~~~~~~~~~~~
777 When a conflict occurs while rebasing, rebase stops and asks the user
778 to resolve.  Since the user may need to make notable changes while
779 resolving conflicts, after conflicts are resolved and the user has run
780 `git rebase --continue`, the rebase should open an editor and ask the
781 user to update the commit message.  The merge backend does this, while
782 the apply backend blindly applies the original commit message.
784 Miscellaneous differences
785 ~~~~~~~~~~~~~~~~~~~~~~~~~
787 There are a few more behavioral differences that most folks would
788 probably consider inconsequential but which are mentioned for
789 completeness:
791 * Reflog: The two backends will use different wording when describing
792   the changes made in the reflog, though both will make use of the
793   word "rebase".
795 * Progress, informational, and error messages: The two backends
796   provide slightly different progress and informational messages.
797   Also, the apply backend writes error messages (such as "Your files
798   would be overwritten...") to stdout, while the merge backend writes
799   them to stderr.
801 * State directories: The two backends keep their state in different
802   directories under .git/
804 include::merge-strategies.txt[]
806 NOTES
807 -----
809 You should understand the implications of using 'git rebase' on a
810 repository that you share.  See also RECOVERING FROM UPSTREAM REBASE
811 below.
813 When the git-rebase command is run, it will first execute a "pre-rebase"
814 hook if one exists.  You can use this hook to do sanity checks and
815 reject the rebase if it isn't appropriate.  Please see the template
816 pre-rebase hook script for an example.
818 Upon completion, <branch> will be the current branch.
820 INTERACTIVE MODE
821 ----------------
823 Rebasing interactively means that you have a chance to edit the commits
824 which are rebased.  You can reorder the commits, and you can
825 remove them (weeding out bad or otherwise unwanted patches).
827 The interactive mode is meant for this type of workflow:
829 1. have a wonderful idea
830 2. hack on the code
831 3. prepare a series for submission
832 4. submit
834 where point 2. consists of several instances of
836 a) regular use
838  1. finish something worthy of a commit
839  2. commit
841 b) independent fixup
843  1. realize that something does not work
844  2. fix that
845  3. commit it
847 Sometimes the thing fixed in b.2. cannot be amended to the not-quite
848 perfect commit it fixes, because that commit is buried deeply in a
849 patch series.  That is exactly what interactive rebase is for: use it
850 after plenty of "a"s and "b"s, by rearranging and editing
851 commits, and squashing multiple commits into one.
853 Start it with the last commit you want to retain as-is:
855         git rebase -i <after-this-commit>
857 An editor will be fired up with all the commits in your current branch
858 (ignoring merge commits), which come after the given commit.  You can
859 reorder the commits in this list to your heart's content, and you can
860 remove them.  The list looks more or less like this:
862 -------------------------------------------
863 pick deadbee The oneline of this commit
864 pick fa1afe1 The oneline of the next commit
866 -------------------------------------------
868 The oneline descriptions are purely for your pleasure; 'git rebase' will
869 not look at them but at the commit names ("deadbee" and "fa1afe1" in this
870 example), so do not delete or edit the names.
872 By replacing the command "pick" with the command "edit", you can tell
873 'git rebase' to stop after applying that commit, so that you can edit
874 the files and/or the commit message, amend the commit, and continue
875 rebasing.
877 To interrupt the rebase (just like an "edit" command would do, but without
878 cherry-picking any commit first), use the "break" command.
880 If you just want to edit the commit message for a commit, replace the
881 command "pick" with the command "reword".
883 To drop a commit, replace the command "pick" with "drop", or just
884 delete the matching line.
886 If you want to fold two or more commits into one, replace the command
887 "pick" for the second and subsequent commits with "squash" or "fixup".
888 If the commits had different authors, the folded commit will be
889 attributed to the author of the first commit.  The suggested commit
890 message for the folded commit is the concatenation of the first
891 commit's message with those identified by "squash" commands, omitting the
892 messages of commits identified by "fixup" commands, unless "fixup -c"
893 is used.  In that case the suggested commit message is only the message
894 of the "fixup -c" commit, and an editor is opened allowing you to edit
895 the message.  The contents (patch) of the "fixup -c" commit are still
896 incorporated into the folded commit. If there is more than one "fixup -c"
897 commit, the message from the final one is used.  You can also use
898 "fixup -C" to get the same behavior as "fixup -c" except without opening
899 an editor.
902 'git rebase' will stop when "pick" has been replaced with "edit" or
903 when a command fails due to merge errors. When you are done editing
904 and/or resolving conflicts you can continue with `git rebase --continue`.
906 For example, if you want to reorder the last 5 commits, such that what
907 was HEAD~4 becomes the new HEAD. To achieve that, you would call
908 'git rebase' like this:
910 ----------------------
911 $ git rebase -i HEAD~5
912 ----------------------
914 And move the first patch to the end of the list.
916 You might want to recreate merge commits, e.g. if you have a history
917 like this:
919 ------------------
920            X
921             \
922          A---M---B
923         /
924 ---o---O---P---Q
925 ------------------
927 Suppose you want to rebase the side branch starting at "A" to "Q". Make
928 sure that the current HEAD is "B", and call
930 -----------------------------
931 $ git rebase -i -r --onto Q O
932 -----------------------------
934 Reordering and editing commits usually creates untested intermediate
935 steps.  You may want to check that your history editing did not break
936 anything by running a test, or at least recompiling at intermediate
937 points in history by using the "exec" command (shortcut "x").  You may
938 do so by creating a todo list like this one:
940 -------------------------------------------
941 pick deadbee Implement feature XXX
942 fixup f1a5c00 Fix to feature XXX
943 exec make
944 pick c0ffeee The oneline of the next commit
945 edit deadbab The oneline of the commit after
946 exec cd subdir; make test
948 -------------------------------------------
950 The interactive rebase will stop when a command fails (i.e. exits with
951 non-0 status) to give you an opportunity to fix the problem. You can
952 continue with `git rebase --continue`.
954 The "exec" command launches the command in a shell (the one specified
955 in `$SHELL`, or the default shell if `$SHELL` is not set), so you can
956 use shell features (like "cd", ">", ";" ...). The command is run from
957 the root of the working tree.
959 ----------------------------------
960 $ git rebase -i --exec "make test"
961 ----------------------------------
963 This command lets you check that intermediate commits are compilable.
964 The todo list becomes like that:
966 --------------------
967 pick 5928aea one
968 exec make test
969 pick 04d0fda two
970 exec make test
971 pick ba46169 three
972 exec make test
973 pick f4593f9 four
974 exec make test
975 --------------------
977 SPLITTING COMMITS
978 -----------------
980 In interactive mode, you can mark commits with the action "edit".  However,
981 this does not necessarily mean that 'git rebase' expects the result of this
982 edit to be exactly one commit.  Indeed, you can undo the commit, or you can
983 add other commits.  This can be used to split a commit into two:
985 - Start an interactive rebase with `git rebase -i <commit>^`, where
986   <commit> is the commit you want to split.  In fact, any commit range
987   will do, as long as it contains that commit.
989 - Mark the commit you want to split with the action "edit".
991 - When it comes to editing that commit, execute `git reset HEAD^`.  The
992   effect is that the HEAD is rewound by one, and the index follows suit.
993   However, the working tree stays the same.
995 - Now add the changes to the index that you want to have in the first
996   commit.  You can use `git add` (possibly interactively) or
997   'git gui' (or both) to do that.
999 - Commit the now-current index with whatever commit message is appropriate
1000   now.
1002 - Repeat the last two steps until your working tree is clean.
1004 - Continue the rebase with `git rebase --continue`.
1006 If you are not absolutely sure that the intermediate revisions are
1007 consistent (they compile, pass the testsuite, etc.) you should use
1008 'git stash' to stash away the not-yet-committed changes
1009 after each commit, test, and amend the commit if fixes are necessary.
1012 RECOVERING FROM UPSTREAM REBASE
1013 -------------------------------
1015 Rebasing (or any other form of rewriting) a branch that others have
1016 based work on is a bad idea: anyone downstream of it is forced to
1017 manually fix their history.  This section explains how to do the fix
1018 from the downstream's point of view.  The real fix, however, would be
1019 to avoid rebasing the upstream in the first place.
1021 To illustrate, suppose you are in a situation where someone develops a
1022 'subsystem' branch, and you are working on a 'topic' that is dependent
1023 on this 'subsystem'.  You might end up with a history like the
1024 following:
1026 ------------
1027     o---o---o---o---o---o---o---o  master
1028          \
1029           o---o---o---o---o  subsystem
1030                            \
1031                             *---*---*  topic
1032 ------------
1034 If 'subsystem' is rebased against 'master', the following happens:
1036 ------------
1037     o---o---o---o---o---o---o---o  master
1038          \                       \
1039           o---o---o---o---o       o'--o'--o'--o'--o'  subsystem
1040                            \
1041                             *---*---*  topic
1042 ------------
1044 If you now continue development as usual, and eventually merge 'topic'
1045 to 'subsystem', the commits from 'subsystem' will remain duplicated forever:
1047 ------------
1048     o---o---o---o---o---o---o---o  master
1049          \                       \
1050           o---o---o---o---o       o'--o'--o'--o'--o'--M  subsystem
1051                            \                         /
1052                             *---*---*-..........-*--*  topic
1053 ------------
1055 Such duplicates are generally frowned upon because they clutter up
1056 history, making it harder to follow.  To clean things up, you need to
1057 transplant the commits on 'topic' to the new 'subsystem' tip, i.e.,
1058 rebase 'topic'.  This becomes a ripple effect: anyone downstream from
1059 'topic' is forced to rebase too, and so on!
1061 There are two kinds of fixes, discussed in the following subsections:
1063 Easy case: The changes are literally the same.::
1065         This happens if the 'subsystem' rebase was a simple rebase and
1066         had no conflicts.
1068 Hard case: The changes are not the same.::
1070         This happens if the 'subsystem' rebase had conflicts, or used
1071         `--interactive` to omit, edit, squash, or fixup commits; or
1072         if the upstream used one of `commit --amend`, `reset`, or
1073         a full history rewriting command like
1074         https://github.com/newren/git-filter-repo[`filter-repo`].
1077 The easy case
1078 ~~~~~~~~~~~~~
1080 Only works if the changes (patch IDs based on the diff contents) on
1081 'subsystem' are literally the same before and after the rebase
1082 'subsystem' did.
1084 In that case, the fix is easy because 'git rebase' knows to skip
1085 changes that are already present in the new upstream (unless
1086 `--reapply-cherry-picks` is given). So if you say
1087 (assuming you're on 'topic')
1088 ------------
1089     $ git rebase subsystem
1090 ------------
1091 you will end up with the fixed history
1092 ------------
1093     o---o---o---o---o---o---o---o  master
1094                                  \
1095                                   o'--o'--o'--o'--o'  subsystem
1096                                                    \
1097                                                     *---*---*  topic
1098 ------------
1101 The hard case
1102 ~~~~~~~~~~~~~
1104 Things get more complicated if the 'subsystem' changes do not exactly
1105 correspond to the ones before the rebase.
1107 NOTE: While an "easy case recovery" sometimes appears to be successful
1108       even in the hard case, it may have unintended consequences.  For
1109       example, a commit that was removed via `git rebase
1110       --interactive` will be **resurrected**!
1112 The idea is to manually tell 'git rebase' "where the old 'subsystem'
1113 ended and your 'topic' began", that is, what the old merge base
1114 between them was.  You will have to find a way to name the last commit
1115 of the old 'subsystem', for example:
1117 * With the 'subsystem' reflog: after 'git fetch', the old tip of
1118   'subsystem' is at `subsystem@{1}`.  Subsequent fetches will
1119   increase the number.  (See linkgit:git-reflog[1].)
1121 * Relative to the tip of 'topic': knowing that your 'topic' has three
1122   commits, the old tip of 'subsystem' must be `topic~3`.
1124 You can then transplant the old `subsystem..topic` to the new tip by
1125 saying (for the reflog case, and assuming you are on 'topic' already):
1126 ------------
1127     $ git rebase --onto subsystem subsystem@{1}
1128 ------------
1130 The ripple effect of a "hard case" recovery is especially bad:
1131 'everyone' downstream from 'topic' will now have to perform a "hard
1132 case" recovery too!
1134 REBASING MERGES
1135 ---------------
1137 The interactive rebase command was originally designed to handle
1138 individual patch series. As such, it makes sense to exclude merge
1139 commits from the todo list, as the developer may have merged the
1140 then-current `master` while working on the branch, only to rebase
1141 all the commits onto `master` eventually (skipping the merge
1142 commits).
1144 However, there are legitimate reasons why a developer may want to
1145 recreate merge commits: to keep the branch structure (or "commit
1146 topology") when working on multiple, inter-related branches.
1148 In the following example, the developer works on a topic branch that
1149 refactors the way buttons are defined, and on another topic branch
1150 that uses that refactoring to implement a "Report a bug" button. The
1151 output of `git log --graph --format=%s -5` may look like this:
1153 ------------
1154 *   Merge branch 'report-a-bug'
1156 | * Add the feedback button
1157 * | Merge branch 'refactor-button'
1158 |\ \
1159 | |/
1160 | * Use the Button class for all buttons
1161 | * Extract a generic Button class from the DownloadButton one
1162 ------------
1164 The developer might want to rebase those commits to a newer `master`
1165 while keeping the branch topology, for example when the first topic
1166 branch is expected to be integrated into `master` much earlier than the
1167 second one, say, to resolve merge conflicts with changes to the
1168 DownloadButton class that made it into `master`.
1170 This rebase can be performed using the `--rebase-merges` option.
1171 It will generate a todo list looking like this:
1173 ------------
1174 label onto
1176 # Branch: refactor-button
1177 reset onto
1178 pick 123456 Extract a generic Button class from the DownloadButton one
1179 pick 654321 Use the Button class for all buttons
1180 label refactor-button
1182 # Branch: report-a-bug
1183 reset refactor-button # Use the Button class for all buttons
1184 pick abcdef Add the feedback button
1185 label report-a-bug
1187 reset onto
1188 merge -C a1b2c3 refactor-button # Merge 'refactor-button'
1189 merge -C 6f5e4d report-a-bug # Merge 'report-a-bug'
1190 ------------
1192 In contrast to a regular interactive rebase, there are `label`, `reset`
1193 and `merge` commands in addition to `pick` ones.
1195 The `label` command associates a label with the current HEAD when that
1196 command is executed. These labels are created as worktree-local refs
1197 (`refs/rewritten/<label>`) that will be deleted when the rebase
1198 finishes. That way, rebase operations in multiple worktrees linked to
1199 the same repository do not interfere with one another. If the `label`
1200 command fails, it is rescheduled immediately, with a helpful message how
1201 to proceed.
1203 The `reset` command resets the HEAD, index and worktree to the specified
1204 revision. It is similar to an `exec git reset --hard <label>`, but
1205 refuses to overwrite untracked files. If the `reset` command fails, it is
1206 rescheduled immediately, with a helpful message how to edit the todo list
1207 (this typically happens when a `reset` command was inserted into the todo
1208 list manually and contains a typo).
1210 The `merge` command will merge the specified revision(s) into whatever
1211 is HEAD at that time. With `-C <original-commit>`, the commit message of
1212 the specified merge commit will be used. When the `-C` is changed to
1213 a lower-case `-c`, the message will be opened in an editor after a
1214 successful merge so that the user can edit the message.
1216 If a `merge` command fails for any reason other than merge conflicts (i.e.
1217 when the merge operation did not even start), it is rescheduled immediately.
1219 By default, the `merge` command will use the `recursive` merge
1220 strategy for regular merges, and `octopus` for octopus merges.  One
1221 can specify a default strategy for all merges using the `--strategy`
1222 argument when invoking rebase, or can override specific merges in the
1223 interactive list of commands by using an `exec` command to call `git
1224 merge` explicitly with a `--strategy` argument.  Note that when
1225 calling `git merge` explicitly like this, you can make use of the fact
1226 that the labels are worktree-local refs (the ref `refs/rewritten/onto`
1227 would correspond to the label `onto`, for example) in order to refer
1228 to the branches you want to merge.
1230 Note: the first command (`label onto`) labels the revision onto which
1231 the commits are rebased; The name `onto` is just a convention, as a nod
1232 to the `--onto` option.
1234 It is also possible to introduce completely new merge commits from scratch
1235 by adding a command of the form `merge <merge-head>`. This form will
1236 generate a tentative commit message and always open an editor to let the
1237 user edit it. This can be useful e.g. when a topic branch turns out to
1238 address more than a single concern and wants to be split into two or
1239 even more topic branches. Consider this todo list:
1241 ------------
1242 pick 192837 Switch from GNU Makefiles to CMake
1243 pick 5a6c7e Document the switch to CMake
1244 pick 918273 Fix detection of OpenSSL in CMake
1245 pick afbecd http: add support for TLS v1.3
1246 pick fdbaec Fix detection of cURL in CMake on Windows
1247 ------------
1249 The one commit in this list that is not related to CMake may very well
1250 have been motivated by working on fixing all those bugs introduced by
1251 switching to CMake, but it addresses a different concern. To split this
1252 branch into two topic branches, the todo list could be edited like this:
1254 ------------
1255 label onto
1257 pick afbecd http: add support for TLS v1.3
1258 label tlsv1.3
1260 reset onto
1261 pick 192837 Switch from GNU Makefiles to CMake
1262 pick 918273 Fix detection of OpenSSL in CMake
1263 pick fdbaec Fix detection of cURL in CMake on Windows
1264 pick 5a6c7e Document the switch to CMake
1265 label cmake
1267 reset onto
1268 merge tlsv1.3
1269 merge cmake
1270 ------------
1272 CONFIGURATION
1273 -------------
1275 include::config/rebase.txt[]
1276 include::config/sequencer.txt[]
1278 BUGS
1279 ----
1280 The todo list presented by the deprecated `--preserve-merges --interactive`
1281 does not represent the topology of the revision graph (use `--rebase-merges`
1282 instead).  Editing commits and rewording their commit messages should work
1283 fine, but attempts to reorder commits tend to produce counterintuitive results.
1284 Use `--rebase-merges` in such scenarios instead.
1286 For example, an attempt to rearrange
1287 ------------
1288 1 --- 2 --- 3 --- 4 --- 5
1289 ------------
1291 ------------
1292 1 --- 2 --- 4 --- 3 --- 5
1293 ------------
1294 by moving the "pick 4" line will result in the following history:
1295 ------------
1296         3
1297        /
1298 1 --- 2 --- 4 --- 5
1299 ------------
1303 Part of the linkgit:git[1] suite