Rebase Extension
This extension is distributed along with Mercurial releases
Author: Stefano Tortarolo
Contents
1. Introduction
Rebase allows moving commits around in Mercurial's history (using a series of internal merges). This has many uses:
- moving changesets between branches
- "linearizing" history
- reordering changesets
- collapsing multiple changes into one changeset
2. Configuration
Enable the extension in the configuration file (e.g. .hg/hgrc):
[extensions] rebase =
3. Basic usage
Let's imagine our repository looks like this:
Here we have local commits X through Z diverging from the upstream line of history A through E. We can easily "linearize" the history by running:
$ hg rebase -s X -d E
This command will take commit from the source X and all its descendants and "move" them to descend instead from the destination E:
Note: moving changesets changes their changeset hashes and revision numbers. Thus we've given our changesets updated names.
Now let's imagine we decided commit X2 was a mistake. We could fix this by moving Y2 to descend from E and then strip X2:
$ hg rebase -s Y2 -d E
$ hg strip X2
Lastly, let's imagine Y3 and Z3 really ought to be one commit. We can "collapse" them thusly:
$ hg rebase -r Y3::Z3 -d E --collapse
Just about any rearrangement of history is possible with a series of rebases. See histedit for a tool that helps automate some of the more common tasks.
4. Dealing with conflicting merges
A situation could arise where some changes we're rebasing conflict with some changes in the destination. In these cases, the extension will stop, store the current status, and provide the user with the ability to solve the conflict on his own.
In event of an interruption, users have two choices:
- abort
- continue
4.1. Abort
An interrupted process can be aborted, thus restoring the repository to its original state, with:
$ hg rebase --abort
4.2. Continue
The most common situation, however, is resuming an interrupted process and this can be done with:
$ hg rebase --continue
5. When rebase is not allowed
There are situations in which a rebasing process is not allowed:
- the rebasing point (source) is an ancestor of target
- the rebasing point (source) is a merge revision and both of its parents are external
6. Notes about MQ Patches
In the current implementation MQ patches are qfinished and qimported after being rebased. This adds an export-like header to each rebased patch. e.g.,
- Original patch:
Description P0 diff --git a/f b/f etc...
- Rebased patch:
# HG changeset patch # User Stefano Tortarolo <stefano.tortarolo@gmail.com> # Date 1217929313 -7200 # Node ID 92bd85e9196feac01fdf2eb2ce7275e9a575a730 # Parent 6e55161e68b2062d629c05b89b0ea3424eec9a2f Description P0 diff --git a/f b/f etc...
7. Scenarios
Now will be analyzed the most interesting scenarios.
7.1. Scenario A
The first one is the simplest one, a simple branch.
In this scenario there are two interesting interactions:
7.1.1. rebase on top
$ hg up C $ hg rebase --dest E
Another syntax that would yield the same result is:
$ hg rebase --dest E --base C
7.1.2. rebase on an intermediate revision
$ hg up C $ hg rebase -d D
7.2. Scenario B
The second scenario involves something more complicated. In this scenario the user cloned from upstream, then merged several times.
7.2.1. rebase D on I
$ hg rebase --dest I --source D
Despite being a merge revision D hasn't been skipped in this case, as opposite to H.
7.2.2. rebase B on I
$ hg rebase --dest I --source B
- In this case two revisions (D and H) have been skipped.
7.2.3. rebase C on B
$ hg rebase --dest B --source C
7.2.4. rebase G onto I
$ hg rebase --dest I --source G
Note: Prior Mercurial 2.3 you need to had --detach option in this situation. otherwise you get this result
7.3. Scenario C
This case represents a quite common situation, a repository with just one (merge) head.
7.3.1. D onto C
$ hg rebase --dest C --source D
- Obviously the revision F has been skipped.
7.4. Collapsing
Sometimes it could be useful to be able to rebase changesets onto another branch, obtaining though just one revision.
This can be achieved using the option --collapse.
$ hg rebase --dest B --source C --collapse
or
The base option could have been used here too
$ hg rebase --dest B --base E --collapse
7.4.1. C onto B and collapsing
8. Details
8.1. Parent relationships
Rebase tries to turn <dest> into a parent of <root> while preserving the number of parents of rebased changesets:
- A changeset with a single parent will always be rebased as a
- changeset with a single parent.
- A merge will be rebased as merge unless its parents are both
ancestors of <dest> or are themselves in the rebased set and pruned while rebased.
If one parent of <root> is an ancestor of <dest>, the rebased version of this parent will be <dest>. This is always true with --base option.
Otherwise, we need to replace the original parents with <dest>. This detaches the rebased set from its former location and rebases it onto <dest>. Changes introduced by ancestors of <root> not common with <dest> are removed from the rebased changesets.
If <root> has a single parent, set it to <dest>.
If <root> is a merge, we cannot decide which parent to
- replace, the rebase operation is not clearly defined. This kind of rebase is not allowed.
The table below sums up this behavior:
|
one parent |
merge |
parent in ::<dest> |
new parent is <dest> |
parents in ::<dest> are remapped to <dest> |
unrelated source |
new parent is <dest> |
ambiguous, abort |
9. Command documentation
As of Mercurial 4.1, here is the official documentation of the rebase command.
move changeset (and descendants) to a different branch
Rebase uses repeated merging to graft changesets from one part of history
(the source) onto another (the destination). This can be useful for
linearizing *local* changes relative to a master development tree.
Published commits cannot be rebased (see 'hg help phases'). To copy
commits, see 'hg help graft'.
If you don't specify a destination changeset ("-d/--dest"), rebase will
use the same logic as 'hg merge' to pick a destination. if the current
branch contains exactly one other head, the other head is merged with by
default. Otherwise, an explicit revision with which to merge with must be
provided. (destination changeset is not modified by rebasing, but new
changesets are added as its descendants.)
Here are the ways to select changesets:
1. Explicitly select them using "--rev".
2. Use "--source" to select a root changeset and include all of its
descendants.
3. Use "--base" to select a changeset; rebase will find ancestors and
their descendants which are not also ancestors of the destination.
4. If you do not specify any of "--rev", "source", or "--base", rebase
will use "--base ." as above.
Rebase will destroy original changesets unless you use "--keep". It will
also move your bookmarks (even if you do).
Some changesets may be dropped if they do not contribute changes (e.g.
merges from the destination branch).
Unlike "merge", rebase will do nothing if you are at the branch tip of a
named branch with two heads. You will need to explicitly specify source
and/or destination.
If you need to use a tool to automate merge/conflict decisions, you can
specify one with "--tool", see 'hg help merge-tools'. As a caveat: the
tool will not be used to mediate when a file was deleted, there is no hook
presently available for this.
If a rebase is interrupted to manually resolve a conflict, it can be
continued with --continue/-c or aborted with --abort/-a.
Returns 0 on success, 1 if nothing to rebase or there are unresolved
conflicts.
10. Related links
RebaseIfExtension - A separate (unbundled) extension that only rebases if there are no conflicted files, otherwise does a merge