##// END OF EJS Templates
histedit: remove superfluous echo() and endwin() calls (issue6859)...
Julien Cristau -
r52067:e306d552 stable
parent child Browse files
Show More
@@ -1,2681 +1,2679 b''
1 1 # histedit.py - interactive history editing for mercurial
2 2 #
3 3 # Copyright 2009 Augie Fackler <raf@durin42.com>
4 4 #
5 5 # This software may be used and distributed according to the terms of the
6 6 # GNU General Public License version 2 or any later version.
7 7 """interactive history editing
8 8
9 9 With this extension installed, Mercurial gains one new command: histedit. Usage
10 10 is as follows, assuming the following history::
11 11
12 12 @ 3[tip] 7c2fd3b9020c 2009-04-27 18:04 -0500 durin42
13 13 | Add delta
14 14 |
15 15 o 2 030b686bedc4 2009-04-27 18:04 -0500 durin42
16 16 | Add gamma
17 17 |
18 18 o 1 c561b4e977df 2009-04-27 18:04 -0500 durin42
19 19 | Add beta
20 20 |
21 21 o 0 d8d2fcd0e319 2009-04-27 18:04 -0500 durin42
22 22 Add alpha
23 23
24 24 If you were to run ``hg histedit c561b4e977df``, you would see the following
25 25 file open in your editor::
26 26
27 27 pick c561b4e977df Add beta
28 28 pick 030b686bedc4 Add gamma
29 29 pick 7c2fd3b9020c Add delta
30 30
31 31 # Edit history between c561b4e977df and 7c2fd3b9020c
32 32 #
33 33 # Commits are listed from least to most recent
34 34 #
35 35 # Commands:
36 36 # p, pick = use commit
37 37 # e, edit = use commit, but allow edits before making new commit
38 38 # f, fold = use commit, but combine it with the one above
39 39 # r, roll = like fold, but discard this commit's description and date
40 40 # d, drop = remove commit from history
41 41 # m, mess = edit commit message without changing commit content
42 42 # b, base = checkout changeset and apply further changesets from there
43 43 #
44 44
45 45 In this file, lines beginning with ``#`` are ignored. You must specify a rule
46 46 for each revision in your history. For example, if you had meant to add gamma
47 47 before beta, and then wanted to add delta in the same revision as beta, you
48 48 would reorganize the file to look like this::
49 49
50 50 pick 030b686bedc4 Add gamma
51 51 pick c561b4e977df Add beta
52 52 fold 7c2fd3b9020c Add delta
53 53
54 54 # Edit history between c561b4e977df and 7c2fd3b9020c
55 55 #
56 56 # Commits are listed from least to most recent
57 57 #
58 58 # Commands:
59 59 # p, pick = use commit
60 60 # e, edit = use commit, but allow edits before making new commit
61 61 # f, fold = use commit, but combine it with the one above
62 62 # r, roll = like fold, but discard this commit's description and date
63 63 # d, drop = remove commit from history
64 64 # m, mess = edit commit message without changing commit content
65 65 # b, base = checkout changeset and apply further changesets from there
66 66 #
67 67
68 68 At which point you close the editor and ``histedit`` starts working. When you
69 69 specify a ``fold`` operation, ``histedit`` will open an editor when it folds
70 70 those revisions together, offering you a chance to clean up the commit message::
71 71
72 72 Add beta
73 73 ***
74 74 Add delta
75 75
76 76 Edit the commit message to your liking, then close the editor. The date used
77 77 for the commit will be the later of the two commits' dates. For this example,
78 78 let's assume that the commit message was changed to ``Add beta and delta.``
79 79 After histedit has run and had a chance to remove any old or temporary
80 80 revisions it needed, the history looks like this::
81 81
82 82 @ 2[tip] 989b4d060121 2009-04-27 18:04 -0500 durin42
83 83 | Add beta and delta.
84 84 |
85 85 o 1 081603921c3f 2009-04-27 18:04 -0500 durin42
86 86 | Add gamma
87 87 |
88 88 o 0 d8d2fcd0e319 2009-04-27 18:04 -0500 durin42
89 89 Add alpha
90 90
91 91 Note that ``histedit`` does *not* remove any revisions (even its own temporary
92 92 ones) until after it has completed all the editing operations, so it will
93 93 probably perform several strip operations when it's done. For the above example,
94 94 it had to run strip twice. Strip can be slow depending on a variety of factors,
95 95 so you might need to be a little patient. You can choose to keep the original
96 96 revisions by passing the ``--keep`` flag.
97 97
98 98 The ``edit`` operation will drop you back to a command prompt,
99 99 allowing you to edit files freely, or even use ``hg record`` to commit
100 100 some changes as a separate commit. When you're done, any remaining
101 101 uncommitted changes will be committed as well. When done, run ``hg
102 102 histedit --continue`` to finish this step. If there are uncommitted
103 103 changes, you'll be prompted for a new commit message, but the default
104 104 commit message will be the original message for the ``edit`` ed
105 105 revision, and the date of the original commit will be preserved.
106 106
107 107 The ``message`` operation will give you a chance to revise a commit
108 108 message without changing the contents. It's a shortcut for doing
109 109 ``edit`` immediately followed by `hg histedit --continue``.
110 110
111 111 If ``histedit`` encounters a conflict when moving a revision (while
112 112 handling ``pick`` or ``fold``), it'll stop in a similar manner to
113 113 ``edit`` with the difference that it won't prompt you for a commit
114 114 message when done. If you decide at this point that you don't like how
115 115 much work it will be to rearrange history, or that you made a mistake,
116 116 you can use ``hg histedit --abort`` to abandon the new changes you
117 117 have made and return to the state before you attempted to edit your
118 118 history.
119 119
120 120 If we clone the histedit-ed example repository above and add four more
121 121 changes, such that we have the following history::
122 122
123 123 @ 6[tip] 038383181893 2009-04-27 18:04 -0500 stefan
124 124 | Add theta
125 125 |
126 126 o 5 140988835471 2009-04-27 18:04 -0500 stefan
127 127 | Add eta
128 128 |
129 129 o 4 122930637314 2009-04-27 18:04 -0500 stefan
130 130 | Add zeta
131 131 |
132 132 o 3 836302820282 2009-04-27 18:04 -0500 stefan
133 133 | Add epsilon
134 134 |
135 135 o 2 989b4d060121 2009-04-27 18:04 -0500 durin42
136 136 | Add beta and delta.
137 137 |
138 138 o 1 081603921c3f 2009-04-27 18:04 -0500 durin42
139 139 | Add gamma
140 140 |
141 141 o 0 d8d2fcd0e319 2009-04-27 18:04 -0500 durin42
142 142 Add alpha
143 143
144 144 If you run ``hg histedit --outgoing`` on the clone then it is the same
145 145 as running ``hg histedit 836302820282``. If you need plan to push to a
146 146 repository that Mercurial does not detect to be related to the source
147 147 repo, you can add a ``--force`` option.
148 148
149 149 Config
150 150 ------
151 151
152 152 Histedit rule lines are truncated to 80 characters by default. You
153 153 can customize this behavior by setting a different length in your
154 154 configuration file::
155 155
156 156 [histedit]
157 157 linelen = 120 # truncate rule lines at 120 characters
158 158
159 159 The summary of a change can be customized as well::
160 160
161 161 [histedit]
162 162 summary-template = '{rev} {bookmarks} {desc|firstline}'
163 163
164 164 The customized summary should be kept short enough that rule lines
165 165 will fit in the configured line length. See above if that requires
166 166 customization.
167 167
168 168 ``hg histedit`` attempts to automatically choose an appropriate base
169 169 revision to use. To change which base revision is used, define a
170 170 revset in your configuration file::
171 171
172 172 [histedit]
173 173 defaultrev = only(.) & draft()
174 174
175 175 By default each edited revision needs to be present in histedit commands.
176 176 To remove revision you need to use ``drop`` operation. You can configure
177 177 the drop to be implicit for missing commits by adding::
178 178
179 179 [histedit]
180 180 dropmissing = True
181 181
182 182 By default, histedit will close the transaction after each action. For
183 183 performance purposes, you can configure histedit to use a single transaction
184 184 across the entire histedit. WARNING: This setting introduces a significant risk
185 185 of losing the work you've done in a histedit if the histedit aborts
186 186 unexpectedly::
187 187
188 188 [histedit]
189 189 singletransaction = True
190 190
191 191 """
192 192
193 193
194 194 # chistedit dependencies that are not available everywhere
195 195 try:
196 196 import fcntl
197 197 import termios
198 198 except ImportError:
199 199 fcntl = None
200 200 termios = None
201 201
202 202 import binascii
203 203 import functools
204 204 import os
205 205 import pickle
206 206 import struct
207 207
208 208 from mercurial.i18n import _
209 209 from mercurial.pycompat import (
210 210 open,
211 211 )
212 212 from mercurial.node import (
213 213 bin,
214 214 hex,
215 215 short,
216 216 )
217 217 from mercurial import (
218 218 bundle2,
219 219 cmdutil,
220 220 context,
221 221 copies,
222 222 destutil,
223 223 discovery,
224 224 encoding,
225 225 error,
226 226 exchange,
227 227 extensions,
228 228 hg,
229 229 logcmdutil,
230 230 merge as mergemod,
231 231 mergestate as mergestatemod,
232 232 mergeutil,
233 233 obsolete,
234 234 pycompat,
235 235 registrar,
236 236 repair,
237 237 rewriteutil,
238 238 scmutil,
239 239 state as statemod,
240 240 util,
241 241 )
242 242 from mercurial.utils import (
243 243 dateutil,
244 244 stringutil,
245 245 urlutil,
246 246 )
247 247
248 248 cmdtable = {}
249 249 command = registrar.command(cmdtable)
250 250
251 251 configtable = {}
252 252 configitem = registrar.configitem(configtable)
253 253 configitem(
254 254 b'experimental',
255 255 b'histedit.autoverb',
256 256 default=False,
257 257 )
258 258 configitem(
259 259 b'histedit',
260 260 b'defaultrev',
261 261 default=None,
262 262 )
263 263 configitem(
264 264 b'histedit',
265 265 b'dropmissing',
266 266 default=False,
267 267 )
268 268 configitem(
269 269 b'histedit',
270 270 b'linelen',
271 271 default=80,
272 272 )
273 273 configitem(
274 274 b'histedit',
275 275 b'singletransaction',
276 276 default=False,
277 277 )
278 278 configitem(
279 279 b'ui',
280 280 b'interface.histedit',
281 281 default=None,
282 282 )
283 283 configitem(b'histedit', b'summary-template', default=b'{rev} {desc|firstline}')
284 284 # TODO: Teach the text-based histedit interface to respect this config option
285 285 # before we make it non-experimental.
286 286 configitem(
287 287 b'histedit', b'later-commits-first', default=False, experimental=True
288 288 )
289 289
290 290 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
291 291 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
292 292 # be specifying the version(s) of Mercurial they are tested with, or
293 293 # leave the attribute unspecified.
294 294 testedwith = b'ships-with-hg-core'
295 295
296 296 actiontable = {}
297 297 primaryactions = set()
298 298 secondaryactions = set()
299 299 tertiaryactions = set()
300 300 internalactions = set()
301 301
302 302
303 303 def geteditcomment(ui, first, last):
304 304 """construct the editor comment
305 305 The comment includes::
306 306 - an intro
307 307 - sorted primary commands
308 308 - sorted short commands
309 309 - sorted long commands
310 310 - additional hints
311 311
312 312 Commands are only included once.
313 313 """
314 314 intro = _(
315 315 b"""Edit history between %s and %s
316 316
317 317 Commits are listed from least to most recent
318 318
319 319 You can reorder changesets by reordering the lines
320 320
321 321 Commands:
322 322 """
323 323 )
324 324 actions = []
325 325
326 326 def addverb(v):
327 327 a = actiontable[v]
328 328 lines = a.message.split(b"\n")
329 329 if len(a.verbs):
330 330 v = b', '.join(sorted(a.verbs, key=lambda v: len(v)))
331 331 actions.append(b" %s = %s" % (v, lines[0]))
332 332 actions.extend([b' %s'] * (len(lines) - 1))
333 333
334 334 for v in (
335 335 sorted(primaryactions)
336 336 + sorted(secondaryactions)
337 337 + sorted(tertiaryactions)
338 338 ):
339 339 addverb(v)
340 340 actions.append(b'')
341 341
342 342 hints = []
343 343 if ui.configbool(b'histedit', b'dropmissing'):
344 344 hints.append(
345 345 b"Deleting a changeset from the list "
346 346 b"will DISCARD it from the edited history!"
347 347 )
348 348
349 349 lines = (intro % (first, last)).split(b'\n') + actions + hints
350 350
351 351 return b''.join([b'# %s\n' % l if l else b'#\n' for l in lines])
352 352
353 353
354 354 class histeditstate:
355 355 def __init__(self, repo):
356 356 self.repo = repo
357 357 self.actions = None
358 358 self.keep = None
359 359 self.topmost = None
360 360 self.parentctxnode = None
361 361 self.lock = None
362 362 self.wlock = None
363 363 self.backupfile = None
364 364 self.stateobj = statemod.cmdstate(repo, b'histedit-state')
365 365 self.replacements = []
366 366
367 367 def read(self):
368 368 """Load histedit state from disk and set fields appropriately."""
369 369 if not self.stateobj.exists():
370 370 cmdutil.wrongtooltocontinue(self.repo, _(b'histedit'))
371 371
372 372 data = self._read()
373 373
374 374 self.parentctxnode = data[b'parentctxnode']
375 375 actions = parserules(data[b'rules'], self)
376 376 self.actions = actions
377 377 self.keep = data[b'keep']
378 378 self.topmost = data[b'topmost']
379 379 self.replacements = data[b'replacements']
380 380 self.backupfile = data[b'backupfile']
381 381
382 382 def _read(self):
383 383 fp = self.repo.vfs.read(b'histedit-state')
384 384 if fp.startswith(b'v1\n'):
385 385 data = self._load()
386 386 parentctxnode, rules, keep, topmost, replacements, backupfile = data
387 387 else:
388 388 data = pickle.loads(fp)
389 389 parentctxnode, rules, keep, topmost, replacements = data
390 390 backupfile = None
391 391 rules = b"\n".join([b"%s %s" % (verb, rest) for [verb, rest] in rules])
392 392
393 393 return {
394 394 b'parentctxnode': parentctxnode,
395 395 b"rules": rules,
396 396 b"keep": keep,
397 397 b"topmost": topmost,
398 398 b"replacements": replacements,
399 399 b"backupfile": backupfile,
400 400 }
401 401
402 402 def write(self, tr=None):
403 403 if tr:
404 404 tr.addfilegenerator(
405 405 b'histedit-state',
406 406 (b'histedit-state',),
407 407 self._write,
408 408 location=b'plain',
409 409 )
410 410 else:
411 411 with self.repo.vfs(b"histedit-state", b"w") as f:
412 412 self._write(f)
413 413
414 414 def _write(self, fp):
415 415 fp.write(b'v1\n')
416 416 fp.write(b'%s\n' % hex(self.parentctxnode))
417 417 fp.write(b'%s\n' % hex(self.topmost))
418 418 fp.write(b'%s\n' % (b'True' if self.keep else b'False'))
419 419 fp.write(b'%d\n' % len(self.actions))
420 420 for action in self.actions:
421 421 fp.write(b'%s\n' % action.tostate())
422 422 fp.write(b'%d\n' % len(self.replacements))
423 423 for replacement in self.replacements:
424 424 fp.write(
425 425 b'%s%s\n'
426 426 % (
427 427 hex(replacement[0]),
428 428 b''.join(hex(r) for r in replacement[1]),
429 429 )
430 430 )
431 431 backupfile = self.backupfile
432 432 if not backupfile:
433 433 backupfile = b''
434 434 fp.write(b'%s\n' % backupfile)
435 435
436 436 def _load(self):
437 437 fp = self.repo.vfs(b'histedit-state', b'r')
438 438 lines = [l[:-1] for l in fp.readlines()]
439 439
440 440 index = 0
441 441 lines[index] # version number
442 442 index += 1
443 443
444 444 parentctxnode = bin(lines[index])
445 445 index += 1
446 446
447 447 topmost = bin(lines[index])
448 448 index += 1
449 449
450 450 keep = lines[index] == b'True'
451 451 index += 1
452 452
453 453 # Rules
454 454 rules = []
455 455 rulelen = int(lines[index])
456 456 index += 1
457 457 for i in range(rulelen):
458 458 ruleaction = lines[index]
459 459 index += 1
460 460 rule = lines[index]
461 461 index += 1
462 462 rules.append((ruleaction, rule))
463 463
464 464 # Replacements
465 465 replacements = []
466 466 replacementlen = int(lines[index])
467 467 index += 1
468 468 for i in range(replacementlen):
469 469 replacement = lines[index]
470 470 original = bin(replacement[:40])
471 471 succ = [
472 472 bin(replacement[i : i + 40])
473 473 for i in range(40, len(replacement), 40)
474 474 ]
475 475 replacements.append((original, succ))
476 476 index += 1
477 477
478 478 backupfile = lines[index]
479 479 index += 1
480 480
481 481 fp.close()
482 482
483 483 return parentctxnode, rules, keep, topmost, replacements, backupfile
484 484
485 485 def clear(self):
486 486 if self.inprogress():
487 487 self.repo.vfs.unlink(b'histedit-state')
488 488
489 489 def inprogress(self):
490 490 return self.repo.vfs.exists(b'histedit-state')
491 491
492 492
493 493 class histeditaction:
494 494 def __init__(self, state, node):
495 495 self.state = state
496 496 self.repo = state.repo
497 497 self.node = node
498 498
499 499 @classmethod
500 500 def fromrule(cls, state, rule):
501 501 """Parses the given rule, returning an instance of the histeditaction."""
502 502 ruleid = rule.strip().split(b' ', 1)[0]
503 503 # ruleid can be anything from rev numbers, hashes, "bookmarks" etc
504 504 # Check for validation of rule ids and get the rulehash
505 505 try:
506 506 rev = bin(ruleid)
507 507 except binascii.Error:
508 508 try:
509 509 _ctx = scmutil.revsingle(state.repo, ruleid)
510 510 rulehash = _ctx.hex()
511 511 rev = bin(rulehash)
512 512 except error.RepoLookupError:
513 513 raise error.ParseError(_(b"invalid changeset %s") % ruleid)
514 514 return cls(state, rev)
515 515
516 516 def verify(self, prev, expected, seen):
517 517 """Verifies semantic correctness of the rule"""
518 518 repo = self.repo
519 519 ha = hex(self.node)
520 520 self.node = scmutil.resolvehexnodeidprefix(repo, ha)
521 521 if self.node is None:
522 522 raise error.ParseError(_(b'unknown changeset %s listed') % ha[:12])
523 523 self._verifynodeconstraints(prev, expected, seen)
524 524
525 525 def _verifynodeconstraints(self, prev, expected, seen):
526 526 # by default command need a node in the edited list
527 527 if self.node not in expected:
528 528 raise error.ParseError(
529 529 _(b'%s "%s" changeset was not a candidate')
530 530 % (self.verb, short(self.node)),
531 531 hint=_(b'only use listed changesets'),
532 532 )
533 533 # and only one command per node
534 534 if self.node in seen:
535 535 raise error.ParseError(
536 536 _(b'duplicated command for changeset %s') % short(self.node)
537 537 )
538 538
539 539 def torule(self):
540 540 """build a histedit rule line for an action
541 541
542 542 by default lines are in the form:
543 543 <hash> <rev> <summary>
544 544 """
545 545 ctx = self.repo[self.node]
546 546 ui = self.repo.ui
547 547 # We don't want color codes in the commit message template, so
548 548 # disable the label() template function while we render it.
549 549 with ui.configoverride(
550 550 {(b'templatealias', b'label(l,x)'): b"x"}, b'histedit'
551 551 ):
552 552 summary = cmdutil.rendertemplate(
553 553 ctx, ui.config(b'histedit', b'summary-template')
554 554 )
555 555 line = b'%s %s %s' % (self.verb, ctx, stringutil.firstline(summary))
556 556 # trim to 75 columns by default so it's not stupidly wide in my editor
557 557 # (the 5 more are left for verb)
558 558 maxlen = self.repo.ui.configint(b'histedit', b'linelen')
559 559 maxlen = max(maxlen, 22) # avoid truncating hash
560 560 return stringutil.ellipsis(line, maxlen)
561 561
562 562 def tostate(self):
563 563 """Print an action in format used by histedit state files
564 564 (the first line is a verb, the remainder is the second)
565 565 """
566 566 return b"%s\n%s" % (self.verb, hex(self.node))
567 567
568 568 def run(self):
569 569 """Runs the action. The default behavior is simply apply the action's
570 570 rulectx onto the current parentctx."""
571 571 self.applychange()
572 572 self.continuedirty()
573 573 return self.continueclean()
574 574
575 575 def applychange(self):
576 576 """Applies the changes from this action's rulectx onto the current
577 577 parentctx, but does not commit them."""
578 578 repo = self.repo
579 579 rulectx = repo[self.node]
580 580 with repo.ui.silent():
581 581 hg.update(repo, self.state.parentctxnode, quietempty=True)
582 582 stats = applychanges(repo.ui, repo, rulectx, {})
583 583 repo.dirstate.setbranch(rulectx.branch(), repo.currenttransaction())
584 584 if stats.unresolvedcount:
585 585 raise error.InterventionRequired(
586 586 _(b'Fix up the change (%s %s)') % (self.verb, short(self.node)),
587 587 hint=_(b'hg histedit --continue to resume'),
588 588 )
589 589
590 590 def continuedirty(self):
591 591 """Continues the action when changes have been applied to the working
592 592 copy. The default behavior is to commit the dirty changes."""
593 593 repo = self.repo
594 594 rulectx = repo[self.node]
595 595
596 596 editor = self.commiteditor()
597 597 commit = commitfuncfor(repo, rulectx)
598 598 if repo.ui.configbool(b'rewrite', b'update-timestamp'):
599 599 date = dateutil.makedate()
600 600 else:
601 601 date = rulectx.date()
602 602 commit(
603 603 text=rulectx.description(),
604 604 user=rulectx.user(),
605 605 date=date,
606 606 extra=rulectx.extra(),
607 607 editor=editor,
608 608 )
609 609
610 610 def commiteditor(self):
611 611 """The editor to be used to edit the commit message."""
612 612 return False
613 613
614 614 def continueclean(self):
615 615 """Continues the action when the working copy is clean. The default
616 616 behavior is to accept the current commit as the new version of the
617 617 rulectx."""
618 618 ctx = self.repo[b'.']
619 619 if ctx.node() == self.state.parentctxnode:
620 620 self.repo.ui.warn(
621 621 _(b'%s: skipping changeset (no changes)\n') % short(self.node)
622 622 )
623 623 return ctx, [(self.node, tuple())]
624 624 if ctx.node() == self.node:
625 625 # Nothing changed
626 626 return ctx, []
627 627 return ctx, [(self.node, (ctx.node(),))]
628 628
629 629
630 630 def commitfuncfor(repo, src):
631 631 """Build a commit function for the replacement of <src>
632 632
633 633 This function ensure we apply the same treatment to all changesets.
634 634
635 635 - Add a 'histedit_source' entry in extra.
636 636
637 637 Note that fold has its own separated logic because its handling is a bit
638 638 different and not easily factored out of the fold method.
639 639 """
640 640 phasemin = src.phase()
641 641
642 642 def commitfunc(**kwargs):
643 643 overrides = {(b'phases', b'new-commit'): phasemin}
644 644 with repo.ui.configoverride(overrides, b'histedit'):
645 645 extra = kwargs.get('extra', {}).copy()
646 646 extra[b'histedit_source'] = src.hex()
647 647 kwargs['extra'] = extra
648 648 return repo.commit(**kwargs)
649 649
650 650 return commitfunc
651 651
652 652
653 653 def applychanges(ui, repo, ctx, opts):
654 654 """Merge changeset from ctx (only) in the current working directory"""
655 655 if ctx.p1().node() == repo.dirstate.p1():
656 656 # edits are "in place" we do not need to make any merge,
657 657 # just applies changes on parent for editing
658 658 with ui.silent():
659 659 cmdutil.revert(ui, repo, ctx, all=True)
660 660 stats = mergemod.updateresult(0, 0, 0, 0)
661 661 else:
662 662 try:
663 663 # ui.forcemerge is an internal variable, do not document
664 664 repo.ui.setconfig(
665 665 b'ui', b'forcemerge', opts.get(b'tool', b''), b'histedit'
666 666 )
667 667 stats = mergemod.graft(
668 668 repo,
669 669 ctx,
670 670 labels=[
671 671 b'already edited',
672 672 b'current change',
673 673 b'parent of current change',
674 674 ],
675 675 )
676 676 finally:
677 677 repo.ui.setconfig(b'ui', b'forcemerge', b'', b'histedit')
678 678 return stats
679 679
680 680
681 681 def collapse(repo, firstctx, lastctx, commitopts, skipprompt=False):
682 682 """collapse the set of revisions from first to last as new one.
683 683
684 684 Expected commit options are:
685 685 - message
686 686 - date
687 687 - username
688 688 Commit message is edited in all cases.
689 689
690 690 This function works in memory."""
691 691 ctxs = list(repo.set(b'%d::%d', firstctx.rev(), lastctx.rev()))
692 692 if not ctxs:
693 693 return None
694 694 for c in ctxs:
695 695 if not c.mutable():
696 696 raise error.ParseError(
697 697 _(b"cannot fold into public change %s") % short(c.node())
698 698 )
699 699 base = firstctx.p1()
700 700
701 701 # commit a new version of the old changeset, including the update
702 702 # collect all files which might be affected
703 703 files = set()
704 704 for ctx in ctxs:
705 705 files.update(ctx.files())
706 706
707 707 # Recompute copies (avoid recording a -> b -> a)
708 708 copied = copies.pathcopies(base, lastctx)
709 709
710 710 # prune files which were reverted by the updates
711 711 files = [f for f in files if not cmdutil.samefile(f, lastctx, base)]
712 712 # commit version of these files as defined by head
713 713 headmf = lastctx.manifest()
714 714
715 715 def filectxfn(repo, ctx, path):
716 716 if path in headmf:
717 717 fctx = lastctx[path]
718 718 flags = fctx.flags()
719 719 mctx = context.memfilectx(
720 720 repo,
721 721 ctx,
722 722 fctx.path(),
723 723 fctx.data(),
724 724 islink=b'l' in flags,
725 725 isexec=b'x' in flags,
726 726 copysource=copied.get(path),
727 727 )
728 728 return mctx
729 729 return None
730 730
731 731 if commitopts.get(b'message'):
732 732 message = commitopts[b'message']
733 733 else:
734 734 message = firstctx.description()
735 735 user = commitopts.get(b'user')
736 736 date = commitopts.get(b'date')
737 737 extra = commitopts.get(b'extra')
738 738
739 739 parents = (firstctx.p1().node(), firstctx.p2().node())
740 740 editor = None
741 741 if not skipprompt:
742 742 editor = cmdutil.getcommiteditor(edit=True, editform=b'histedit.fold')
743 743 new = context.memctx(
744 744 repo,
745 745 parents=parents,
746 746 text=message,
747 747 files=files,
748 748 filectxfn=filectxfn,
749 749 user=user,
750 750 date=date,
751 751 extra=extra,
752 752 editor=editor,
753 753 )
754 754 return repo.commitctx(new)
755 755
756 756
757 757 def _isdirtywc(repo):
758 758 return repo[None].dirty(missing=True)
759 759
760 760
761 761 def abortdirty():
762 762 raise error.StateError(
763 763 _(b'working copy has pending changes'),
764 764 hint=_(
765 765 b'amend, commit, or revert them and run histedit '
766 766 b'--continue, or abort with histedit --abort'
767 767 ),
768 768 )
769 769
770 770
771 771 def action(verbs, message, priority=False, internal=False):
772 772 def wrap(cls):
773 773 assert not priority or not internal
774 774 verb = verbs[0]
775 775 if priority:
776 776 primaryactions.add(verb)
777 777 elif internal:
778 778 internalactions.add(verb)
779 779 elif len(verbs) > 1:
780 780 secondaryactions.add(verb)
781 781 else:
782 782 tertiaryactions.add(verb)
783 783
784 784 cls.verb = verb
785 785 cls.verbs = verbs
786 786 cls.message = message
787 787 for verb in verbs:
788 788 actiontable[verb] = cls
789 789 return cls
790 790
791 791 return wrap
792 792
793 793
794 794 @action([b'pick', b'p'], _(b'use commit'), priority=True)
795 795 class pick(histeditaction):
796 796 def run(self):
797 797 rulectx = self.repo[self.node]
798 798 if rulectx.p1().node() == self.state.parentctxnode:
799 799 self.repo.ui.debug(b'node %s unchanged\n' % short(self.node))
800 800 return rulectx, []
801 801
802 802 return super(pick, self).run()
803 803
804 804
805 805 @action(
806 806 [b'edit', b'e'],
807 807 _(b'use commit, but allow edits before making new commit'),
808 808 priority=True,
809 809 )
810 810 class edit(histeditaction):
811 811 def run(self):
812 812 repo = self.repo
813 813 rulectx = repo[self.node]
814 814 hg.update(repo, self.state.parentctxnode, quietempty=True)
815 815 applychanges(repo.ui, repo, rulectx, {})
816 816 hint = _(b'to edit %s, `hg histedit --continue` after making changes')
817 817 raise error.InterventionRequired(
818 818 _(b'Editing (%s), commit as needed now to split the change')
819 819 % short(self.node),
820 820 hint=hint % short(self.node),
821 821 )
822 822
823 823 def commiteditor(self):
824 824 return cmdutil.getcommiteditor(edit=True, editform=b'histedit.edit')
825 825
826 826
827 827 @action([b'fold', b'f'], _(b'use commit, but combine it with the one above'))
828 828 class fold(histeditaction):
829 829 def verify(self, prev, expected, seen):
830 830 """Verifies semantic correctness of the fold rule"""
831 831 super(fold, self).verify(prev, expected, seen)
832 832 repo = self.repo
833 833 if not prev:
834 834 c = repo[self.node].p1()
835 835 elif not prev.verb in (b'pick', b'base'):
836 836 return
837 837 else:
838 838 c = repo[prev.node]
839 839 if not c.mutable():
840 840 raise error.ParseError(
841 841 _(b"cannot fold into public change %s") % short(c.node())
842 842 )
843 843
844 844 def continuedirty(self):
845 845 repo = self.repo
846 846 rulectx = repo[self.node]
847 847
848 848 commit = commitfuncfor(repo, rulectx)
849 849 commit(
850 850 text=b'fold-temp-revision %s' % short(self.node),
851 851 user=rulectx.user(),
852 852 date=rulectx.date(),
853 853 extra=rulectx.extra(),
854 854 )
855 855
856 856 def continueclean(self):
857 857 repo = self.repo
858 858 ctx = repo[b'.']
859 859 rulectx = repo[self.node]
860 860 parentctxnode = self.state.parentctxnode
861 861 if ctx.node() == parentctxnode:
862 862 repo.ui.warn(_(b'%s: empty changeset\n') % short(self.node))
863 863 return ctx, [(self.node, (parentctxnode,))]
864 864
865 865 parentctx = repo[parentctxnode]
866 866 newcommits = {
867 867 c.node()
868 868 for c in repo.set(b'(%d::. - %d)', parentctx.rev(), parentctx.rev())
869 869 }
870 870 if not newcommits:
871 871 repo.ui.warn(
872 872 _(
873 873 b'%s: cannot fold - working copy is not a '
874 874 b'descendant of previous commit %s\n'
875 875 )
876 876 % (short(self.node), short(parentctxnode))
877 877 )
878 878 return ctx, [(self.node, (ctx.node(),))]
879 879
880 880 middlecommits = newcommits.copy()
881 881 middlecommits.discard(ctx.node())
882 882
883 883 return self.finishfold(
884 884 repo.ui, repo, parentctx, rulectx, ctx.node(), middlecommits
885 885 )
886 886
887 887 def skipprompt(self):
888 888 """Returns true if the rule should skip the message editor.
889 889
890 890 For example, 'fold' wants to show an editor, but 'rollup'
891 891 doesn't want to.
892 892 """
893 893 return False
894 894
895 895 def mergedescs(self):
896 896 """Returns true if the rule should merge messages of multiple changes.
897 897
898 898 This exists mainly so that 'rollup' rules can be a subclass of
899 899 'fold'.
900 900 """
901 901 return True
902 902
903 903 def firstdate(self):
904 904 """Returns true if the rule should preserve the date of the first
905 905 change.
906 906
907 907 This exists mainly so that 'rollup' rules can be a subclass of
908 908 'fold'.
909 909 """
910 910 return False
911 911
912 912 def finishfold(self, ui, repo, ctx, oldctx, newnode, internalchanges):
913 913 mergemod.update(ctx.p1())
914 914 ### prepare new commit data
915 915 commitopts = {}
916 916 commitopts[b'user'] = ctx.user()
917 917 # commit message
918 918 if not self.mergedescs():
919 919 newmessage = ctx.description()
920 920 else:
921 921 newmessage = (
922 922 b'\n***\n'.join(
923 923 [ctx.description()]
924 924 + [repo[r].description() for r in internalchanges]
925 925 + [oldctx.description()]
926 926 )
927 927 + b'\n'
928 928 )
929 929 commitopts[b'message'] = newmessage
930 930 # date
931 931 if self.firstdate():
932 932 commitopts[b'date'] = ctx.date()
933 933 else:
934 934 commitopts[b'date'] = max(ctx.date(), oldctx.date())
935 935 # if date is to be updated to current
936 936 if ui.configbool(b'rewrite', b'update-timestamp'):
937 937 commitopts[b'date'] = dateutil.makedate()
938 938
939 939 extra = ctx.extra().copy()
940 940 # histedit_source
941 941 # note: ctx is likely a temporary commit but that the best we can do
942 942 # here. This is sufficient to solve issue3681 anyway.
943 943 extra[b'histedit_source'] = b'%s,%s' % (ctx.hex(), oldctx.hex())
944 944 commitopts[b'extra'] = extra
945 945 phasemin = max(ctx.phase(), oldctx.phase())
946 946 overrides = {(b'phases', b'new-commit'): phasemin}
947 947 with repo.ui.configoverride(overrides, b'histedit'):
948 948 n = collapse(
949 949 repo,
950 950 ctx,
951 951 repo[newnode],
952 952 commitopts,
953 953 skipprompt=self.skipprompt(),
954 954 )
955 955 if n is None:
956 956 return ctx, []
957 957 mergemod.update(repo[n])
958 958 replacements = [
959 959 (oldctx.node(), (newnode,)),
960 960 (ctx.node(), (n,)),
961 961 (newnode, (n,)),
962 962 ]
963 963 for ich in internalchanges:
964 964 replacements.append((ich, (n,)))
965 965 return repo[n], replacements
966 966
967 967
968 968 @action(
969 969 [b'base', b'b'],
970 970 _(b'checkout changeset and apply further changesets from there'),
971 971 )
972 972 class base(histeditaction):
973 973 def run(self):
974 974 if self.repo[b'.'].node() != self.node:
975 975 mergemod.clean_update(self.repo[self.node])
976 976 return self.continueclean()
977 977
978 978 def continuedirty(self):
979 979 abortdirty()
980 980
981 981 def continueclean(self):
982 982 basectx = self.repo[b'.']
983 983 return basectx, []
984 984
985 985 def _verifynodeconstraints(self, prev, expected, seen):
986 986 # base can only be use with a node not in the edited set
987 987 if self.node in expected:
988 988 msg = _(b'%s "%s" changeset was an edited list candidate')
989 989 raise error.ParseError(
990 990 msg % (self.verb, short(self.node)),
991 991 hint=_(b'base must only use unlisted changesets'),
992 992 )
993 993
994 994
995 995 @action(
996 996 [b'_multifold'],
997 997 _(
998 998 b"""fold subclass used for when multiple folds happen in a row
999 999
1000 1000 We only want to fire the editor for the folded message once when
1001 1001 (say) four changes are folded down into a single change. This is
1002 1002 similar to rollup, but we should preserve both messages so that
1003 1003 when the last fold operation runs we can show the user all the
1004 1004 commit messages in their editor.
1005 1005 """
1006 1006 ),
1007 1007 internal=True,
1008 1008 )
1009 1009 class _multifold(fold):
1010 1010 def skipprompt(self):
1011 1011 return True
1012 1012
1013 1013
1014 1014 @action(
1015 1015 [b"roll", b"r"],
1016 1016 _(b"like fold, but discard this commit's description and date"),
1017 1017 )
1018 1018 class rollup(fold):
1019 1019 def mergedescs(self):
1020 1020 return False
1021 1021
1022 1022 def skipprompt(self):
1023 1023 return True
1024 1024
1025 1025 def firstdate(self):
1026 1026 return True
1027 1027
1028 1028
1029 1029 @action([b"drop", b"d"], _(b'remove commit from history'))
1030 1030 class drop(histeditaction):
1031 1031 def run(self):
1032 1032 parentctx = self.repo[self.state.parentctxnode]
1033 1033 return parentctx, [(self.node, tuple())]
1034 1034
1035 1035
1036 1036 @action(
1037 1037 [b"mess", b"m"],
1038 1038 _(b'edit commit message without changing commit content'),
1039 1039 priority=True,
1040 1040 )
1041 1041 class message(histeditaction):
1042 1042 def commiteditor(self):
1043 1043 return cmdutil.getcommiteditor(edit=True, editform=b'histedit.mess')
1044 1044
1045 1045
1046 1046 def findoutgoing(ui, repo, remote=None, force=False, opts=None):
1047 1047 """utility function to find the first outgoing changeset
1048 1048
1049 1049 Used by initialization code"""
1050 1050 if opts is None:
1051 1051 opts = {}
1052 1052 path = urlutil.get_unique_push_path(b'histedit', repo, ui, remote)
1053 1053
1054 1054 ui.status(_(b'comparing with %s\n') % urlutil.hidepassword(path.loc))
1055 1055
1056 1056 revs, checkout = hg.addbranchrevs(repo, repo, (path.branch, []), None)
1057 1057 other = hg.peer(repo, opts, path)
1058 1058
1059 1059 if revs:
1060 1060 revs = [repo.lookup(rev) for rev in revs]
1061 1061
1062 1062 outgoing = discovery.findcommonoutgoing(repo, other, revs, force=force)
1063 1063 if not outgoing.missing:
1064 1064 raise error.StateError(_(b'no outgoing ancestors'))
1065 1065 roots = list(repo.revs(b"roots(%ln)", outgoing.missing))
1066 1066 if len(roots) > 1:
1067 1067 msg = _(b'there are ambiguous outgoing revisions')
1068 1068 hint = _(b"see 'hg help histedit' for more detail")
1069 1069 raise error.StateError(msg, hint=hint)
1070 1070 return repo[roots[0]].node()
1071 1071
1072 1072
1073 1073 # Curses Support
1074 1074 try:
1075 1075 import curses
1076 1076 except ImportError:
1077 1077 curses = None
1078 1078
1079 1079 KEY_LIST = [b'pick', b'edit', b'fold', b'drop', b'mess', b'roll']
1080 1080 ACTION_LABELS = {
1081 1081 b'fold': b'^fold',
1082 1082 b'roll': b'^roll',
1083 1083 }
1084 1084
1085 1085 COLOR_HELP, COLOR_SELECTED, COLOR_OK, COLOR_WARN, COLOR_CURRENT = 1, 2, 3, 4, 5
1086 1086 COLOR_DIFF_ADD_LINE, COLOR_DIFF_DEL_LINE, COLOR_DIFF_OFFSET = 6, 7, 8
1087 1087 COLOR_ROLL, COLOR_ROLL_CURRENT, COLOR_ROLL_SELECTED = 9, 10, 11
1088 1088
1089 1089 E_QUIT, E_HISTEDIT = 1, 2
1090 1090 E_PAGEDOWN, E_PAGEUP, E_LINEUP, E_LINEDOWN, E_RESIZE = 3, 4, 5, 6, 7
1091 1091 MODE_INIT, MODE_PATCH, MODE_RULES, MODE_HELP = 0, 1, 2, 3
1092 1092
1093 1093 KEYTABLE = {
1094 1094 b'global': {
1095 1095 b'h': b'next-action',
1096 1096 b'KEY_RIGHT': b'next-action',
1097 1097 b'l': b'prev-action',
1098 1098 b'KEY_LEFT': b'prev-action',
1099 1099 b'q': b'quit',
1100 1100 b'c': b'histedit',
1101 1101 b'C': b'histedit',
1102 1102 b'v': b'showpatch',
1103 1103 b'?': b'help',
1104 1104 },
1105 1105 MODE_RULES: {
1106 1106 b'd': b'action-drop',
1107 1107 b'e': b'action-edit',
1108 1108 b'f': b'action-fold',
1109 1109 b'm': b'action-mess',
1110 1110 b'p': b'action-pick',
1111 1111 b'r': b'action-roll',
1112 1112 b' ': b'select',
1113 1113 b'j': b'down',
1114 1114 b'k': b'up',
1115 1115 b'KEY_DOWN': b'down',
1116 1116 b'KEY_UP': b'up',
1117 1117 b'J': b'move-down',
1118 1118 b'K': b'move-up',
1119 1119 b'KEY_NPAGE': b'move-down',
1120 1120 b'KEY_PPAGE': b'move-up',
1121 1121 b'0': b'goto', # Used for 0..9
1122 1122 },
1123 1123 MODE_PATCH: {
1124 1124 b' ': b'page-down',
1125 1125 b'KEY_NPAGE': b'page-down',
1126 1126 b'KEY_PPAGE': b'page-up',
1127 1127 b'j': b'line-down',
1128 1128 b'k': b'line-up',
1129 1129 b'KEY_DOWN': b'line-down',
1130 1130 b'KEY_UP': b'line-up',
1131 1131 b'J': b'down',
1132 1132 b'K': b'up',
1133 1133 },
1134 1134 MODE_HELP: {},
1135 1135 }
1136 1136
1137 1137
1138 1138 def screen_size():
1139 1139 return struct.unpack(b'hh', fcntl.ioctl(1, termios.TIOCGWINSZ, b' '))
1140 1140
1141 1141
1142 1142 class histeditrule:
1143 1143 def __init__(self, ui, ctx, pos, action=b'pick'):
1144 1144 self.ui = ui
1145 1145 self.ctx = ctx
1146 1146 self.action = action
1147 1147 self.origpos = pos
1148 1148 self.pos = pos
1149 1149 self.conflicts = []
1150 1150
1151 1151 def __bytes__(self):
1152 1152 # Example display of several histeditrules:
1153 1153 #
1154 1154 # #10 pick 316392:06a16c25c053 add option to skip tests
1155 1155 # #11 ^roll 316393:71313c964cc5 <RED>oops a fixup commit</RED>
1156 1156 # #12 pick 316394:ab31f3973b0d include mfbt for mozilla-config.h
1157 1157 # #13 ^fold 316395:14ce5803f4c3 fix warnings
1158 1158 #
1159 1159 # The carets point to the changeset being folded into ("roll this
1160 1160 # changeset into the changeset above").
1161 1161 return b'%s%s' % (self.prefix, self.desc)
1162 1162
1163 1163 __str__ = encoding.strmethod(__bytes__)
1164 1164
1165 1165 @property
1166 1166 def prefix(self):
1167 1167 # Some actions ('fold' and 'roll') combine a patch with a
1168 1168 # previous one. Add a marker showing which patch they apply
1169 1169 # to.
1170 1170 action = ACTION_LABELS.get(self.action, self.action)
1171 1171
1172 1172 h = self.ctx.hex()[0:12]
1173 1173 r = self.ctx.rev()
1174 1174
1175 1175 return b"#%s %s %d:%s " % (
1176 1176 (b'%d' % self.origpos).ljust(2),
1177 1177 action.ljust(6),
1178 1178 r,
1179 1179 h,
1180 1180 )
1181 1181
1182 1182 @util.propertycache
1183 1183 def desc(self):
1184 1184 summary = cmdutil.rendertemplate(
1185 1185 self.ctx, self.ui.config(b'histedit', b'summary-template')
1186 1186 )
1187 1187 if summary:
1188 1188 return summary
1189 1189 # This is split off from the prefix property so that we can
1190 1190 # separately make the description for 'roll' red (since it
1191 1191 # will get discarded).
1192 1192 return stringutil.firstline(self.ctx.description())
1193 1193
1194 1194 def checkconflicts(self, other):
1195 1195 if other.pos > self.pos and other.origpos <= self.origpos:
1196 1196 if set(other.ctx.files()) & set(self.ctx.files()) != set():
1197 1197 self.conflicts.append(other)
1198 1198 return self.conflicts
1199 1199
1200 1200 if other in self.conflicts:
1201 1201 self.conflicts.remove(other)
1202 1202 return self.conflicts
1203 1203
1204 1204
1205 1205 def makecommands(rules):
1206 1206 """Returns a list of commands consumable by histedit --commands based on
1207 1207 our list of rules"""
1208 1208 commands = []
1209 1209 for rules in rules:
1210 1210 commands.append(b'%s %s\n' % (rules.action, rules.ctx))
1211 1211 return commands
1212 1212
1213 1213
1214 1214 def addln(win, y, x, line, color=None):
1215 1215 """Add a line to the given window left padding but 100% filled with
1216 1216 whitespace characters, so that the color appears on the whole line"""
1217 1217 maxy, maxx = win.getmaxyx()
1218 1218 length = maxx - 1 - x
1219 1219 line = bytes(line).ljust(length)[:length]
1220 1220 if y < 0:
1221 1221 y = maxy + y
1222 1222 if x < 0:
1223 1223 x = maxx + x
1224 1224 if color:
1225 1225 win.addstr(y, x, line, color)
1226 1226 else:
1227 1227 win.addstr(y, x, line)
1228 1228
1229 1229
1230 1230 def _trunc_head(line, n):
1231 1231 if len(line) <= n:
1232 1232 return line
1233 1233 return b'> ' + line[-(n - 2) :]
1234 1234
1235 1235
1236 1236 def _trunc_tail(line, n):
1237 1237 if len(line) <= n:
1238 1238 return line
1239 1239 return line[: n - 2] + b' >'
1240 1240
1241 1241
1242 1242 class _chistedit_state:
1243 1243 def __init__(
1244 1244 self,
1245 1245 repo,
1246 1246 rules,
1247 1247 stdscr,
1248 1248 ):
1249 1249 self.repo = repo
1250 1250 self.rules = rules
1251 1251 self.stdscr = stdscr
1252 1252 self.later_on_top = repo.ui.configbool(
1253 1253 b'histedit', b'later-commits-first'
1254 1254 )
1255 1255 # The current item in display order, initialized to point to the top
1256 1256 # of the screen.
1257 1257 self.pos = 0
1258 1258 self.selected = None
1259 1259 self.mode = (MODE_INIT, MODE_INIT)
1260 1260 self.page_height = None
1261 1261 self.modes = {
1262 1262 MODE_RULES: {
1263 1263 b'line_offset': 0,
1264 1264 },
1265 1265 MODE_PATCH: {
1266 1266 b'line_offset': 0,
1267 1267 },
1268 1268 }
1269 1269
1270 1270 def render_commit(self, win):
1271 1271 """Renders the commit window that shows the log of the current selected
1272 1272 commit"""
1273 1273 rule = self.rules[self.display_pos_to_rule_pos(self.pos)]
1274 1274
1275 1275 ctx = rule.ctx
1276 1276 win.box()
1277 1277
1278 1278 maxy, maxx = win.getmaxyx()
1279 1279 length = maxx - 3
1280 1280
1281 1281 line = b"changeset: %d:%s" % (ctx.rev(), ctx.hex()[:12])
1282 1282 win.addstr(1, 1, line[:length])
1283 1283
1284 1284 line = b"user: %s" % ctx.user()
1285 1285 win.addstr(2, 1, line[:length])
1286 1286
1287 1287 bms = self.repo.nodebookmarks(ctx.node())
1288 1288 line = b"bookmark: %s" % b' '.join(bms)
1289 1289 win.addstr(3, 1, line[:length])
1290 1290
1291 1291 line = b"summary: %s" % stringutil.firstline(ctx.description())
1292 1292 win.addstr(4, 1, line[:length])
1293 1293
1294 1294 line = b"files: "
1295 1295 win.addstr(5, 1, line)
1296 1296 fnx = 1 + len(line)
1297 1297 fnmaxx = length - fnx + 1
1298 1298 y = 5
1299 1299 fnmaxn = maxy - (1 + y) - 1
1300 1300 files = ctx.files()
1301 1301 for i, line1 in enumerate(files):
1302 1302 if len(files) > fnmaxn and i == fnmaxn - 1:
1303 1303 win.addstr(y, fnx, _trunc_tail(b','.join(files[i:]), fnmaxx))
1304 1304 y = y + 1
1305 1305 break
1306 1306 win.addstr(y, fnx, _trunc_head(line1, fnmaxx))
1307 1307 y = y + 1
1308 1308
1309 1309 conflicts = rule.conflicts
1310 1310 if len(conflicts) > 0:
1311 1311 conflictstr = b','.join(map(lambda r: r.ctx.hex()[:12], conflicts))
1312 1312 conflictstr = b"changed files overlap with %s" % conflictstr
1313 1313 else:
1314 1314 conflictstr = b'no overlap'
1315 1315
1316 1316 win.addstr(y, 1, conflictstr[:length])
1317 1317 win.noutrefresh()
1318 1318
1319 1319 def helplines(self):
1320 1320 if self.mode[0] == MODE_PATCH:
1321 1321 help = b"""\
1322 1322 ?: help, k/up: line up, j/down: line down, v: stop viewing patch
1323 1323 pgup: prev page, space/pgdn: next page, c: commit, q: abort
1324 1324 """
1325 1325 else:
1326 1326 help = b"""\
1327 1327 ?: help, k/up: move up, j/down: move down, space: select, v: view patch
1328 1328 d: drop, e: edit, f: fold, m: mess, p: pick, r: roll
1329 1329 pgup/K: move patch up, pgdn/J: move patch down, c: commit, q: abort
1330 1330 """
1331 1331 if self.later_on_top:
1332 1332 help += b"Newer commits are shown above older commits.\n"
1333 1333 else:
1334 1334 help += b"Older commits are shown above newer commits.\n"
1335 1335 return help.splitlines()
1336 1336
1337 1337 def render_help(self, win):
1338 1338 maxy, maxx = win.getmaxyx()
1339 1339 for y, line in enumerate(self.helplines()):
1340 1340 if y >= maxy:
1341 1341 break
1342 1342 addln(win, y, 0, line, curses.color_pair(COLOR_HELP))
1343 1343 win.noutrefresh()
1344 1344
1345 1345 def layout(self):
1346 1346 maxy, maxx = self.stdscr.getmaxyx()
1347 1347 helplen = len(self.helplines())
1348 1348 mainlen = maxy - helplen - 12
1349 1349 if mainlen < 1:
1350 1350 raise error.Abort(
1351 1351 _(b"terminal dimensions %d by %d too small for curses histedit")
1352 1352 % (maxy, maxx),
1353 1353 hint=_(
1354 1354 b"enlarge your terminal or use --config ui.interface=text"
1355 1355 ),
1356 1356 )
1357 1357 return {
1358 1358 b'commit': (12, maxx),
1359 1359 b'help': (helplen, maxx),
1360 1360 b'main': (mainlen, maxx),
1361 1361 }
1362 1362
1363 1363 def display_pos_to_rule_pos(self, display_pos):
1364 1364 """Converts a position in display order to rule order.
1365 1365
1366 1366 The `display_pos` is the order from the top in display order, not
1367 1367 considering which items are currently visible on the screen. Thus,
1368 1368 `display_pos=0` is the item at the top (possibly after scrolling to
1369 1369 the top)
1370 1370 """
1371 1371 if self.later_on_top:
1372 1372 return len(self.rules) - 1 - display_pos
1373 1373 else:
1374 1374 return display_pos
1375 1375
1376 1376 def render_rules(self, rulesscr):
1377 1377 start = self.modes[MODE_RULES][b'line_offset']
1378 1378
1379 1379 conflicts = [r.ctx for r in self.rules if r.conflicts]
1380 1380 if len(conflicts) > 0:
1381 1381 line = b"potential conflict in %s" % b','.join(
1382 1382 map(pycompat.bytestr, conflicts)
1383 1383 )
1384 1384 addln(rulesscr, -1, 0, line, curses.color_pair(COLOR_WARN))
1385 1385
1386 1386 for display_pos in range(start, len(self.rules)):
1387 1387 y = display_pos - start
1388 1388 if y < 0 or y >= self.page_height:
1389 1389 continue
1390 1390 rule_pos = self.display_pos_to_rule_pos(display_pos)
1391 1391 rule = self.rules[rule_pos]
1392 1392 if len(rule.conflicts) > 0:
1393 1393 rulesscr.addstr(y, 0, b" ", curses.color_pair(COLOR_WARN))
1394 1394 else:
1395 1395 rulesscr.addstr(y, 0, b" ", curses.COLOR_BLACK)
1396 1396
1397 1397 if display_pos == self.selected:
1398 1398 rollcolor = COLOR_ROLL_SELECTED
1399 1399 addln(rulesscr, y, 2, rule, curses.color_pair(COLOR_SELECTED))
1400 1400 elif display_pos == self.pos:
1401 1401 rollcolor = COLOR_ROLL_CURRENT
1402 1402 addln(
1403 1403 rulesscr,
1404 1404 y,
1405 1405 2,
1406 1406 rule,
1407 1407 curses.color_pair(COLOR_CURRENT) | curses.A_BOLD,
1408 1408 )
1409 1409 else:
1410 1410 rollcolor = COLOR_ROLL
1411 1411 addln(rulesscr, y, 2, rule)
1412 1412
1413 1413 if rule.action == b'roll':
1414 1414 rulesscr.addstr(
1415 1415 y,
1416 1416 2 + len(rule.prefix),
1417 1417 rule.desc,
1418 1418 curses.color_pair(rollcolor),
1419 1419 )
1420 1420
1421 1421 rulesscr.noutrefresh()
1422 1422
1423 1423 def render_string(self, win, output, diffcolors=False):
1424 1424 maxy, maxx = win.getmaxyx()
1425 1425 length = min(maxy - 1, len(output))
1426 1426 for y in range(0, length):
1427 1427 line = output[y]
1428 1428 if diffcolors:
1429 1429 if line.startswith(b'+'):
1430 1430 win.addstr(
1431 1431 y, 0, line, curses.color_pair(COLOR_DIFF_ADD_LINE)
1432 1432 )
1433 1433 elif line.startswith(b'-'):
1434 1434 win.addstr(
1435 1435 y, 0, line, curses.color_pair(COLOR_DIFF_DEL_LINE)
1436 1436 )
1437 1437 elif line.startswith(b'@@ '):
1438 1438 win.addstr(y, 0, line, curses.color_pair(COLOR_DIFF_OFFSET))
1439 1439 else:
1440 1440 win.addstr(y, 0, line)
1441 1441 else:
1442 1442 win.addstr(y, 0, line)
1443 1443 win.noutrefresh()
1444 1444
1445 1445 def render_patch(self, win):
1446 1446 start = self.modes[MODE_PATCH][b'line_offset']
1447 1447 content = self.modes[MODE_PATCH][b'patchcontents']
1448 1448 self.render_string(win, content[start:], diffcolors=True)
1449 1449
1450 1450 def event(self, ch):
1451 1451 """Change state based on the current character input
1452 1452
1453 1453 This takes the current state and based on the current character input from
1454 1454 the user we change the state.
1455 1455 """
1456 1456 oldpos = self.pos
1457 1457
1458 1458 if ch in (curses.KEY_RESIZE, b"KEY_RESIZE"):
1459 1459 return E_RESIZE
1460 1460
1461 1461 lookup_ch = ch
1462 1462 if ch is not None and b'0' <= ch <= b'9':
1463 1463 lookup_ch = b'0'
1464 1464
1465 1465 curmode, prevmode = self.mode
1466 1466 action = KEYTABLE[curmode].get(
1467 1467 lookup_ch, KEYTABLE[b'global'].get(lookup_ch)
1468 1468 )
1469 1469 if action is None:
1470 1470 return
1471 1471 if action in (b'down', b'move-down'):
1472 1472 newpos = min(oldpos + 1, len(self.rules) - 1)
1473 1473 self.move_cursor(oldpos, newpos)
1474 1474 if self.selected is not None or action == b'move-down':
1475 1475 self.swap(oldpos, newpos)
1476 1476 elif action in (b'up', b'move-up'):
1477 1477 newpos = max(0, oldpos - 1)
1478 1478 self.move_cursor(oldpos, newpos)
1479 1479 if self.selected is not None or action == b'move-up':
1480 1480 self.swap(oldpos, newpos)
1481 1481 elif action == b'next-action':
1482 1482 self.cycle_action(oldpos, next=True)
1483 1483 elif action == b'prev-action':
1484 1484 self.cycle_action(oldpos, next=False)
1485 1485 elif action == b'select':
1486 1486 self.selected = oldpos if self.selected is None else None
1487 1487 self.make_selection(self.selected)
1488 1488 elif action == b'goto' and int(ch) < len(self.rules) <= 10:
1489 1489 newrule = next((r for r in self.rules if r.origpos == int(ch)))
1490 1490 self.move_cursor(oldpos, newrule.pos)
1491 1491 if self.selected is not None:
1492 1492 self.swap(oldpos, newrule.pos)
1493 1493 elif action.startswith(b'action-'):
1494 1494 self.change_action(oldpos, action[7:])
1495 1495 elif action == b'showpatch':
1496 1496 self.change_mode(MODE_PATCH if curmode != MODE_PATCH else prevmode)
1497 1497 elif action == b'help':
1498 1498 self.change_mode(MODE_HELP if curmode != MODE_HELP else prevmode)
1499 1499 elif action == b'quit':
1500 1500 return E_QUIT
1501 1501 elif action == b'histedit':
1502 1502 return E_HISTEDIT
1503 1503 elif action == b'page-down':
1504 1504 return E_PAGEDOWN
1505 1505 elif action == b'page-up':
1506 1506 return E_PAGEUP
1507 1507 elif action == b'line-down':
1508 1508 return E_LINEDOWN
1509 1509 elif action == b'line-up':
1510 1510 return E_LINEUP
1511 1511
1512 1512 def patch_contents(self):
1513 1513 repo = self.repo
1514 1514 rule = self.rules[self.display_pos_to_rule_pos(self.pos)]
1515 1515 displayer = logcmdutil.changesetdisplayer(
1516 1516 repo.ui,
1517 1517 repo,
1518 1518 {b"patch": True, b"template": b"status"},
1519 1519 buffered=True,
1520 1520 )
1521 1521 overrides = {(b'ui', b'verbose'): True}
1522 1522 with repo.ui.configoverride(overrides, source=b'histedit'):
1523 1523 displayer.show(rule.ctx)
1524 1524 displayer.close()
1525 1525 return displayer.hunk[rule.ctx.rev()].splitlines()
1526 1526
1527 1527 def move_cursor(self, oldpos, newpos):
1528 1528 """Change the rule/changeset that the cursor is pointing to, regardless of
1529 1529 current mode (you can switch between patches from the view patch window)."""
1530 1530 self.pos = newpos
1531 1531
1532 1532 mode, _ = self.mode
1533 1533 if mode == MODE_RULES:
1534 1534 # Scroll through the list by updating the view for MODE_RULES, so that
1535 1535 # even if we are not currently viewing the rules, switching back will
1536 1536 # result in the cursor's rule being visible.
1537 1537 modestate = self.modes[MODE_RULES]
1538 1538 if newpos < modestate[b'line_offset']:
1539 1539 modestate[b'line_offset'] = newpos
1540 1540 elif newpos > modestate[b'line_offset'] + self.page_height - 1:
1541 1541 modestate[b'line_offset'] = newpos - self.page_height + 1
1542 1542
1543 1543 # Reset the patch view region to the top of the new patch.
1544 1544 self.modes[MODE_PATCH][b'line_offset'] = 0
1545 1545
1546 1546 def change_mode(self, mode):
1547 1547 curmode, _ = self.mode
1548 1548 self.mode = (mode, curmode)
1549 1549 if mode == MODE_PATCH:
1550 1550 self.modes[MODE_PATCH][b'patchcontents'] = self.patch_contents()
1551 1551
1552 1552 def make_selection(self, pos):
1553 1553 self.selected = pos
1554 1554
1555 1555 def swap(self, oldpos, newpos):
1556 1556 """Swap two positions and calculate necessary conflicts in
1557 1557 O(|newpos-oldpos|) time"""
1558 1558 old_rule_pos = self.display_pos_to_rule_pos(oldpos)
1559 1559 new_rule_pos = self.display_pos_to_rule_pos(newpos)
1560 1560
1561 1561 rules = self.rules
1562 1562 assert 0 <= old_rule_pos < len(rules) and 0 <= new_rule_pos < len(rules)
1563 1563
1564 1564 rules[old_rule_pos], rules[new_rule_pos] = (
1565 1565 rules[new_rule_pos],
1566 1566 rules[old_rule_pos],
1567 1567 )
1568 1568
1569 1569 # TODO: swap should not know about histeditrule's internals
1570 1570 rules[new_rule_pos].pos = new_rule_pos
1571 1571 rules[old_rule_pos].pos = old_rule_pos
1572 1572
1573 1573 start = min(old_rule_pos, new_rule_pos)
1574 1574 end = max(old_rule_pos, new_rule_pos)
1575 1575 for r in range(start, end + 1):
1576 1576 rules[new_rule_pos].checkconflicts(rules[r])
1577 1577 rules[old_rule_pos].checkconflicts(rules[r])
1578 1578
1579 1579 if self.selected:
1580 1580 self.make_selection(newpos)
1581 1581
1582 1582 def change_action(self, pos, action):
1583 1583 """Change the action state on the given position to the new action"""
1584 1584 assert 0 <= pos < len(self.rules)
1585 1585 self.rules[pos].action = action
1586 1586
1587 1587 def cycle_action(self, pos, next=False):
1588 1588 """Changes the action state the next or the previous action from
1589 1589 the action list"""
1590 1590 assert 0 <= pos < len(self.rules)
1591 1591 current = self.rules[pos].action
1592 1592
1593 1593 assert current in KEY_LIST
1594 1594
1595 1595 index = KEY_LIST.index(current)
1596 1596 if next:
1597 1597 index += 1
1598 1598 else:
1599 1599 index -= 1
1600 1600 self.change_action(pos, KEY_LIST[index % len(KEY_LIST)])
1601 1601
1602 1602 def change_view(self, delta, unit):
1603 1603 """Change the region of whatever is being viewed (a patch or the list of
1604 1604 changesets). 'delta' is an amount (+/- 1) and 'unit' is 'page' or 'line'."""
1605 1605 mode, _ = self.mode
1606 1606 if mode != MODE_PATCH:
1607 1607 return
1608 1608 mode_state = self.modes[mode]
1609 1609 num_lines = len(mode_state[b'patchcontents'])
1610 1610 page_height = self.page_height
1611 1611 unit = page_height if unit == b'page' else 1
1612 1612 num_pages = 1 + (num_lines - 1) // page_height
1613 1613 max_offset = (num_pages - 1) * page_height
1614 1614 newline = mode_state[b'line_offset'] + delta * unit
1615 1615 mode_state[b'line_offset'] = max(0, min(max_offset, newline))
1616 1616
1617 1617
1618 1618 def _chisteditmain(repo, rules, stdscr):
1619 1619 try:
1620 1620 curses.use_default_colors()
1621 1621 except curses.error:
1622 1622 pass
1623 1623
1624 1624 # initialize color pattern
1625 1625 curses.init_pair(COLOR_HELP, curses.COLOR_WHITE, curses.COLOR_BLUE)
1626 1626 curses.init_pair(COLOR_SELECTED, curses.COLOR_BLACK, curses.COLOR_WHITE)
1627 1627 curses.init_pair(COLOR_WARN, curses.COLOR_BLACK, curses.COLOR_YELLOW)
1628 1628 curses.init_pair(COLOR_OK, curses.COLOR_BLACK, curses.COLOR_GREEN)
1629 1629 curses.init_pair(COLOR_CURRENT, curses.COLOR_WHITE, curses.COLOR_MAGENTA)
1630 1630 curses.init_pair(COLOR_DIFF_ADD_LINE, curses.COLOR_GREEN, -1)
1631 1631 curses.init_pair(COLOR_DIFF_DEL_LINE, curses.COLOR_RED, -1)
1632 1632 curses.init_pair(COLOR_DIFF_OFFSET, curses.COLOR_MAGENTA, -1)
1633 1633 curses.init_pair(COLOR_ROLL, curses.COLOR_RED, -1)
1634 1634 curses.init_pair(
1635 1635 COLOR_ROLL_CURRENT, curses.COLOR_BLACK, curses.COLOR_MAGENTA
1636 1636 )
1637 1637 curses.init_pair(COLOR_ROLL_SELECTED, curses.COLOR_RED, curses.COLOR_WHITE)
1638 1638
1639 1639 # don't display the cursor
1640 1640 try:
1641 1641 curses.curs_set(0)
1642 1642 except curses.error:
1643 1643 pass
1644 1644
1645 1645 def drawvertwin(size, y, x):
1646 1646 win = curses.newwin(size[0], size[1], y, x)
1647 1647 y += size[0]
1648 1648 return win, y, x
1649 1649
1650 1650 state = _chistedit_state(repo, rules, stdscr)
1651 1651
1652 1652 # eventloop
1653 1653 ch = None
1654 1654 stdscr.clear()
1655 1655 stdscr.refresh()
1656 1656 while True:
1657 1657 oldmode, unused = state.mode
1658 1658 if oldmode == MODE_INIT:
1659 1659 state.change_mode(MODE_RULES)
1660 1660 e = state.event(ch)
1661 1661
1662 1662 if e == E_QUIT:
1663 1663 return False
1664 1664 if e == E_HISTEDIT:
1665 1665 return state.rules
1666 1666 else:
1667 1667 if e == E_RESIZE:
1668 1668 size = screen_size()
1669 1669 if size != stdscr.getmaxyx():
1670 1670 curses.resizeterm(*size)
1671 1671
1672 1672 sizes = state.layout()
1673 1673 curmode, unused = state.mode
1674 1674 if curmode != oldmode:
1675 1675 state.page_height = sizes[b'main'][0]
1676 1676 # Adjust the view to fit the current screen size.
1677 1677 state.move_cursor(state.pos, state.pos)
1678 1678
1679 1679 # Pack the windows against the top, each pane spread across the
1680 1680 # full width of the screen.
1681 1681 y, x = (0, 0)
1682 1682 helpwin, y, x = drawvertwin(sizes[b'help'], y, x)
1683 1683 mainwin, y, x = drawvertwin(sizes[b'main'], y, x)
1684 1684 commitwin, y, x = drawvertwin(sizes[b'commit'], y, x)
1685 1685
1686 1686 if e in (E_PAGEDOWN, E_PAGEUP, E_LINEDOWN, E_LINEUP):
1687 1687 if e == E_PAGEDOWN:
1688 1688 state.change_view(+1, b'page')
1689 1689 elif e == E_PAGEUP:
1690 1690 state.change_view(-1, b'page')
1691 1691 elif e == E_LINEDOWN:
1692 1692 state.change_view(+1, b'line')
1693 1693 elif e == E_LINEUP:
1694 1694 state.change_view(-1, b'line')
1695 1695
1696 1696 # start rendering
1697 1697 commitwin.erase()
1698 1698 helpwin.erase()
1699 1699 mainwin.erase()
1700 1700 if curmode == MODE_PATCH:
1701 1701 state.render_patch(mainwin)
1702 1702 elif curmode == MODE_HELP:
1703 1703 state.render_string(mainwin, __doc__.strip().splitlines())
1704 1704 else:
1705 1705 state.render_rules(mainwin)
1706 1706 state.render_commit(commitwin)
1707 1707 state.render_help(helpwin)
1708 1708 curses.doupdate()
1709 1709 # done rendering
1710 1710 ch = encoding.strtolocal(stdscr.getkey())
1711 1711
1712 1712
1713 1713 def _chistedit(ui, repo, freeargs, opts):
1714 1714 """interactively edit changeset history via a curses interface
1715 1715
1716 1716 Provides a ncurses interface to histedit. Press ? in chistedit mode
1717 1717 to see an extensive help. Requires python-curses to be installed."""
1718 1718
1719 1719 if curses is None:
1720 1720 raise error.Abort(_(b"Python curses library required"))
1721 1721
1722 1722 # disable color
1723 1723 ui._colormode = None
1724 1724
1725 1725 try:
1726 1726 keep = opts.get(b'keep')
1727 1727 revs = opts.get(b'rev', [])[:]
1728 1728 cmdutil.checkunfinished(repo)
1729 1729 cmdutil.bailifchanged(repo)
1730 1730
1731 1731 revs.extend(freeargs)
1732 1732 if not revs:
1733 1733 defaultrev = destutil.desthistedit(ui, repo)
1734 1734 if defaultrev is not None:
1735 1735 revs.append(defaultrev)
1736 1736 if len(revs) != 1:
1737 1737 raise error.InputError(
1738 1738 _(b'histedit requires exactly one ancestor revision')
1739 1739 )
1740 1740
1741 1741 rr = list(repo.set(b'roots(%ld)', logcmdutil.revrange(repo, revs)))
1742 1742 if len(rr) != 1:
1743 1743 raise error.InputError(
1744 1744 _(
1745 1745 b'The specified revisions must have '
1746 1746 b'exactly one common root'
1747 1747 )
1748 1748 )
1749 1749 root = rr[0].node()
1750 1750
1751 1751 topmost = repo.dirstate.p1()
1752 1752 revs = between(repo, root, topmost, keep)
1753 1753 if not revs:
1754 1754 raise error.InputError(
1755 1755 _(b'%s is not an ancestor of working directory') % short(root)
1756 1756 )
1757 1757
1758 1758 rules = []
1759 1759 for i, r in enumerate(revs):
1760 1760 rules.append(histeditrule(ui, repo[r], i))
1761 1761 with util.with_lc_ctype():
1762 1762 rc = curses.wrapper(functools.partial(_chisteditmain, repo, rules))
1763 curses.echo()
1764 curses.endwin()
1765 1763 if rc is False:
1766 1764 ui.write(_(b"histedit aborted\n"))
1767 1765 return 0
1768 1766 if type(rc) is list:
1769 1767 ui.status(_(b"performing changes\n"))
1770 1768 rules = makecommands(rc)
1771 1769 with repo.vfs(b'chistedit', b'w+') as fp:
1772 1770 for r in rules:
1773 1771 fp.write(r)
1774 1772 opts[b'commands'] = fp.name
1775 1773 return _texthistedit(ui, repo, freeargs, opts)
1776 1774 except KeyboardInterrupt:
1777 1775 pass
1778 1776 return -1
1779 1777
1780 1778
1781 1779 @command(
1782 1780 b'histedit',
1783 1781 [
1784 1782 (
1785 1783 b'',
1786 1784 b'commands',
1787 1785 b'',
1788 1786 _(b'read history edits from the specified file'),
1789 1787 _(b'FILE'),
1790 1788 ),
1791 1789 (b'c', b'continue', False, _(b'continue an edit already in progress')),
1792 1790 (b'', b'edit-plan', False, _(b'edit remaining actions list')),
1793 1791 (
1794 1792 b'k',
1795 1793 b'keep',
1796 1794 False,
1797 1795 _(b"don't strip old nodes after edit is complete"),
1798 1796 ),
1799 1797 (b'', b'abort', False, _(b'abort an edit in progress')),
1800 1798 (b'o', b'outgoing', False, _(b'changesets not found in destination')),
1801 1799 (
1802 1800 b'f',
1803 1801 b'force',
1804 1802 False,
1805 1803 _(b'force outgoing even for unrelated repositories'),
1806 1804 ),
1807 1805 (b'r', b'rev', [], _(b'first revision to be edited'), _(b'REV')),
1808 1806 ]
1809 1807 + cmdutil.formatteropts,
1810 1808 _(b"[OPTIONS] ([ANCESTOR] | --outgoing [URL])"),
1811 1809 helpcategory=command.CATEGORY_CHANGE_MANAGEMENT,
1812 1810 )
1813 1811 def histedit(ui, repo, *freeargs, **opts):
1814 1812 """interactively edit changeset history
1815 1813
1816 1814 This command lets you edit a linear series of changesets (up to
1817 1815 and including the working directory, which should be clean).
1818 1816 You can:
1819 1817
1820 1818 - `pick` to [re]order a changeset
1821 1819
1822 1820 - `drop` to omit changeset
1823 1821
1824 1822 - `mess` to reword the changeset commit message
1825 1823
1826 1824 - `fold` to combine it with the preceding changeset (using the later date)
1827 1825
1828 1826 - `roll` like fold, but discarding this commit's description and date
1829 1827
1830 1828 - `edit` to edit this changeset (preserving date)
1831 1829
1832 1830 - `base` to checkout changeset and apply further changesets from there
1833 1831
1834 1832 There are a number of ways to select the root changeset:
1835 1833
1836 1834 - Specify ANCESTOR directly
1837 1835
1838 1836 - Use --outgoing -- it will be the first linear changeset not
1839 1837 included in destination. (See :hg:`help config.paths.default-push`)
1840 1838
1841 1839 - Otherwise, the value from the "histedit.defaultrev" config option
1842 1840 is used as a revset to select the base revision when ANCESTOR is not
1843 1841 specified. The first revision returned by the revset is used. By
1844 1842 default, this selects the editable history that is unique to the
1845 1843 ancestry of the working directory.
1846 1844
1847 1845 .. container:: verbose
1848 1846
1849 1847 If you use --outgoing, this command will abort if there are ambiguous
1850 1848 outgoing revisions. For example, if there are multiple branches
1851 1849 containing outgoing revisions.
1852 1850
1853 1851 Use "min(outgoing() and ::.)" or similar revset specification
1854 1852 instead of --outgoing to specify edit target revision exactly in
1855 1853 such ambiguous situation. See :hg:`help revsets` for detail about
1856 1854 selecting revisions.
1857 1855
1858 1856 .. container:: verbose
1859 1857
1860 1858 Examples:
1861 1859
1862 1860 - A number of changes have been made.
1863 1861 Revision 3 is no longer needed.
1864 1862
1865 1863 Start history editing from revision 3::
1866 1864
1867 1865 hg histedit -r 3
1868 1866
1869 1867 An editor opens, containing the list of revisions,
1870 1868 with specific actions specified::
1871 1869
1872 1870 pick 5339bf82f0ca 3 Zworgle the foobar
1873 1871 pick 8ef592ce7cc4 4 Bedazzle the zerlog
1874 1872 pick 0a9639fcda9d 5 Morgify the cromulancy
1875 1873
1876 1874 Additional information about the possible actions
1877 1875 to take appears below the list of revisions.
1878 1876
1879 1877 To remove revision 3 from the history,
1880 1878 its action (at the beginning of the relevant line)
1881 1879 is changed to 'drop'::
1882 1880
1883 1881 drop 5339bf82f0ca 3 Zworgle the foobar
1884 1882 pick 8ef592ce7cc4 4 Bedazzle the zerlog
1885 1883 pick 0a9639fcda9d 5 Morgify the cromulancy
1886 1884
1887 1885 - A number of changes have been made.
1888 1886 Revision 2 and 4 need to be swapped.
1889 1887
1890 1888 Start history editing from revision 2::
1891 1889
1892 1890 hg histedit -r 2
1893 1891
1894 1892 An editor opens, containing the list of revisions,
1895 1893 with specific actions specified::
1896 1894
1897 1895 pick 252a1af424ad 2 Blorb a morgwazzle
1898 1896 pick 5339bf82f0ca 3 Zworgle the foobar
1899 1897 pick 8ef592ce7cc4 4 Bedazzle the zerlog
1900 1898
1901 1899 To swap revision 2 and 4, its lines are swapped
1902 1900 in the editor::
1903 1901
1904 1902 pick 8ef592ce7cc4 4 Bedazzle the zerlog
1905 1903 pick 5339bf82f0ca 3 Zworgle the foobar
1906 1904 pick 252a1af424ad 2 Blorb a morgwazzle
1907 1905
1908 1906 Returns 0 on success, 1 if user intervention is required (not only
1909 1907 for intentional "edit" command, but also for resolving unexpected
1910 1908 conflicts).
1911 1909 """
1912 1910 opts = pycompat.byteskwargs(opts)
1913 1911
1914 1912 # kludge: _chistedit only works for starting an edit, not aborting
1915 1913 # or continuing, so fall back to regular _texthistedit for those
1916 1914 # operations.
1917 1915 if ui.interface(b'histedit') == b'curses' and _getgoal(opts) == goalnew:
1918 1916 return _chistedit(ui, repo, freeargs, opts)
1919 1917 return _texthistedit(ui, repo, freeargs, opts)
1920 1918
1921 1919
1922 1920 def _texthistedit(ui, repo, freeargs, opts):
1923 1921 state = histeditstate(repo)
1924 1922 with repo.wlock() as wlock, repo.lock() as lock:
1925 1923 state.wlock = wlock
1926 1924 state.lock = lock
1927 1925 _histedit(ui, repo, state, freeargs, opts)
1928 1926
1929 1927
1930 1928 goalcontinue = b'continue'
1931 1929 goalabort = b'abort'
1932 1930 goaleditplan = b'edit-plan'
1933 1931 goalnew = b'new'
1934 1932
1935 1933
1936 1934 def _getgoal(opts):
1937 1935 if opts.get(b'continue'):
1938 1936 return goalcontinue
1939 1937 if opts.get(b'abort'):
1940 1938 return goalabort
1941 1939 if opts.get(b'edit_plan'):
1942 1940 return goaleditplan
1943 1941 return goalnew
1944 1942
1945 1943
1946 1944 def _readfile(ui, path):
1947 1945 if path == b'-':
1948 1946 with ui.timeblockedsection(b'histedit'):
1949 1947 return ui.fin.read()
1950 1948 else:
1951 1949 with open(path, b'rb') as f:
1952 1950 return f.read()
1953 1951
1954 1952
1955 1953 def _validateargs(ui, repo, freeargs, opts, goal, rules, revs):
1956 1954 # TODO only abort if we try to histedit mq patches, not just
1957 1955 # blanket if mq patches are applied somewhere
1958 1956 mq = getattr(repo, 'mq', None)
1959 1957 if mq and mq.applied:
1960 1958 raise error.StateError(_(b'source has mq patches applied'))
1961 1959
1962 1960 # basic argument incompatibility processing
1963 1961 outg = opts.get(b'outgoing')
1964 1962 editplan = opts.get(b'edit_plan')
1965 1963 abort = opts.get(b'abort')
1966 1964 force = opts.get(b'force')
1967 1965 if force and not outg:
1968 1966 raise error.InputError(_(b'--force only allowed with --outgoing'))
1969 1967 if goal == b'continue':
1970 1968 if any((outg, abort, revs, freeargs, rules, editplan)):
1971 1969 raise error.InputError(_(b'no arguments allowed with --continue'))
1972 1970 elif goal == b'abort':
1973 1971 if any((outg, revs, freeargs, rules, editplan)):
1974 1972 raise error.InputError(_(b'no arguments allowed with --abort'))
1975 1973 elif goal == b'edit-plan':
1976 1974 if any((outg, revs, freeargs)):
1977 1975 raise error.InputError(
1978 1976 _(b'only --commands argument allowed with --edit-plan')
1979 1977 )
1980 1978 else:
1981 1979 if outg:
1982 1980 if revs:
1983 1981 raise error.InputError(
1984 1982 _(b'no revisions allowed with --outgoing')
1985 1983 )
1986 1984 if len(freeargs) > 1:
1987 1985 raise error.InputError(
1988 1986 _(b'only one repo argument allowed with --outgoing')
1989 1987 )
1990 1988 else:
1991 1989 revs.extend(freeargs)
1992 1990 if len(revs) == 0:
1993 1991 defaultrev = destutil.desthistedit(ui, repo)
1994 1992 if defaultrev is not None:
1995 1993 revs.append(defaultrev)
1996 1994
1997 1995 if len(revs) != 1:
1998 1996 raise error.InputError(
1999 1997 _(b'histedit requires exactly one ancestor revision')
2000 1998 )
2001 1999
2002 2000
2003 2001 def _histedit(ui, repo, state, freeargs, opts):
2004 2002 fm = ui.formatter(b'histedit', opts)
2005 2003 fm.startitem()
2006 2004 goal = _getgoal(opts)
2007 2005 revs = opts.get(b'rev', [])
2008 2006 nobackup = not ui.configbool(b'rewrite', b'backup-bundle')
2009 2007 rules = opts.get(b'commands', b'')
2010 2008 state.keep = opts.get(b'keep', False)
2011 2009
2012 2010 _validateargs(ui, repo, freeargs, opts, goal, rules, revs)
2013 2011
2014 2012 hastags = False
2015 2013 if revs:
2016 2014 revs = logcmdutil.revrange(repo, revs)
2017 2015 ctxs = [repo[rev] for rev in revs]
2018 2016 for ctx in ctxs:
2019 2017 tags = [tag for tag in ctx.tags() if tag != b'tip']
2020 2018 if not hastags:
2021 2019 hastags = len(tags)
2022 2020 if hastags:
2023 2021 if ui.promptchoice(
2024 2022 _(
2025 2023 b'warning: tags associated with the given'
2026 2024 b' changeset will be lost after histedit.\n'
2027 2025 b'do you want to continue (yN)? $$ &Yes $$ &No'
2028 2026 ),
2029 2027 default=1,
2030 2028 ):
2031 2029 raise error.CanceledError(_(b'histedit cancelled\n'))
2032 2030 # rebuild state
2033 2031 if goal == goalcontinue:
2034 2032 state.read()
2035 2033 state = bootstrapcontinue(ui, state, opts)
2036 2034 elif goal == goaleditplan:
2037 2035 _edithisteditplan(ui, repo, state, rules)
2038 2036 return
2039 2037 elif goal == goalabort:
2040 2038 _aborthistedit(ui, repo, state, nobackup=nobackup)
2041 2039 return
2042 2040 else:
2043 2041 # goal == goalnew
2044 2042 _newhistedit(ui, repo, state, revs, freeargs, opts)
2045 2043
2046 2044 _continuehistedit(ui, repo, state)
2047 2045 _finishhistedit(ui, repo, state, fm)
2048 2046 fm.end()
2049 2047
2050 2048
2051 2049 def _continuehistedit(ui, repo, state):
2052 2050 """This function runs after either:
2053 2051 - bootstrapcontinue (if the goal is 'continue')
2054 2052 - _newhistedit (if the goal is 'new')
2055 2053 """
2056 2054 # preprocess rules so that we can hide inner folds from the user
2057 2055 # and only show one editor
2058 2056 actions = state.actions[:]
2059 2057 for idx, (action, nextact) in enumerate(zip(actions, actions[1:] + [None])):
2060 2058 if action.verb == b'fold' and nextact and nextact.verb == b'fold':
2061 2059 state.actions[idx].__class__ = _multifold
2062 2060
2063 2061 # Force an initial state file write, so the user can run --abort/continue
2064 2062 # even if there's an exception before the first transaction serialize.
2065 2063 state.write()
2066 2064
2067 2065 tr = None
2068 2066 # Don't use singletransaction by default since it rolls the entire
2069 2067 # transaction back if an unexpected exception happens (like a
2070 2068 # pretxncommit hook throws, or the user aborts the commit msg editor).
2071 2069 if ui.configbool(b"histedit", b"singletransaction"):
2072 2070 # Don't use a 'with' for the transaction, since actions may close
2073 2071 # and reopen a transaction. For example, if the action executes an
2074 2072 # external process it may choose to commit the transaction first.
2075 2073 tr = repo.transaction(b'histedit')
2076 2074 progress = ui.makeprogress(
2077 2075 _(b"editing"), unit=_(b'changes'), total=len(state.actions)
2078 2076 )
2079 2077 with progress, util.acceptintervention(tr):
2080 2078 while state.actions:
2081 2079 state.write(tr=tr)
2082 2080 actobj = state.actions[0]
2083 2081 progress.increment(item=actobj.torule())
2084 2082 ui.debug(
2085 2083 b'histedit: processing %s %s\n' % (actobj.verb, actobj.torule())
2086 2084 )
2087 2085 parentctx, replacement_ = actobj.run()
2088 2086 state.parentctxnode = parentctx.node()
2089 2087 state.replacements.extend(replacement_)
2090 2088 state.actions.pop(0)
2091 2089
2092 2090 state.write()
2093 2091
2094 2092
2095 2093 def _finishhistedit(ui, repo, state, fm):
2096 2094 """This action runs when histedit is finishing its session"""
2097 2095 mergemod.update(repo[state.parentctxnode])
2098 2096
2099 2097 mapping, tmpnodes, created, ntm = processreplacement(state)
2100 2098 if mapping:
2101 2099 for prec, succs in mapping.items():
2102 2100 if not succs:
2103 2101 ui.debug(b'histedit: %s is dropped\n' % short(prec))
2104 2102 else:
2105 2103 ui.debug(
2106 2104 b'histedit: %s is replaced by %s\n'
2107 2105 % (short(prec), short(succs[0]))
2108 2106 )
2109 2107 if len(succs) > 1:
2110 2108 m = b'histedit: %s'
2111 2109 for n in succs[1:]:
2112 2110 ui.debug(m % short(n))
2113 2111
2114 2112 if not state.keep:
2115 2113 if mapping:
2116 2114 movetopmostbookmarks(repo, state.topmost, ntm)
2117 2115 # TODO update mq state
2118 2116 else:
2119 2117 mapping = {}
2120 2118
2121 2119 for n in tmpnodes:
2122 2120 if n in repo:
2123 2121 mapping[n] = ()
2124 2122
2125 2123 # remove entries about unknown nodes
2126 2124 has_node = repo.unfiltered().changelog.index.has_node
2127 2125 mapping = {
2128 2126 k: v
2129 2127 for k, v in mapping.items()
2130 2128 if has_node(k) and all(has_node(n) for n in v)
2131 2129 }
2132 2130 scmutil.cleanupnodes(repo, mapping, b'histedit')
2133 2131 hf = fm.hexfunc
2134 2132 fl = fm.formatlist
2135 2133 fd = fm.formatdict
2136 2134 nodechanges = fd(
2137 2135 {
2138 2136 hf(oldn): fl([hf(n) for n in newn], name=b'node')
2139 2137 for oldn, newn in mapping.items()
2140 2138 },
2141 2139 key=b"oldnode",
2142 2140 value=b"newnodes",
2143 2141 )
2144 2142 fm.data(nodechanges=nodechanges)
2145 2143
2146 2144 state.clear()
2147 2145 if os.path.exists(repo.sjoin(b'undo')):
2148 2146 os.unlink(repo.sjoin(b'undo'))
2149 2147 if repo.vfs.exists(b'histedit-last-edit.txt'):
2150 2148 repo.vfs.unlink(b'histedit-last-edit.txt')
2151 2149
2152 2150
2153 2151 def _aborthistedit(ui, repo, state, nobackup=False):
2154 2152 try:
2155 2153 state.read()
2156 2154 __, leafs, tmpnodes, __ = processreplacement(state)
2157 2155 ui.debug(b'restore wc to old parent %s\n' % short(state.topmost))
2158 2156
2159 2157 # Recover our old commits if necessary
2160 2158 if not state.topmost in repo and state.backupfile:
2161 2159 backupfile = repo.vfs.join(state.backupfile)
2162 2160 f = hg.openpath(ui, backupfile)
2163 2161 gen = exchange.readbundle(ui, f, backupfile)
2164 2162 with repo.transaction(b'histedit.abort') as tr:
2165 2163 bundle2.applybundle(
2166 2164 repo,
2167 2165 gen,
2168 2166 tr,
2169 2167 source=b'histedit',
2170 2168 url=b'bundle:' + backupfile,
2171 2169 )
2172 2170
2173 2171 os.remove(backupfile)
2174 2172
2175 2173 # check whether we should update away
2176 2174 if repo.unfiltered().revs(
2177 2175 b'parents() and (%n or %ln::)',
2178 2176 state.parentctxnode,
2179 2177 leafs | tmpnodes,
2180 2178 ):
2181 2179 hg.clean(repo, state.topmost, show_stats=True, quietempty=True)
2182 2180 cleanupnode(ui, repo, tmpnodes, nobackup=nobackup)
2183 2181 cleanupnode(ui, repo, leafs, nobackup=nobackup)
2184 2182 except Exception:
2185 2183 if state.inprogress():
2186 2184 ui.warn(
2187 2185 _(
2188 2186 b'warning: encountered an exception during histedit '
2189 2187 b'--abort; the repository may not have been completely '
2190 2188 b'cleaned up\n'
2191 2189 )
2192 2190 )
2193 2191 raise
2194 2192 finally:
2195 2193 state.clear()
2196 2194
2197 2195
2198 2196 def hgaborthistedit(ui, repo):
2199 2197 state = histeditstate(repo)
2200 2198 nobackup = not ui.configbool(b'rewrite', b'backup-bundle')
2201 2199 with repo.wlock() as wlock, repo.lock() as lock:
2202 2200 state.wlock = wlock
2203 2201 state.lock = lock
2204 2202 _aborthistedit(ui, repo, state, nobackup=nobackup)
2205 2203
2206 2204
2207 2205 def _edithisteditplan(ui, repo, state, rules):
2208 2206 state.read()
2209 2207 if not rules:
2210 2208 comment = geteditcomment(
2211 2209 ui, short(state.parentctxnode), short(state.topmost)
2212 2210 )
2213 2211 rules = ruleeditor(repo, ui, state.actions, comment)
2214 2212 else:
2215 2213 rules = _readfile(ui, rules)
2216 2214 actions = parserules(rules, state)
2217 2215 ctxs = [repo[act.node] for act in state.actions if act.node]
2218 2216 warnverifyactions(ui, repo, actions, state, ctxs)
2219 2217 state.actions = actions
2220 2218 state.write()
2221 2219
2222 2220
2223 2221 def _newhistedit(ui, repo, state, revs, freeargs, opts):
2224 2222 outg = opts.get(b'outgoing')
2225 2223 rules = opts.get(b'commands', b'')
2226 2224 force = opts.get(b'force')
2227 2225
2228 2226 cmdutil.checkunfinished(repo)
2229 2227 cmdutil.bailifchanged(repo)
2230 2228
2231 2229 topmost = repo.dirstate.p1()
2232 2230 if outg:
2233 2231 if freeargs:
2234 2232 remote = freeargs[0]
2235 2233 else:
2236 2234 remote = None
2237 2235 root = findoutgoing(ui, repo, remote, force, opts)
2238 2236 else:
2239 2237 rr = list(repo.set(b'roots(%ld)', logcmdutil.revrange(repo, revs)))
2240 2238 if len(rr) != 1:
2241 2239 raise error.InputError(
2242 2240 _(
2243 2241 b'The specified revisions must have '
2244 2242 b'exactly one common root'
2245 2243 )
2246 2244 )
2247 2245 root = rr[0].node()
2248 2246
2249 2247 revs = between(repo, root, topmost, state.keep)
2250 2248 if not revs:
2251 2249 raise error.InputError(
2252 2250 _(b'%s is not an ancestor of working directory') % short(root)
2253 2251 )
2254 2252
2255 2253 ctxs = [repo[r] for r in revs]
2256 2254
2257 2255 wctx = repo[None]
2258 2256 # Please don't ask me why `ancestors` is this value. I figured it
2259 2257 # out with print-debugging, not by actually understanding what the
2260 2258 # merge code is doing. :(
2261 2259 ancs = [repo[b'.']]
2262 2260 # Sniff-test to make sure we won't collide with untracked files in
2263 2261 # the working directory. If we don't do this, we can get a
2264 2262 # collision after we've started histedit and backing out gets ugly
2265 2263 # for everyone, especially the user.
2266 2264 for c in [ctxs[0].p1()] + ctxs:
2267 2265 try:
2268 2266 mergemod.calculateupdates(
2269 2267 repo,
2270 2268 wctx,
2271 2269 c,
2272 2270 ancs,
2273 2271 # These parameters were determined by print-debugging
2274 2272 # what happens later on inside histedit.
2275 2273 branchmerge=False,
2276 2274 force=False,
2277 2275 acceptremote=False,
2278 2276 followcopies=False,
2279 2277 )
2280 2278 except error.Abort:
2281 2279 raise error.StateError(
2282 2280 _(
2283 2281 b"untracked files in working directory conflict with files in %s"
2284 2282 )
2285 2283 % c
2286 2284 )
2287 2285
2288 2286 if not rules:
2289 2287 comment = geteditcomment(ui, short(root), short(topmost))
2290 2288 actions = [pick(state, r) for r in revs]
2291 2289 rules = ruleeditor(repo, ui, actions, comment)
2292 2290 else:
2293 2291 rules = _readfile(ui, rules)
2294 2292 actions = parserules(rules, state)
2295 2293 warnverifyactions(ui, repo, actions, state, ctxs)
2296 2294
2297 2295 parentctxnode = repo[root].p1().node()
2298 2296
2299 2297 state.parentctxnode = parentctxnode
2300 2298 state.actions = actions
2301 2299 state.topmost = topmost
2302 2300 state.replacements = []
2303 2301
2304 2302 ui.log(
2305 2303 b"histedit",
2306 2304 b"%d actions to histedit\n",
2307 2305 len(actions),
2308 2306 histedit_num_actions=len(actions),
2309 2307 )
2310 2308
2311 2309 # Create a backup so we can always abort completely.
2312 2310 backupfile = None
2313 2311 if not obsolete.isenabled(repo, obsolete.createmarkersopt):
2314 2312 backupfile = repair.backupbundle(
2315 2313 repo, [parentctxnode], [topmost], root, b'histedit'
2316 2314 )
2317 2315 state.backupfile = backupfile
2318 2316
2319 2317
2320 2318 def _getsummary(ctx):
2321 2319 return stringutil.firstline(ctx.description())
2322 2320
2323 2321
2324 2322 def bootstrapcontinue(ui, state, opts):
2325 2323 repo = state.repo
2326 2324
2327 2325 ms = mergestatemod.mergestate.read(repo)
2328 2326 mergeutil.checkunresolved(ms)
2329 2327
2330 2328 if state.actions:
2331 2329 actobj = state.actions.pop(0)
2332 2330
2333 2331 if _isdirtywc(repo):
2334 2332 actobj.continuedirty()
2335 2333 if _isdirtywc(repo):
2336 2334 abortdirty()
2337 2335
2338 2336 parentctx, replacements = actobj.continueclean()
2339 2337
2340 2338 state.parentctxnode = parentctx.node()
2341 2339 state.replacements.extend(replacements)
2342 2340
2343 2341 return state
2344 2342
2345 2343
2346 2344 def between(repo, old, new, keep):
2347 2345 """select and validate the set of revision to edit
2348 2346
2349 2347 When keep is false, the specified set can't have children."""
2350 2348 revs = repo.revs(b'%n::%n', old, new)
2351 2349 if revs and not keep:
2352 2350 rewriteutil.precheck(repo, revs, b'edit')
2353 2351 if repo.revs(b'(%ld) and merge()', revs):
2354 2352 raise error.StateError(
2355 2353 _(b'cannot edit history that contains merges')
2356 2354 )
2357 2355 return pycompat.maplist(repo.changelog.node, revs)
2358 2356
2359 2357
2360 2358 def ruleeditor(repo, ui, actions, editcomment=b""):
2361 2359 """open an editor to edit rules
2362 2360
2363 2361 rules are in the format [ [act, ctx], ...] like in state.rules
2364 2362 """
2365 2363 if repo.ui.configbool(b"experimental", b"histedit.autoverb"):
2366 2364 newact = util.sortdict()
2367 2365 for act in actions:
2368 2366 ctx = repo[act.node]
2369 2367 summary = _getsummary(ctx)
2370 2368 fword = summary.split(b' ', 1)[0].lower()
2371 2369 added = False
2372 2370
2373 2371 # if it doesn't end with the special character '!' just skip this
2374 2372 if fword.endswith(b'!'):
2375 2373 fword = fword[:-1]
2376 2374 if fword in primaryactions | secondaryactions | tertiaryactions:
2377 2375 act.verb = fword
2378 2376 # get the target summary
2379 2377 tsum = summary[len(fword) + 1 :].lstrip()
2380 2378 # safe but slow: reverse iterate over the actions so we
2381 2379 # don't clash on two commits having the same summary
2382 2380 for na, l in reversed(list(newact.items())):
2383 2381 actx = repo[na.node]
2384 2382 asum = _getsummary(actx)
2385 2383 if asum == tsum:
2386 2384 added = True
2387 2385 l.append(act)
2388 2386 break
2389 2387
2390 2388 if not added:
2391 2389 newact[act] = []
2392 2390
2393 2391 # copy over and flatten the new list
2394 2392 actions = []
2395 2393 for na, l in newact.items():
2396 2394 actions.append(na)
2397 2395 actions += l
2398 2396
2399 2397 rules = b'\n'.join([act.torule() for act in actions])
2400 2398 rules += b'\n\n'
2401 2399 rules += editcomment
2402 2400 rules = ui.edit(
2403 2401 rules,
2404 2402 ui.username(),
2405 2403 {b'prefix': b'histedit'},
2406 2404 repopath=repo.path,
2407 2405 action=b'histedit',
2408 2406 )
2409 2407
2410 2408 # Save edit rules in .hg/histedit-last-edit.txt in case
2411 2409 # the user needs to ask for help after something
2412 2410 # surprising happens.
2413 2411 with repo.vfs(b'histedit-last-edit.txt', b'wb') as f:
2414 2412 f.write(rules)
2415 2413
2416 2414 return rules
2417 2415
2418 2416
2419 2417 def parserules(rules, state):
2420 2418 """Read the histedit rules string and return list of action objects"""
2421 2419 rules = [
2422 2420 l
2423 2421 for l in (r.strip() for r in rules.splitlines())
2424 2422 if l and not l.startswith(b'#')
2425 2423 ]
2426 2424 actions = []
2427 2425 for r in rules:
2428 2426 if b' ' not in r:
2429 2427 raise error.ParseError(_(b'malformed line "%s"') % r)
2430 2428 verb, rest = r.split(b' ', 1)
2431 2429
2432 2430 if verb not in actiontable:
2433 2431 raise error.ParseError(_(b'unknown action "%s"') % verb)
2434 2432
2435 2433 action = actiontable[verb].fromrule(state, rest)
2436 2434 actions.append(action)
2437 2435 return actions
2438 2436
2439 2437
2440 2438 def warnverifyactions(ui, repo, actions, state, ctxs):
2441 2439 try:
2442 2440 verifyactions(actions, state, ctxs)
2443 2441 except error.ParseError:
2444 2442 if repo.vfs.exists(b'histedit-last-edit.txt'):
2445 2443 ui.warn(
2446 2444 _(
2447 2445 b'warning: histedit rules saved '
2448 2446 b'to: .hg/histedit-last-edit.txt\n'
2449 2447 )
2450 2448 )
2451 2449 raise
2452 2450
2453 2451
2454 2452 def verifyactions(actions, state, ctxs):
2455 2453 """Verify that there exists exactly one action per given changeset and
2456 2454 other constraints.
2457 2455
2458 2456 Will abort if there are to many or too few rules, a malformed rule,
2459 2457 or a rule on a changeset outside of the user-given range.
2460 2458 """
2461 2459 expected = {c.node() for c in ctxs}
2462 2460 seen = set()
2463 2461 prev = None
2464 2462
2465 2463 if actions and actions[0].verb in [b'roll', b'fold']:
2466 2464 raise error.ParseError(
2467 2465 _(b'first changeset cannot use verb "%s"') % actions[0].verb
2468 2466 )
2469 2467
2470 2468 for action in actions:
2471 2469 action.verify(prev, expected, seen)
2472 2470 prev = action
2473 2471 if action.node is not None:
2474 2472 seen.add(action.node)
2475 2473 missing = sorted(expected - seen) # sort to stabilize output
2476 2474
2477 2475 if state.repo.ui.configbool(b'histedit', b'dropmissing'):
2478 2476 if len(actions) == 0:
2479 2477 raise error.ParseError(
2480 2478 _(b'no rules provided'),
2481 2479 hint=_(b'use strip extension to remove commits'),
2482 2480 )
2483 2481
2484 2482 drops = [drop(state, n) for n in missing]
2485 2483 # put the in the beginning so they execute immediately and
2486 2484 # don't show in the edit-plan in the future
2487 2485 actions[:0] = drops
2488 2486 elif missing:
2489 2487 raise error.ParseError(
2490 2488 _(b'missing rules for changeset %s') % short(missing[0]),
2491 2489 hint=_(
2492 2490 b'use "drop %s" to discard, see also: '
2493 2491 b"'hg help -e histedit.config'"
2494 2492 )
2495 2493 % short(missing[0]),
2496 2494 )
2497 2495
2498 2496
2499 2497 def adjustreplacementsfrommarkers(repo, oldreplacements):
2500 2498 """Adjust replacements from obsolescence markers
2501 2499
2502 2500 Replacements structure is originally generated based on
2503 2501 histedit's state and does not account for changes that are
2504 2502 not recorded there. This function fixes that by adding
2505 2503 data read from obsolescence markers"""
2506 2504 if not obsolete.isenabled(repo, obsolete.createmarkersopt):
2507 2505 return oldreplacements
2508 2506
2509 2507 unfi = repo.unfiltered()
2510 2508 get_rev = unfi.changelog.index.get_rev
2511 2509 obsstore = repo.obsstore
2512 2510 newreplacements = list(oldreplacements)
2513 2511 oldsuccs = [r[1] for r in oldreplacements]
2514 2512 # successors that have already been added to succstocheck once
2515 2513 seensuccs = set().union(
2516 2514 *oldsuccs
2517 2515 ) # create a set from an iterable of tuples
2518 2516 succstocheck = list(seensuccs)
2519 2517 while succstocheck:
2520 2518 n = succstocheck.pop()
2521 2519 missing = get_rev(n) is None
2522 2520 markers = obsstore.successors.get(n, ())
2523 2521 if missing and not markers:
2524 2522 # dead end, mark it as such
2525 2523 newreplacements.append((n, ()))
2526 2524 for marker in markers:
2527 2525 nsuccs = marker[1]
2528 2526 newreplacements.append((n, nsuccs))
2529 2527 for nsucc in nsuccs:
2530 2528 if nsucc not in seensuccs:
2531 2529 seensuccs.add(nsucc)
2532 2530 succstocheck.append(nsucc)
2533 2531
2534 2532 return newreplacements
2535 2533
2536 2534
2537 2535 def processreplacement(state):
2538 2536 """process the list of replacements to return
2539 2537
2540 2538 1) the final mapping between original and created nodes
2541 2539 2) the list of temporary node created by histedit
2542 2540 3) the list of new commit created by histedit"""
2543 2541 replacements = adjustreplacementsfrommarkers(state.repo, state.replacements)
2544 2542 allsuccs = set()
2545 2543 replaced = set()
2546 2544 fullmapping = {}
2547 2545 # initialize basic set
2548 2546 # fullmapping records all operations recorded in replacement
2549 2547 for rep in replacements:
2550 2548 allsuccs.update(rep[1])
2551 2549 replaced.add(rep[0])
2552 2550 fullmapping.setdefault(rep[0], set()).update(rep[1])
2553 2551 new = allsuccs - replaced
2554 2552 tmpnodes = allsuccs & replaced
2555 2553 # Reduce content fullmapping into direct relation between original nodes
2556 2554 # and final node created during history edition
2557 2555 # Dropped changeset are replaced by an empty list
2558 2556 toproceed = set(fullmapping)
2559 2557 final = {}
2560 2558 while toproceed:
2561 2559 for x in list(toproceed):
2562 2560 succs = fullmapping[x]
2563 2561 for s in list(succs):
2564 2562 if s in toproceed:
2565 2563 # non final node with unknown closure
2566 2564 # We can't process this now
2567 2565 break
2568 2566 elif s in final:
2569 2567 # non final node, replace with closure
2570 2568 succs.remove(s)
2571 2569 succs.update(final[s])
2572 2570 else:
2573 2571 final[x] = succs
2574 2572 toproceed.remove(x)
2575 2573 # remove tmpnodes from final mapping
2576 2574 for n in tmpnodes:
2577 2575 del final[n]
2578 2576 # we expect all changes involved in final to exist in the repo
2579 2577 # turn `final` into list (topologically sorted)
2580 2578 get_rev = state.repo.changelog.index.get_rev
2581 2579 for prec, succs in final.items():
2582 2580 final[prec] = sorted(succs, key=get_rev)
2583 2581
2584 2582 # computed topmost element (necessary for bookmark)
2585 2583 if new:
2586 2584 newtopmost = sorted(new, key=state.repo.changelog.rev)[-1]
2587 2585 elif not final:
2588 2586 # Nothing rewritten at all. we won't need `newtopmost`
2589 2587 # It is the same as `oldtopmost` and `processreplacement` know it
2590 2588 newtopmost = None
2591 2589 else:
2592 2590 # every body died. The newtopmost is the parent of the root.
2593 2591 r = state.repo.changelog.rev
2594 2592 newtopmost = state.repo[sorted(final, key=r)[0]].p1().node()
2595 2593
2596 2594 return final, tmpnodes, new, newtopmost
2597 2595
2598 2596
2599 2597 def movetopmostbookmarks(repo, oldtopmost, newtopmost):
2600 2598 """Move bookmark from oldtopmost to newly created topmost
2601 2599
2602 2600 This is arguably a feature and we may only want that for the active
2603 2601 bookmark. But the behavior is kept compatible with the old version for now.
2604 2602 """
2605 2603 if not oldtopmost or not newtopmost:
2606 2604 return
2607 2605 oldbmarks = repo.nodebookmarks(oldtopmost)
2608 2606 if oldbmarks:
2609 2607 with repo.lock(), repo.transaction(b'histedit') as tr:
2610 2608 marks = repo._bookmarks
2611 2609 changes = []
2612 2610 for name in oldbmarks:
2613 2611 changes.append((name, newtopmost))
2614 2612 marks.applychanges(repo, tr, changes)
2615 2613
2616 2614
2617 2615 def cleanupnode(ui, repo, nodes, nobackup=False):
2618 2616 """strip a group of nodes from the repository
2619 2617
2620 2618 The set of node to strip may contains unknown nodes."""
2621 2619 with repo.lock():
2622 2620 # do not let filtering get in the way of the cleanse
2623 2621 # we should probably get rid of obsolescence marker created during the
2624 2622 # histedit, but we currently do not have such information.
2625 2623 repo = repo.unfiltered()
2626 2624 # Find all nodes that need to be stripped
2627 2625 # (we use %lr instead of %ln to silently ignore unknown items)
2628 2626 has_node = repo.changelog.index.has_node
2629 2627 nodes = sorted(n for n in nodes if has_node(n))
2630 2628 roots = [c.node() for c in repo.set(b"roots(%ln)", nodes)]
2631 2629 if roots:
2632 2630 backup = not nobackup
2633 2631 repair.strip(ui, repo, roots, backup=backup)
2634 2632
2635 2633
2636 2634 def stripwrapper(orig, ui, repo, nodelist, *args, **kwargs):
2637 2635 if isinstance(nodelist, bytes):
2638 2636 nodelist = [nodelist]
2639 2637 state = histeditstate(repo)
2640 2638 if state.inprogress():
2641 2639 state.read()
2642 2640 histedit_nodes = {
2643 2641 action.node for action in state.actions if action.node
2644 2642 }
2645 2643 common_nodes = histedit_nodes & set(nodelist)
2646 2644 if common_nodes:
2647 2645 raise error.Abort(
2648 2646 _(b"histedit in progress, can't strip %s")
2649 2647 % b', '.join(short(x) for x in common_nodes)
2650 2648 )
2651 2649 return orig(ui, repo, nodelist, *args, **kwargs)
2652 2650
2653 2651
2654 2652 extensions.wrapfunction(repair, 'strip', stripwrapper)
2655 2653
2656 2654
2657 2655 def summaryhook(ui, repo):
2658 2656 state = histeditstate(repo)
2659 2657 if not state.inprogress():
2660 2658 return
2661 2659 state.read()
2662 2660 if state.actions:
2663 2661 # i18n: column positioning for "hg summary"
2664 2662 ui.write(
2665 2663 _(b'hist: %s (histedit --continue)\n')
2666 2664 % (
2667 2665 ui.label(_(b'%d remaining'), b'histedit.remaining')
2668 2666 % len(state.actions)
2669 2667 )
2670 2668 )
2671 2669
2672 2670
2673 2671 def extsetup(ui):
2674 2672 cmdutil.summaryhooks.add(b'histedit', summaryhook)
2675 2673 statemod.addunfinished(
2676 2674 b'histedit',
2677 2675 fname=b'histedit-state',
2678 2676 allowcommit=True,
2679 2677 continueflag=True,
2680 2678 abortfunc=hgaborthistedit,
2681 2679 )
General Comments 0
You need to be logged in to leave comments. Login now