other versions
- wheezy 1:1.7.10.4-1+wheezy3
- wheezy-backports 1:1.9.1-1~bpo70+2
- jessie 1:2.1.4-2.1+deb8u2
- jessie-backports 1:2.11.0-3~bpo8+1
- testing 1:2.11.0-3
- unstable 1:2.11.0-4
- experimental 1:2.13.1+next.20170610-1
GIT-REBASE(1) | Git Manual | GIT-REBASE(1) |
NAME¶
git-rebase - Forward-port local commits to the updated upstream headSYNOPSIS¶
git rebase [-i | --interactive] [options] [--onto <newbase>] [<upstream>] [<branch>] git rebase [-i | --interactive] [options] --onto <newbase> --root [<branch>] git rebase --continue | --skip | --abort
DESCRIPTION¶
If <branch> is specified, git rebase will perform an automatic git checkout <branch> before doing anything else. Otherwise it remains on the current branch.A---B---C topic / D---E---F---G master
git rebase master git rebase master topic
A'--B'--C' topic / D---E---F---G master
A---B---C topic / D---E---A'---F master
B'---C' topic / D---E---A'---F master
o---o---o---o---o master \ o---o---o---o---o next \ o---o---o topic
o---o---o---o---o master | \ | o'--o'--o' topic \ o---o---o---o---o next
git rebase --onto master next topic
H---I---J topicB / E---F---G topicA / A---B---C---D master
git rebase --onto master topicA topicB
H'--I'--J' topicB / | E---F---G topicA |/ A---B---C---D master
E---F---G---H---I---J topicA
git rebase --onto topicA~5 topicA~3 topicA
E---H'---I'---J' topicA
git add <filename>
git rebase --continue
git rebase --abort
CONFIGURATION¶
rebase.statWhether to show a diffstat of what changed
upstream since the last rebase. False by default.
rebase.autosquash
If set to true enable --autosquash
option by default.
OPTIONS¶
<newbase>Starting point at which to create the new
commits. If the --onto option is not specified, the starting point is
<upstream>. May be any valid commit, and not just an existing branch
name.
As a special case, you may use "A...B" as a shortcut for the merge
base of A and B if there is exactly one merge base. You can leave out at most
one of A and B, in which case it defaults to HEAD.
<upstream>
Upstream branch to compare against. May be any
valid commit, not just an existing branch name. Defaults to the configured
upstream for the current branch.
<branch>
Working branch; defaults to HEAD.
--continue
Restart the rebasing process after having
resolved a merge conflict.
--abort
Abort the rebase operation and reset HEAD to
the original branch. If <branch> was provided when the rebase operation
was started, then HEAD will be reset to <branch>. Otherwise HEAD will be
reset to where it was when the rebase operation was started.
--skip
Restart the rebasing process by skipping the
current patch.
-m, --merge
Use merging strategies to rebase. When the
recursive (default) merge strategy is used, this allows rebase to be aware of
renames on the upstream side.
Note that a rebase merge works by replaying each commit from the working branch
on top of the <upstream> branch. Because of this, when a merge conflict
happens, the side reported as ours is the so-far rebased series,
starting with <upstream>, and theirs is the working branch. In
other words, the sides are swapped.
-s <strategy>, --strategy=<strategy>
Use the given merge strategy. If there is no
-s option git merge-recursive is used instead. This implies --merge.
Because git rebase replays each commit from the working branch on top of
the <upstream> branch using the given strategy, using the ours
strategy simply discards all patches from the <branch>, which makes
little sense.
-X <strategy-option>, --strategy-option=<strategy-option>
Pass the <strategy-option> through to
the merge strategy. This implies --merge and, if no strategy has been
specified, -s recursive. Note the reversal of ours and theirs as
noted in above for the -m option.
-q, --quiet
Be quiet. Implies --no-stat.
-v, --verbose
Be verbose. Implies --stat.
--stat
Show a diffstat of what changed upstream since
the last rebase. The diffstat is also controlled by the configuration option
rebase.stat.
-n, --no-stat
Do not show a diffstat as part of the rebase
process.
--no-verify
This option bypasses the pre-rebase hook. See
also githooks(5).
--verify
Allows the pre-rebase hook to run, which is
the default. This option can be used to override --no-verify. See also
githooks(5).
-C<n>
Ensure at least <n> lines of surrounding
context match before and after each change. When fewer lines of surrounding
context exist they all must match. By default no context is ever
ignored.
-f, --force-rebase
Force the rebase even if the current branch is
a descendant of the commit you are rebasing onto. Normally non-interactive
rebase will exit with the message "Current branch is up to date" in
such a situation. Incompatible with the --interactive option.
You may find this (or --no-ff with an interactive rebase) helpful after
reverting a topic branch merge, as this option recreates the topic branch with
fresh commits so it can be remerged successfully without needing to
"revert the reversion" (see the revert-a-faulty-merge
How-To[1] for details).
--ignore-whitespace, --whitespace=<option>
These flag are passed to the git apply
program (see git-apply(1)) that applies the patch. Incompatible with
the --interactive option.
--committer-date-is-author-date, --ignore-date
These flags are passed to git am to
easily change the dates of the rebased commits (see git-am(1)).
Incompatible with the --interactive option.
-i, --interactive
Make a list of the commits which are about to
be rebased. Let the user edit that list before rebasing. This mode can also be
used to split commits (see SPLITTING COMMITS below).
-p, --preserve-merges
Instead of ignoring merges, try to recreate
them.
This uses the --interactive machinery internally, but combining it with the
--interactive option explicitly is generally not a good idea unless you know
what you are doing (see BUGS below).
--root
Rebase all commits reachable from
<branch>, instead of limiting them with an <upstream>. This allows
you to rebase the root commit(s) on a branch. Must be used with --onto, and
will skip changes already contained in <newbase> (instead of
<upstream>). When used together with --preserve-merges, all root
commits will be rewritten to have <newbase> as parent instead.
--autosquash, --no-autosquash
When the commit log message begins with
"squash! ..." (or "fixup! ..."), and there is a commit
whose title begins with the same ..., automatically modify the todo list of
rebase -i so that the commit marked for squashing comes right after the commit
to be modified, and change the action of the moved commit from pick to squash
(or fixup).
This option is only valid when the --interactive option is used.
If the --autosquash option is enabled by default using the configuration
variable rebase.autosquash, this option can be used to override and disable
this setting.
--no-ff
With --interactive, cherry-pick all rebased
commits instead of fast-forwarding over the unchanged ones. This ensures that
the entire history of the rebased branch is composed of new commits.
Without --interactive, this is a synonym for --force-rebase.
You may find this helpful after reverting a topic branch merge, as this option
recreates the topic branch with fresh commits so it can be remerged
successfully without needing to "revert the reversion" (see the
revert-a-faulty-merge How-To[1] for details).
MERGE STRATEGIES¶
The merge mechanism ( git-merge and git-pull commands) allows the backend merge strategies to be chosen with -s option. Some strategies can also take their own options, which can be passed by giving -X<option> arguments to git-merge and/or git-pull. resolveThis can only resolve two heads (i.e. the
current branch and another branch you pulled from) using a 3-way merge
algorithm. It tries to carefully detect criss-cross merge ambiguities and is
considered generally safe and fast.
recursive
This can only resolve two heads using a 3-way
merge algorithm. When there is more than one common ancestor that can be used
for 3-way merge, it creates a merged tree of the common ancestors and uses
that as the reference tree for the 3-way merge. This has been reported to
result in fewer merge conflicts without causing mis-merges by tests done on
actual merge commits taken from Linux 2.6 kernel development history.
Additionally this can detect and handle merges involving renames. This is the
default merge strategy when pulling or merging one branch.
The recursive strategy can take the following options:
ours
octopus
This option forces conflicting hunks to be
auto-resolved cleanly by favoring our version. Changes from the other
tree that do not conflict with our side are reflected to the merge result.
This should not be confused with the ours merge strategy, which does not
even look at what the other tree contains at all. It discards everything the
other tree did, declaring our history contains all that happened in
it.
theirs
This is opposite of ours.
patience
With this option, merge-recursive
spends a little extra time to avoid mismerges that sometimes occur due to
unimportant matching lines (e.g., braces from distinct functions). Use this
when the branches to be merged have diverged wildly. See also
git-diff(1) --patience.
ignore-space-change, ignore-all-space, ignore-space-at-eol
Treats lines with the indicated type of
whitespace change as unchanged for the sake of a three-way merge. Whitespace
changes mixed with other changes to a line are not ignored. See also
git-diff(1) -b, -w, and --ignore-space-at-eol.
renormalize
•If their version only introduces
whitespace changes to a line, our version is used;
•If our version introduces
whitespace changes but their version includes a substantial change,
their version is used;
•Otherwise, the merge proceeds in the
usual way.
This runs a virtual check-out and check-in of
all three stages of a file when resolving a three-way merge. This option is
meant to be used when merging branches with different clean filters or
end-of-line normalization rules. See "Merging branches with differing
checkin/checkout attributes" in gitattributes(5) for
details.
no-renormalize
Disables the renormalize option. This
overrides the merge.renormalize configuration variable.
rename-threshold=<n>
Controls the similarity threshold used for
rename detection. See also git-diff(1) -M.
subtree[=<path>]
This option is a more advanced form of
subtree strategy, where the strategy makes a guess on how two trees
must be shifted to match with each other when merging. Instead, the specified
path is prefixed (or stripped from the beginning) to make the shape of two
trees to match.
This resolves cases with more than two heads,
but refuses to do a complex merge that needs manual resolution. It is
primarily meant to be used for bundling topic branch heads together. This is
the default merge strategy when pulling or merging more than one branch.
ours
This resolves any number of heads, but the
resulting tree of the merge is always that of the current branch head,
effectively ignoring all changes from all other branches. It is meant to be
used to supersede old development history of side branches. Note that this is
different from the -Xours option to the recursive merge strategy.
subtree
This is a modified recursive strategy. When
merging trees A and B, if B corresponds to a subtree of A, B is first adjusted
to match the tree structure of A, instead of reading the trees at the same
level. This adjustment is also done to the common ancestor tree.
NOTES¶
You should understand the implications of using git rebase on a repository that you share. See also RECOVERING FROM UPSTREAM REBASE below.INTERACTIVE MODE¶
Rebasing interactively means that you have a chance to edit the commits which are rebased. You can reorder the commits, and you can remove them (weeding out bad or otherwise unwanted patches). 1.have a wonderful idea
2.hack on the code
3.prepare a series for submission
4.submit
1.finish something worthy of a commit
2.commit
1.realize that something does not work
2.fix that
3.commit it
git rebase -i <after-this-commit>
pick deadbee The oneline of this commit pick fa1afe1 The oneline of the next commit ...
$ git rebase -i HEAD~5
X \ A---M---B / ---o---O---P---Q
$ git rebase -i -p --onto Q O
pick deadbee Implement feature XXX fixup f1a5c00 Fix to feature XXX exec make pick c0ffeee The oneline of the next commit edit deadbab The oneline of the commit after exec cd subdir; make test ...
SPLITTING COMMITS¶
In interactive mode, you can mark commits with the action "edit". However, this does not necessarily mean that git rebase expects the result of this edit to be exactly one commit. Indeed, you can undo the commit, or you can add other commits. This can be used to split a commit into two:•Start an interactive rebase with git
rebase -i <commit>^, where <commit> is the commit you want to
split. In fact, any commit range will do, as long as it contains that
commit.
•Mark the commit you want to split with
the action "edit".
•When it comes to editing that commit,
execute git reset HEAD^. The effect is that the HEAD is rewound by one, and
the index follows suit. However, the working tree stays the same.
•Now add the changes to the index that
you want to have in the first commit. You can use git add (possibly
interactively) or git gui (or both) to do that.
•Commit the now-current index with
whatever commit message is appropriate now.
•Repeat the last two steps until your
working tree is clean.
•Continue the rebase with git rebase
--continue.
RECOVERING FROM UPSTREAM REBASE¶
Rebasing (or any other form of rewriting) a branch that others have based work on is a bad idea: anyone downstream of it is forced to manually fix their history. This section explains how to do the fix from the downstream’s point of view. The real fix, however, would be to avoid rebasing the upstream in the first place.o---o---o---o---o---o---o---o---o master \ o---o---o---o---o subsystem \ *---*---* topic
o---o---o---o---o---o---o---o master \ \ o---o---o---o---o o'--o'--o'--o'--o' subsystem \ *---*---* topic
o---o---o---o---o---o---o---o master \ \ o---o---o---o---o o'--o'--o'--o'--o'--M subsystem \ / *---*---*-..........-*--* topic
This happens if the subsystem rebase
was a simple rebase and had no conflicts.
Hard case: The changes are not the same.
This happens if the subsystem rebase
had conflicts, or used --interactive to omit, edit, squash, or fixup commits;
or if the upstream used one of commit --amend, reset, or filter-branch.
The easy case¶
Only works if the changes (patch IDs based on the diff contents) on subsystem are literally the same before and after the rebase subsystem did.$ git rebase subsystem
o---o---o---o---o---o---o---o master \ o'--o'--o'--o'--o' subsystem \ *---*---* topic
The hard case¶
Things get more complicated if the subsystem changes do not exactly correspond to the ones before the rebase.•With the subsystem reflog: after
git fetch, the old tip of subsystem is at subsystem@{1}.
Subsequent fetches will increase the number. (See git-reflog(1).)
•Relative to the tip of topic:
knowing that your topic has three commits, the old tip of
subsystem must be topic~3.
$ git rebase --onto subsystem subsystem@{1}
BUGS¶
The todo list presented by --preserve-merges --interactive does not represent the topology of the revision graph. Editing commits and rewording their commit messages should work fine, but attempts to reorder commits tend to produce counterintuitive results.1 --- 2 --- 3 --- 4 --- 5
1 --- 2 --- 4 --- 3 --- 5
3 / 1 --- 2 --- 4 --- 5
GIT¶
Part of the git(1) suiteNOTES¶
- 1.
- revert-a-faulty-merge How-To
03/19/2016 | Git 1.7.10.4 |