histedit.py
1059 lines
| 38.2 KiB
| text/x-python
|
PythonLexer
/ hgext / histedit.py
|
r17064 | # histedit.py - interactive history editing for mercurial | ||
# | ||||
# Copyright 2009 Augie Fackler <raf@durin42.com> | ||||
# | ||||
# This software may be used and distributed according to the terms of the | ||||
# GNU General Public License version 2 or any later version. | ||||
|
r17131 | """interactive history editing | ||
With this extension installed, Mercurial gains one new command: histedit. Usage | ||||
is as follows, assuming the following history:: | ||||
@ 3[tip] 7c2fd3b9020c 2009-04-27 18:04 -0500 durin42 | ||||
| Add delta | ||||
| | ||||
o 2 030b686bedc4 2009-04-27 18:04 -0500 durin42 | ||||
| Add gamma | ||||
| | ||||
o 1 c561b4e977df 2009-04-27 18:04 -0500 durin42 | ||||
| Add beta | ||||
| | ||||
o 0 d8d2fcd0e319 2009-04-27 18:04 -0500 durin42 | ||||
Add alpha | ||||
If you were to run ``hg histedit c561b4e977df``, you would see the following | ||||
file open in your editor:: | ||||
pick c561b4e977df Add beta | ||||
pick 030b686bedc4 Add gamma | ||||
pick 7c2fd3b9020c Add delta | ||||
|
r18322 | # Edit history between c561b4e977df and 7c2fd3b9020c | ||
|
r17131 | # | ||
|
r20503 | # Commits are listed from least to most recent | ||
# | ||||
|
r17131 | # Commands: | ||
# p, pick = use commit | ||||
# e, edit = use commit, but stop for amending | ||||
|
r20511 | # f, fold = use commit, but combine it with the one above | ||
|
r22152 | # r, roll = like fold, but discard this commit's description | ||
|
r17131 | # d, drop = remove commit from history | ||
# m, mess = edit message without changing commit content | ||||
# | ||||
In this file, lines beginning with ``#`` are ignored. You must specify a rule | ||||
for each revision in your history. For example, if you had meant to add gamma | ||||
before beta, and then wanted to add delta in the same revision as beta, you | ||||
would reorganize the file to look like this:: | ||||
pick 030b686bedc4 Add gamma | ||||
pick c561b4e977df Add beta | ||||
fold 7c2fd3b9020c Add delta | ||||
|
r18322 | # Edit history between c561b4e977df and 7c2fd3b9020c | ||
|
r17131 | # | ||
|
r20503 | # Commits are listed from least to most recent | ||
# | ||||
|
r17131 | # Commands: | ||
# p, pick = use commit | ||||
# e, edit = use commit, but stop for amending | ||||
|
r20511 | # f, fold = use commit, but combine it with the one above | ||
|
r22152 | # r, roll = like fold, but discard this commit's description | ||
|
r17131 | # d, drop = remove commit from history | ||
# m, mess = edit message without changing commit content | ||||
# | ||||
At which point you close the editor and ``histedit`` starts working. When you | ||||
specify a ``fold`` operation, ``histedit`` will open an editor when it folds | ||||
those revisions together, offering you a chance to clean up the commit message:: | ||||
Add beta | ||||
*** | ||||
Add delta | ||||
|
r17064 | |||
|
r17131 | Edit the commit message to your liking, then close the editor. For | ||
this example, let's assume that the commit message was changed to | ||||
``Add beta and delta.`` After histedit has run and had a chance to | ||||
remove any old or temporary revisions it needed, the history looks | ||||
like this:: | ||||
@ 2[tip] 989b4d060121 2009-04-27 18:04 -0500 durin42 | ||||
| Add beta and delta. | ||||
| | ||||
o 1 081603921c3f 2009-04-27 18:04 -0500 durin42 | ||||
| Add gamma | ||||
| | ||||
o 0 d8d2fcd0e319 2009-04-27 18:04 -0500 durin42 | ||||
Add alpha | ||||
Note that ``histedit`` does *not* remove any revisions (even its own temporary | ||||
ones) until after it has completed all the editing operations, so it will | ||||
probably perform several strip operations when it's done. For the above example, | ||||
it had to run strip twice. Strip can be slow depending on a variety of factors, | ||||
so you might need to be a little patient. You can choose to keep the original | ||||
revisions by passing the ``--keep`` flag. | ||||
The ``edit`` operation will drop you back to a command prompt, | ||||
allowing you to edit files freely, or even use ``hg record`` to commit | ||||
some changes as a separate commit. When you're done, any remaining | ||||
uncommitted changes will be committed as well. When done, run ``hg | ||||
histedit --continue`` to finish this step. You'll be prompted for a | ||||
new commit message, but the default commit message will be the | ||||
original message for the ``edit`` ed revision. | ||||
The ``message`` operation will give you a chance to revise a commit | ||||
message without changing the contents. It's a shortcut for doing | ||||
``edit`` immediately followed by `hg histedit --continue``. | ||||
If ``histedit`` encounters a conflict when moving a revision (while | ||||
handling ``pick`` or ``fold``), it'll stop in a similar manner to | ||||
``edit`` with the difference that it won't prompt you for a commit | ||||
message when done. If you decide at this point that you don't like how | ||||
much work it will be to rearrange history, or that you made a mistake, | ||||
you can use ``hg histedit --abort`` to abandon the new changes you | ||||
have made and return to the state before you attempted to edit your | ||||
history. | ||||
|
r18323 | If we clone the histedit-ed example repository above and add four more | ||
changes, such that we have the following history:: | ||||
|
r17131 | |||
@ 6[tip] 038383181893 2009-04-27 18:04 -0500 stefan | ||||
| Add theta | ||||
| | ||||
o 5 140988835471 2009-04-27 18:04 -0500 stefan | ||||
| Add eta | ||||
| | ||||
o 4 122930637314 2009-04-27 18:04 -0500 stefan | ||||
| Add zeta | ||||
| | ||||
o 3 836302820282 2009-04-27 18:04 -0500 stefan | ||||
| Add epsilon | ||||
| | ||||
o 2 989b4d060121 2009-04-27 18:04 -0500 durin42 | ||||
| Add beta and delta. | ||||
| | ||||
o 1 081603921c3f 2009-04-27 18:04 -0500 durin42 | ||||
| Add gamma | ||||
| | ||||
o 0 d8d2fcd0e319 2009-04-27 18:04 -0500 durin42 | ||||
Add alpha | ||||
If you run ``hg histedit --outgoing`` on the clone then it is the same | ||||
as running ``hg histedit 836302820282``. If you need plan to push to a | ||||
repository that Mercurial does not detect to be related to the source | ||||
repo, you can add a ``--force`` option. | ||||
|
r24199 | |||
Histedit rule lines are truncated to 80 characters by default. You | ||||
can customise this behaviour by setting a different length in your | ||||
configuration file: | ||||
[histedit] | ||||
linelen = 120 # truncate rule lines at 120 characters | ||||
|
r17064 | """ | ||
|
r17131 | |||
|
r17064 | try: | ||
import cPickle as pickle | ||||
|
r19284 | pickle.dump # import now | ||
|
r17064 | except ImportError: | ||
import pickle | ||||
|
r22368 | import errno | ||
|
r17064 | import os | ||
|
r19018 | import sys | ||
|
r17064 | |||
from mercurial import cmdutil | ||||
from mercurial import discovery | ||||
from mercurial import error | ||||
|
r17644 | from mercurial import copies | ||
from mercurial import context | ||||
|
r24111 | from mercurial import extensions | ||
|
r17064 | from mercurial import hg | ||
from mercurial import node | ||||
from mercurial import repair | ||||
|
r21950 | from mercurial import scmutil | ||
|
r17064 | from mercurial import util | ||
|
r17759 | from mercurial import obsolete | ||
|
r17647 | from mercurial import merge as mergemod | ||
|
r20071 | from mercurial.lock import release | ||
|
r17064 | from mercurial.i18n import _ | ||
|
r17147 | cmdtable = {} | ||
command = cmdutil.command(cmdtable) | ||||
|
r17069 | testedwith = 'internal' | ||
|
r17064 | |||
|
r17337 | # i18n: command names and abbreviations must remain untranslated | ||
|
r17315 | editcomment = _("""# Edit history between %s and %s | ||
|
r17064 | # | ||
|
r20503 | # Commits are listed from least to most recent | ||
# | ||||
|
r17064 | # Commands: | ||
# p, pick = use commit | ||||
# e, edit = use commit, but stop for amending | ||||
|
r20511 | # f, fold = use commit, but combine it with the one above | ||
|
r22152 | # r, roll = like fold, but discard this commit's description | ||
|
r17064 | # d, drop = remove commit from history | ||
# m, mess = edit message without changing commit content | ||||
# | ||||
|
r17315 | """) | ||
|
r17064 | |||
|
r22976 | class histeditstate(object): | ||
|
r24112 | def __init__(self, repo, parentctxnode=None, rules=None, keep=None, | ||
|
r22984 | topmost=None, replacements=None, lock=None, wlock=None): | ||
|
r22976 | self.repo = repo | ||
self.rules = rules | ||||
self.keep = keep | ||||
self.topmost = topmost | ||||
|
r24112 | self.parentctxnode = parentctxnode | ||
|
r22984 | self.lock = lock | ||
self.wlock = wlock | ||||
|
r22976 | if replacements is None: | ||
self.replacements = [] | ||||
else: | ||||
self.replacements = replacements | ||||
|
r22983 | def read(self): | ||
|
r22986 | """Load histedit state from disk and set fields appropriately.""" | ||
|
r22983 | try: | ||
fp = self.repo.vfs('histedit-state', 'r') | ||||
except IOError, err: | ||||
if err.errno != errno.ENOENT: | ||||
raise | ||||
raise util.Abort(_('no histedit in progress')) | ||||
|
r22987 | parentctxnode, rules, keep, topmost, replacements = pickle.load(fp) | ||
|
r22983 | |||
|
r24112 | self.parentctxnode = parentctxnode | ||
|
r22983 | self.rules = rules | ||
self.keep = keep | ||||
self.topmost = topmost | ||||
self.replacements = replacements | ||||
|
r22976 | def write(self): | ||
fp = self.repo.vfs('histedit-state', 'w') | ||||
|
r24112 | pickle.dump((self.parentctxnode, self.rules, self.keep, | ||
|
r22987 | self.topmost, self.replacements), fp) | ||
|
r22976 | fp.close() | ||
|
r22978 | def clear(self): | ||
self.repo.vfs.unlink('histedit-state') | ||||
|
r18436 | def commitfuncfor(repo, src): | ||
"""Build a commit function for the replacement of <src> | ||||
|
r18644 | This function ensure we apply the same treatment to all changesets. | ||
|
r18436 | |||
|
r18437 | - Add a 'histedit_source' entry in extra. | ||
|
r18436 | |||
Note that fold have its own separated logic because its handling is a bit | ||||
different and not easily factored out of the fold method. | ||||
""" | ||||
|
r18440 | phasemin = src.phase() | ||
|
r18436 | def commitfunc(**kwargs): | ||
|
r18440 | phasebackup = repo.ui.backupconfig('phases', 'new-commit') | ||
try: | ||||
|
r20790 | repo.ui.setconfig('phases', 'new-commit', phasemin, | ||
'histedit') | ||||
|
r18440 | extra = kwargs.get('extra', {}).copy() | ||
extra['histedit_source'] = src.hex() | ||||
kwargs['extra'] = extra | ||||
return repo.commit(**kwargs) | ||||
finally: | ||||
repo.ui.restoreconfig(phasebackup) | ||||
|
r18436 | return commitfunc | ||
|
r17647 | def applychanges(ui, repo, ctx, opts): | ||
"""Merge changeset from ctx (only) in the current working directory""" | ||||
wcpar = repo.dirstate.parents()[0] | ||||
if ctx.p1().node() == wcpar: | ||||
# edition ar "in place" we do not need to make any merge, | ||||
# just applies changes on parent for edition | ||||
cmdutil.revert(ui, repo, ctx, (wcpar, node.nullid), all=True) | ||||
stats = None | ||||
else: | ||||
try: | ||||
# ui.forcemerge is an internal variable, do not document | ||||
|
r20790 | repo.ui.setconfig('ui', 'forcemerge', opts.get('tool', ''), | ||
'histedit') | ||||
|
r22904 | stats = mergemod.graft(repo, ctx, ctx.p1(), ['local', 'histedit']) | ||
|
r17647 | finally: | ||
|
r20790 | repo.ui.setconfig('ui', 'forcemerge', '', 'histedit') | ||
|
r17647 | return stats | ||
|
r17407 | |||
|
r17644 | def collapse(repo, first, last, commitopts): | ||
"""collapse the set of revisions from first to last as new one. | ||||
Expected commit options are: | ||||
- message | ||||
- date | ||||
- username | ||||
|
r17738 | Commit message is edited in all cases. | ||
|
r17644 | |||
This function works in memory.""" | ||||
ctxs = list(repo.set('%d::%d', first, last)) | ||||
if not ctxs: | ||||
return None | ||||
base = first.parents()[0] | ||||
# commit a new version of the old changeset, including the update | ||||
# collect all files which might be affected | ||||
files = set() | ||||
for ctx in ctxs: | ||||
files.update(ctx.files()) | ||||
# Recompute copies (avoid recording a -> b -> a) | ||||
|
r19392 | copied = copies.pathcopies(base, last) | ||
|
r17644 | |||
# prune files which were reverted by the updates | ||||
def samefile(f): | ||||
if f in last.manifest(): | ||||
a = last.filectx(f) | ||||
if f in base.manifest(): | ||||
b = base.filectx(f) | ||||
return (a.data() == b.data() | ||||
and a.flags() == b.flags()) | ||||
else: | ||||
return False | ||||
else: | ||||
return f not in base.manifest() | ||||
files = [f for f in files if not samefile(f)] | ||||
# commit version of these files as defined by head | ||||
headmf = last.manifest() | ||||
def filectxfn(repo, ctx, path): | ||||
if path in headmf: | ||||
fctx = last[path] | ||||
flags = fctx.flags() | ||||
|
r21689 | mctx = context.memfilectx(repo, | ||
fctx.path(), fctx.data(), | ||||
|
r17644 | islink='l' in flags, | ||
isexec='x' in flags, | ||||
copied=copied.get(path)) | ||||
return mctx | ||||
|
r22296 | return None | ||
|
r17644 | |||
if commitopts.get('message'): | ||||
message = commitopts['message'] | ||||
else: | ||||
message = first.description() | ||||
user = commitopts.get('user') | ||||
date = commitopts.get('date') | ||||
|
r18437 | extra = commitopts.get('extra') | ||
|
r17644 | |||
parents = (first.p1().node(), first.p2().node()) | ||||
|
r22152 | editor = None | ||
if not commitopts.get('rollup'): | ||||
editor = cmdutil.getcommiteditor(edit=True, editform='histedit.fold') | ||||
|
r17644 | new = context.memctx(repo, | ||
parents=parents, | ||||
text=message, | ||||
files=files, | ||||
filectxfn=filectxfn, | ||||
user=user, | ||||
date=date, | ||||
|
r21239 | extra=extra, | ||
|
r22002 | editor=editor) | ||
|
r17644 | return repo.commitctx(new) | ||
|
r22982 | def pick(ui, state, ha, opts): | ||
|
r24112 | repo, ctxnode = state.repo, state.parentctxnode | ||
ctx = repo[ctxnode] | ||||
|
r17064 | oldctx = repo[ha] | ||
if oldctx.parents()[0] == ctx: | ||||
|
r24002 | ui.debug('node %s unchanged\n' % ha[:12]) | ||
|
r17758 | return oldctx, [] | ||
|
r17064 | hg.update(repo, ctx.node()) | ||
|
r17647 | stats = applychanges(ui, repo, oldctx, opts) | ||
if stats and stats[3] > 0: | ||||
|
r18934 | raise error.InterventionRequired(_('Fix up the change and run ' | ||
'hg histedit --continue')) | ||||
|
r17647 | # drop the second merge parent | ||
|
r18436 | commit = commitfuncfor(repo, oldctx) | ||
n = commit(text=oldctx.description(), user=oldctx.user(), | ||||
date=oldctx.date(), extra=oldctx.extra()) | ||||
|
r17647 | if n is None: | ||
|
r24002 | ui.warn(_('%s: empty changeset\n') % ha[:12]) | ||
|
r17758 | return ctx, [] | ||
new = repo[n] | ||||
return new, [(oldctx.node(), (n,))] | ||||
|
r17064 | |||
|
r22982 | def edit(ui, state, ha, opts): | ||
|
r24112 | repo, ctxnode = state.repo, state.parentctxnode | ||
ctx = repo[ctxnode] | ||||
|
r17064 | oldctx = repo[ha] | ||
hg.update(repo, ctx.node()) | ||||
|
r17647 | applychanges(ui, repo, oldctx, opts) | ||
|
r18934 | raise error.InterventionRequired( | ||
_('Make changes as needed, you may commit or record as needed now.\n' | ||||
'When you are finished, run hg histedit --continue to resume.')) | ||||
|
r17064 | |||
|
r22982 | def rollup(ui, state, ha, opts): | ||
|
r22152 | rollupopts = opts.copy() | ||
rollupopts['rollup'] = True | ||||
|
r22982 | return fold(ui, state, ha, rollupopts) | ||
|
r22152 | |||
|
r22982 | def fold(ui, state, ha, opts): | ||
|
r24112 | repo, ctxnode = state.repo, state.parentctxnode | ||
ctx = repo[ctxnode] | ||||
|
r17064 | oldctx = repo[ha] | ||
hg.update(repo, ctx.node()) | ||||
|
r17647 | stats = applychanges(ui, repo, oldctx, opts) | ||
if stats and stats[3] > 0: | ||||
|
r18934 | raise error.InterventionRequired( | ||
_('Fix up the change and run hg histedit --continue')) | ||||
|
r24002 | n = repo.commit(text='fold-temp-revision %s' % ha[:12], user=oldctx.user(), | ||
|
r17066 | date=oldctx.date(), extra=oldctx.extra()) | ||
|
r17647 | if n is None: | ||
|
r24002 | ui.warn(_('%s: empty changeset') % ha[:12]) | ||
|
r17758 | return ctx, [] | ||
|
r17064 | return finishfold(ui, repo, ctx, oldctx, n, opts, []) | ||
def finishfold(ui, repo, ctx, oldctx, newnode, opts, internalchanges): | ||||
parent = ctx.parents()[0].node() | ||||
hg.update(repo, parent) | ||||
|
r17644 | ### prepare new commit data | ||
commitopts = opts.copy() | ||||
|
r22147 | commitopts['user'] = ctx.user() | ||
|
r17644 | # commit message | ||
|
r22152 | if opts.get('rollup'): | ||
newmessage = ctx.description() | ||||
else: | ||||
newmessage = '\n***\n'.join( | ||||
[ctx.description()] + | ||||
[repo[r].description() for r in internalchanges] + | ||||
[oldctx.description()]) + '\n' | ||||
|
r17644 | commitopts['message'] = newmessage | ||
# date | ||||
commitopts['date'] = max(ctx.date(), oldctx.date()) | ||||
|
r18437 | extra = ctx.extra().copy() | ||
# histedit_source | ||||
# note: ctx is likely a temporary commit but that the best we can do here | ||||
# This is sufficient to solve issue3681 anyway | ||||
extra['histedit_source'] = '%s,%s' % (ctx.hex(), oldctx.hex()) | ||||
commitopts['extra'] = extra | ||||
|
r18440 | phasebackup = repo.ui.backupconfig('phases', 'new-commit') | ||
try: | ||||
phasemin = max(ctx.phase(), oldctx.phase()) | ||||
|
r20790 | repo.ui.setconfig('phases', 'new-commit', phasemin, 'histedit') | ||
|
r18440 | n = collapse(repo, ctx, repo[newnode], commitopts) | ||
finally: | ||||
repo.ui.restoreconfig(phasebackup) | ||||
|
r17644 | if n is None: | ||
|
r17758 | return ctx, [] | ||
|
r17644 | hg.update(repo, n) | ||
|
r17758 | replacements = [(oldctx.node(), (newnode,)), | ||
|
r22987 | (ctx.node(), (n,)), | ||
(newnode, (n,)), | ||||
] | ||||
|
r17758 | for ich in internalchanges: | ||
replacements.append((ich, (n,))) | ||||
return repo[n], replacements | ||||
|
r17064 | |||
|
r22982 | def drop(ui, state, ha, opts): | ||
|
r24112 | repo, ctxnode = state.repo, state.parentctxnode | ||
ctx = repo[ctxnode] | ||||
|
r17758 | return ctx, [(repo[ha].node(), ())] | ||
|
r17064 | |||
|
r22982 | def message(ui, state, ha, opts): | ||
|
r24112 | repo, ctxnode = state.repo, state.parentctxnode | ||
ctx = repo[ctxnode] | ||||
|
r17064 | oldctx = repo[ha] | ||
hg.update(repo, ctx.node()) | ||||
|
r17647 | stats = applychanges(ui, repo, oldctx, opts) | ||
if stats and stats[3] > 0: | ||||
|
r18934 | raise error.InterventionRequired( | ||
_('Fix up the change and run hg histedit --continue')) | ||||
|
r21233 | message = oldctx.description() | ||
|
r18436 | commit = commitfuncfor(repo, oldctx) | ||
|
r22002 | editor = cmdutil.getcommiteditor(edit=True, editform='histedit.mess') | ||
|
r18436 | new = commit(text=message, user=oldctx.user(), date=oldctx.date(), | ||
|
r22987 | extra=oldctx.extra(), editor=editor) | ||
|
r17064 | newctx = repo[new] | ||
if oldctx.node() != newctx.node(): | ||||
|
r17758 | return newctx, [(oldctx.node(), (new,))] | ||
|
r17064 | # We didn't make an edit, so just indicate no replaced nodes | ||
|
r17758 | return newctx, [] | ||
|
r17064 | |||
|
r19021 | def findoutgoing(ui, repo, remote=None, force=False, opts={}): | ||
"""utility function to find the first outgoing changeset | ||||
Used by initialisation code""" | ||||
dest = ui.expandpath(remote or 'default-push', remote or 'default') | ||||
dest, revs = hg.parseurl(dest, None)[:2] | ||||
ui.status(_('comparing with %s\n') % util.hidepassword(dest)) | ||||
revs, checkout = hg.addbranchrevs(repo, repo, revs, None) | ||||
other = hg.peer(repo, opts, dest) | ||||
if revs: | ||||
revs = [repo.lookup(rev) for rev in revs] | ||||
outgoing = discovery.findcommonoutgoing(repo, other, revs, force=force) | ||||
if not outgoing.missing: | ||||
raise util.Abort(_('no outgoing ancestors')) | ||||
|
r19841 | roots = list(repo.revs("roots(%ln)", outgoing.missing)) | ||
if 1 < len(roots): | ||||
msg = _('there are ambiguous outgoing revisions') | ||||
hint = _('see "hg help histedit" for more detail') | ||||
raise util.Abort(msg, hint=hint) | ||||
return repo.lookup(roots[0]) | ||||
|
r19021 | |||
|
r17064 | actiontable = {'p': pick, | ||
'pick': pick, | ||||
'e': edit, | ||||
'edit': edit, | ||||
'f': fold, | ||||
'fold': fold, | ||||
|
r22152 | 'r': rollup, | ||
'roll': rollup, | ||||
|
r17064 | 'd': drop, | ||
'drop': drop, | ||||
'm': message, | ||||
'mess': message, | ||||
} | ||||
|
r17147 | |||
@command('histedit', | ||||
[('', 'commands', '', | ||||
|
r24231 | _('read history edits from the specified file')), | ||
|
r17147 | ('c', 'continue', False, _('continue an edit already in progress')), | ||
|
r24142 | ('', 'edit-plan', False, _('edit remaining actions list')), | ||
|
r17147 | ('k', 'keep', False, | ||
_("don't strip old nodes after edit is complete")), | ||||
('', 'abort', False, _('abort an edit in progress')), | ||||
('o', 'outgoing', False, _('changesets not found in destination')), | ||||
('f', 'force', False, | ||||
_('force outgoing even for unrelated repositories')), | ||||
('r', 'rev', [], _('first revision to be edited'))], | ||||
|
r19622 | _("ANCESTOR | --outgoing [URL]")) | ||
|
r19020 | def histedit(ui, repo, *freeargs, **opts): | ||
|
r17131 | """interactively edit changeset history | ||
|
r19621 | |||
This command edits changesets between ANCESTOR and the parent of | ||||
the working directory. | ||||
|
r19622 | |||
With --outgoing, this edits changesets not found in the | ||||
destination repository. If URL of the destination is omitted, the | ||||
'default-push' (or 'default') path will be used. | ||||
|
r19842 | |||
For safety, this command is aborted, also if there are ambiguous | ||||
outgoing revisions which may confuse users: for example, there are | ||||
multiple branches containing outgoing revisions. | ||||
Use "min(outgoing() and ::.)" or similar revset specification | ||||
instead of --outgoing to specify edit target revision exactly in | ||||
such ambiguous situation. See :hg:`help revsets` for detail about | ||||
selecting revisions. | ||||
|
r19972 | |||
Returns 0 on success, 1 if user intervention is required (not only | ||||
for intentional "edit" command, but also for resolving unexpected | ||||
conflicts). | ||||
|
r17064 | """ | ||
|
r22984 | state = histeditstate(repo) | ||
|
r20071 | try: | ||
|
r22984 | state.wlock = repo.wlock() | ||
state.lock = repo.lock() | ||||
_histedit(ui, repo, state, *freeargs, **opts) | ||||
|
r20071 | finally: | ||
|
r22984 | release(state.lock, state.wlock) | ||
|
r20071 | |||
|
r22984 | def _histedit(ui, repo, state, *freeargs, **opts): | ||
|
r17064 | # TODO only abort if we try and histedit mq patches, not just | ||
# blanket if mq patches are applied somewhere | ||||
mq = getattr(repo, 'mq', None) | ||||
if mq and mq.applied: | ||||
raise util.Abort(_('source has mq patches applied')) | ||||
|
r19020 | # basic argument incompatibility processing | ||
outg = opts.get('outgoing') | ||||
cont = opts.get('continue') | ||||
|
r24142 | editplan = opts.get('edit_plan') | ||
|
r19020 | abort = opts.get('abort') | ||
force = opts.get('force') | ||||
rules = opts.get('commands', '') | ||||
revs = opts.get('rev', []) | ||||
goal = 'new' # This invocation goal, in new, continue, abort | ||||
if force and not outg: | ||||
raise util.Abort(_('--force only allowed with --outgoing')) | ||||
if cont: | ||||
|
r24142 | if util.any((outg, abort, revs, freeargs, rules, editplan)): | ||
|
r19020 | raise util.Abort(_('no arguments allowed with --continue')) | ||
goal = 'continue' | ||||
elif abort: | ||||
|
r24142 | if util.any((outg, revs, freeargs, rules, editplan)): | ||
|
r19020 | raise util.Abort(_('no arguments allowed with --abort')) | ||
goal = 'abort' | ||||
|
r24142 | elif editplan: | ||
if util.any((outg, revs, freeargs)): | ||||
raise util.Abort(_('only --commands argument allowed with' | ||||
'--edit-plan')) | ||||
goal = 'edit-plan' | ||||
|
r19020 | else: | ||
if os.path.exists(os.path.join(repo.path, 'histedit-state')): | ||||
raise util.Abort(_('history edit already in progress, try ' | ||||
'--continue or --abort')) | ||||
if outg: | ||||
if revs: | ||||
raise util.Abort(_('no revisions allowed with --outgoing')) | ||||
if len(freeargs) > 1: | ||||
raise util.Abort( | ||||
_('only one repo argument allowed with --outgoing')) | ||||
else: | ||||
|
r19021 | revs.extend(freeargs) | ||
|
r24009 | if len(revs) == 0: | ||
histeditdefault = ui.config('histedit', 'defaultrev') | ||||
if histeditdefault: | ||||
revs.append(histeditdefault) | ||||
|
r19021 | if len(revs) != 1: | ||
|
r19020 | raise util.Abort( | ||
|
r19621 | _('histedit requires exactly one ancestor revision')) | ||
|
r19020 | |||
|
r17064 | |||
|
r22977 | replacements = [] | ||
keep = opts.get('keep', False) | ||||
# rebuild state | ||||
|
r19020 | if goal == 'continue': | ||
|
r22983 | state.read() | ||
|
r22980 | state = bootstrapcontinue(ui, state, opts) | ||
|
r24142 | elif goal == 'edit-plan': | ||
state = histeditstate(repo) | ||||
state.read() | ||||
if not rules: | ||||
comment = editcomment % (state.parentctx, node.short(state.topmost)) | ||||
rules = ruleeditor(repo, ui, state.rules, comment) | ||||
else: | ||||
if rules == '-': | ||||
f = sys.stdin | ||||
else: | ||||
f = open(rules) | ||||
rules = f.read() | ||||
f.close() | ||||
rules = [l for l in (r.strip() for r in rules.splitlines()) | ||||
if l and not l.startswith('#')] | ||||
rules = verifyrules(rules, repo, [repo[c] for [_a, c] in state.rules]) | ||||
state.rules = rules | ||||
state.write() | ||||
return | ||||
|
r19020 | elif goal == 'abort': | ||
|
r22983 | state.read() | ||
|
r22985 | mapping, tmpnodes, leafs, _ntm = processreplacement(state) | ||
|
r22977 | ui.debug('restore wc to old parent %s\n' % node.short(state.topmost)) | ||
|
r19519 | # check whether we should update away | ||
parentnodes = [c.node() for c in repo[None].parents()] | ||||
|
r24112 | for n in leafs | set([state.parentctxnode]): | ||
|
r19519 | if n in parentnodes: | ||
|
r22977 | hg.clean(repo, state.topmost) | ||
|
r19519 | break | ||
else: | ||||
pass | ||||
|
r17758 | cleanupnode(ui, repo, 'created', tmpnodes) | ||
cleanupnode(ui, repo, 'temp', leafs) | ||||
|
r22978 | state.clear() | ||
|
r17064 | return | ||
else: | ||||
|
r19479 | cmdutil.checkunfinished(repo) | ||
|
r17064 | cmdutil.bailifchanged(repo) | ||
|
r17665 | topmost, empty = repo.dirstate.parents() | ||
|
r19021 | if outg: | ||
if freeargs: | ||||
remote = freeargs[0] | ||||
else: | ||||
remote = None | ||||
root = findoutgoing(ui, repo, remote, force, opts) | ||||
else: | ||||
|
r21950 | rr = list(repo.set('roots(%ld)', scmutil.revrange(repo, revs))) | ||
if len(rr) != 1: | ||||
|
r21175 | raise util.Abort(_('The specified revisions must have ' | ||
|
r20806 | 'exactly one common root')) | ||
|
r21950 | root = rr[0].node() | ||
|
r17064 | |||
|
r19021 | revs = between(repo, root, topmost, keep) | ||
|
r17766 | if not revs: | ||
|
r18608 | raise util.Abort(_('%s is not an ancestor of working directory') % | ||
|
r19021 | node.short(root)) | ||
|
r17064 | |||
ctxs = [repo[r] for r in revs] | ||||
if not rules: | ||||
|
r24142 | comment = editcomment % (node.short(root), node.short(topmost)) | ||
rules = ruleeditor(repo, ui, [['pick', c] for c in ctxs], comment) | ||||
|
r17064 | else: | ||
|
r19018 | if rules == '-': | ||
f = sys.stdin | ||||
else: | ||||
f = open(rules) | ||||
|
r17064 | rules = f.read() | ||
f.close() | ||||
rules = [l for l in (r.strip() for r in rules.splitlines()) | ||||
|
r22280 | if l and not l.startswith('#')] | ||
|
r17064 | rules = verifyrules(rules, repo, ctxs) | ||
|
r24112 | parentctxnode = repo[root].parents()[0].node() | ||
|
r17064 | |||
|
r24112 | state.parentctxnode = parentctxnode | ||
|
r22984 | state.rules = rules | ||
state.keep = keep | ||||
state.topmost = topmost | ||||
state.replacements = replacements | ||||
|
r17064 | |||
|
r22977 | while state.rules: | ||
state.write() | ||||
action, ha = state.rules.pop(0) | ||||
|
r24002 | ui.debug('histedit: processing %s %s\n' % (action, ha[:12])) | ||
|
r17758 | actfunc = actiontable[action] | ||
|
r24112 | parentctx, replacement_ = actfunc(ui, state, ha, opts) | ||
state.parentctxnode = parentctx.node() | ||||
|
r22977 | state.replacements.extend(replacement_) | ||
|
r24111 | state.write() | ||
|
r17064 | |||
|
r24112 | hg.update(repo, state.parentctxnode) | ||
|
r17064 | |||
|
r22985 | mapping, tmpnodes, created, ntm = processreplacement(state) | ||
|
r17758 | if mapping: | ||
for prec, succs in mapping.iteritems(): | ||||
if not succs: | ||||
ui.debug('histedit: %s is dropped\n' % node.short(prec)) | ||||
else: | ||||
ui.debug('histedit: %s is replaced by %s\n' % ( | ||||
node.short(prec), node.short(succs[0]))) | ||||
if len(succs) > 1: | ||||
m = 'histedit: %s' | ||||
for n in succs[1:]: | ||||
ui.debug(m % node.short(n)) | ||||
|
r17064 | if not keep: | ||
|
r17758 | if mapping: | ||
|
r22977 | movebookmarks(ui, repo, mapping, state.topmost, ntm) | ||
|
r17663 | # TODO update mq state | ||
|
r22951 | if obsolete.isenabled(repo, obsolete.createmarkersopt): | ||
|
r17759 | markers = [] | ||
|
r17771 | # sort by revision number because it sound "right" | ||
for prec in sorted(mapping, key=repo.changelog.rev): | ||||
succs = mapping[prec] | ||||
|
r17759 | markers.append((repo[prec], | ||
tuple(repo[s] for s in succs))) | ||||
if markers: | ||||
obsolete.createmarkers(repo, markers) | ||||
else: | ||||
cleanupnode(ui, repo, 'replaced', mapping) | ||||
|
r17064 | |||
|
r17664 | cleanupnode(ui, repo, 'temp', tmpnodes) | ||
|
r22978 | state.clear() | ||
|
r17064 | if os.path.exists(repo.sjoin('undo')): | ||
os.unlink(repo.sjoin('undo')) | ||||
|
r20648 | def gatherchildren(repo, ctx): | ||
|
r17749 | # is there any new commit between the expected parent and "." | ||
# | ||||
# note: does not take non linear new change in account (but previous | ||||
# implementation didn't used them anyway (issue3655) | ||||
|
r20648 | newchildren = [c.node() for c in repo.set('(%d::.)', ctx)] | ||
if ctx.node() != node.nullid: | ||||
|
r18913 | if not newchildren: | ||
|
r20648 | # `ctx` should match but no result. This means that | ||
# currentnode is not a descendant from ctx. | ||||
|
r18913 | msg = _('%s is not an ancestor of working directory') | ||
|
r19847 | hint = _('use "histedit --abort" to clear broken state') | ||
|
r20648 | raise util.Abort(msg % ctx, hint=hint) | ||
newchildren.pop(0) # remove ctx | ||||
return newchildren | ||||
|
r22980 | def bootstrapcontinue(ui, state, opts): | ||
|
r24112 | repo, parentctxnode = state.repo, state.parentctxnode | ||
parentctx = repo[parentctxnode] | ||||
|
r22980 | action, currentnode = state.rules.pop(0) | ||
|
r20648 | ctx = repo[currentnode] | ||
newchildren = gatherchildren(repo, parentctx) | ||||
|
r17758 | # Commit dirty working directory if necessary | ||
new = None | ||||
|
r22923 | s = repo.status() | ||
if s.modified or s.added or s.removed or s.deleted: | ||||
|
r17758 | # prepare the message for the commit to comes | ||
|
r22152 | if action in ('f', 'fold', 'r', 'roll'): | ||
|
r24002 | message = 'fold-temp-revision %s' % currentnode[:12] | ||
|
r17758 | else: | ||
|
r21409 | message = ctx.description() | ||
editopt = action in ('e', 'edit', 'm', 'mess') | ||||
|
r22002 | canonaction = {'e': 'edit', 'm': 'mess', 'p': 'pick'} | ||
editform = 'histedit.%s' % canonaction.get(action, action) | ||||
editor = cmdutil.getcommiteditor(edit=editopt, editform=editform) | ||||
|
r18436 | commit = commitfuncfor(repo, ctx) | ||
|
r22987 | new = commit(text=message, user=ctx.user(), date=ctx.date(), | ||
extra=ctx.extra(), editor=editor) | ||||
|
r17758 | if new is not None: | ||
newchildren.append(new) | ||||
|
r17666 | |||
|
r17758 | replacements = [] | ||
# track replacements | ||||
if ctx.node() not in newchildren: | ||||
# note: new children may be empty when the changeset is dropped. | ||||
# this happen e.g during conflicting pick where we revert content | ||||
# to parent. | ||||
replacements.append((ctx.node(), tuple(newchildren))) | ||||
|
r22152 | if action in ('f', 'fold', 'r', 'roll'): | ||
|
r19017 | if newchildren: | ||
# finalize fold operation if applicable | ||||
if new is None: | ||||
new = newchildren[-1] | ||||
else: | ||||
newchildren.pop() # remove new from internal changes | ||||
|
r22152 | foldopts = opts | ||
if action in ('r', 'roll'): | ||||
foldopts = foldopts.copy() | ||||
foldopts['rollup'] = True | ||||
parentctx, repl = finishfold(ui, repo, parentctx, ctx, new, | ||||
foldopts, newchildren) | ||||
|
r19017 | replacements.extend(repl) | ||
|
r17758 | else: | ||
|
r19017 | # newchildren is empty if the fold did not result in any commit | ||
# this happen when all folded change are discarded during the | ||||
# merge. | ||||
replacements.append((ctx.node(), (parentctx.node(),))) | ||||
|
r17758 | elif newchildren: | ||
|
r18644 | # otherwise update "parentctx" before proceeding to further operation | ||
|
r17758 | parentctx = repo[newchildren[-1]] | ||
|
r17666 | |||
|
r24112 | state.parentctxnode = parentctx.node() | ||
|
r22980 | state.replacements.extend(replacements) | ||
return state | ||||
|
r17666 | |||
|
r17642 | def between(repo, old, new, keep): | ||
"""select and validate the set of revision to edit | ||||
When keep is false, the specified set can't have children.""" | ||||
|
r17765 | ctxs = list(repo.set('%n::%n', old, new)) | ||
|
r17766 | if ctxs and not keep: | ||
|
r22952 | if (not obsolete.isenabled(repo, obsolete.allowunstableopt) and | ||
|
r18270 | repo.revs('(%ld::) - (%ld)', ctxs, ctxs)): | ||
|
r17762 | raise util.Abort(_('cannot edit history that would orphan nodes')) | ||
|
r19473 | if repo.revs('(%ld) and merge()', ctxs): | ||
raise util.Abort(_('cannot edit history that contains merges')) | ||||
|
r17767 | root = ctxs[0] # list is already sorted by repo.set | ||
|
r22416 | if not root.mutable(): | ||
|
r17762 | raise util.Abort(_('cannot edit immutable changeset: %s') % root) | ||
|
r17765 | return [c.node() for c in ctxs] | ||
|
r17642 | |||
|
r24141 | def makedesc(repo, action, rev): | ||
"""build a initial action line for a ctx | ||||
|
r17643 | |||
line are in the form: | ||||
|
r24141 | <action> <hash> <rev> <summary> | ||
|
r17643 | """ | ||
|
r24141 | ctx = repo[rev] | ||
|
r17643 | summary = '' | ||
|
r24141 | if ctx.description(): | ||
summary = ctx.description().splitlines()[0] | ||||
line = '%s %s %d %s' % (action, ctx, ctx.rev(), summary) | ||||
|
r21858 | # trim to 80 columns so it's not stupidly wide in my editor | ||
|
r24199 | maxlen = repo.ui.configint('histedit', 'linelen', default=80) | ||
maxlen = max(maxlen, 22) # avoid truncating hash | ||||
return util.ellipsis(line, maxlen) | ||||
|
r17643 | |||
|
r24140 | def ruleeditor(repo, ui, rules, editcomment=""): | ||
"""open an editor to edit rules | ||||
rules are in the format [ [act, ctx], ...] like in state.rules | ||||
""" | ||||
|
r24141 | rules = '\n'.join([makedesc(repo, act, rev) for [act, rev] in rules]) | ||
|
r24140 | rules += '\n\n' | ||
rules += editcomment | ||||
rules = ui.edit(rules, ui.username()) | ||||
# Save edit rules in .hg/histedit-last-edit.txt in case | ||||
# the user needs to ask for help after something | ||||
# surprising happens. | ||||
f = open(repo.join('histedit-last-edit.txt'), 'w') | ||||
f.write(rules) | ||||
f.close() | ||||
return rules | ||||
|
r17064 | def verifyrules(rules, repo, ctxs): | ||
"""Verify that there exists exactly one edit rule per given changeset. | ||||
Will abort if there are to many or too few rules, a malformed rule, | ||||
or a rule on a changeset outside of the user-given range. | ||||
""" | ||||
parsed = [] | ||||
|
r24002 | expected = set(c.hex() for c in ctxs) | ||
|
r19047 | seen = set() | ||
|
r17064 | for r in rules: | ||
if ' ' not in r: | ||||
raise util.Abort(_('malformed line "%s"') % r) | ||||
action, rest = r.split(' ', 1) | ||||
|
r19039 | ha = rest.strip().split(' ', 1)[0] | ||
|
r17064 | try: | ||
|
r24002 | ha = repo[ha].hex() | ||
|
r17064 | except error.RepoError: | ||
|
r24002 | raise util.Abort(_('unknown changeset %s listed') % ha[:12]) | ||
|
r19046 | if ha not in expected: | ||
|
r19045 | raise util.Abort( | ||
_('may not use changesets other than the ones listed')) | ||||
|
r19047 | if ha in seen: | ||
|
r24002 | raise util.Abort(_('duplicated command for changeset %s') % | ||
ha[:12]) | ||||
|
r19047 | seen.add(ha) | ||
|
r17064 | if action not in actiontable: | ||
raise util.Abort(_('unknown action "%s"') % action) | ||||
parsed.append([action, ha]) | ||||
|
r19048 | missing = sorted(expected - seen) # sort to stabilize output | ||
if missing: | ||||
|
r24002 | raise util.Abort(_('missing rules for changeset %s') % | ||
missing[0][:12], | ||||
hint=_('do you want to use the drop action?')) | ||||
|
r17064 | return parsed | ||
|
r17663 | |||
|
r22985 | def processreplacement(state): | ||
|
r17758 | """process the list of replacements to return | ||
1) the final mapping between original and created nodes | ||||
2) the list of temporary node created by histedit | ||||
3) the list of new commit created by histedit""" | ||||
|
r22981 | replacements = state.replacements | ||
|
r17758 | allsuccs = set() | ||
replaced = set() | ||||
fullmapping = {} | ||||
# initialise basic set | ||||
# fullmapping record all operation recorded in replacement | ||||
for rep in replacements: | ||||
allsuccs.update(rep[1]) | ||||
replaced.add(rep[0]) | ||||
fullmapping.setdefault(rep[0], set()).update(rep[1]) | ||||
new = allsuccs - replaced | ||||
tmpnodes = allsuccs & replaced | ||||
# Reduce content fullmapping into direct relation between original nodes | ||||
# and final node created during history edition | ||||
# Dropped changeset are replaced by an empty list | ||||
toproceed = set(fullmapping) | ||||
final = {} | ||||
while toproceed: | ||||
for x in list(toproceed): | ||||
succs = fullmapping[x] | ||||
for s in list(succs): | ||||
if s in toproceed: | ||||
# non final node with unknown closure | ||||
# We can't process this now | ||||
break | ||||
elif s in final: | ||||
# non final node, replace with closure | ||||
succs.remove(s) | ||||
succs.update(final[s]) | ||||
else: | ||||
final[x] = succs | ||||
toproceed.remove(x) | ||||
# remove tmpnodes from final mapping | ||||
for n in tmpnodes: | ||||
del final[n] | ||||
# we expect all changes involved in final to exist in the repo | ||||
# turn `final` into list (topologically sorted) | ||||
|
r22985 | nm = state.repo.changelog.nodemap | ||
|
r17758 | for prec, succs in final.items(): | ||
final[prec] = sorted(succs, key=nm.get) | ||||
|
r17663 | |||
|
r17758 | # computed topmost element (necessary for bookmark) | ||
if new: | ||||
|
r22985 | newtopmost = sorted(new, key=state.repo.changelog.rev)[-1] | ||
|
r17758 | elif not final: | ||
# Nothing rewritten at all. we won't need `newtopmost` | ||||
# It is the same as `oldtopmost` and `processreplacement` know it | ||||
newtopmost = None | ||||
else: | ||||
# every body died. The newtopmost is the parent of the root. | ||||
|
r22985 | r = state.repo.changelog.rev | ||
newtopmost = state.repo[sorted(final, key=r)[0]].p1().node() | ||||
|
r17758 | |||
return final, tmpnodes, new, newtopmost | ||||
|
r17663 | |||
|
r17758 | def movebookmarks(ui, repo, mapping, oldtopmost, newtopmost): | ||
"""Move bookmark from old to newly created node""" | ||||
if not mapping: | ||||
# if nothing got rewritten there is not purpose for this function | ||||
return | ||||
moves = [] | ||||
|
r18370 | for bk, old in sorted(repo._bookmarks.iteritems()): | ||
|
r17758 | if old == oldtopmost: | ||
|
r18436 | # special case ensure bookmark stay on tip. | ||
|
r17758 | # | ||
# This is arguably a feature and we may only want that for the | ||||
# active bookmark. But the behavior is kept compatible with the old | ||||
# version for now. | ||||
moves.append((bk, newtopmost)) | ||||
continue | ||||
base = old | ||||
new = mapping.get(base, None) | ||||
if new is None: | ||||
continue | ||||
while not new: | ||||
# base is killed, trying with parent | ||||
base = repo[base].p1().node() | ||||
new = mapping.get(base, (base,)) | ||||
# nothing to move | ||||
moves.append((bk, new[-1])) | ||||
if moves: | ||||
|
r17922 | marks = repo._bookmarks | ||
|
r17758 | for mark, new in moves: | ||
|
r17922 | old = marks[mark] | ||
|
r17758 | ui.note(_('histedit: moving bookmarks %s from %s to %s\n') | ||
% (mark, node.short(old), node.short(new))) | ||||
|
r17922 | marks[mark] = new | ||
marks.write() | ||||
|
r17664 | |||
def cleanupnode(ui, repo, name, nodes): | ||||
"""strip a group of nodes from the repository | ||||
The set of node to strip may contains unknown nodes.""" | ||||
ui.debug('should strip %s nodes %s\n' % | ||||
(name, ', '.join([node.short(n) for n in nodes]))) | ||||
lock = None | ||||
try: | ||||
lock = repo.lock() | ||||
# Find all node that need to be stripped | ||||
# (we hg %lr instead of %ln to silently ignore unknown item | ||||
nm = repo.changelog.nodemap | ||||
|
r22873 | nodes = sorted(n for n in nodes if n in nm) | ||
|
r17664 | roots = [c.node() for c in repo.set("roots(%ln)", nodes)] | ||
for c in roots: | ||||
# We should process node in reverse order to strip tip most first. | ||||
# but this trigger a bug in changegroup hook. | ||||
# This would reduce bundle overhead | ||||
repair.strip(ui, repo, c) | ||||
finally: | ||||
|
r20647 | release(lock) | ||
|
r19215 | |||
|
r24111 | def stripwrapper(orig, ui, repo, nodelist, *args, **kwargs): | ||
if isinstance(nodelist, str): | ||||
nodelist = [nodelist] | ||||
if os.path.exists(os.path.join(repo.path, 'histedit-state')): | ||||
state = histeditstate(repo) | ||||
state.read() | ||||
histedit_nodes = set([ctx for (action, ctx) in state.rules]) | ||||
strip_nodes = set([repo[n].hex() for n in nodelist]) | ||||
common_nodes = histedit_nodes & strip_nodes | ||||
if common_nodes: | ||||
|
r24196 | raise util.Abort(_("histedit in progress, can't strip %s") | ||
% ', '.join(node.short(x) for x in common_nodes)) | ||||
|
r24111 | return orig(ui, repo, nodelist, *args, **kwargs) | ||
extensions.wrapfunction(repair, 'strip', stripwrapper) | ||||
|
r19215 | def summaryhook(ui, repo): | ||
if not os.path.exists(repo.join('histedit-state')): | ||||
return | ||||
|
r22983 | state = histeditstate(repo) | ||
state.read() | ||||
|
r22977 | if state.rules: | ||
|
r19215 | # i18n: column positioning for "hg summary" | ||
ui.write(_('hist: %s (histedit --continue)\n') % | ||||
(ui.label(_('%d remaining'), 'histedit.remaining') % | ||||
|
r22977 | len(state.rules))) | ||
|
r19215 | |||
def extsetup(ui): | ||||
cmdutil.summaryhooks.add('histedit', summaryhook) | ||||
|
r19479 | cmdutil.unfinishedstates.append( | ||
|
r19496 | ['histedit-state', False, True, _('histedit in progress'), | ||
|
r19479 | _("use 'hg histedit --continue' or 'hg histedit --abort'")]) | ||