This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1729

githelp: don't reference 3rd party commands for `git show`
ClosedPublic

Authored by indygreg on Dec 19 2017, 12:36 AM.

Details

Reviewers
durin42
pulkit
krbullock
Group Reviewers
hg-reviewers
Commits
rHGf50067fbeead: githelp: don't reference 3rd party commands for `git show`
Summary

hg show is a Facebook-ism. Reference functionality in core.

The logic here isn't terrific. But it is better than nothing.

Diff Detail

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

Event Timeline

indygreg created this revision.Dec 19 2017, 12:36 AM
durin42 accepted this revision.Dec 20 2017, 8:41 PM
This revision is now accepted and ready to land.Dec 20 2017, 8:41 PM
indygreg updated this revision to Diff 4597.Dec 22 2017, 8:39 PM
pulkit accepted this revision.Dec 28 2017, 3:54 PM
pulkit added a subscriber: pulkit.

I really like the extension added by the series. It will be nice one to have to help people who wanted to consider hg.

Added some inline comments which can be follow-ups if sounds good. There is also some inconsistency in output format which needs to be fixed.

How about having something like hg githelp concepts which can describe the basic difference between git and hg?

hgext/githelp.py
45

Maybe HEAD~ => .^ will be better.

162

We should add about how hg add is different from git add.

193

We should align this with other messages.

350

Maybe we should tell about hg update -C trick?

indygreg added a comment.Dec 29 2017, 1:45 PM
In D1729#30292, @pulkit wrote:

I really like the extension added by the series. It will be nice one to have to help people who wanted to consider hg.
Added some inline comments which can be follow-ups if sounds good. There is also some inconsistency in output format which needs to be fixed.
How about having something like hg githelp concepts which can describe the basic difference between git and hg?

I agree with these points! My immediate goal was getting the extension upstreamed near its current form. It still needs a bit of love.

With regards to the help section, I think hg help git should exist and should be a "Mercurial for Git Users" guide or something. It can inform users about the "githelp" extension.

krbullock requested changes to this revision.Jan 4 2018, 10:09 PM
krbullock added a subscriber: krbullock.
krbullock added inline comments.
hgext/githelp.py
881–882

I don't think tip is correct here, shouldn't this be .?

886

Same here, shouldn't use tip in newly-added docs or help if we can avoid it.

This revision now requires changes to proceed.Jan 4 2018, 10:09 PM
indygreg updated this revision to Diff 4817.Jan 14 2018, 2:20 PM
indygreg marked 2 inline comments as done.Jan 14 2018, 2:21 PM
durin42 accepted this revision.Jan 18 2018, 2:34 PM
Closed by commit rHGf50067fbeead: githelp: don't reference 3rd party commands for `git show` (authored by indygreg). · Explain WhyJan 18 2018, 2:58 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext/githelp.py (14 lines)
Mtests/test-githelp.t (20 lines)

Diff 4925

hgext/githelp.py

cmdtable = {} cmdtable = {}
command = registrar.command(cmdtable) command = registrar.command(cmdtable)
def convert(s): def convert(s):
if s.startswith("origin/"): if s.startswith("origin/"):
return s[7:] return s[7:]
if 'HEAD' in s: if 'HEAD' in s:
s = s.replace('HEAD', '.') s = s.replace('HEAD', '.')
# HEAD~ in git is .~1 in mercurial # HEAD~ in git is .~1 in mercurial
pulkitUnsubmitted
Not Done

Maybe HEAD~ => .^ will be better.

pulkit: Maybe HEAD~ => .^ will be better.
s = re.sub('~$', '~1', s) s = re.sub('~$', '~1', s)
return s return s
@command('^githelp|git', [ @command('^githelp|git', [
], _('hg githelp')) ], _('hg githelp'))
def githelp(ui, repo, *args, **kwargs): def githelp(ui, repo, *args, **kwargs):
'''suggests the Mercurial equivalent of the given git command '''suggests the Mercurial equivalent of the given git command
] ]
args, opts = parseoptions(ui, cmdoptions, args) args, opts = parseoptions(ui, cmdoptions, args)
if (opts.get('patch')): if (opts.get('patch')):
ui.status(_("note: Mercurial will commit when complete, " ui.status(_("note: Mercurial will commit when complete, "
"as there is no staging area in Mercurial\n\n")) "as there is no staging area in Mercurial\n\n"))
cmd = Command('commit --interactive') cmd = Command('commit --interactive')
else: else:
cmd = Command("add") cmd = Command("add")
pulkitUnsubmitted
Not Done

We should add about how hg add is different from git add.

pulkit: We should add about how `hg add` is different from `git add`.
if not opts.get('all'): if not opts.get('all'):
cmd.extend(args) cmd.extend(args)
else: else:
ui.status(_("note: use hg addremove to remove files that have " ui.status(_("note: use hg addremove to remove files that have "
"been deleted.\n\n")) "been deleted.\n\n"))
ui.status((str(cmd)), "\n") ui.status((str(cmd)), "\n")
cmd = Command('import --no-commit') cmd = Command('import --no-commit')
if (opts.get('p')): if (opts.get('p')):
cmd['-p'] = opts.get('p') cmd['-p'] = opts.get('p')
cmd.extend(args) cmd.extend(args)
ui.status((str(cmd)), "\n") ui.status((str(cmd)), "\n")
def bisect(ui, repo, *args, **kwargs): def bisect(ui, repo, *args, **kwargs):
ui.status(_("See 'hg help bisect' for how to use bisect.\n\n")) ui.status(_("See 'hg help bisect' for how to use bisect.\n\n"))
pulkitUnsubmitted
Not Done

We should align this with other messages.

pulkit: We should align this with other messages.
def blame(ui, repo, *args, **kwargs): def blame(ui, repo, *args, **kwargs):
cmdoptions = [ cmdoptions = [
] ]
args, opts = parseoptions(ui, cmdoptions, args) args, opts = parseoptions(ui, cmdoptions, args)
cmd = Command('annotate -udl') cmd = Command('annotate -udl')
cmd.extend([convert(v) for v in args]) cmd.extend([convert(v) for v in args])
ui.status((str(cmd)), "\n") ui.status((str(cmd)), "\n")
cmd = Command('graft') cmd = Command('graft')
if opts.get('edit'): if opts.get('edit'):
cmd['--edit'] = None cmd['--edit'] = None
if opts.get('continue'): if opts.get('continue'):
cmd['--continue'] = None cmd['--continue'] = None
elif opts.get('abort'): elif opts.get('abort'):
ui.status(_("note: hg graft does not have --abort.\n\n")) ui.status(_("note: hg graft does not have --abort.\n\n"))
pulkitUnsubmitted
Not Done

Maybe we should tell about hg update -C trick?

pulkit: Maybe we should tell about `hg update -C` trick?
return return
else: else:
cmd.extend(args) cmd.extend(args)
ui.status((str(cmd)), "\n") ui.status((str(cmd)), "\n")
def clean(ui, repo, *args, **kwargs): def clean(ui, repo, *args, **kwargs):
cmdoptions = [ cmdoptions = [
def show(ui, repo, *args, **kwargs): def show(ui, repo, *args, **kwargs):
cmdoptions = [ cmdoptions = [
('', 'name-status', None, ''), ('', 'name-status', None, ''),
('', 'pretty', '', ''), ('', 'pretty', '', ''),
('U', 'unified', int, ''), ('U', 'unified', int, ''),
] ]
args, opts = parseoptions(ui, cmdoptions, args) args, opts = parseoptions(ui, cmdoptions, args)
cmd = Command('show')
if opts.get('name_status'): if opts.get('name_status'):
if opts.get('pretty') == 'format:': if opts.get('pretty') == 'format:':
cmd = Command('stat') cmd = Command('status')
cmd['--change'] = 'tip' cmd['--change'] = '.'
krbullockUnsubmitted
Done

I don't think tip is correct here, shouldn't this be .?

krbullock: I don't think `tip` is correct here, shouldn't this be `.`?
else: else:
cmd = Command('log') cmd = Command('log')
cmd.append('--style status') cmd.append('--style status')
cmd.append('-r tip') cmd.append('-r .')
krbullockUnsubmitted
Done

Same here, shouldn't use tip in newly-added docs or help if we can avoid it.

krbullock: Same here, shouldn't use `tip` in newly-added docs or help if we can avoid it.
elif len(args) > 0: elif len(args) > 0:
if ispath(repo, args[0]): if ispath(repo, args[0]):
cmd.append('.') cmd = Command('cat')
else:
cmd = Command('export')
cmd.extend(args) cmd.extend(args)
if opts.get('unified'): if opts.get('unified'):
cmd.append('--config diff.unified=%d' % (opts['unified'],)) cmd.append('--config diff.unified=%d' % (opts['unified'],))
elif opts.get('unified'): elif opts.get('unified'):
cmd = Command('export')
cmd.append('--config diff.unified=%d' % (opts['unified'],)) cmd.append('--config diff.unified=%d' % (opts['unified'],))
else:
cmd = Command('export')
ui.status((str(cmd)), "\n") ui.status((str(cmd)), "\n")
def stash(ui, repo, *args, **kwargs): def stash(ui, repo, *args, **kwargs):
cmdoptions = [ cmdoptions = [
] ]
args, opts = parseoptions(ui, cmdoptions, args) args, opts = parseoptions(ui, cmdoptions, args)

tests/test-githelp.t

NOTE: --soft has no meaning since Mercurial has no staging area NOTE: --soft has no meaning since Mercurial has no staging area
hg update . hg update .
$ hg githelp -- reset --hard HEAD $ hg githelp -- reset --hard HEAD
hg update --clean . hg update --clean .
githelp for git show --name-status githelp for git show --name-status
$ hg githelp -- git show --name-status $ hg githelp -- git show --name-status
hg log --style status -r tip hg log --style status -r .
githelp for git show --pretty=format: --name-status githelp for git show --pretty=format: --name-status
$ hg githelp -- git show --pretty=format: --name-status $ hg githelp -- git show --pretty=format: --name-status
hg stat --change tip hg status --change .
githelp for show with no arguments githelp for show with no arguments
$ hg githelp -- show $ hg githelp -- show
hg show hg export
githelp for show with a path githelp for show with a path
$ hg githelp -- show test_file $ hg githelp -- show test_file
hg show . test_file hg cat test_file
githelp for show with not a path: githelp for show with not a path:
$ hg githelp -- show rev $ hg githelp -- show rev
hg show rev hg export rev
githelp for show with many arguments githelp for show with many arguments
$ hg githelp -- show argone argtwo $ hg githelp -- show argone argtwo
hg show argone argtwo hg export argone argtwo
$ hg githelp -- show test_file argone argtwo $ hg githelp -- show test_file argone argtwo
hg show . test_file argone argtwo hg cat test_file argone argtwo
githelp for show with --unified options githelp for show with --unified options
$ hg githelp -- show --unified=10 $ hg githelp -- show --unified=10
hg show --config diff.unified=10 hg export --config diff.unified=10
$ hg githelp -- show -U100 $ hg githelp -- show -U100
hg show --config diff.unified=100 hg export --config diff.unified=100
githelp for show with a path and --unified githelp for show with a path and --unified
$ hg githelp -- show -U20 test_file $ hg githelp -- show -U20 test_file
hg show . test_file --config diff.unified=20 hg cat test_file --config diff.unified=20
githelp for stash drop without name githelp for stash drop without name
$ hg githelp -- git stash drop $ hg githelp -- git stash drop
hg shelve -d <shelve name> hg shelve -d <shelve name>
githelp for stash drop with name githelp for stash drop with name
$ hg githelp -- git stash drop xyz $ hg githelp -- git stash drop xyz
hg shelve -d xyz hg shelve -d xyz