D2678: help: supporting both help and doc for aliases
rdamazio (Rodrigo Damazio Bovendorp)
phabricator at mercurial-scm.org
Sun Mar 4 22:15:19 UTC 2018
rdamazio created this revision.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.
REVISION SUMMARY
This allows an alias to be definted like:
[alias]
lj = log -Tjson
lj:help = [-r REV]
lj:doc = Shows the revision log in JSON format.
REPOSITORY
rHG Mercurial
REVISION DETAIL
https://phab.mercurial-scm.org/D2678
AFFECTED FILES
mercurial/configitems.py
mercurial/dispatch.py
CHANGE DETAILS
diff --git a/mercurial/dispatch.py b/mercurial/dispatch.py
--- a/mercurial/dispatch.py
+++ b/mercurial/dispatch.py
@@ -420,7 +420,7 @@
return r.sub(lambda x: replacemap[x.group()], cmd)
class cmdalias(object):
- def __init__(self, name, definition, cmdtable, source):
+ def __init__(self, ui, name, definition, cmdtable, source):
self.name = self.cmd = name
self.cmdname = ''
self.definition = definition
@@ -447,6 +447,7 @@
return
if self.definition.startswith('!'):
+ shdef = self.definition[1:]
self.shell = True
def fn(ui, *args):
env = {'HG_ARGS': ' '.join((self.name,) + args)}
@@ -460,11 +461,12 @@
"of %i variable in alias '%s' definition.\n"
% (int(m.groups()[0]), self.name))
return ''
- cmd = re.sub(br'\$(\d+|\$)', _checkvar, self.definition[1:])
+ cmd = re.sub(br'\$(\d+|\$)', _checkvar, shdef)
cmd = aliasinterpolate(self.name, args, cmd)
return ui.system(cmd, environ=env,
blockedtag='alias_%s' % self.name)
self.fn = fn
+ self._populatehelp(ui, name, shdef, self.fn)
return
try:
@@ -486,14 +488,12 @@
try:
tableentry = cmdutil.findcmd(cmd, cmdtable, False)[1]
if len(tableentry) > 2:
- self.fn, self.opts, self.help = tableentry
+ self.fn, self.opts, cmdhelp = tableentry
else:
self.fn, self.opts = tableentry
+ cmdhelp = None
- if self.help.startswith("hg " + cmd):
- # drop prefix in old-style help lines so hg shows the alias
- self.help = self.help[4 + len(cmd):]
- self.__doc__ = self.fn.__doc__
+ self._populatehelp(ui, name, cmd, self.fn, cmdhelp)
except error.UnknownCommand:
self.badalias = (_("alias '%s' resolves to unknown command '%s'")
@@ -503,6 +503,14 @@
self.badalias = (_("alias '%s' resolves to ambiguous command '%s'")
% (self.name, cmd))
+ def _populatehelp(self, ui, name, cmd, fn, defaulthelp=None):
+ self.help = ui.config('alias', '%s:help' % name, defaulthelp or '')
+ if self.help and self.help.startswith("hg " + cmd):
+ # drop prefix in old-style help lines so hg shows the alias
+ self.help = self.help[4 + len(cmd):]
+
+ self.__doc__ = ui.config('alias', '%s:doc' % name, fn.__doc__)
+
@property
def args(self):
args = pycompat.maplist(util.expandpath, self.givenargs)
@@ -547,15 +555,17 @@
class lazyaliasentry(object):
"""like a typical command entry (func, opts, help), but is lazy"""
- def __init__(self, name, definition, cmdtable, source):
+ def __init__(self, ui, name, definition, cmdtable, source):
+ self.ui = ui
self.name = name
self.definition = definition
self.cmdtable = cmdtable.copy()
self.source = source
@util.propertycache
def _aliasdef(self):
- return cmdalias(self.name, self.definition, self.cmdtable, self.source)
+ return cmdalias(self.ui, self.name, self.definition, self.cmdtable,
+ self.source)
def __getitem__(self, n):
aliasdef = self._aliasdef
@@ -579,16 +589,16 @@
# aliases are processed after extensions have been loaded, so they
# may use extension commands. Aliases can also use other alias definitions,
# but only if they have been defined prior to the current definition.
- for alias, definition in ui.configitems('alias'):
+ for alias, definition in ui.configitems('alias', ignoresub=True):
try:
if cmdtable[alias].definition == definition:
continue
except (KeyError, AttributeError):
# definition might not exist or it might not be a cmdalias
pass
source = ui.configsource('alias', alias)
- entry = lazyaliasentry(alias, definition, cmdtable, source)
+ entry = lazyaliasentry(ui, alias, definition, cmdtable, source)
cmdtable[alias] = entry
def _parse(ui, args):
diff --git a/mercurial/configitems.py b/mercurial/configitems.py
--- a/mercurial/configitems.py
+++ b/mercurial/configitems.py
@@ -114,7 +114,7 @@
coreconfigitem = getitemregister(coreitems)
coreconfigitem('alias', '.*',
- default=None,
+ default=dynamicdefault,
generic=True,
)
coreconfigitem('annotate', 'nodates',
To: rdamazio, #hg-reviewers
Cc: mercurial-devel
More information about the Mercurial-devel
mailing list