This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5187

help: describe what ui.tweakdefaults changes, concretely
ClosedPublic

Authored by valentin.gatienbaron on Oct 23 2018, 3:28 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGe928bedf0919: help: describe what ui.tweakdefaults changes, concretely
Summary

Currently, one has to look at the code.

A couple things are suboptimal:

  • probably not translatable
  • lines don't get wrapped (a couple are a bit too long)

but it seems to better this way than without help at all.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

yuja added a subscriber: yuja.Oct 24 2018, 7:45 AM

+ ui,

Nit: ui as uimod per test-check-code.t.

@@ -436,6 +437,11 @@
addtopicsymbols('templates', '.. functionsmarker', templatefuncs.funcs)
addtopicsymbols('hgweb', '.. webcommandsmarker', webcommands.commands,

dedent=True)

+def docplaceholder():
+ pass
+docplaceholder.doc = ui.tweakrc
+addtopicsymbols('config', '.. tweakdefaultsmarker', {'': docplaceholder},
+ dedent=True)

Alternatively, we can register a dedicated loader by addtopichook(). Only
thing we'll have to do is to replace a placeholder with indented tweakrc.

valentin.gatienbaron edited the summary of this revision. (Show Details)Oct 24 2018, 11:01 AM
valentin.gatienbaron updated this revision to Diff 12340.
valentin.gatienbaron added a comment.Oct 24 2018, 7:29 PM

I actually ran the tests, but didn't see the style error, because the test in question is among the several ones that never pass for me. Fixed now.

yuja added a comment.Oct 25 2018, 7:35 AM

Looks good and simple. Queued for stable, thanks.

Closed by commit rHGe928bedf0919: help: describe what ui.tweakdefaults changes, concretely (authored by valentin.gatienbaron). · Explain WhyOct 25 2018, 7:41 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/help.py (12 lines)
Mmercurial/help/config.txt (4 lines)

Diff 12340

mercurial/help.py

# help.py - help data for mercurial # help.py - help data for mercurial
# #
# Copyright 2006 Matt Mackall <mpm@selenic.com> # Copyright 2006 Matt Mackall <mpm@selenic.com>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
import itertools import itertools
import os import os
import re
import textwrap import textwrap
from .i18n import ( from .i18n import (
_, _,
gettext, gettext,
) )
from . import ( from . import (
cmdutil, cmdutil,
encoding, encoding,
error, error,
extensions, extensions,
fancyopts, fancyopts,
filemerge, filemerge,
fileset, fileset,
minirst, minirst,
pycompat, pycompat,
registrar, registrar,
revset, revset,
templatefilters, templatefilters,
templatefuncs, templatefuncs,
templatekw, templatekw,
ui as uimod,
util, util,
) )
from .hgweb import ( from .hgweb import (
webcommands, webcommands,
) )
_exclkeywords = { _exclkeywords = {
"(ADVANCED)", "(ADVANCED)",
filemerge.internalsdoc) filemerge.internalsdoc)
addtopicsymbols('revisions', '.. predicatesmarker', revset.symbols) addtopicsymbols('revisions', '.. predicatesmarker', revset.symbols)
addtopicsymbols('templates', '.. keywordsmarker', templatekw.keywords) addtopicsymbols('templates', '.. keywordsmarker', templatekw.keywords)
addtopicsymbols('templates', '.. filtersmarker', templatefilters.filters) addtopicsymbols('templates', '.. filtersmarker', templatefilters.filters)
addtopicsymbols('templates', '.. functionsmarker', templatefuncs.funcs) addtopicsymbols('templates', '.. functionsmarker', templatefuncs.funcs)
addtopicsymbols('hgweb', '.. webcommandsmarker', webcommands.commands, addtopicsymbols('hgweb', '.. webcommandsmarker', webcommands.commands,
dedent=True) dedent=True)
def inserttweakrc(ui, topic, doc):
marker = '.. tweakdefaultsmarker'
repl = uimod.tweakrc
def sub(m):
lines = [m.group(1) + s for s in repl.splitlines()]
return '\n'.join(lines)
return re.sub(br'( *)%s' % re.escape(marker), sub, doc)
addtopichook('config', inserttweakrc)
def help_(ui, commands, name, unknowncmd=False, full=True, subtopic=None, def help_(ui, commands, name, unknowncmd=False, full=True, subtopic=None,
**opts): **opts):
''' '''
Generate the help for 'name' as unformatted restructured text. If Generate the help for 'name' as unformatted restructured text. If
'name' is None, describe the commands available. 'name' is None, describe the commands available.
''' '''
opts = pycompat.byteskwargs(opts) opts = pycompat.byteskwargs(opts)

mercurial/help/config.txt

By default Mercurial's behavior changes very little from release By default Mercurial's behavior changes very little from release
to release, but over time the recommended config settings to release, but over time the recommended config settings
shift. Enable this config to opt in to get automatic tweaks to shift. Enable this config to opt in to get automatic tweaks to
Mercurial's behavior over time. This config setting will have no Mercurial's behavior over time. This config setting will have no
effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
not include ``tweakdefaults``. (default: False) not include ``tweakdefaults``. (default: False)
It currently means::
.. tweakdefaultsmarker
``username`` ``username``
The committer of a changeset created when running "commit". The committer of a changeset created when running "commit".
Typically a person's name and email address, e.g. ``Fred Widget Typically a person's name and email address, e.g. ``Fred Widget
<fred@example.com>``. Environment variables in the <fred@example.com>``. Environment variables in the
username are expanded. username are expanded.
(default: ``$EMAIL`` or ``username@hostname``. If the username in (default: ``$EMAIL`` or ``username@hostname``. If the username in
hgrc is empty, e.g. if the system admin set ``username =`` in the hgrc is empty, e.g. if the system admin set ``username =`` in the