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 (19 lines)
Mmercurial/help.py (19 lines)
Mtests/test-histedit-commute.t (47 lines)

Diff 13570

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-template = '{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.
mergeutil, mergeutil,
node, node,
obsolete, obsolete,
pycompat, pycompat,
registrar, registrar,
repair, repair,
scmutil, scmutil,
state as statemod, state as statemod,
templatekw,
util, util,
) )
from mercurial.utils import ( from mercurial.utils import (
dateutil, dateutil,
stringutil, stringutil,
) )
pickle = util.pickle pickle = util.pickle
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-template',
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) summary = cmdutil.rendertemplate(
ctx, ui.config('histedit', 'summary-template')) or ''
summary = summary.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

mercurial/help.py

# Map topics to lists of callable taking the current topic help and # Map topics to lists of callable taking the current topic help and
# returning the updated version # returning the updated version
helphooks = {} helphooks = {}
def addtopichook(topic, rewriter): def addtopichook(topic, rewriter):
helphooks.setdefault(topic, []).append(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 """Extract docstring from the items key to function mapping, build a
single documentation block and use it to overwrite the marker in doc. single documentation block and use it to overwrite the marker in doc.
""" """
entries = [] entries = []
for name in sorted(items): for name in sorted(items):
text = (pycompat.getdoc(items[name]) or '').rstrip() text = (pycompat.getdoc(items[name]) or '').rstrip()
if (not text if (not text
or not ui.verbose and any(w in text for w in _exclkeywords)): or not ui.verbose and any(w in text for w in _exclkeywords)):
if l.strip().startswith('>>>'): if l.strip().startswith('>>>'):
break break
if dedent: if dedent:
doclines.append(l.rstrip()) doclines.append(l.rstrip())
else: else:
doclines.append(' ' + l.strip()) doclines.append(' ' + l.strip())
entries.append('\n'.join(doclines)) entries.append('\n'.join(doclines))
entries = '\n\n'.join(entries) entries = '\n\n'.join(entries)
if keepmarker:
entries = entries + '\n\n' + marker
return doc.replace(marker, entries) 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): 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)
addtopichook(topic, add) addtopichook(topic, add)
addtopicsymbols('bundlespec', '.. bundlecompressionmarker', addtopicsymbols('bundlespec', '.. bundlecompressionmarker',
util.bundlecompressiontopics()) util.bundlecompressiontopics())
addtopicsymbols('filesets', '.. predicatesmarker', fileset.symbols) addtopicsymbols('filesets', '.. predicatesmarker', fileset.symbols)
addtopicsymbols('merge-tools', '.. internaltoolsmarker', addtopicsymbols('merge-tools', '.. internaltoolsmarker',
filemerge.internalsdoc) filemerge.internalsdoc)
addtopicsymbols('revisions', '.. predicatesmarker', revset.symbols) addtopicsymbols('revisions', '.. predicatesmarker', revset.symbols)

tests/test-histedit-commute.t

| user: test | user: test
| date: Thu Jan 01 00:00:00 1970 +0000 | date: Thu Jan 01 00:00:00 1970 +0000
| summary: b | summary: b
| |
o changeset: 0:cb9a9f314b8b o changeset: 0:cb9a9f314b8b
user: test user: test
date: Thu Jan 01 00:00:00 1970 +0000 date: Thu Jan 01 00:00:00 1970 +0000
summary: a summary: a
show the edit commands offered show the edit commands offered
$ HGEDITOR=cat hg histedit 177f92b77385 $ HGEDITOR=cat hg histedit 177f92b77385
pick 177f92b77385 2 c pick 177f92b77385 2 c
pick 055a42cdd887 3 d pick 055a42cdd887 3 d
pick e860deea161a 4 e pick e860deea161a 4 e
pick 652413bf663e 5 f pick 652413bf663e 5 f
# Edit history between 177f92b77385 and 652413bf663e # Edit history between 177f92b77385 and 652413bf663e
# #
# Commits are listed from least to most recent # Commits are listed from least to most recent
# #
# You can reorder changesets by reordering the lines # You can reorder changesets by reordering the lines
# #
# Commands: # Commands:
# #
# e, edit = use commit, but stop for amending # e, edit = use commit, but stop for amending
# 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-template='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
| user: test | user: test
| date: Thu Jan 01 00:00:00 1970 +0000 | date: Thu Jan 01 00:00:00 1970 +0000
| summary: b | summary: b
| |
o changeset: 0:cb9a9f314b8b o changeset: 0:cb9a9f314b8b
user: test user: test
date: Thu Jan 01 00:00:00 1970 +0000 date: Thu Jan 01 00:00:00 1970 +0000
summary: a summary: a
put things back put things back
$ hg histedit 177f92b77385 --commands - 2>&1 << EOF | fixbundle $ hg histedit 177f92b77385 --commands - 2>&1 << EOF | fixbundle
> pick 177f92b77385 c > pick 177f92b77385 c
> pick 07114f51870f d > pick 07114f51870f d
> pick d8249471110a e > pick d8249471110a e
> pick 8ade9693061e f > pick 8ade9693061e f
| user: test | user: test
| date: Thu Jan 01 00:00:00 1970 +0000 | date: Thu Jan 01 00:00:00 1970 +0000
| summary: b | summary: b
| |
o changeset: 0:cb9a9f314b8b o changeset: 0:cb9a9f314b8b
user: test user: test
date: Thu Jan 01 00:00:00 1970 +0000 date: Thu Jan 01 00:00:00 1970 +0000
summary: a summary: a
slightly different this time slightly different this time
$ hg histedit 177f92b77385 --commands - << EOF 2>&1 | fixbundle $ hg histedit 177f92b77385 --commands - << EOF 2>&1 | fixbundle
> pick 10517e47bbbb d > pick 10517e47bbbb d
> pick 7eca9b5b1148 f > pick 7eca9b5b1148 f
> pick 915da888f2de e > pick 915da888f2de e
> pick 177f92b77385 c > pick 177f92b77385 c
| user: test | user: test
| date: Thu Jan 01 00:00:00 1970 +0000 | date: Thu Jan 01 00:00:00 1970 +0000
| summary: b | summary: b
| |
o changeset: 0:cb9a9f314b8b o changeset: 0:cb9a9f314b8b
user: test user: test
date: Thu Jan 01 00:00:00 1970 +0000 date: Thu Jan 01 00:00:00 1970 +0000
summary: a summary: a
keep prevents stripping dead revs keep prevents stripping dead revs
$ hg histedit 799205341b6b --keep --commands - 2>&1 << EOF | fixbundle $ hg histedit 799205341b6b --keep --commands - 2>&1 << EOF | fixbundle
> pick 799205341b6b d > pick 799205341b6b d
> pick be9ae3a309c6 f > pick be9ae3a309c6 f
> pick 38b92f448761 c > pick 38b92f448761 c
> pick de71b079d9ce e > pick de71b079d9ce e
> EOF > EOF
| user: test | user: test
| date: Thu Jan 01 00:00:00 1970 +0000 | date: Thu Jan 01 00:00:00 1970 +0000
| summary: b | summary: b
| |
o changeset: 0:cb9a9f314b8b o changeset: 0:cb9a9f314b8b
user: test user: test
date: Thu Jan 01 00:00:00 1970 +0000 date: Thu Jan 01 00:00:00 1970 +0000
summary: a summary: a
try with --rev try with --rev
$ hg histedit --commands - --rev -2 2>&1 <<EOF | fixbundle $ hg histedit --commands - --rev -2 2>&1 <<EOF | fixbundle
> pick de71b079d9ce e > pick de71b079d9ce e
> pick 38b92f448761 c > pick 38b92f448761 c
> EOF > EOF
hg: parse error: pick "de71b079d9ce" changeset was not a candidate hg: parse error: pick "de71b079d9ce" changeset was not a candidate
(only use listed changesets) (only use listed changesets)
| user: test | user: test
| date: Thu Jan 01 00:00:00 1970 +0000 | date: Thu Jan 01 00:00:00 1970 +0000
| summary: b | summary: b
| |
o changeset: 0:cb9a9f314b8b o changeset: 0:cb9a9f314b8b
user: test user: test
date: Thu Jan 01 00:00:00 1970 +0000 date: Thu Jan 01 00:00:00 1970 +0000
summary: a summary: a
Verify that revsetalias entries work with histedit: Verify that revsetalias entries work with histedit:
$ cat >> $HGRCPATH <<EOF $ cat >> $HGRCPATH <<EOF
> [revsetalias] > [revsetalias]
> grandparent(ARG) = p1(p1(ARG)) > grandparent(ARG) = p1(p1(ARG))
> EOF > EOF
$ echo extra commit >> c $ echo extra commit >> c
$ hg ci -m 'extra commit to c' $ hg ci -m 'extra commit to c'
$ HGEDITOR=cat hg histedit 'grandparent(.)' $ HGEDITOR=cat hg histedit 'grandparent(.)'
pick ece0b8d93dda 6 c pick ece0b8d93dda 6 c
pick 803ef1c6fcfd 7 e pick 803ef1c6fcfd 7 e
pick 9c863c565126 8 extra commit to c pick 9c863c565126 8 extra commit to c
# Edit history between ece0b8d93dda and 9c863c565126 # Edit history between ece0b8d93dda and 9c863c565126
# #
# Commits are listed from least to most recent # Commits are listed from least to most recent
# #
# You can reorder changesets by reordering the lines # You can reorder changesets by reordering the lines
# #
# Commands: # Commands:
# #
o changeset: 1:3b3e956f9171 o changeset: 1:3b3e956f9171
| user: Robert Altman <robert.altman@telventDTN.com> | user: Robert Altman <robert.altman@telventDTN.com>
| date: Mon Nov 28 16:37:57 2011 +0000 | date: Mon Nov 28 16:37:57 2011 +0000
| |
o changeset: 0:141947992243 o changeset: 0:141947992243
user: Robert Altman <robert.altman@telventDTN.com> user: Robert Altman <robert.altman@telventDTN.com>
date: Mon Nov 28 16:35:28 2011 +0000 date: Mon Nov 28 16:35:28 2011 +0000
summary: Checked in text file summary: Checked in text file
$ hg histedit 0 $ hg histedit 0
$ cd .. $ cd ..
$ cd .. $ cd ..
Test to make sure folding renames doesn't cause bogus conflicts (issue4251): Test to make sure folding renames doesn't cause bogus conflicts (issue4251):
$ hg init issue4251 $ hg init issue4251
# User test # User test
# Date 0 0 # Date 0 0
# Thu Jan 01 00:00:00 1970 +0000 # Thu Jan 01 00:00:00 1970 +0000
# Node ID fffadc26f8f85623ce60b028a3f1ccc3730f8530 # Node ID fffadc26f8f85623ce60b028a3f1ccc3730f8530
# Parent 0000000000000000000000000000000000000000 # Parent 0000000000000000000000000000000000000000
pick b0f4233702ca 0 initial commit pick b0f4233702ca 0 initial commit
fold 5e8704a8f2d2 1 moved and changed fold 5e8704a8f2d2 1 moved and changed
pick 40e7299e8fa7 2 renamed pick 40e7299e8fa7 2 renamed
diff --git a/another-dir/initial-file b/another-dir/initial-file diff --git a/another-dir/initial-file b/another-dir/initial-file
new file mode 100644 new file mode 100644
--- /dev/null --- /dev/null
+++ b/another-dir/initial-file +++ b/another-dir/initial-file
@@ -0,0 +1,1 @@ @@ -0,0 +1,1 @@
+changed +changed
$ hg --config diff.git=yes export 1 $ hg --config diff.git=yes export 1
# HG changeset patch # HG changeset patch
# User test # User test
# Date 0 0 # Date 0 0
# Thu Jan 01 00:00:00 1970 +0000 # Thu Jan 01 00:00:00 1970 +0000
# Node ID 9b730d82b00af8a2766facebfa47cc124405a118 # Node ID 9b730d82b00af8a2766facebfa47cc124405a118
# Parent fffadc26f8f85623ce60b028a3f1ccc3730f8530 # Parent fffadc26f8f85623ce60b028a3f1ccc3730f8530
renamed renamed
diff --git a/another-dir/initial-file b/another-dir/renamed-file diff --git a/another-dir/initial-file b/another-dir/renamed-file
rename from another-dir/initial-file rename from another-dir/initial-file
rename to another-dir/renamed-file rename to another-dir/renamed-file
$ cd .. $ cd ..
Test that branches are preserved and stays active Test that branches are preserved and stays active
------------------------------------------------- -------------------------------------------------