Skip to content
Snippets Groups Projects
rebase.py 19.2 KiB
Newer Older
Stefano Tortarolo's avatar
Stefano Tortarolo committed
# rebase.py - rebasing feature for mercurial
#
# Copyright 2008 Stefano Tortarolo <stefano.tortarolo at gmail dot com>
#
# This software may be used and distributed according to the terms of the
Matt Mackall's avatar
Matt Mackall committed
# GNU General Public License version 2 or any later version.
'''command to move sets of revisions to a different ancestor
This extension lets you rebase changesets in an existing Mercurial
repository.
Stefano Tortarolo's avatar
Stefano Tortarolo committed

For more information:
http://mercurial.selenic.com/wiki/RebaseExtension
Matt Mackall's avatar
Matt Mackall committed
from mercurial import util, repair, merge, cmdutil, commands, error
from mercurial import extensions, ancestor, copies, patch
Stefano Tortarolo's avatar
Stefano Tortarolo committed
from mercurial.commands import templateopts
from mercurial.node import nullrev
from mercurial.lock import release
Stefano Tortarolo's avatar
Stefano Tortarolo committed
from mercurial.i18n import _
import os, errno

Stefano Tortarolo's avatar
Stefano Tortarolo committed
def rebase(ui, repo, **opts):
    """move changeset (and descendants) to a different branch

    Rebase uses repeated merging to graft changesets from one part of
    history onto another. This can be useful for linearizing local
    changes relative to a master development tree.
    If a rebase is interrupted to manually resolve a merge, it can be
    continued with --continue/-c or aborted with --abort/-a.
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    """
Benoit Boissinot's avatar
Benoit Boissinot committed
    originalwd = target = None
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    external = nullrev
    state = {}
    skipped = set()
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    targetancestors = set()
Stefano Tortarolo's avatar
Stefano Tortarolo committed

    lock = wlock = None
    try:
        lock = repo.lock()
        wlock = repo.wlock()

        # Validate input and define rebasing points
        destf = opts.get('dest', None)
        srcf = opts.get('source', None)
        basef = opts.get('base', None)
        contf = opts.get('continue')
        abortf = opts.get('abort')
        collapsef = opts.get('collapse', False)
        extrafn = opts.get('extrafn')
        keepf = opts.get('keep', False)
        keepbranchesf = opts.get('keepbranches', False)
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        if contf or abortf:
            if contf and abortf:
Matt Mackall's avatar
Matt Mackall committed
                raise error.ParseError('rebase',
                                       _('cannot use both abort and continue'))
Stefano Tortarolo's avatar
Stefano Tortarolo committed
            if collapsef:
Matt Mackall's avatar
Matt Mackall committed
                raise error.ParseError(
                    'rebase', _('cannot use collapse with continue or abort'))
            if detachf:
                raise error.ParseError(
                    'rebase', _('cannot use detach with continue or abort'))

            if srcf or basef or destf:
Matt Mackall's avatar
Matt Mackall committed
                raise error.ParseError('rebase',
Stefano Tortarolo's avatar
Stefano Tortarolo committed
                    _('abort and continue do not allow specifying revisions'))

            (originalwd, target, state, collapsef, keepf,
                                keepbranchesf, external) = restorestatus(repo)
Stefano Tortarolo's avatar
Stefano Tortarolo committed
            if abortf:
                abort(repo, originalwd, target, state)
                return
        else:
            if srcf and basef:
Matt Mackall's avatar
Matt Mackall committed
                raise error.ParseError('rebase', _('cannot specify both a '
                                                   'revision and a base'))
            if detachf:
                if not srcf:
                    raise error.ParseError(
                      'rebase', _('detach requires a revision to be specified'))
                if basef:
                    raise error.ParseError(
                        'rebase', _('cannot specify a base with detach'))

Stefano Tortarolo's avatar
Stefano Tortarolo committed
            cmdutil.bail_if_changed(repo)
            result = buildstate(repo, destf, srcf, basef, detachf)
Stefano Tortarolo's avatar
Stefano Tortarolo committed
            if not result:
                # Empty state built, nothing to rebase
                ui.status(_('nothing to rebase\n'))
Stefano Tortarolo's avatar
Stefano Tortarolo committed
                return
Stefano Tortarolo's avatar
Stefano Tortarolo committed
            else:
                originalwd, target, state = result
                if collapsef:
                    targetancestors = set(repo.changelog.ancestors(target))
                    external = checkexternal(repo, state, targetancestors)
        if keepbranchesf:
            if extrafn:
                raise error.ParseError(
                    'rebase', _('cannot use both keepbranches and extrafn'))
            def extrafn(ctx, extra):
                extra['branch'] = ctx.branch()

Stefano Tortarolo's avatar
Stefano Tortarolo committed
        # Rebase
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        if not targetancestors:
            targetancestors = set(repo.changelog.ancestors(target))
            targetancestors.add(target)
        for rev in sorted(state):
Stefano Tortarolo's avatar
Stefano Tortarolo committed
            if state[rev] == -1:
Stefano Tortarolo's avatar
Stefano Tortarolo committed
                ui.debug("rebasing %d:%s\n" % (rev, repo[rev]))
                storestatus(repo, originalwd, target, state, collapsef, keepf,
                                                    keepbranchesf, external)
Stefano Tortarolo's avatar
Stefano Tortarolo committed
                p1, p2 = defineparents(repo, rev, target, state,
                                                        targetancestors)
                if len(repo.parents()) == 2:
                    repo.ui.debug('resuming interrupted rebase\n')
                else:
                    stats = rebasenode(repo, rev, p1, p2, state)
                    if stats and stats[3] > 0:
                        raise util.Abort(_('fix unresolved conflicts with hg '
                                    'resolve then run hg rebase --continue'))
                updatedirstate(repo, rev, target, p2)
                if not collapsef:
                    extra = {'rebase_source': repo[rev].hex()}
                    if extrafn:
                        extrafn(repo[rev], extra)
                    newrev = concludenode(repo, rev, p1, p2, extra=extra)
                else:
                    # Skip commit if we are collapsing
                    repo.dirstate.setparents(repo[p1].node())
                    newrev = None
                # Update the state
                if newrev is not None:
                    state[rev] = repo[newrev].rev()
                else:
                    if not collapsef:
                        ui.note(_('no changes, revision %d skipped\n') % rev)
                        ui.debug('next revision set to %s\n' % p1)
                        skipped.add(rev)
                    state[rev] = p1

Stefano Tortarolo's avatar
Stefano Tortarolo committed
        ui.note(_('rebase merging completed\n'))

        if collapsef:
            p1, p2 = defineparents(repo, min(state), target,
Stefano Tortarolo's avatar
Stefano Tortarolo committed
                                                        state, targetancestors)
Stefano Tortarolo's avatar
Stefano Tortarolo committed
            commitmsg = 'Collapsed revision'
            for rebased in state:
                if rebased not in skipped and state[rebased] != nullmerge:
Stefano Tortarolo's avatar
Stefano Tortarolo committed
                    commitmsg += '\n* %s' % repo[rebased].description()
            commitmsg = ui.edit(commitmsg, repo.ui.username())
            newrev = concludenode(repo, rev, p1, external, commitmsg=commitmsg,
Stefano Tortarolo's avatar
Stefano Tortarolo committed
                                                    extra=extrafn)
Stefano Tortarolo's avatar
Stefano Tortarolo committed

        if 'qtip' in repo.tags():
            updatemq(repo, state, skipped, **opts)

Stefano Tortarolo's avatar
Stefano Tortarolo committed
            # Remove no more useful revisions
            rebased = [rev for rev in state if state[rev] != nullmerge]
            if rebased:
                if set(repo.changelog.descendants(min(rebased))) - set(state):
                    ui.warn(_("warning: new changesets detected "
                              "on source branch, not stripping\n"))
                else:
                    repair.strip(ui, repo, repo[min(rebased)].node(), "strip")
Stefano Tortarolo's avatar
Stefano Tortarolo committed

        clearstatus(repo)
        ui.status(_("rebase completed\n"))
        if os.path.exists(repo.sjoin('undo')):
            util.unlink(repo.sjoin('undo'))
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        if skipped:
            ui.note(_("%d revisions have been skipped\n") % len(skipped))
    finally:
Stefano Tortarolo's avatar
Stefano Tortarolo committed
def rebasemerge(repo, rev, first=False):
    'return the correct ancestor'
    oldancestor = ancestor.ancestor

    def newancestor(a, b, pfunc):
        if b == rev:
            return repo[rev].parents()[0].rev()
        return oldancestor(a, b, pfunc)
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    if not first:
        ancestor.ancestor = newancestor
    else:
        repo.ui.debug("first revision, do not change ancestor\n")
    try:
        stats = merge.update(repo, rev, True, True, False)
        return stats
    finally:
        ancestor.ancestor = oldancestor
Stefano Tortarolo's avatar
Stefano Tortarolo committed
def checkexternal(repo, state, targetancestors):
    """Check whether one or more external revisions need to be taken in
    consideration. In the latter case, abort.
    """
    external = nullrev
    source = min(state)
    for rev in state:
        if rev == source:
            continue
        # Check externals and fail if there are more than one
        for p in repo[rev].parents():
            if (p.rev() not in state
                        and p.rev() not in targetancestors):
                if external != nullrev:
                    raise util.Abort(_('unable to collapse, there is more '
                            'than one external parent'))
                external = p.rev()
    return external

def updatedirstate(repo, rev, p1, p2):
    """Keep track of renamed files in the revision that is going to be rebased
    """
    # Here we simulate the copies and renames in the source changeset
    cop, diver = copies.copies(repo, repo[rev], repo[p1], repo[p2], True)
    m1 = repo[rev].manifest()
    m2 = repo[p1].manifest()
    for k, v in cop.iteritems():
        if k in m1:
            if v in m1 or v in m2:
                repo.dirstate.copy(v, k)
                if v in m2 and v not in m1:
                    repo.dirstate.remove(v)

def concludenode(repo, rev, p1, p2, commitmsg=None, extra=None):
    'Commit the changes and store useful information in extra'
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    try:
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        repo.dirstate.setparents(repo[p1].node(), repo[p2].node())
        if commitmsg is None:
Stefano Tortarolo's avatar
Stefano Tortarolo committed
            commitmsg = repo[rev].description()
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        if extra is None:
            extra = {}
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        # Commit might fail if unresolved files exist
        newrev = repo.commit(text=commitmsg, user=repo[rev].user(),
                             date=repo[rev].date(), extra=extra)
        repo.dirstate.setbranch(repo[newrev].branch())
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        return newrev
    except util.Abort:
        # Invalidate the previous setparents
        repo.dirstate.invalidate()
        raise

Stefano Tortarolo's avatar
Stefano Tortarolo committed
def rebasenode(repo, rev, p1, p2, state):
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    'Rebase a single revision'
    # Merge phase
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    # Update to target and merge it with local
    if repo['.'].rev() != repo[p1].rev():
        repo.ui.debug(" update to %d:%s\n" % (repo[p1].rev(), repo[p1]))
        merge.update(repo, p1, False, True, False)
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    else:
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        repo.ui.debug(" already in target\n")
    repo.dirstate.write()
    repo.ui.debug(" merge against %d:%s\n" % (repo[rev].rev(), repo[rev]))
    first = repo[rev].rev() == repo[min(state)].rev()
    stats = rebasemerge(repo, rev, first)
    return stats
Stefano Tortarolo's avatar
Stefano Tortarolo committed
def defineparents(repo, rev, target, state, targetancestors):
    'Return the new parent relationship of the revision that will be rebased'
    parents = repo[rev].parents()
    p1 = p2 = nullrev

    P1n = parents[0].rev()
    if P1n in targetancestors:
        p1 = target
    elif P1n in state:
        if state[P1n] == nullmerge:
            p1 = target
        else:
            p1 = state[P1n]
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    else: # P1n external
        p1 = target
        p2 = P1n

    if len(parents) == 2 and parents[1].rev() not in targetancestors:
        P2n = parents[1].rev()
        # interesting second parent
        if P2n in state:
            if p1 == target: # P1n in targetancestors or external
                p1 = state[P2n]
            else:
                p2 = state[P2n]
        else: # P2n external
            if p2 != nullrev: # P1n external too => rev is a merged revision
                raise util.Abort(_('cannot use revision %d as base, result '
                        'would have 3 parents') % rev)
            p2 = P2n
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    repo.ui.debug(" future parents are %d and %d\n" %
                            (repo[p1].rev(), repo[p2].rev()))
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    return p1, p2

def isagitpatch(repo, patchname):
    'Return true if the given patch is in git format'
    mqpatch = os.path.join(repo.mq.path, patchname)
    for line in patch.linereader(file(mqpatch, 'rb')):
        if line.startswith('diff --git'):
            return True
    return False

Stefano Tortarolo's avatar
Stefano Tortarolo committed
def updatemq(repo, state, skipped, **opts):
    'Update rebased mq patches - finalize and then import them'
    mqrebase = {}
    for p in repo.mq.applied:
        if repo[p.rev].rev() in state:
            repo.ui.debug('revision %d is an mq patch (%s), finalize it.\n' %
Stefano Tortarolo's avatar
Stefano Tortarolo committed
                                        (repo[p.rev].rev(), p.name))
            mqrebase[repo[p.rev].rev()] = (p.name, isagitpatch(repo, p.name))
Stefano Tortarolo's avatar
Stefano Tortarolo committed

    if mqrebase:
        repo.mq.finish(repo, mqrebase.keys())

        # We must start import from the newest revision
        for rev in sorted(mqrebase, reverse=True):
Stefano Tortarolo's avatar
Stefano Tortarolo committed
            if rev not in skipped:
                repo.ui.debug('import mq patch %d (%s)\n'
                              % (state[rev], mqrebase[rev][0]))
                repo.mq.qimport(repo, (), patchname=mqrebase[rev][0],
                            git=mqrebase[rev][1],rev=[str(state[rev])])
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        repo.mq.save_dirty()

def storestatus(repo, originalwd, target, state, collapse, keep, keepbranches,
                                                                external):
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    'Store the current status to allow recovery'
    f = repo.opener("rebasestate", "w")
    f.write(repo[originalwd].hex() + '\n')
    f.write(repo[target].hex() + '\n')
    f.write(repo[external].hex() + '\n')
    f.write('%d\n' % int(collapse))
    f.write('%d\n' % int(keep))
    f.write('%d\n' % int(keepbranches))
    for d, v in state.iteritems():
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        oldrev = repo[d].hex()
        newrev = repo[v].hex()
        f.write("%s:%s\n" % (oldrev, newrev))
    f.close()
    repo.ui.debug('rebase status stored\n')
Stefano Tortarolo's avatar
Stefano Tortarolo committed

def clearstatus(repo):
    'Remove the status files'
    if os.path.exists(repo.join("rebasestate")):
        util.unlink(repo.join("rebasestate"))

def restorestatus(repo):
    'Restore a previously stored status'
    try:
        target = None
        collapse = False
        external = nullrev
        state = {}
        f = repo.opener("rebasestate")
        for i, l in enumerate(f.read().splitlines()):
            if i == 0:
                originalwd = repo[l].rev()
            elif i == 1:
                target = repo[l].rev()
            elif i == 2:
                external = repo[l].rev()
            elif i == 3:
                collapse = bool(int(l))
            elif i == 4:
                keep = bool(int(l))
            elif i == 5:
                keepbranches = bool(int(l))
Stefano Tortarolo's avatar
Stefano Tortarolo committed
            else:
                oldrev, newrev = l.split(':')
                state[repo[oldrev].rev()] = repo[newrev].rev()
        repo.ui.debug('rebase status resumed\n')
        return originalwd, target, state, collapse, keep, keepbranches, external
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    except IOError, err:
        if err.errno != errno.ENOENT:
            raise
        raise util.Abort(_('no rebase in progress'))

def abort(repo, originalwd, target, state):
    'Restore the repository to its original state'
    if set(repo.changelog.descendants(target)) - set(state.values()):
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        repo.ui.warn(_("warning: new changesets detected on target branch, "
                                                    "not stripping\n"))
    else:
        # Strip from the first rebased revision
        merge.update(repo, repo[originalwd].rev(), False, True, False)
        rebased = filter(lambda x: x > -1, state.values())
        if rebased:
            strippoint = min(rebased)
            repair.strip(repo.ui, repo, repo[strippoint].node(), "strip")
        clearstatus(repo)
        repo.ui.status(_('rebase aborted\n'))

def buildstate(repo, dest, src, base, detach):
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    'Define which revisions are going to be rebased and where'
    targetancestors = set()
Stefano Tortarolo's avatar
Stefano Tortarolo committed

    if not dest:
        # Destination defaults to the latest revision in the current branch
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        branch = repo[None].branch()
        dest = repo[branch].rev()
    else:
        if 'qtip' in repo.tags() and (repo[dest].hex() in
                                [s.rev for s in repo.mq.applied]):
            raise util.Abort(_('cannot rebase onto an applied mq patch'))
        dest = repo[dest].rev()

    if src:
        commonbase = repo[src].ancestor(repo[dest])
        if commonbase == repo[src]:
            raise util.Abort(_('source is ancestor of destination'))
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        if commonbase == repo[dest]:
            raise util.Abort(_('source is descendant of destination'))
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        source = repo[src].rev()
        if detach:
            # We need to keep track of source's ancestors up to the common base
            srcancestors = set(repo.changelog.ancestors(source))
            baseancestors = set(repo.changelog.ancestors(commonbase.rev()))
            detachset = srcancestors - baseancestors
            detachset.remove(commonbase.rev())
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    else:
        if base:
            cwd = repo[base].rev()
        else:
            cwd = repo['.'].rev()

        if cwd == dest:
            repo.ui.debug('source and destination are the same\n')
Stefano Tortarolo's avatar
Stefano Tortarolo committed
            return None

        targetancestors = set(repo.changelog.ancestors(dest))
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        if cwd in targetancestors:
            repo.ui.debug('source is ancestor of destination\n')
Stefano Tortarolo's avatar
Stefano Tortarolo committed
            return None

        cwdancestors = set(repo.changelog.ancestors(cwd))
        if dest in cwdancestors:
            repo.ui.debug('source is descendant of destination\n')
            return None

Stefano Tortarolo's avatar
Stefano Tortarolo committed
        cwdancestors.add(cwd)
        rebasingbranch = cwdancestors - targetancestors
        source = min(rebasingbranch)
    repo.ui.debug('rebase onto %d starting from %d\n' % (dest, source))
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    state = dict.fromkeys(repo.changelog.descendants(source), nullrev)
    state.update(dict.fromkeys(detachset, nullmerge))
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    state[source] = nullrev
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    return repo['.'].rev(), repo[dest].rev(), state
def pullrebase(orig, ui, repo, *args, **opts):
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    'Call rebase after pull if the latter has been invoked with --rebase'
    if opts.get('rebase'):
        if opts.get('update'):
            ui.debug('--update and --rebase are not compatible, ignoring '
                     'the update flag\n')
Stefano Tortarolo's avatar
Stefano Tortarolo committed

        cmdutil.bail_if_changed(repo)
        revsprepull = len(repo)
        orig(ui, repo, *args, **opts)
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        revspostpull = len(repo)
        if revspostpull > revsprepull:
            rebase(ui, repo, **opts)
            branch = repo[None].branch()
            dest = repo[branch].rev()
            if dest != repo['.'].rev():
                # there was nothing to rebase we force an update
                merge.update(repo, dest, False, False, False)
Stefano Tortarolo's avatar
Stefano Tortarolo committed
    else:
        orig(ui, repo, *args, **opts)
Stefano Tortarolo's avatar
Stefano Tortarolo committed

def uisetup(ui):
    'Replace pull with a decorator to provide --rebase option'
    entry = extensions.wrapcommand(commands.table, 'pull', pullrebase)
    entry[1].append(('', 'rebase', None,
                     _("rebase working directory to branch head"))
)
Stefano Tortarolo's avatar
Stefano Tortarolo committed

cmdtable = {
"rebase":
        (rebase,
        [
        ('s', 'source', '', _('rebase from a given revision')),
        ('b', 'base', '', _('rebase from the base of a given revision')),
        ('d', 'dest', '', _('rebase onto a given revision')),
        ('', 'collapse', False, _('collapse the rebased changesets')),
        ('', 'keep', False, _('keep original changesets')),
        ('', 'keepbranches', False, _('keep original branch names')),
        ('', 'detach', False, _('force detaching of source from its original '
                                'branch')),
Stefano Tortarolo's avatar
Stefano Tortarolo committed
        ('c', 'continue', False, _('continue an interrupted rebase')),
        ('a', 'abort', False, _('abort an interrupted rebase'))] +
Stefano Tortarolo's avatar
Stefano Tortarolo committed
         templateopts,
        _('hg rebase [-s REV | -b REV] [-d REV] [--collapse] [--detach] '
                        '[--keep] [--keepbranches] | [-c] | [-a]')),