This is an archive of the discontinued Mercurial Phabricator instance.

Differential D287

undo: better docs
ClosedPublic

Authored by felixmerk on Aug 8 2017, 7:43 PM.
Tags
None
Subscribers
quark

Details

Reviewers
stash
quark
Group Reviewers
Restricted Project
Commits
rFBHGXc28c2ff754c4: undo: better docs
Summary

Strips docs of unnescerary info and sticks complex things behind --verbose flag.
In most cases hg undo and redo or hg undo --preview should be enough for the
user. Also changes --index to --step, which seems clearer.

Diff Detail

Repository
rFBHGX Facebook Mercurial Extensions
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

felixmerk created this revision.Aug 8 2017, 7:43 PM
Herald added a reviewer: Restricted Project. · View Herald TranscriptAug 8 2017, 7:43 PM
stash accepted this revision.Aug 9 2017, 10:10 AM
This revision is now accepted and ready to land.Aug 9 2017, 10:10 AM
quark accepted this revision.Aug 9 2017, 2:14 PM
quark added a subscriber: quark.
quark added inline comments.
hgext3rd/undo.py
540

_like_

felixmerk updated this revision to Diff 742.Aug 10 2017, 1:55 PM
Closed by commit rFBHGXc28c2ff754c4: undo: better docs (authored by felixmerk). · Explain WhyAug 14 2017, 5:19 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext3rd/undo.py (68 lines)
Mtests/test-undo.t (6 lines)

Diff 885

hgext3rd/undo.py

@command('undo', [ @command('undo', [
('a', 'absolute', False, _("absolute based on command index instead of " ('a', 'absolute', False, _("absolute based on command index instead of "
"relative undo")), "relative undo")),
('b', 'branch', "", _("local branch undo, accepts commit hash " ('b', 'branch', "", _("local branch undo, accepts commit hash "
"(ADVANCED)")), "(ADVANCED)")),
('f', 'force', False, _("undo across missing undo history (ADVANCED)")), ('f', 'force', False, _("undo across missing undo history (ADVANCED)")),
('i', 'interactive', False, _("use interactive ui for undo")), ('i', 'interactive', False, _("use interactive ui for undo")),
('k', 'keep', False, _("keep working copy changes")), ('k', 'keep', False, _("keep working copy changes")),
('n', 'index', 1, _("how many steps to undo back")), ('n', 'step', 1, _("how many steps to undo back")),
('p', 'preview', False, _("see smartlog like preview of future undo " ('p', 'preview', False, _("see smartlog like preview of future undo "
"state")), "state")),
]) ])
def undo(ui, repo, *args, **opts): def undo(ui, repo, *args, **opts):
"""perform an undo """perform an undo
Undoes an undoable command. An undoable command is one that changed at Undoes an undoable command. An undoable command is one that changed at
least one of the following three: bookmarks, working copy parent or least one of the following three: bookmarks, working copy parent or
changesets. Note that this specifically does not include commands like log. changesets. Note that this specifically does not include commands like log.
It will include update if update changes the working copy parent (you update It will include update if update changes the working copy parent (you update
to a changeset that isn't the current one). Note that commands that edit to a changeset that isn't the current one). Note that commands that edit
public repos can't be undone (specifically push). public repos can't be undone (specifically push).
Undo does not preserve the working copy changes. Undo does not preserve the working copy changes.
To undo to a specific state use the --index and --absolute flags. Use hg undo --preview for interactive preview. Use your left and right
See hg debugundohistory to get a list of indeces and commands run. arrow keys to explore possible states, hit enter to go to a state or q to
By undoing to a specific index you undo to the state after that command. quit out of preview.
For example, hg undo --index 0 --absolute won't do anything, while
hg undo -n 1 -a will bring you back to the repo state before the current .. container:: verbose
quarkUnsubmitted
Not Done

_like_

quark: _like_
one.
Without the --absolute flag, your undos will be relative. This means Without the --absolute flag, your undos will be relative. This means
they will behave how you expect them to. If you run hg undo twice, they will behave how you expect them to. If you run hg undo twice,
you will move back two repo states from where you ran your first hg undo. you will move back two repo states from where you ran your first hg
You can use this in conjunction with hg redo to move up and down repo undo. You can use this in conjunction with `hg undo -n -1` to move up
states. Note that as soon as you execute a different undoable command, and down repo states. Note that as soon as you execute a different
which isn't hg undo or hg redo, any new undos or redos will be relative to undoable command, which isn't hg undo or hg redo, any new undos or redos
the state after this command. When using --index with relative undos, will be relative to the state after this command.
this is equivalent to running index many undos, except for leaving your
repo state history (hg debugundohistory) less cluttered.
Undo states are also distinct repo states and can thereby be inspected using
debugundohistory and specifically jumped to using undo --index --absolute.
If the undo extension was turned off and on again, you might loose the If the undo extension was turned off and on again, you might loose the
ability to undo to certain repo states. Undoing to repo states before the ability to undo to certain repo states. Undoing to repo states before
missing ones can be forced, but isn't advised unless its known how the the missing ones can be forced, but isn't advised unless its known how
before and after states are connected. the before and after states are connected.
Use keep to maintain working copy changes. With keep, undo mimics hg Use keep to maintain working copy changes. With keep, undo mimics hg
unamend and hg uncommit. Specifically, files that exist currently that unamend and hg uncommit. Specifically, files that exist currently that
don't exist at the repo state we are undoing to will remain in your don't exist at the repo state we are undoing to will remain in your
working copy but not in your changeset. Maintaining your working copy working copy but not in your changeset. Maintaining your working copy
has primarily two downsides: firstly your new working copy won't be clean has primarily two downsides: firstly your new working copy won't be
so you can't simply redo without cleaning your working copy. Secondly, clean so you can't simply redo without cleaning your working copy.
the operation may be slow if your working copy is large. If unsure, Secondly, the operation may be slow if your working copy is large. If
its generally easier try undo without --keep first and redo if you want unsure, its generally easier try undo without --keep first and redo if
to change this. you want to change this.
Branch limits the scope of an undo to a group of local (draft) changectxs, Branch limits the scope of an undo to a group of local (draft)
identified by any one member of this group. changectxs, identified by any one member of this group.
""" """
reverseindex = opts.get("index") reverseindex = opts.get("step")
relativeundo = not opts.get("absolute") relativeundo = not opts.get("absolute")
keep = opts.get("keep") keep = opts.get("keep")
branch = opts.get("branch") branch = opts.get("branch")
preview = opts.get("preview") preview = opts.get("preview")
interactive = opts.get("interactive") interactive = opts.get("interactive")
if interactive: if interactive:
preview = True preview = True
def rightarrow(self): def rightarrow(self):
self.index += 1 self.index += 1
def leftarrow(self): def leftarrow(self):
self.index -= 1 self.index -= 1
def enter(self): def enter(self):
del opts["preview"] del opts["preview"]
del opts["interactive"] del opts["interactive"]
opts["absolute"] = "absolute" opts["absolute"] = "absolute"
opts["index"] = self.index opts["step"] = self.index
undo(ui, repo, *args, **opts) undo(ui, repo, *args, **opts)
return return
viewobj = undopreview(ui, repo, reverseindex) viewobj = undopreview(ui, repo, reverseindex)
interactiveui.view(viewobj) interactiveui.view(viewobj)
return return
elif preview: elif preview:
_preview(ui, repo, reverseindex) _preview(ui, repo, reverseindex)
return return
if commandlist[0] == "undo": if commandlist[0] == "undo":
undoopts = {} undoopts = {}
fancyopts.fancyopts(commandlist[1:], fancyopts.fancyopts(commandlist[1:],
cmdtable['undo'][1] + commands.globalopts, cmdtable['undo'][1] + commands.globalopts,
undoopts) undoopts)
if redocount == 0: if redocount == 0:
# want to go to state before the undo (not after) # want to go to state before the undo (not after)
toshift = undoopts['index'] toshift = undoopts['step']
shiftedindex -= toshift shiftedindex -= toshift
reverseindex += 1 reverseindex += 1
done = True done = True
else: else:
if undoopts['absolute']: if undoopts['absolute']:
raise error.Abort(_("can't redo past absolute undo")) raise error.Abort(_("can't redo past absolute undo"))
reverseindex += 1 reverseindex += 1
redocount -= 1 redocount -= 1

tests/test-undo.t

$ hg undo $ hg undo
0 files updated, 0 files merged, 0 files removed, 0 files unresolved 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
(leaving bookmark test) (leaving bookmark test)
$ hg bookmarks $ hg bookmarks
feature1 2:49cdb4091aca feature1 2:49cdb4091aca
feature2 7:296fda51a303 feature2 7:296fda51a303
master 9:1dafc0b43612 master 9:1dafc0b43612
hg undo with negative index hg undo with negative step
$ hg undo -n -1 $ hg undo -n -1
0 files updated, 0 files merged, 0 files removed, 0 files unresolved 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ hg log -G -T compact -l1 $ hg log -G -T compact -l1
@ 9[tip][master,test] 1dafc0b43612 1970-01-01 00:00 +0000 test @ 9[tip][master,test] 1dafc0b43612 1970-01-01 00:00 +0000 test
| cmiss | cmiss
~ ~
$ hg undo $ hg undo
0 files updated, 0 files merged, 0 files removed, 0 files unresolved 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ hg redo $ hg redo
1 files updated, 0 files merged, 0 files removed, 0 files unresolved 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ hg redo $ hg redo
1 files updated, 0 files merged, 0 files removed, 0 files unresolved 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ hg log -r . -T {node} $ hg log -r . -T {node}
a0b72b3048d6d07b35b1d79c8e5c46b159d21cc9 (no-eol) a0b72b3048d6d07b35b1d79c8e5c46b159d21cc9 (no-eol)
$ hg undo -fn 3 $ hg undo -fn 3
0 files updated, 0 files merged, 1 files removed, 0 files unresolved 0 files updated, 0 files merged, 1 files removed, 0 files unresolved
$ hg undo --force --index -1 $ hg undo --force --step -1
0 files updated, 0 files merged, 1 files removed, 0 files unresolved 0 files updated, 0 files merged, 1 files removed, 0 files unresolved
$ hg debugundohistory -l $ hg debugundohistory -l
0: undo --force --index -1 0: undo --force --step -1
1: undo -fn 3 1: undo -fn 3
2: redo 2: redo
3: redo 3: redo
4: redo 4: redo
$ hg redo $ hg redo
1 files updated, 0 files merged, 0 files removed, 0 files unresolved 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ hg undo $ hg undo
0 files updated, 0 files merged, 1 files removed, 0 files unresolved 0 files updated, 0 files merged, 1 files removed, 0 files unresolved