histedit.py
1670 lines
| 58.5 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 | ||
|
r31056 | # r, roll = like fold, but discard this commit's description and date | ||
|
r17131 | # d, drop = remove commit from history | ||
|
r26100 | # m, mess = edit commit message without changing commit content | ||
|
r17131 | # | ||
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 | ||
|
r31056 | # r, roll = like fold, but discard this commit's description and date | ||
|
r17131 | # d, drop = remove commit from history | ||
|
r26100 | # m, mess = edit commit message without changing commit content | ||
|
r17131 | # | ||
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 | |||
|
r31055 | Edit the commit message to your liking, then close the editor. The date used | ||
for the commit will be the later of the two commits' dates. 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:: | ||||
|
r17131 | |||
@ 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 | ||||
|
r31055 | histedit --continue`` to finish this step. If there are uncommitted | ||
changes, you'll be prompted for a new commit message, but the default | ||||
commit message will be the original message for the ``edit`` ed | ||||
revision, and the date of the original commit will be preserved. | ||||
|
r17131 | |||
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 | |||
|
r27414 | Config | ||
------ | ||||
|
r24199 | Histedit rule lines are truncated to 80 characters by default. You | ||
|
r26171 | can customize this behavior by setting a different length in your | ||
|
r24869 | configuration file:: | ||
|
r24199 | |||
|
r24869 | [histedit] | ||
linelen = 120 # truncate rule lines at 120 characters | ||||
|
r27262 | |||
``hg histedit`` attempts to automatically choose an appropriate base | ||||
revision to use. To change which base revision is used, define a | ||||
revset in your configuration file:: | ||||
[histedit] | ||||
defaultrev = only(.) & draft() | ||||
|
r27414 | |||
By default each edited revision needs to be present in histedit commands. | ||||
To remove revision you need to use ``drop`` operation. You can configure | ||||
|
r27957 | the drop to be implicit for missing commits by adding:: | ||
|
r27414 | |||
[histedit] | ||||
dropmissing = True | ||||
|
r31513 | By default, histedit will close the transaction after each action. For | ||
performance purposes, you can configure histedit to use a single transaction | ||||
across the entire histedit. WARNING: This setting introduces a significant risk | ||||
of losing the work you've done in a histedit if the histedit aborts | ||||
unexpectedly:: | ||||
[histedit] | ||||
singletransaction = True | ||||
|
r17064 | """ | ||
|
r17131 | |||
|
r29126 | from __future__ import absolute_import | ||
|
r22368 | import errno | ||
|
r17064 | import os | ||
|
r29205 | |||
from mercurial.i18n import _ | ||||
|
r29126 | from mercurial import ( | ||
bundle2, | ||||
cmdutil, | ||||
context, | ||||
copies, | ||||
destutil, | ||||
discovery, | ||||
error, | ||||
exchange, | ||||
extensions, | ||||
hg, | ||||
lock, | ||||
merge as mergemod, | ||||
node, | ||||
obsolete, | ||||
repair, | ||||
scmutil, | ||||
util, | ||||
) | ||||
|
r17064 | |||
|
r29324 | pickle = util.pickle | ||
|
r29126 | release = lock.release | ||
|
r17147 | cmdtable = {} | ||
command = cmdutil.command(cmdtable) | ||||
|
r29841 | # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for | ||
|
r25186 | # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should | ||
# be specifying the version(s) of Mercurial they are tested with, or | ||||
# leave the attribute unspecified. | ||||
|
r29841 | testedwith = 'ships-with-hg-core' | ||
|
r17064 | |||
|
r27675 | actiontable = {} | ||
primaryactions = set() | ||||
secondaryactions = set() | ||||
tertiaryactions = set() | ||||
internalactions = set() | ||||
|
r28592 | def geteditcomment(ui, first, last): | ||
|
r27673 | """ construct the editor comment | ||
The comment includes:: | ||||
- an intro | ||||
|
r27674 | - sorted primary commands | ||
- sorted short commands | ||||
|
r27675 | - sorted long commands | ||
|
r28592 | - additional hints | ||
|
r27673 | |||
Commands are only included once. | ||||
""" | ||||
intro = _("""Edit history between %s and %s | ||||
Commits are listed from least to most recent | ||||
|
r28396 | You can reorder changesets by reordering the lines | ||
|
r27675 | Commands: | ||
|
r17315 | """) | ||
|
r27675 | actions = [] | ||
def addverb(v): | ||||
a = actiontable[v] | ||||
lines = a.message.split("\n") | ||||
if len(a.verbs): | ||||
v = ', '.join(sorted(a.verbs, key=lambda v: len(v))) | ||||
actions.append(" %s = %s" % (v, lines[0])) | ||||
actions.extend([' %s' for l in lines[1:]]) | ||||
for v in ( | ||||
sorted(primaryactions) + | ||||
sorted(secondaryactions) + | ||||
sorted(tertiaryactions) | ||||
): | ||||
addverb(v) | ||||
actions.append('') | ||||
|
r17064 | |||
|
r28592 | hints = [] | ||
if ui.configbool('histedit', 'dropmissing'): | ||||
hints.append("Deleting a changeset from the list " | ||||
"will DISCARD it from the edited history!") | ||||
lines = (intro % (first, last)).split('\n') + actions + hints | ||||
return ''.join(['# %s\n' % l if l else '#\n' for l in lines]) | ||||
|
r27673 | |||
|
r22976 | class histeditstate(object): | ||
|
r27208 | def __init__(self, repo, parentctxnode=None, actions=None, keep=None, | ||
|
r22984 | topmost=None, replacements=None, lock=None, wlock=None): | ||
|
r22976 | self.repo = repo | ||
|
r27208 | self.actions = actions | ||
|
r22976 | self.keep = keep | ||
self.topmost = topmost | ||||
|
r24112 | self.parentctxnode = parentctxnode | ||
|
r22984 | self.lock = lock | ||
self.wlock = wlock | ||||
|
r24757 | self.backupfile = None | ||
|
r31513 | self.tr = None | ||
|
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: | ||
|
r27527 | state = self.repo.vfs.read('histedit-state') | ||
|
r25660 | except IOError as err: | ||
|
r22983 | if err.errno != errno.ENOENT: | ||
raise | ||||
|
r28123 | cmdutil.wrongtooltocontinue(self.repo, _('histedit')) | ||
|
r22983 | |||
|
r27527 | if state.startswith('v1\n'): | ||
data = self._load() | ||||
parentctxnode, rules, keep, topmost, replacements, backupfile = data | ||||
else: | ||||
data = pickle.loads(state) | ||||
|
r24756 | parentctxnode, rules, keep, topmost, replacements = data | ||
|
r24757 | backupfile = None | ||
|
r22983 | |||
|
r24112 | self.parentctxnode = parentctxnode | ||
|
r27208 | rules = "\n".join(["%s %s" % (verb, rest) for [verb, rest] in rules]) | ||
actions = parserules(rules, self) | ||||
self.actions = actions | ||||
|
r22983 | self.keep = keep | ||
self.topmost = topmost | ||||
self.replacements = replacements | ||||
|
r24757 | self.backupfile = backupfile | ||
|
r22983 | |||
|
r31511 | def write(self, tr=None): | ||
if tr: | ||||
tr.addfilegenerator('histedit-state', ('histedit-state',), | ||||
self._write, location='plain') | ||||
else: | ||||
with self.repo.vfs("histedit-state", "w") as f: | ||||
self._write(f) | ||||
def _write(self, fp): | ||||
|
r24756 | fp.write('v1\n') | ||
fp.write('%s\n' % node.hex(self.parentctxnode)) | ||||
fp.write('%s\n' % node.hex(self.topmost)) | ||||
fp.write('%s\n' % self.keep) | ||||
|
r27208 | fp.write('%d\n' % len(self.actions)) | ||
for action in self.actions: | ||||
fp.write('%s\n' % action.tostate()) | ||||
|
r24756 | fp.write('%d\n' % len(self.replacements)) | ||
for replacement in self.replacements: | ||||
fp.write('%s%s\n' % (node.hex(replacement[0]), ''.join(node.hex(r) | ||||
for r in replacement[1]))) | ||||
|
r24958 | backupfile = self.backupfile | ||
if not backupfile: | ||||
backupfile = '' | ||||
fp.write('%s\n' % backupfile) | ||||
|
r22976 | |||
|
r24756 | def _load(self): | ||
fp = self.repo.vfs('histedit-state', 'r') | ||||
lines = [l[:-1] for l in fp.readlines()] | ||||
index = 0 | ||||
lines[index] # version number | ||||
index += 1 | ||||
parentctxnode = node.bin(lines[index]) | ||||
index += 1 | ||||
topmost = node.bin(lines[index]) | ||||
index += 1 | ||||
keep = lines[index] == 'True' | ||||
index += 1 | ||||
# Rules | ||||
rules = [] | ||||
rulelen = int(lines[index]) | ||||
index += 1 | ||||
for i in xrange(rulelen): | ||||
|
r24810 | ruleaction = lines[index] | ||
index += 1 | ||||
|
r24756 | rule = lines[index] | ||
index += 1 | ||||
|
r24810 | rules.append((ruleaction, rule)) | ||
|
r24756 | |||
# Replacements | ||||
replacements = [] | ||||
replacementlen = int(lines[index]) | ||||
index += 1 | ||||
for i in xrange(replacementlen): | ||||
replacement = lines[index] | ||||
original = node.bin(replacement[:40]) | ||||
succ = [node.bin(replacement[i:i + 40]) for i in | ||||
range(40, len(replacement), 40)] | ||||
replacements.append((original, succ)) | ||||
index += 1 | ||||
|
r24757 | backupfile = lines[index] | ||
index += 1 | ||||
|
r24756 | fp.close() | ||
|
r24757 | return parentctxnode, rules, keep, topmost, replacements, backupfile | ||
|
r24756 | |||
|
r22978 | def clear(self): | ||
|
r26583 | if self.inprogress(): | ||
self.repo.vfs.unlink('histedit-state') | ||||
|
r22978 | |||
|
r26582 | def inprogress(self): | ||
return self.repo.vfs.exists('histedit-state') | ||||
|
r27200 | |||
|
r24765 | class histeditaction(object): | ||
def __init__(self, state, node): | ||||
self.state = state | ||||
self.repo = state.repo | ||||
self.node = node | ||||
@classmethod | ||||
def fromrule(cls, state, rule): | ||||
"""Parses the given rule, returning an instance of the histeditaction. | ||||
""" | ||||
rulehash = rule.strip().split(' ', 1)[0] | ||||
|
r27547 | try: | ||
rev = node.bin(rulehash) | ||||
except TypeError: | ||||
raise error.ParseError("invalid changeset %s" % rulehash) | ||||
return cls(state, rev) | ||||
|
r27202 | |||
|
r29879 | def verify(self, prev, expected, seen): | ||
|
r27202 | """ Verifies semantic correctness of the rule""" | ||
repo = self.repo | ||||
ha = node.hex(self.node) | ||||
|
r24765 | try: | ||
|
r27202 | self.node = repo[ha].node() | ||
|
r24765 | except error.RepoError: | ||
|
r27545 | raise error.ParseError(_('unknown changeset %s listed') | ||
|
r27202 | % ha[:12]) | ||
|
r29880 | if self.node is not None: | ||
self._verifynodeconstraints(prev, expected, seen) | ||||
|
r29879 | |||
|
r29880 | def _verifynodeconstraints(self, prev, expected, seen): | ||
# by default command need a node in the edited list | ||||
if self.node not in expected: | ||||
raise error.ParseError(_('%s "%s" changeset was not a candidate') | ||||
% (self.verb, node.short(self.node)), | ||||
hint=_('only use listed changesets')) | ||||
# and only one command per node | ||||
if self.node in seen: | ||||
raise error.ParseError(_('duplicated command for changeset %s') % | ||||
node.short(self.node)) | ||||
|
r24765 | |||
|
r29466 | def torule(self): | ||
|
r27203 | """build a histedit rule line for an action | ||
by default lines are in the form: | ||||
<hash> <rev> <summary> | ||||
""" | ||||
ctx = self.repo[self.node] | ||||
|
r29468 | summary = _getsummary(ctx) | ||
|
r27203 | line = '%s %s %d %s' % (self.verb, ctx, ctx.rev(), summary) | ||
# trim to 75 columns by default so it's not stupidly wide in my editor | ||||
# (the 5 more are left for verb) | ||||
maxlen = self.repo.ui.configint('histedit', 'linelen', default=80) | ||||
maxlen = max(maxlen, 22) # avoid truncating hash | ||||
return util.ellipsis(line, maxlen) | ||||
|
r27206 | def tostate(self): | ||
"""Print an action in format used by histedit state files | ||||
(the first line is a verb, the remainder is the second) | ||||
""" | ||||
return "%s\n%s" % (self.verb, node.hex(self.node)) | ||||
|
r24765 | def run(self): | ||
"""Runs the action. The default behavior is simply apply the action's | ||||
rulectx onto the current parentctx.""" | ||||
self.applychange() | ||||
self.continuedirty() | ||||
return self.continueclean() | ||||
def applychange(self): | ||||
"""Applies the changes from this action's rulectx onto the current | ||||
parentctx, but does not commit them.""" | ||||
repo = self.repo | ||||
rulectx = repo[self.node] | ||||
|
r28004 | repo.ui.pushbuffer(error=True, labeled=True) | ||
|
r27405 | hg.update(repo, self.state.parentctxnode, quietempty=True) | ||
|
r24765 | stats = applychanges(repo.ui, repo, rulectx, {}) | ||
if stats and stats[3] > 0: | ||||
|
r28004 | buf = repo.ui.popbuffer() | ||
repo.ui.write(*buf) | ||||
|
r27629 | raise error.InterventionRequired( | ||
_('Fix up the change (%s %s)') % | ||||
(self.verb, node.short(self.node)), | ||||
hint=_('hg histedit --continue to resume')) | ||||
|
r28004 | else: | ||
repo.ui.popbuffer() | ||||
|
r24765 | |||
def continuedirty(self): | ||||
"""Continues the action when changes have been applied to the working | ||||
copy. The default behavior is to commit the dirty changes.""" | ||||
repo = self.repo | ||||
rulectx = repo[self.node] | ||||
editor = self.commiteditor() | ||||
commit = commitfuncfor(repo, rulectx) | ||||
commit(text=rulectx.description(), user=rulectx.user(), | ||||
date=rulectx.date(), extra=rulectx.extra(), editor=editor) | ||||
def commiteditor(self): | ||||
"""The editor to be used to edit the commit message.""" | ||||
return False | ||||
def continueclean(self): | ||||
"""Continues the action when the working copy is clean. The default | ||||
behavior is to accept the current commit as the new version of the | ||||
rulectx.""" | ||||
ctx = self.repo['.'] | ||||
if ctx.node() == self.state.parentctxnode: | ||||
|
r28340 | self.repo.ui.warn(_('%s: skipping changeset (no changes)\n') % | ||
|
r24765 | node.short(self.node)) | ||
return ctx, [(self.node, tuple())] | ||||
if ctx.node() == self.node: | ||||
# Nothing changed | ||||
return ctx, [] | ||||
return ctx, [(self.node, (ctx.node(),))] | ||||
|
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 | |||
|
r25450 | Note that fold has its own separated logic because its handling is a bit | ||
|
r18436 | different and not easily factored out of the fold method. | ||
""" | ||||
|
r18440 | phasemin = src.phase() | ||
|
r18436 | def commitfunc(**kwargs): | ||
|
r31459 | overrides = {('phases', 'new-commit'): phasemin} | ||
with repo.ui.configoverride(overrides, 'histedit'): | ||||
|
r18440 | extra = kwargs.get('extra', {}).copy() | ||
extra['histedit_source'] = src.hex() | ||||
kwargs['extra'] = extra | ||||
return repo.commit(**kwargs) | ||||
|
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: | ||||
|
r26171 | # edits are "in place" we do not need to make any merge, | ||
|
r27603 | # just applies changes on parent for editing | ||
|
r17647 | 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 | |||
|
r24828 | def collapse(repo, first, last, commitopts, skipprompt=False): | ||
|
r17644 | """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 | ||||
|
r25452 | for c in ctxs: | ||
if not c.mutable(): | ||||
|
r27545 | raise error.ParseError( | ||
|
r25452 | _("cannot fold into public change %s") % node.short(c.node())) | ||
|
r17644 | 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 | ||||
|
r29820 | files = [f for f in files if not cmdutil.samefile(f, last, base)] | ||
|
r17644 | # 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 | ||
|
r24828 | if not skipprompt: | ||
|
r22152 | 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) | ||
|
r26981 | def _isdirtywc(repo): | ||
return repo[None].dirty(missing=True) | ||||
|
r27084 | def abortdirty(): | ||
raise error.Abort(_('working copy has pending changes'), | ||||
hint=_('amend, commit, or revert them and run histedit ' | ||||
'--continue, or abort with histedit --abort')) | ||||
|
r27675 | def action(verbs, message, priority=False, internal=False): | ||
def wrap(cls): | ||||
assert not priority or not internal | ||||
verb = verbs[0] | ||||
if priority: | ||||
primaryactions.add(verb) | ||||
elif internal: | ||||
internalactions.add(verb) | ||||
elif len(verbs) > 1: | ||||
secondaryactions.add(verb) | ||||
else: | ||||
tertiaryactions.add(verb) | ||||
|
r27201 | |||
|
r27675 | cls.verb = verb | ||
cls.verbs = verbs | ||||
cls.message = message | ||||
|
r27201 | for verb in verbs: | ||
actiontable[verb] = cls | ||||
return cls | ||||
return wrap | ||||
|
r27675 | @action(['pick', 'p'], | ||
_('use commit'), | ||||
priority=True) | ||||
|
r24767 | class pick(histeditaction): | ||
def run(self): | ||||
rulectx = self.repo[self.node] | ||||
if rulectx.parents()[0].node() == self.state.parentctxnode: | ||||
self.repo.ui.debug('node %s unchanged\n' % node.short(self.node)) | ||||
return rulectx, [] | ||||
|
r17064 | |||
|
r24767 | return super(pick, self).run() | ||
|
r17064 | |||
|
r27675 | @action(['edit', 'e'], | ||
_('use commit, but stop for amending'), | ||||
priority=True) | ||||
|
r24770 | class edit(histeditaction): | ||
def run(self): | ||||
repo = self.repo | ||||
rulectx = repo[self.node] | ||||
|
r27407 | hg.update(repo, self.state.parentctxnode, quietempty=True) | ||
|
r24770 | applychanges(repo.ui, repo, rulectx, {}) | ||
raise error.InterventionRequired( | ||||
|
r27629 | _('Editing (%s), you may commit or record as needed now.') | ||
% node.short(self.node), | ||||
hint=_('hg histedit --continue to resume')) | ||||
|
r24770 | |||
def commiteditor(self): | ||||
return cmdutil.getcommiteditor(edit=True, editform='histedit.edit') | ||||
|
r17064 | |||
|
r27675 | @action(['fold', 'f'], | ||
_('use commit, but combine it with the one above')) | ||||
|
r24771 | class fold(histeditaction): | ||
|
r29879 | def verify(self, prev, expected, seen): | ||
|
r27542 | """ Verifies semantic correctness of the fold rule""" | ||
|
r29879 | super(fold, self).verify(prev, expected, seen) | ||
|
r27542 | repo = self.repo | ||
if not prev: | ||||
c = repo[self.node].parents()[0] | ||||
elif not prev.verb in ('pick', 'base'): | ||||
return | ||||
else: | ||||
c = repo[prev.node] | ||||
if not c.mutable(): | ||||
|
r27545 | raise error.ParseError( | ||
|
r27542 | _("cannot fold into public change %s") % node.short(c.node())) | ||
|
r24771 | def continuedirty(self): | ||
repo = self.repo | ||||
rulectx = repo[self.node] | ||||
commit = commitfuncfor(repo, rulectx) | ||||
commit(text='fold-temp-revision %s' % node.short(self.node), | ||||
user=rulectx.user(), date=rulectx.date(), | ||||
extra=rulectx.extra()) | ||||
def continueclean(self): | ||||
repo = self.repo | ||||
ctx = repo['.'] | ||||
rulectx = repo[self.node] | ||||
parentctxnode = self.state.parentctxnode | ||||
if ctx.node() == parentctxnode: | ||||
repo.ui.warn(_('%s: empty changeset\n') % | ||||
node.short(self.node)) | ||||
return ctx, [(self.node, (parentctxnode,))] | ||||
|
r22152 | |||
|
r24771 | parentctx = repo[parentctxnode] | ||
newcommits = set(c.node() for c in repo.set('(%d::. - %d)', parentctx, | ||||
parentctx)) | ||||
if not newcommits: | ||||
repo.ui.warn(_('%s: cannot fold - working copy is not a ' | ||||
'descendant of previous commit %s\n') % | ||||
(node.short(self.node), node.short(parentctxnode))) | ||||
return ctx, [(self.node, (ctx.node(),))] | ||||
middlecommits = newcommits.copy() | ||||
middlecommits.discard(ctx.node()) | ||||
|
r24773 | return self.finishfold(repo.ui, repo, parentctx, rulectx, ctx.node(), | ||
middlecommits) | ||||
|
r24771 | |||
|
r24773 | def skipprompt(self): | ||
|
r26246 | """Returns true if the rule should skip the message editor. | ||
For example, 'fold' wants to show an editor, but 'rollup' | ||||
doesn't want to. | ||||
""" | ||||
|
r24773 | return False | ||
|
r24772 | |||
|
r26246 | def mergedescs(self): | ||
"""Returns true if the rule should merge messages of multiple changes. | ||||
This exists mainly so that 'rollup' rules can be a subclass of | ||||
'fold'. | ||||
""" | ||||
return True | ||||
|
r31056 | def firstdate(self): | ||
"""Returns true if the rule should preserve the date of the first | ||||
change. | ||||
This exists mainly so that 'rollup' rules can be a subclass of | ||||
'fold'. | ||||
""" | ||||
return False | ||||
|
r24773 | def finishfold(self, ui, repo, ctx, oldctx, newnode, internalchanges): | ||
|
r24772 | parent = ctx.parents()[0].node() | ||
|
r28004 | repo.ui.pushbuffer() | ||
|
r24772 | hg.update(repo, parent) | ||
|
r28004 | repo.ui.popbuffer() | ||
|
r24772 | ### prepare new commit data | ||
|
r24773 | commitopts = {} | ||
|
r24772 | commitopts['user'] = ctx.user() | ||
# commit message | ||||
|
r26246 | if not self.mergedescs(): | ||
|
r24772 | newmessage = ctx.description() | ||
else: | ||||
newmessage = '\n***\n'.join( | ||||
[ctx.description()] + | ||||
[repo[r].description() for r in internalchanges] + | ||||
[oldctx.description()]) + '\n' | ||||
commitopts['message'] = newmessage | ||||
# date | ||||
|
r31056 | if self.firstdate(): | ||
commitopts['date'] = ctx.date() | ||||
else: | ||||
commitopts['date'] = max(ctx.date(), oldctx.date()) | ||||
|
r24772 | 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 | ||||
|
r31459 | phasemin = max(ctx.phase(), oldctx.phase()) | ||
overrides = {('phases', 'new-commit'): phasemin} | ||||
with repo.ui.configoverride(overrides, 'histedit'): | ||||
|
r24828 | n = collapse(repo, ctx, repo[newnode], commitopts, | ||
skipprompt=self.skipprompt()) | ||||
|
r24772 | if n is None: | ||
return ctx, [] | ||||
|
r28004 | repo.ui.pushbuffer() | ||
|
r24772 | hg.update(repo, n) | ||
|
r28004 | repo.ui.popbuffer() | ||
|
r24772 | replacements = [(oldctx.node(), (newnode,)), | ||
(ctx.node(), (n,)), | ||||
(newnode, (n,)), | ||||
] | ||||
for ich in internalchanges: | ||||
replacements.append((ich, (n,))) | ||||
return repo[n], replacements | ||||
|
r24771 | |||
|
r27085 | class base(histeditaction): | ||
def run(self): | ||||
if self.repo['.'].node() != self.node: | ||||
|
r27344 | mergemod.update(self.repo, self.node, False, True) | ||
# branchmerge, force) | ||||
|
r27085 | return self.continueclean() | ||
def continuedirty(self): | ||||
abortdirty() | ||||
def continueclean(self): | ||||
basectx = self.repo['.'] | ||||
return basectx, [] | ||||
|
r29880 | def _verifynodeconstraints(self, prev, expected, seen): | ||
# base can only be use with a node not in the edited set | ||||
if self.node in expected: | ||||
|
r29887 | msg = _('%s "%s" changeset was an edited list candidate') | ||
raise error.ParseError( | ||||
msg % (self.verb, node.short(self.node)), | ||||
hint=_('base must only use unlisted changesets')) | ||||
|
r29880 | |||
|
r27675 | @action(['_multifold'], | ||
_( | ||||
|
r26246 | """fold subclass used for when multiple folds happen in a row | ||
We only want to fire the editor for the folded message once when | ||||
(say) four changes are folded down into a single change. This is | ||||
similar to rollup, but we should preserve both messages so that | ||||
when the last fold operation runs we can show the user all the | ||||
commit messages in their editor. | ||||
|
r27675 | """), | ||
internal=True) | ||||
class _multifold(fold): | ||||
|
r26246 | def skipprompt(self): | ||
return True | ||||
|
r27675 | @action(["roll", "r"], | ||
|
r31056 | _("like fold, but discard this commit's description and date")) | ||
|
r24771 | class rollup(fold): | ||
|
r26246 | def mergedescs(self): | ||
return False | ||||
|
r24773 | def skipprompt(self): | ||
return True | ||||
|
r17064 | |||
|
r31056 | def firstdate(self): | ||
return True | ||||
|
r27675 | @action(["drop", "d"], | ||
_('remove commit from history')) | ||||
|
r24768 | class drop(histeditaction): | ||
def run(self): | ||||
parentctx = self.repo[self.state.parentctxnode] | ||||
return parentctx, [(self.node, tuple())] | ||||
|
r17064 | |||
|
r27675 | @action(["mess", "m"], | ||
_('edit commit message without changing commit content'), | ||||
priority=True) | ||||
|
r24769 | class message(histeditaction): | ||
def commiteditor(self): | ||||
return cmdutil.getcommiteditor(edit=True, editform='histedit.mess') | ||||
|
r17064 | |||
|
r26335 | def findoutgoing(ui, repo, remote=None, force=False, opts=None): | ||
|
r19021 | """utility function to find the first outgoing changeset | ||
|
r26171 | Used by initialization code""" | ||
|
r26335 | if opts is None: | ||
opts = {} | ||||
|
r19021 | 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: | ||||
|
r26587 | raise error.Abort(_('no outgoing ancestors')) | ||
|
r19841 | roots = list(repo.revs("roots(%ln)", outgoing.missing)) | ||
if 1 < len(roots): | ||||
msg = _('there are ambiguous outgoing revisions') | ||||
|
r29970 | hint = _("see 'hg help histedit' for more detail") | ||
|
r26587 | raise error.Abort(msg, hint=hint) | ||
|
r19841 | return repo.lookup(roots[0]) | ||
|
r19021 | |||
|
r17147 | |||
@command('histedit', | ||||
[('', 'commands', '', | ||||
|
r24232 | _('read history edits from the specified file'), _('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')), | ||||
|
r24232 | ('r', 'rev', [], _('first revision to be edited'), _('REV'))], | ||
|
r27714 | _("[OPTIONS] ([ANCESTOR] | --outgoing [URL])")) | ||
|
r19020 | def histedit(ui, repo, *freeargs, **opts): | ||
|
r17131 | """interactively edit changeset history | ||
|
r19621 | |||
|
r27713 | This command lets you edit a linear series of changesets (up to | ||
and including the working directory, which should be clean). | ||||
|
r27956 | You can: | ||
|
r27713 | |||
- `pick` to [re]order a changeset | ||||
- `drop` to omit changeset | ||||
- `mess` to reword the changeset commit message | ||||
|
r31055 | - `fold` to combine it with the preceding changeset (using the later date) | ||
|
r27713 | |||
|
r31056 | - `roll` like fold, but discarding this commit's description and date | ||
|
r27713 | |||
|
r31055 | - `edit` to edit this changeset (preserving date) | ||
|
r19622 | |||
|
r27972 | There are a number of ways to select the root changeset: | ||
|
r27714 | |||
- Specify ANCESTOR directly | ||||
|
r27262 | |||
|
r27714 | - Use --outgoing -- it will be the first linear changeset not | ||
|
r28077 | included in destination. (See :hg:`help config.paths.default-push`) | ||
|
r27714 | |||
- Otherwise, the value from the "histedit.defaultrev" config option | ||||
is used as a revset to select the base revision when ANCESTOR is not | ||||
specified. The first revision returned by the revset is used. By | ||||
default, this selects the editable history that is unique to the | ||||
ancestry of the working directory. | ||||
|
r19842 | |||
|
r27630 | .. container:: verbose | ||
|
r19842 | |||
|
r27630 | If you use --outgoing, this command will abort if there are ambiguous | ||
outgoing revisions. For example, if 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 | |||
|
r27145 | .. container:: verbose | ||
Examples: | ||||
- A number of changes have been made. | ||||
Revision 3 is no longer needed. | ||||
Start history editing from revision 3:: | ||||
hg histedit -r 3 | ||||
An editor opens, containing the list of revisions, | ||||
with specific actions specified:: | ||||
pick 5339bf82f0ca 3 Zworgle the foobar | ||||
pick 8ef592ce7cc4 4 Bedazzle the zerlog | ||||
pick 0a9639fcda9d 5 Morgify the cromulancy | ||||
Additional information about the possible actions | ||||
to take appears below the list of revisions. | ||||
To remove revision 3 from the history, | ||||
its action (at the beginning of the relevant line) | ||||
is changed to 'drop':: | ||||
drop 5339bf82f0ca 3 Zworgle the foobar | ||||
pick 8ef592ce7cc4 4 Bedazzle the zerlog | ||||
pick 0a9639fcda9d 5 Morgify the cromulancy | ||||
- A number of changes have been made. | ||||
Revision 2 and 4 need to be swapped. | ||||
Start history editing from revision 2:: | ||||
hg histedit -r 2 | ||||
An editor opens, containing the list of revisions, | ||||
with specific actions specified:: | ||||
pick 252a1af424ad 2 Blorb a morgwazzle | ||||
pick 5339bf82f0ca 3 Zworgle the foobar | ||||
pick 8ef592ce7cc4 4 Bedazzle the zerlog | ||||
To swap revision 2 and 4, its lines are swapped | ||||
in the editor:: | ||||
pick 8ef592ce7cc4 4 Bedazzle the zerlog | ||||
pick 5339bf82f0ca 3 Zworgle the foobar | ||||
pick 252a1af424ad 2 Blorb a morgwazzle | ||||
|
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 | |||
|
r28144 | goalcontinue = 'continue' | ||
goalabort = 'abort' | ||||
goaleditplan = 'edit-plan' | ||||
goalnew = 'new' | ||||
|
r28134 | def _getgoal(opts): | ||
if opts.get('continue'): | ||||
|
r28144 | return goalcontinue | ||
|
r28134 | if opts.get('abort'): | ||
|
r28144 | return goalabort | ||
|
r28134 | if opts.get('edit_plan'): | ||
|
r28144 | return goaleditplan | ||
return goalnew | ||||
|
r28134 | |||
|
r30262 | def _readfile(ui, path): | ||
|
r28550 | if path == '-': | ||
|
r30983 | with ui.timeblockedsection('histedit'): | ||
return ui.fin.read() | ||||
|
r28550 | else: | ||
with open(path, 'rb') as f: | ||||
return f.read() | ||||
|
r28134 | def _validateargs(ui, repo, state, freeargs, opts, goal, rules, revs): | ||
|
r27169 | # TODO only abort if we try to histedit mq patches, not just | ||
|
r17064 | # blanket if mq patches are applied somewhere | ||
mq = getattr(repo, 'mq', None) | ||||
if mq and mq.applied: | ||||
|
r26587 | raise error.Abort(_('source has mq patches applied')) | ||
|
r17064 | |||
|
r19020 | # basic argument incompatibility processing | ||
outg = opts.get('outgoing') | ||||
|
r24142 | editplan = opts.get('edit_plan') | ||
|
r19020 | abort = opts.get('abort') | ||
force = opts.get('force') | ||||
if force and not outg: | ||||
|
r26587 | raise error.Abort(_('--force only allowed with --outgoing')) | ||
|
r28134 | if goal == 'continue': | ||
|
r25149 | if any((outg, abort, revs, freeargs, rules, editplan)): | ||
|
r26587 | raise error.Abort(_('no arguments allowed with --continue')) | ||
|
r28134 | elif goal == 'abort': | ||
|
r25149 | if any((outg, revs, freeargs, rules, editplan)): | ||
|
r26587 | raise error.Abort(_('no arguments allowed with --abort')) | ||
|
r28134 | elif goal == 'edit-plan': | ||
|
r25149 | if any((outg, revs, freeargs)): | ||
|
r26587 | raise error.Abort(_('only --commands argument allowed with ' | ||
|
r24142 | '--edit-plan')) | ||
|
r19020 | else: | ||
if os.path.exists(os.path.join(repo.path, 'histedit-state')): | ||||
|
r26587 | raise error.Abort(_('history edit already in progress, try ' | ||
|
r19020 | '--continue or --abort')) | ||
if outg: | ||||
if revs: | ||||
|
r26587 | raise error.Abort(_('no revisions allowed with --outgoing')) | ||
|
r19020 | if len(freeargs) > 1: | ||
|
r26587 | raise error.Abort( | ||
|
r19020 | _('only one repo argument allowed with --outgoing')) | ||
else: | ||||
|
r19021 | revs.extend(freeargs) | ||
|
r24009 | if len(revs) == 0: | ||
|
r27262 | defaultrev = destutil.desthistedit(ui, repo) | ||
if defaultrev is not None: | ||||
revs.append(defaultrev) | ||||
|
r19021 | if len(revs) != 1: | ||
|
r26587 | raise error.Abort( | ||
|
r19621 | _('histedit requires exactly one ancestor revision')) | ||
|
r19020 | |||
|
r28134 | def _histedit(ui, repo, state, *freeargs, **opts): | ||
goal = _getgoal(opts) | ||||
revs = opts.get('rev', []) | ||||
rules = opts.get('commands', '') | ||||
state.keep = opts.get('keep', False) | ||||
|
r17064 | |||
|
r28134 | _validateargs(ui, repo, state, freeargs, opts, goal, rules, revs) | ||
|
r22977 | |||
# rebuild state | ||||
|
r28144 | if goal == goalcontinue: | ||
|
r22983 | state.read() | ||
|
r22980 | state = bootstrapcontinue(ui, state, opts) | ||
|
r28144 | elif goal == goaleditplan: | ||
|
r28154 | _edithisteditplan(ui, repo, state, rules) | ||
|
r24142 | return | ||
|
r28144 | elif goal == goalabort: | ||
|
r28154 | _aborthistedit(ui, repo, state) | ||
|
r17064 | return | ||
else: | ||||
|
r28144 | # goal == goalnew | ||
|
r28154 | _newhistedit(ui, repo, state, revs, freeargs, opts) | ||
|
r24757 | |||
|
r28154 | _continuehistedit(ui, repo, state) | ||
_finishhistedit(ui, repo, state) | ||||
|
r28133 | |||
|
r28154 | def _continuehistedit(ui, repo, state): | ||
"""This function runs after either: | ||||
|
r28133 | - bootstrapcontinue (if the goal is 'continue') | ||
|
r28154 | - _newhistedit (if the goal is 'new') | ||
|
r28133 | """ | ||
|
r26246 | # preprocess rules so that we can hide inner folds from the user | ||
# and only show one editor | ||||
|
r27207 | actions = state.actions[:] | ||
for idx, (action, nextact) in enumerate( | ||||
zip(actions, actions[1:] + [None])): | ||||
if action.verb == 'fold' and nextact and nextact.verb == 'fold': | ||||
state.actions[idx].__class__ = _multifold | ||||
|
r26246 | |||
|
r27451 | total = len(state.actions) | ||
pos = 0 | ||||
|
r31513 | state.tr = None | ||
# Force an initial state file write, so the user can run --abort/continue | ||||
# even if there's an exception before the first transaction serialize. | ||||
state.write() | ||||
try: | ||||
# Don't use singletransaction by default since it rolls the entire | ||||
# transaction back if an unexpected exception happens (like a | ||||
# pretxncommit hook throws, or the user aborts the commit msg editor). | ||||
if ui.configbool("histedit", "singletransaction", False): | ||||
# Don't use a 'with' for the transaction, since actions may close | ||||
# and reopen a transaction. For example, if the action executes an | ||||
# external process it may choose to commit the transaction first. | ||||
state.tr = repo.transaction('histedit') | ||||
while state.actions: | ||||
state.write(tr=state.tr) | ||||
actobj = state.actions[0] | ||||
pos += 1 | ||||
ui.progress(_("editing"), pos, actobj.torule(), | ||||
_('changes'), total) | ||||
ui.debug('histedit: processing %s %s\n' % (actobj.verb,\ | ||||
actobj.torule())) | ||||
parentctx, replacement_ = actobj.run() | ||||
state.parentctxnode = parentctx.node() | ||||
state.replacements.extend(replacement_) | ||||
state.actions.pop(0) | ||||
if state.tr is not None: | ||||
state.tr.close() | ||||
except error.InterventionRequired: | ||||
if state.tr is not None: | ||||
state.tr.close() | ||||
raise | ||||
except Exception: | ||||
if state.tr is not None: | ||||
state.tr.abort() | ||||
raise | ||||
|
r24111 | state.write() | ||
|
r27451 | ui.progress(_("editing"), None) | ||
|
r17064 | |||
|
r28154 | def _finishhistedit(ui, repo, state): | ||
|
r28153 | """This action runs when histedit is finishing its session""" | ||
|
r28004 | repo.ui.pushbuffer() | ||
|
r27406 | hg.update(repo, state.parentctxnode, quietempty=True) | ||
|
r28004 | repo.ui.popbuffer() | ||
|
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)) | ||||
|
r31526 | safecleanupnode(ui, repo, 'temp', tmpnodes) | ||
|
r26763 | |||
|
r25330 | if not state.keep: | ||
|
r17758 | if mapping: | ||
|
r22977 | movebookmarks(ui, repo, mapping, state.topmost, ntm) | ||
|
r17663 | # TODO update mq state | ||
|
r31526 | safecleanupnode(ui, repo, 'replaced', mapping) | ||
|
r25894 | |||
|
r22978 | state.clear() | ||
|
r17064 | if os.path.exists(repo.sjoin('undo')): | ||
os.unlink(repo.sjoin('undo')) | ||||
|
r27546 | if repo.vfs.exists('histedit-last-edit.txt'): | ||
repo.vfs.unlink('histedit-last-edit.txt') | ||||
|
r17064 | |||
|
r28154 | def _aborthistedit(ui, repo, state): | ||
|
r28130 | try: | ||
state.read() | ||||
|
r28179 | __, leafs, tmpnodes, __ = processreplacement(state) | ||
|
r28130 | ui.debug('restore wc to old parent %s\n' | ||
% node.short(state.topmost)) | ||||
# Recover our old commits if necessary | ||||
if not state.topmost in repo and state.backupfile: | ||||
|
r31329 | backupfile = repo.vfs.join(state.backupfile) | ||
|
r28130 | f = hg.openpath(ui, backupfile) | ||
gen = exchange.readbundle(ui, f, backupfile) | ||||
with repo.transaction('histedit.abort') as tr: | ||||
if not isinstance(gen, bundle2.unbundle20): | ||||
gen.apply(repo, 'histedit', 'bundle:' + backupfile) | ||||
if isinstance(gen, bundle2.unbundle20): | ||||
bundle2.applybundle(repo, gen, tr, | ||||
source='histedit', | ||||
url='bundle:' + backupfile) | ||||
os.remove(backupfile) | ||||
# check whether we should update away | ||||
if repo.unfiltered().revs('parents() and (%n or %ln::)', | ||||
state.parentctxnode, leafs | tmpnodes): | ||||
hg.clean(repo, state.topmost, show_stats=True, quietempty=True) | ||||
cleanupnode(ui, repo, 'created', tmpnodes) | ||||
cleanupnode(ui, repo, 'temp', leafs) | ||||
except Exception: | ||||
if state.inprogress(): | ||||
ui.warn(_('warning: encountered an exception during histedit ' | ||||
'--abort; the repository may not have been completely ' | ||||
'cleaned up\n')) | ||||
raise | ||||
finally: | ||||
state.clear() | ||||
|
r28154 | def _edithisteditplan(ui, repo, state, rules): | ||
|
r28131 | state.read() | ||
if not rules: | ||||
|
r28592 | comment = geteditcomment(ui, | ||
node.short(state.parentctxnode), | ||||
|
r28131 | node.short(state.topmost)) | ||
rules = ruleeditor(repo, ui, state.actions, comment) | ||||
else: | ||||
|
r30262 | rules = _readfile(ui, rules) | ||
|
r28131 | actions = parserules(rules, state) | ||
|
r29874 | ctxs = [repo[act.node] \ | ||
for act in state.actions if act.node] | ||||
|
r28131 | warnverifyactions(ui, repo, actions, state, ctxs) | ||
state.actions = actions | ||||
state.write() | ||||
|
r28154 | def _newhistedit(ui, repo, state, revs, freeargs, opts): | ||
|
r28132 | outg = opts.get('outgoing') | ||
rules = opts.get('commands', '') | ||||
force = opts.get('force') | ||||
cmdutil.checkunfinished(repo) | ||||
cmdutil.bailifchanged(repo) | ||||
topmost, empty = repo.dirstate.parents() | ||||
if outg: | ||||
if freeargs: | ||||
remote = freeargs[0] | ||||
else: | ||||
remote = None | ||||
root = findoutgoing(ui, repo, remote, force, opts) | ||||
else: | ||||
rr = list(repo.set('roots(%ld)', scmutil.revrange(repo, revs))) | ||||
if len(rr) != 1: | ||||
raise error.Abort(_('The specified revisions must have ' | ||||
'exactly one common root')) | ||||
root = rr[0].node() | ||||
revs = between(repo, root, topmost, state.keep) | ||||
if not revs: | ||||
raise error.Abort(_('%s is not an ancestor of working directory') % | ||||
node.short(root)) | ||||
ctxs = [repo[r] for r in revs] | ||||
if not rules: | ||||
|
r28592 | comment = geteditcomment(ui, node.short(root), node.short(topmost)) | ||
|
r28132 | actions = [pick(state, r) for r in revs] | ||
rules = ruleeditor(repo, ui, actions, comment) | ||||
else: | ||||
|
r30262 | rules = _readfile(ui, rules) | ||
|
r28132 | actions = parserules(rules, state) | ||
warnverifyactions(ui, repo, actions, state, ctxs) | ||||
parentctxnode = repo[root].parents()[0].node() | ||||
state.parentctxnode = parentctxnode | ||||
state.actions = actions | ||||
state.topmost = topmost | ||||
state.replacements = [] | ||||
# Create a backup so we can always abort completely. | ||||
backupfile = None | ||||
if not obsolete.isenabled(repo, obsolete.createmarkersopt): | ||||
backupfile = repair._bundle(repo, [parentctxnode], [topmost], root, | ||||
'histedit') | ||||
state.backupfile = backupfile | ||||
|
r29467 | def _getsummary(ctx): | ||
# a common pattern is to extract the summary but default to the empty | ||||
# string | ||||
summary = ctx.description() or '' | ||||
if summary: | ||||
summary = summary.splitlines()[0] | ||||
return summary | ||||
|
r24774 | def bootstrapcontinue(ui, state, opts): | ||
repo = state.repo | ||||
|
r27207 | if state.actions: | ||
actobj = state.actions.pop(0) | ||||
|
r24959 | |||
|
r26981 | if _isdirtywc(repo): | ||
|
r24959 | actobj.continuedirty() | ||
|
r26981 | if _isdirtywc(repo): | ||
|
r27084 | abortdirty() | ||
|
r24766 | |||
|
r24959 | parentctx, replacements = actobj.continueclean() | ||
|
r17666 | |||
|
r24959 | state.parentctxnode = parentctx.node() | ||
state.replacements.extend(replacements) | ||||
|
r22980 | |||
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)): | ||
|
r28294 | raise error.Abort(_('can only histedit a changeset together ' | ||
'with all its descendants')) | ||||
|
r19473 | if repo.revs('(%ld) and merge()', ctxs): | ||
|
r26587 | raise error.Abort(_('cannot edit history that contains merges')) | ||
|
r17767 | root = ctxs[0] # list is already sorted by repo.set | ||
|
r22416 | if not root.mutable(): | ||
|
r26587 | raise error.Abort(_('cannot edit public changeset: %s') % root, | ||
|
r29970 | hint=_("see 'hg help phases' for details")) | ||
|
r17765 | return [c.node() for c in ctxs] | ||
|
r17642 | |||
|
r27204 | def ruleeditor(repo, ui, actions, editcomment=""): | ||
|
r24140 | """open an editor to edit rules | ||
rules are in the format [ [act, ctx], ...] like in state.rules | ||||
""" | ||||
|
r29465 | if repo.ui.configbool("experimental", "histedit.autoverb"): | ||
|
r29470 | newact = util.sortdict() | ||
|
r29465 | for act in actions: | ||
ctx = repo[act.node] | ||||
|
r29469 | summary = _getsummary(ctx) | ||
|
r29465 | fword = summary.split(' ', 1)[0].lower() | ||
|
r29470 | added = False | ||
|
r29465 | # if it doesn't end with the special character '!' just skip this | ||
if fword.endswith('!'): | ||||
fword = fword[:-1] | ||||
if fword in primaryactions | secondaryactions | tertiaryactions: | ||||
act.verb = fword | ||||
|
r29470 | # get the target summary | ||
tsum = summary[len(fword) + 1:].lstrip() | ||||
# safe but slow: reverse iterate over the actions so we | ||||
# don't clash on two commits having the same summary | ||||
for na, l in reversed(list(newact.iteritems())): | ||||
actx = repo[na.node] | ||||
asum = _getsummary(actx) | ||||
if asum == tsum: | ||||
added = True | ||||
l.append(act) | ||||
break | ||||
if not added: | ||||
newact[act] = [] | ||||
# copy over and flatten the new list | ||||
actions = [] | ||||
for na, l in newact.iteritems(): | ||||
actions.append(na) | ||||
actions += l | ||||
|
r29465 | |||
|
r29466 | rules = '\n'.join([act.torule() for act in actions]) | ||
|
r24140 | rules += '\n\n' | ||
rules += editcomment | ||||
|
r30837 | rules = ui.edit(rules, ui.username(), {'prefix': 'histedit'}, | ||
|
r30848 | repopath=repo.path) | ||
|
r24140 | |||
# Save edit rules in .hg/histedit-last-edit.txt in case | ||||
# the user needs to ask for help after something | ||||
# surprising happens. | ||||
|
r31329 | f = open(repo.vfs.join('histedit-last-edit.txt'), 'w') | ||
|
r24140 | f.write(rules) | ||
f.close() | ||||
return rules | ||||
|
r27208 | def parserules(rules, state): | ||
"""Read the histedit rules string and return list of action objects """ | ||||
rules = [l for l in (r.strip() for r in rules.splitlines()) | ||||
if l and not l.startswith('#')] | ||||
actions = [] | ||||
|
r17064 | for r in rules: | ||
if ' ' not in r: | ||||
|
r27545 | raise error.ParseError(_('malformed line "%s"') % r) | ||
|
r27082 | verb, rest = r.split(' ', 1) | ||
|
r27208 | if verb not in actiontable: | ||
|
r27545 | raise error.ParseError(_('unknown action "%s"') % verb) | ||
|
r27208 | |||
|
r27082 | action = actiontable[verb].fromrule(state, rest) | ||
|
r27208 | actions.append(action) | ||
return actions | ||||
|
r27543 | def warnverifyactions(ui, repo, actions, state, ctxs): | ||
try: | ||||
verifyactions(actions, state, ctxs) | ||||
|
r27545 | except error.ParseError: | ||
|
r27543 | if repo.vfs.exists('histedit-last-edit.txt'): | ||
ui.warn(_('warning: histedit rules saved ' | ||||
'to: .hg/histedit-last-edit.txt\n')) | ||||
raise | ||||
|
r27208 | def verifyactions(actions, state, ctxs): | ||
"""Verify that there exists exactly one action per given changeset and | ||||
other constraints. | ||||
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. | ||||
""" | ||||
|
r29878 | expected = set(c.node() for c in ctxs) | ||
|
r27208 | seen = set() | ||
|
r27541 | prev = None | ||
|
r27208 | for action in actions: | ||
|
r29879 | action.verify(prev, expected, seen) | ||
|
r27541 | prev = action | ||
|
r29876 | if action.node is not None: | ||
|
r29878 | seen.add(action.node) | ||
|
r19048 | missing = sorted(expected - seen) # sort to stabilize output | ||
|
r27414 | |||
if state.repo.ui.configbool('histedit', 'dropmissing'): | ||||
|
r28519 | if len(actions) == 0: | ||
raise error.ParseError(_('no rules provided'), | ||||
hint=_('use strip extension to remove commits')) | ||||
|
r29878 | drops = [drop(state, n) for n in missing] | ||
|
r27414 | # put the in the beginning so they execute immediately and | ||
# don't show in the edit-plan in the future | ||||
actions[:0] = drops | ||||
elif missing: | ||||
|
r27545 | raise error.ParseError(_('missing rules for changeset %s') % | ||
|
r29878 | node.short(missing[0]), | ||
|
r27414 | hint=_('use "drop %s" to discard, see also: ' | ||
|
r29970 | "'hg help -e histedit.config'") | ||
|
r29878 | % node.short(missing[0])) | ||
|
r17663 | |||
|
r28216 | def adjustreplacementsfrommarkers(repo, oldreplacements): | ||
|
r30332 | """Adjust replacements from obsolescence markers | ||
|
r28216 | |||
Replacements structure is originally generated based on | ||||
histedit's state and does not account for changes that are | ||||
not recorded there. This function fixes that by adding | ||||
|
r30332 | data read from obsolescence markers""" | ||
|
r28216 | if not obsolete.isenabled(repo, obsolete.createmarkersopt): | ||
return oldreplacements | ||||
unfi = repo.unfiltered() | ||||
|
r28224 | nm = unfi.changelog.nodemap | ||
obsstore = repo.obsstore | ||||
|
r28216 | newreplacements = list(oldreplacements) | ||
oldsuccs = [r[1] for r in oldreplacements] | ||||
# successors that have already been added to succstocheck once | ||||
seensuccs = set().union(*oldsuccs) # create a set from an iterable of tuples | ||||
succstocheck = list(seensuccs) | ||||
while succstocheck: | ||||
n = succstocheck.pop() | ||||
|
r28224 | missing = nm.get(n) is None | ||
markers = obsstore.successors.get(n, ()) | ||||
if missing and not markers: | ||||
# dead end, mark it as such | ||||
|
r28216 | newreplacements.append((n, ())) | ||
|
r28224 | for marker in markers: | ||
nsuccs = marker[1] | ||||
|
r28216 | newreplacements.append((n, nsuccs)) | ||
for nsucc in nsuccs: | ||||
if nsucc not in seensuccs: | ||||
seensuccs.add(nsucc) | ||||
succstocheck.append(nsucc) | ||||
return newreplacements | ||||
|
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""" | ||||
|
r28216 | replacements = adjustreplacementsfrommarkers(state.repo, state.replacements) | ||
|
r17758 | allsuccs = set() | ||
replaced = set() | ||||
fullmapping = {} | ||||
|
r26039 | # initialize basic set | ||
# fullmapping records all operations recorded in replacement | ||||
|
r17758 | 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 | ||||
|
r26039 | # Reduce content fullmapping into direct relation between original nodes | ||
|
r17758 | # 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: | ||||
|
r27051 | lock = tr = None | ||
try: | ||||
lock = repo.lock() | ||||
tr = repo.transaction('histedit') | ||||
marks = repo._bookmarks | ||||
for mark, new in moves: | ||||
old = marks[mark] | ||||
ui.note(_('histedit: moving bookmarks %s from %s to %s\n') | ||||
% (mark, node.short(old), node.short(new))) | ||||
marks[mark] = new | ||||
marks.recordchange(tr) | ||||
tr.close() | ||||
finally: | ||||
release(tr, lock) | ||||
|
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]))) | ||||
|
r27833 | with repo.lock(): | ||
|
r25906 | # do not let filtering get in the way of the cleanse | ||
|
r26203 | # we should probably get rid of obsolescence marker created during the | ||
|
r25906 | # histedit, but we currently do not have such information. | ||
repo = repo.unfiltered() | ||||
|
r26171 | # Find all nodes that need to be stripped | ||
# (we use %lr instead of %ln to silently ignore unknown items) | ||||
|
r17664 | 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) | ||||
|
r19215 | |||
|
r31525 | def safecleanupnode(ui, repo, name, nodes): | ||
"""strip or obsolete nodes | ||||
nodes could be either a set or dict which maps to replacements. | ||||
nodes could be unknown (outside the repo). | ||||
""" | ||||
supportsmarkers = obsolete.isenabled(repo, obsolete.createmarkersopt) | ||||
if supportsmarkers: | ||||
if util.safehasattr(nodes, 'get'): | ||||
# nodes is a dict-like mapping | ||||
# use unfiltered repo for successors in case they are hidden | ||||
urepo = repo.unfiltered() | ||||
def getmarker(prec): | ||||
succs = tuple(urepo[n] for n in nodes.get(prec, ())) | ||||
return (repo[prec], succs) | ||||
else: | ||||
# nodes is a set-like | ||||
def getmarker(prec): | ||||
return (repo[prec], ()) | ||||
# sort by revision number because it sound "right" | ||||
sortednodes = sorted([n for n in nodes if n in repo], | ||||
key=repo.changelog.rev) | ||||
markers = [getmarker(t) for t in sortednodes] | ||||
if markers: | ||||
obsolete.createmarkers(repo, markers) | ||||
else: | ||||
return cleanupnode(ui, repo, name, nodes) | ||||
|
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() | ||||
|
r29874 | histedit_nodes = set([action.node for action | ||
in state.actions if action.node]) | ||||
|
r30025 | common_nodes = histedit_nodes & set(nodelist) | ||
|
r24111 | if common_nodes: | ||
|
r26587 | raise error.Abort(_("histedit in progress, can't strip %s") | ||
|
r24196 | % ', '.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): | ||
|
r31329 | if not os.path.exists(repo.vfs.join('histedit-state')): | ||
|
r19215 | return | ||
|
r22983 | state = histeditstate(repo) | ||
state.read() | ||||
|
r27207 | if state.actions: | ||
|
r19215 | # i18n: column positioning for "hg summary" | ||
ui.write(_('hist: %s (histedit --continue)\n') % | ||||
(ui.label(_('%d remaining'), 'histedit.remaining') % | ||||
|
r27207 | len(state.actions))) | ||
|
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'")]) | ||
|
r27627 | cmdutil.afterresolvedstates.append( | ||
['histedit-state', _('hg histedit --continue')]) | ||||
|
r27085 | if ui.configbool("experimental", "histeditng"): | ||
|
r27675 | globals()['base'] = action(['base', 'b'], | ||
_('checkout changeset and apply further changesets from there') | ||||
)(base) | ||||