( )⚙ D10668 config: add --source option to include source of value

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10668

config: add --source option to include source of value
ClosedPublic

Authored by martinvonz on May 4 2021, 12:22 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG3e381eb557f3: config: add --source option to include source of value
Summary

Showing the source of each config option is quite useful and not
something the user should have to reach for the --debug flag for.

I updates documentation and tests, except for one place in
test-hgrc.t where I thought the test might have been intended to
also test that --debug results in ui.quiet etc being test.

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

martinvonz created this revision.May 4 2021, 12:22 PM
martinvonz added a commit: rHG3e381eb557f3: config: add --source option to include source of value.May 5 2021, 6:36 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG3e381eb557f3: config: add --source option to include source of value (authored by martinvonz). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 27596

mercurial/commands.py

  • This file is larger than 256 KB, so syntax highlighting is disabled by default.
@command( @command(
b'config|showconfig|debugconfig', b'config|showconfig|debugconfig',
[ [
(b'u', b'untrusted', None, _(b'show untrusted configuration options')), (b'u', b'untrusted', None, _(b'show untrusted configuration options')),
(b'e', b'edit', None, _(b'edit user config')), (b'e', b'edit', None, _(b'edit user config')),
(b'l', b'local', None, _(b'edit repository config')), (b'l', b'local', None, _(b'edit repository config')),
(b'', b'source', None, _(b'show source of configuration value')),
( (
b'', b'',
b'shared', b'shared',
None, None,
_(b'edit shared source repository config (EXPERIMENTAL)'), _(b'edit shared source repository config (EXPERIMENTAL)'),
), ),
(b'', b'non-shared', None, _(b'edit non shared config (EXPERIMENTAL)')), (b'', b'non-shared', None, _(b'edit non shared config (EXPERIMENTAL)')),
(b'g', b'global', None, _(b'edit global config')), (b'g', b'global', None, _(b'edit global config')),
With multiple arguments, print names and values of all config With multiple arguments, print names and values of all config
items with matching section names or section.names. items with matching section names or section.names.
With --edit, start an editor on the user-level config file. With With --edit, start an editor on the user-level config file. With
--global, edit the system-wide config file. With --local, edit the --global, edit the system-wide config file. With --local, edit the
repository-level config file. repository-level config file.
With --debug, the source (filename and line number) is printed With --source, the source (filename and line number) is printed
for each config item. for each config item.
See :hg:`help config` for more information about config files. See :hg:`help config` for more information about config files.
.. container:: verbose .. container:: verbose
--non-shared flag is used to edit `.hg/hgrc-not-shared` config file. --non-shared flag is used to edit `.hg/hgrc-not-shared` config file.
This file is not shared across shares when in share-safe mode. This file is not shared across shares when in share-safe mode.
if values: if values:
selsections = [v for v in values if b'.' not in v] selsections = [v for v in values if b'.' not in v]
selentries = [v for v in values if b'.' in v] selentries = [v for v in values if b'.' in v]
uniquesel = len(selentries) == 1 and not selsections uniquesel = len(selentries) == 1 and not selsections
selsections = set(selsections) selsections = set(selsections)
selentries = set(selentries) selentries = set(selentries)
matched = False matched = False
show_source = ui.debugflag or opts.get(b'source')
for section, name, value in ui.walkconfig(untrusted=untrusted): for section, name, value in ui.walkconfig(untrusted=untrusted):
source = ui.configsource(section, name, untrusted) source = ui.configsource(section, name, untrusted)
value = pycompat.bytestr(value) value = pycompat.bytestr(value)
defaultvalue = ui.configdefault(section, name) defaultvalue = ui.configdefault(section, name)
if fm.isplain(): if fm.isplain():
source = source or b'none' source = source or b'none'
value = value.replace(b'\n', b'\\n') value = value.replace(b'\n', b'\\n')
entryname = section + b'.' + name entryname = section + b'.' + name
if values and not (section in selsections or entryname in selentries): if values and not (section in selsections or entryname in selentries):
continue continue
fm.startitem() fm.startitem()
fm.condwrite(ui.debugflag, b'source', b'%s: ', source) fm.condwrite(show_source, b'source', b'%s: ', source)
if uniquesel: if uniquesel:
fm.data(name=entryname) fm.data(name=entryname)
fm.write(b'value', b'%s\n', value) fm.write(b'value', b'%s\n', value)
else: else:
fm.write(b'name value', b'%s=%s\n', entryname, value) fm.write(b'name value', b'%s=%s\n', entryname, value)
if formatter.isprintable(defaultvalue): if formatter.isprintable(defaultvalue):
fm.data(defaultvalue=defaultvalue) fm.data(defaultvalue=defaultvalue)
elif isinstance(defaultvalue, list) and all( elif isinstance(defaultvalue, list) and all(

mercurial/helptext/config.txt

The Mercurial system uses a set of configuration files to control The Mercurial system uses a set of configuration files to control
aspects of its behavior. aspects of its behavior.
Troubleshooting Troubleshooting
=============== ===============
If you're having problems with your configuration, If you're having problems with your configuration,
:hg:`config --debug` can help you understand what is introducing :hg:`config --source` can help you understand what is introducing
a setting into your environment. a setting into your environment.
See :hg:`help config.syntax` and :hg:`help config.files` See :hg:`help config.syntax` and :hg:`help config.files`
for information about how and where to override things. for information about how and where to override things.
Structure Structure
========= =========

relnotes/next

== New Features == == New Features ==
* `hg config` now has a `--source` option to show where each
configuration value comes from.
== Default Format Change == == Default Format Change ==
These changes affects newly created repositories (or new clone) done with These changes affects newly created repositories (or new clone) done with
Mercurial 5.8. Mercurial 5.8.
== New Experimental Features == == New Experimental Features ==

tests/test-completion.t

bisect: reset, good, bad, skip, extend, command, noupdate bisect: reset, good, bad, skip, extend, command, noupdate
bookmarks: force, rev, delete, rename, inactive, list, template bookmarks: force, rev, delete, rename, inactive, list, template
branch: force, clean, rev branch: force, clean, rev
branches: active, closed, rev, template branches: active, closed, rev, template
bundle: force, rev, branch, base, all, type, ssh, remotecmd, insecure bundle: force, rev, branch, base, all, type, ssh, remotecmd, insecure
cat: output, rev, decode, include, exclude, template cat: output, rev, decode, include, exclude, template
clone: noupdate, updaterev, rev, branch, pull, uncompressed, stream, ssh, remotecmd, insecure clone: noupdate, updaterev, rev, branch, pull, uncompressed, stream, ssh, remotecmd, insecure
commit: addremove, close-branch, amend, secret, edit, force-close-branch, interactive, include, exclude, message, logfile, date, user, subrepos commit: addremove, close-branch, amend, secret, edit, force-close-branch, interactive, include, exclude, message, logfile, date, user, subrepos
config: untrusted, edit, local, shared, non-shared, global, template config: untrusted, edit, local, source, shared, non-shared, global, template
continue: dry-run continue: dry-run
copy: forget, after, at-rev, force, include, exclude, dry-run copy: forget, after, at-rev, force, include, exclude, dry-run
debugancestor: debugancestor:
debugantivirusrunning: debugantivirusrunning:
debugapplystreamclonebundle: debugapplystreamclonebundle:
debugbackupbundle: recover, patch, git, limit, no-merges, stat, graph, style, template debugbackupbundle: recover, patch, git, limit, no-merges, stat, graph, style, template
debugbuilddag: mergeable-file, overwritten-file, new-file debugbuilddag: mergeable-file, overwritten-file, new-file
debugbundle: all, part-type, spec debugbundle: all, part-type, spec

tests/test-config.t

> ui.setconfig(b'empty', b'source', b'value') > ui.setconfig(b'empty', b'source', b'value')
> EOF > EOF
$ cp .hg/hgrc .hg/hgrc.orig $ cp .hg/hgrc .hg/hgrc.orig
$ cat <<EOF >> .hg/hgrc $ cat <<EOF >> .hg/hgrc
> [extensions] > [extensions]
> emptysource = `pwd`/emptysource.py > emptysource = `pwd`/emptysource.py
> EOF > EOF
$ hg config --debug empty.source $ hg config --source empty.source
read config from: * (glob)
none: value none: value
$ hg config empty.source -Tjson $ hg config empty.source -Tjson
[ [
{ {
"defaultvalue": null, "defaultvalue": null,
"name": "empty.source", "name": "empty.source",
"source": "", "source": "",
"value": "value" "value": "value"
edit failure edit failure
$ HGEDITOR=false hg config --edit $ HGEDITOR=false hg config --edit
abort: edit failed: false exited with status 1 abort: edit failed: false exited with status 1
[10] [10]
config affected by environment variables config affected by environment variables
$ EDITOR=e1 VISUAL=e2 hg config --debug | grep 'ui\.editor' $ EDITOR=e1 VISUAL=e2 hg config --source | grep 'ui\.editor'
$VISUAL: ui.editor=e2 $VISUAL: ui.editor=e2
$ VISUAL=e2 hg config --debug --config ui.editor=e3 | grep 'ui\.editor' $ VISUAL=e2 hg config --source --config ui.editor=e3 | grep 'ui\.editor'
--config: ui.editor=e3 --config: ui.editor=e3
$ PAGER=p1 hg config --debug | grep 'pager\.pager' $ PAGER=p1 hg config --source | grep 'pager\.pager'
$PAGER: pager.pager=p1 $PAGER: pager.pager=p1
$ PAGER=p1 hg config --debug --config pager.pager=p2 | grep 'pager\.pager' $ PAGER=p1 hg config --source --config pager.pager=p2 | grep 'pager\.pager'
--config: pager.pager=p2 --config: pager.pager=p2
verify that aliases are evaluated as well verify that aliases are evaluated as well
$ hg init aliastest $ hg init aliastest
$ cd aliastest $ cd aliastest
$ cat > .hg/hgrc << EOF $ cat > .hg/hgrc << EOF
> [ui] > [ui]

tests/test-hgrc.t

--quiet: ui.quiet=False --quiet: ui.quiet=False
source of paths is not mangled source of paths is not mangled
$ cat >> $HGRCPATH <<EOF $ cat >> $HGRCPATH <<EOF
> [paths] > [paths]
> foo = bar > foo = bar
> EOF > EOF
$ hg showconfig --debug paths $ hg showconfig --source paths
plain: True plain: True
read config from: $TESTTMP/hgrc
$TESTTMP/hgrc:17: paths.foo=$TESTTMP/bar $TESTTMP/hgrc:17: paths.foo=$TESTTMP/bar
Test we can skip the user configuration Test we can skip the user configuration
$ cat >> .hg/hgrc <<EOF $ cat >> .hg/hgrc <<EOF
> [paths] > [paths]
> elephant = babar > elephant = babar
> EOF > EOF

tests/test-lfs-bundle.t

---- Applying src-lfs.bundle to dst-lfs ---- ---- Applying src-lfs.bundle to dst-lfs ----
OK OK
Hint if the cache location cannot be inferred from the environment Hint if the cache location cannot be inferred from the environment
#if windows #if windows
$ unset LOCALAPPDATA $ unset LOCALAPPDATA
$ unset APPDATA $ unset APPDATA
$ HGRCPATH= hg config lfs --debug $ HGRCPATH= hg config lfs --source
abort: unknown lfs usercache location abort: unknown lfs usercache location
(define LOCALAPPDATA or APPDATA in the environment, or set lfs.usercache) (define LOCALAPPDATA or APPDATA in the environment, or set lfs.usercache)
[255] [255]
#endif #endif
#if osx #if osx
$ unset HOME $ unset HOME
$ HGRCPATH= hg config lfs --debug $ HGRCPATH= hg config lfs --source
abort: unknown lfs usercache location abort: unknown lfs usercache location
(define HOME in the environment, or set lfs.usercache) (define HOME in the environment, or set lfs.usercache)
[255] [255]
#endif #endif
#if no-windows no-osx #if no-windows no-osx
$ unset XDG_CACHE_HOME $ unset XDG_CACHE_HOME
$ unset HOME $ unset HOME
$ HGRCPATH= hg config lfs --debug $ HGRCPATH= hg config lfs --source
abort: unknown lfs usercache location abort: unknown lfs usercache location
(define XDG_CACHE_HOME or HOME in the environment, or set lfs.usercache) (define XDG_CACHE_HOME or HOME in the environment, or set lfs.usercache)
[255] [255]
#endif #endif

tests/test-phabricator.t

+ return set() + return set()
+ +
def _loadextensions(self): def _loadextensions(self):
extensions.loadall(self.ui) extensions.loadall(self.ui)
A bad .arcconfig doesn't error out A bad .arcconfig doesn't error out
$ echo 'garbage' > .arcconfig $ echo 'garbage' > .arcconfig
$ hg config phabricator --debug $ hg config phabricator --source
invalid JSON in $TESTTMP/repo/.arcconfig invalid JSON in $TESTTMP/repo/.arcconfig
read config from: */.hgrc (glob)
*/.hgrc:*: phabricator.debug=True (glob) */.hgrc:*: phabricator.debug=True (glob)
$TESTTMP/repo/.hg/hgrc:*: phabricator.url=https://phab.mercurial-scm.org/ (glob) $TESTTMP/repo/.hg/hgrc:*: phabricator.url=https://phab.mercurial-scm.org/ (glob)
$TESTTMP/repo/.hg/hgrc:*: phabricator.callsign=HG (glob) $TESTTMP/repo/.hg/hgrc:*: phabricator.callsign=HG (glob)
The .arcconfig content overrides global config The .arcconfig content overrides global config
$ cat >> $HGRCPATH << EOF $ cat >> $HGRCPATH << EOF
> [phabricator] > [phabricator]
> url = global > url = global
> callsign = global > callsign = global
> EOF > EOF
$ cp $TESTDIR/../.arcconfig . $ cp $TESTDIR/../.arcconfig .
$ mv .hg/hgrc .hg/hgrc.bak $ mv .hg/hgrc .hg/hgrc.bak
$ hg config phabricator --debug $ hg config phabricator --source
read config from: */.hgrc (glob)
*/.hgrc:*: phabricator.debug=True (glob) */.hgrc:*: phabricator.debug=True (glob)
$TESTTMP/repo/.arcconfig: phabricator.callsign=HG $TESTTMP/repo/.arcconfig: phabricator.callsign=HG
$TESTTMP/repo/.arcconfig: phabricator.url=https://phab.mercurial-scm.org/ $TESTTMP/repo/.arcconfig: phabricator.url=https://phab.mercurial-scm.org/
But it doesn't override local config But it doesn't override local config
$ cat >> .hg/hgrc << EOF $ cat >> .hg/hgrc << EOF
> [phabricator] > [phabricator]
> url = local > url = local
> callsign = local > callsign = local
> EOF > EOF
$ hg config phabricator --debug $ hg config phabricator --source
read config from: */.hgrc (glob)
*/.hgrc:*: phabricator.debug=True (glob) */.hgrc:*: phabricator.debug=True (glob)
$TESTTMP/repo/.hg/hgrc:*: phabricator.url=local (glob) $TESTTMP/repo/.hg/hgrc:*: phabricator.url=local (glob)
$TESTTMP/repo/.hg/hgrc:*: phabricator.callsign=local (glob) $TESTTMP/repo/.hg/hgrc:*: phabricator.callsign=local (glob)
$ mv .hg/hgrc.bak .hg/hgrc $ mv .hg/hgrc.bak .hg/hgrc
Phabimport works with a stack Phabimport works with a stack
$ cd .. $ cd ..