This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5742

histedit: add templating support to histedit's rule file generation
ClosedPublic

Authored by durin42 on Jan 29 2019, 7:26 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG11c076786d56: histedit: add templating support to histedit's rule file generation
rHG8d0c14d3420f: histedit: add templating support to histedit's rule file generation
rHG2b11fb23a1fe: histedit: add templating support to histedit's rule file generation
rHG43a40d6fd56c: histedit: add templating support to histedit's rule file generation
Summary

This will allow users to customize the display of the rule list for the
free-form segment that we don't interpret. We've had users want to add things
like bookmark names or similar to the rule list as a convenience, which seems
reasonable.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

durin42 created this revision.Jan 29 2019, 7:26 PM
durin42 updated this revision to Diff 13565.Jan 29 2019, 7:52 PM
yuja added a subscriber: yuja.Jan 30 2019, 7:11 AM

+ [histedit]
+ summary-format = '{rev} {bookmarks} {desc|firstline}'

Perhaps, "summary-template" is more consistent with the other config keys.

ctx = self.repo[self.node]
  • summary = _getsummary(ctx)
  • line = '%s %s %d %s' % (self.verb, ctx, ctx.rev(), summary)

+ ui = self.repo.ui
+ tres = formatter.templateresources(ui, self.repo)
+ t = formatter.maketemplater(ui, ui.config('histedit', 'summary-format'),
+ defaults=templatekw.keywords,
+ resources=tres)

cmdutil.rendertemplate() can be used.

And it's probably better to do templater.unquotestring(ui.config(...)) for
consistency, even though we won't need any syntax to preserve leading/trailing
spaces here.

+ summary = t.renderdefault({'ctx': ctx}).splitlines()[0]

Nit: splitlines()[0] would fail if template was empty.

durin42 updated this revision to Diff 13570.Jan 30 2019, 8:18 AM
Closed by commit rHG43a40d6fd56c: histedit: add templating support to histedit's rule file generation (authored by durin42). · Explain WhyFeb 1 2019, 8:50 PM
This revision was automatically updated to reflect the committed changes.
yuja added a comment.Feb 1 2019, 8:50 PM

Queued, thanks.

+++ b/mercurial/help.py
@@ -394,7 +394,17 @@
def addtopichook(topic, rewriter):

helphooks.setdefault(topic, []).append(rewriter)

-def makeitemsdoc(ui, topic, doc, marker, items, dedent=False):
+def _templateextsyms(ui, topic, doc):
+ for name, ext in extensions.extensions(ui):
+ kw = getattr(ext, 'templatekeyword', None)
+ if kw is not None:
+ doc = addtopicsymbols(
+ 'templates', 'Filters\n=======', kw, keepmarker=True)
+ return doc
+
+addtopichook('templating', _templateextsyms)
+
+def makeitemsdoc(ui, topic, doc, marker, items, dedent=False, keepmarker=False):

"""Extract docstring from the items key to function mapping, build a
single documentation block and use it to overwrite the marker in doc.
"""

@@ -420,11 +430,14 @@

            doclines.append('  ' + l.strip())
    entries.append('\n'.join(doclines))
entries = '\n\n'.join(entries)

+ if keepmarker:
+ entries = entries + '\n\n' + marker

return doc.replace(marker, entries)

-def addtopicsymbols(topic, marker, symbols, dedent=False):
+def addtopicsymbols(topic, marker, symbols, dedent=False, keepmarker=False):

def add(ui, topic, doc):
  • return makeitemsdoc(ui, topic, doc, marker, symbols, dedent=dedent)

+ return makeitemsdoc(ui, topic, doc, marker, symbols, dedent=dedent,
+ keepmarker=keepmarker)

Looks like unrelated change. Dropped.

+ summary = cmdutil.rendertemplate(
+ ctx, ui.config('histedit', 'summary-template')) or ''
+ summary = summary.splitlines()[0]

Still crash. ''.splitlines() == []

Revision Contents
Changeset List

PathPackages
Mhgext/histedit.py (22 lines)
Mtests/test-histedit-commute.t (25 lines)

Diff 13564

hgext/histedit.py

Histedit rule lines are truncated to 80 characters by default. You Histedit rule lines are truncated to 80 characters by default. You
can customize this behavior by setting a different length in your can customize this behavior by setting a different length in your
configuration file:: configuration file::
[histedit] [histedit]
linelen = 120 # truncate rule lines at 120 characters linelen = 120 # truncate rule lines at 120 characters
The summary of a change can be customized as well::
[histedit]
summary-format = '{rev} {bookmarks} {desc|firstline}'
The customized summary should be kept short enough that rule lines
will fit in the configured line length. See above if that requires
customization.
``hg histedit`` attempts to automatically choose an appropriate base ``hg histedit`` attempts to automatically choose an appropriate base
revision to use. To change which base revision is used, define a revision to use. To change which base revision is used, define a
revset in your configuration file:: revset in your configuration file::
[histedit] [histedit]
defaultrev = only(.) & draft() defaultrev = only(.) & draft()
By default each edited revision needs to be present in histedit commands. By default each edited revision needs to be present in histedit commands.
cmdutil, cmdutil,
context, context,
copies, copies,
destutil, destutil,
discovery, discovery,
error, error,
exchange, exchange,
extensions, extensions,
formatter,
templatekw,
hg, hg,
logcmdutil, logcmdutil,
merge as mergemod, merge as mergemod,
mergeutil, mergeutil,
node, node,
obsolete, obsolete,
pycompat, pycompat,
registrar, registrar,
default=80, default=80,
) )
configitem('histedit', 'singletransaction', configitem('histedit', 'singletransaction',
default=False, default=False,
) )
configitem('ui', 'interface.histedit', configitem('ui', 'interface.histedit',
default=None, default=None,
) )
configitem('histedit', 'summary-format',
default='{rev} {desc|firstline}')
# Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
# extensions which SHIP WITH MERCURIAL. Non-mainline extensions should # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
# be specifying the version(s) of Mercurial they are tested with, or # be specifying the version(s) of Mercurial they are tested with, or
# leave the attribute unspecified. # leave the attribute unspecified.
testedwith = 'ships-with-hg-core' testedwith = 'ships-with-hg-core'
actiontable = {} actiontable = {}
def torule(self): def torule(self):
"""build a histedit rule line for an action """build a histedit rule line for an action
by default lines are in the form: by default lines are in the form:
<hash> <rev> <summary> <hash> <rev> <summary>
""" """
ctx = self.repo[self.node] ctx = self.repo[self.node]
summary = _getsummary(ctx) ui = self.repo.ui
line = '%s %s %d %s' % (self.verb, ctx, ctx.rev(), summary) tres = formatter.templateresources(ui, self.repo)
t = formatter.maketemplater(ui, ui.config('histedit', 'summary-format'),
defaults=templatekw.keywords,
resources=tres)
summary = t.renderdefault({'ctx': ctx}).splitlines()[0]
line = '%s %s %s' % (self.verb, ctx, summary)
# trim to 75 columns by default so it's not stupidly wide in my editor # trim to 75 columns by default so it's not stupidly wide in my editor
# (the 5 more are left for verb) # (the 5 more are left for verb)
maxlen = self.repo.ui.configint('histedit', 'linelen') maxlen = self.repo.ui.configint('histedit', 'linelen')
maxlen = max(maxlen, 22) # avoid truncating hash maxlen = max(maxlen, 22) # avoid truncating hash
return stringutil.ellipsis(line, maxlen) return stringutil.ellipsis(line, maxlen)
def tostate(self): def tostate(self):
"""Print an action in format used by histedit state files """Print an action in format used by histedit state files

tests/test-histedit-commute.t

# m, mess = edit commit message without changing commit content # m, mess = edit commit message without changing commit content
# p, pick = use commit # p, pick = use commit
# b, base = checkout changeset and apply further changesets from there # b, base = checkout changeset and apply further changesets from there
# d, drop = remove commit from history # d, drop = remove commit from history
# f, fold = use commit, but combine it with the one above # f, fold = use commit, but combine it with the one above
# r, roll = like fold, but discard this commit's description and date # r, roll = like fold, but discard this commit's description and date
# #
test customization of revision summary
$ HGEDITOR=cat hg histedit 177f92b77385 \
> --config histedit.summary-format='I am rev {rev} desc {desc} tags {tags}'
pick 177f92b77385 I am rev 2 desc c tags
pick 055a42cdd887 I am rev 3 desc d tags
pick e860deea161a I am rev 4 desc e tags
pick 652413bf663e I am rev 5 desc f tags tip
# Edit history between 177f92b77385 and 652413bf663e
#
# Commits are listed from least to most recent
#
# You can reorder changesets by reordering the lines
#
# Commands:
#
# e, edit = use commit, but stop for amending
# m, mess = edit commit message without changing commit content
# p, pick = use commit
# b, base = checkout changeset and apply further changesets from there
# d, drop = remove commit from history
# f, fold = use commit, but combine it with the one above
# r, roll = like fold, but discard this commit's description and date
#
edit the history edit the history
(use a hacky editor to check histedit-last-edit.txt backup) (use a hacky editor to check histedit-last-edit.txt backup)
$ EDITED="$TESTTMP/editedhistory" $ EDITED="$TESTTMP/editedhistory"
$ cat > $EDITED <<EOF $ cat > $EDITED <<EOF
> edit 177f92b77385 c > edit 177f92b77385 c
> pick e860deea161a e > pick e860deea161a e
> pick 652413bf663e f > pick 652413bf663e f