This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3209

amend: exit 0 if there are no changes
AbandonedPublic

Authored by spectral on Apr 9 2018, 6:09 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Summary

It's useful for writing some scripts or shell aliases if hg amend doesn't
abort the series of commands if there's nothing to amend. Users can then have
something like "alias amendevo='hg amend && hg evolve -a'" to amend and evolve
in one step.

To do this otherwise would require something like this:

alias amendevo='[[ -z "$(hg status -mar)" ]] && hg amend && hg evolve -a'

While that's not too onerous, it's not immediately obvious to most that this is
what would have to be done, so it's a small hurdle that users either have to
spend time to figure out on their own or ask about.

A similar change was made to hg evolve recently, for similar reasons.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

spectral created this revision.Apr 9 2018, 6:09 PM
quark added a subscriber: quark.Apr 9 2018, 7:37 PM

Returning 1 is actually more consistent with other core commands like pull, push, commit. See https://www.mercurial-scm.org/pipermail/mercurial-devel/2012-January/037711.html. Scripts should be updated to use $? explicitly.

spectral added a comment.Apr 9 2018, 8:20 PM
In D3209#51512, @quark wrote:

Returning 1 is actually more consistent with other core commands like pull, push, commit. See https://www.mercurial-scm.org/pipermail/mercurial-devel/2012-January/037711.html. Scripts should be updated to use $? explicitly.

I'm not sure how scripts can be updated to use $? explicitly. Mercurial exits 1 in many situations:

  • nothing found
  • hg verify, if there's any problems
  • unresolved conflicts when updating/rebasing/whatever
  • histedit 'edit' seems to dump you back into a terminal with exit status 1
  • MQ seems to use it a lot
  • I think a few others?

Yes, none of these apply to hg amend, so doing something like hg amend; [[ $? -eq 1 ]] && hg evolve -a is feasible, but again, feels really weird and non-discoverable. :/

I also see a few cases that return 2, mostly in MQ stuff (though there is one case in test-bookmarks-pushpull.t that's a little odd). There's obviously the "255" return whenever there's a major problem.

I'm not too tied to the patch and can abandon it if people feel it's incorrect.

quark added a comment.Apr 9 2018, 9:51 PM

I think it depends on what scripts want to do. I guess mpm's original point is, suppose you have a build script, or something that should do nothing if nothing changed, then hg amend && build_script just works as expected. If amend returns 0, then it'd be more complex to detect "nothing changed" case.

spectral abandoned this revision.Feb 6 2019, 6:19 PM

Revision Contents
Changeset List

PathPackages
Mmercurial/commands.py (7 lines)
Mtests/test-amend.t (3 lines)
Mtests/test-commit-amend.t (1 line)

Diff 7916

mercurial/commands.py

# Note: eventually this guard will be removed. Please do not expect # Note: eventually this guard will be removed. Please do not expect
# this behavior to remain. # this behavior to remain.
if not obsolete.isenabled(repo, obsolete.createmarkersopt): if not obsolete.isenabled(repo, obsolete.createmarkersopt):
cmdutil.checkunfinished(repo) cmdutil.checkunfinished(repo)
node = cmdutil.amend(ui, repo, old, extra, pats, opts) node = cmdutil.amend(ui, repo, old, extra, pats, opts)
if node == old.node(): if node == old.node():
ui.status(_("nothing changed\n")) ui.status(_("nothing changed\n"))
return 1 # Returning 0 because this is not technically an error condition,
# and it makes some scripts a little easier to write.
return 0
else: else:
def commitfunc(ui, repo, message, match, opts): def commitfunc(ui, repo, message, match, opts):
overrides = {} overrides = {}
if opts.get('secret'): if opts.get('secret'):
overrides[('phases', 'new-commit')] = 'secret' overrides[('phases', 'new-commit')] = 'secret'
baseui = repo.baseui baseui = repo.baseui
with baseui.configoverride(overrides, 'commit'): with baseui.configoverride(overrides, 'commit'):
if not node: if not node:
stat = cmdutil.postcommitstatus(repo, pats, opts) stat = cmdutil.postcommitstatus(repo, pats, opts)
if stat[3]: if stat[3]:
ui.status(_("nothing changed (%d missing files, see " ui.status(_("nothing changed (%d missing files, see "
"'hg status')\n") % len(stat[3])) "'hg status')\n") % len(stat[3]))
else: else:
ui.status(_("nothing changed\n")) ui.status(_("nothing changed\n"))
# "amend" not doing something in a script might be expected;
# "commit" not doing something in a script is generally a bug
# somewhere, so we return non-zero here.
return 1 return 1
cmdutil.commitstatus(repo, node, branch, bheads, opts) cmdutil.commitstatus(repo, node, branch, bheads, opts)
@command('config|showconfig|debugconfig', @command('config|showconfig|debugconfig',
[('u', 'untrusted', None, _('show untrusted configuration options')), [('u', 'untrusted', None, _('show untrusted configuration options')),
('e', 'edit', None, _('edit user config')), ('e', 'edit', None, _('edit user config')),
('l', 'local', None, _('edit repository config')), ('l', 'local', None, _('edit repository config')),

tests/test-amend.t

\ No newline at end of file \ No newline at end of file
#endif #endif
Nothing changed Nothing changed
$ hg amend $ hg amend
nothing changed nothing changed
[1]
$ hg amend -d "0 0" $ hg amend -d "0 0"
nothing changed nothing changed
[1]
$ hg amend -d "Thu Jan 01 00:00:00 1970 UTC" $ hg amend -d "Thu Jan 01 00:00:00 1970 UTC"
nothing changed nothing changed
[1]
Matcher and metadata options Matcher and metadata options
$ echo 3 > C $ echo 3 > C
$ echo 4 > D $ echo 4 > D
$ hg add C D $ hg add C D
$ hg amend -m NEWMESSAGE -I C $ hg amend -m NEWMESSAGE -I C
saved backup bundle to $TESTTMP/repo1/.hg/strip-backup/be169c7e8dbe-7684ddc5-amend.hg (obsstore-off !) saved backup bundle to $TESTTMP/repo1/.hg/strip-backup/be169c7e8dbe-7684ddc5-amend.hg (obsstore-off !)

tests/test-commit-amend.t

$ echo a >> a $ echo a >> a
$ hg ci -Am 'base1' $ hg ci -Am 'base1'
Nothing to amend: Nothing to amend:
$ hg ci --amend -m 'base1' $ hg ci --amend -m 'base1'
nothing changed nothing changed
[1]
$ cat >> $HGRCPATH <<EOF $ cat >> $HGRCPATH <<EOF
> [hooks] > [hooks]
> pretxncommit.foo = sh -c "echo \\"pretxncommit \$HG_NODE\\"; hg id -r \$HG_NODE" > pretxncommit.foo = sh -c "echo \\"pretxncommit \$HG_NODE\\"; hg id -r \$HG_NODE"
> EOF > EOF
Amending changeset with changes in working dir: Amending changeset with changes in working dir:
(and check that --message does not trigger an editor) (and check that --message does not trigger an editor)