This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7807

hgrc: introduce HGRCSKIPREPO to skip reading the repository's hgrc
ClosedPublic

Authored by marmoute on Jan 7 2020, 6:04 AM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGd56a2d6f34f0: hgrc: introduce HGRCSKIPREPO to skip reading the repository's hgrc
Summary

We had a way to change the behavior regarding reading the global and user
config, but we had nothing regarding the repository hgrc itself.

This option is useful in situation where scripts need to be able to work around
strange configuration set by the user in his repository. (and were HGPLAIN is
not enough).

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

marmoute created this revision.Jan 7 2020, 6:04 AM
pulkit added a subscriber: pulkit.Jan 8 2020, 6:54 AM

hgrc: introduce HGRCSKIPREPO to skip reading the hgrc's repository

s/ hgrc's repository/repository's hgrc

durin42 added subscribers: krbullock, durin42.Jan 8 2020, 11:31 AM
durin42 added inline comments.
mercurial/helptext/scripting.txt
80

Awkward. Maybe:

Note that not reading the repository's configuration is likely to have unintended consequences, as the repository config files can define things like extensions that are required for access to the repository.

(I don't love that either. Maybe @krbullock has an idea?)

marmoute retitled this revision from hgrc: introduce HGRCSKIPREPO to skip reading the hgrc's repository to hgrc: introduce HGRCSKIPREPO to skip reading the repository's hgrc.Jan 9 2020, 3:45 AM
marmoute updated this revision to Diff 19120.
pulkit accepted this revision.Jan 21 2020, 11:05 AM
This revision is now accepted and ready to land.Jan 21 2020, 11:05 AM

Revision Contents
Changeset List

Diff 19482

mercurial/helptext/environment.txt

is not set, platform default search path is used. If empty, only is not set, platform default search path is used. If empty, only
the .hg/hgrc from the current repository is read. the .hg/hgrc from the current repository is read.
For each element in HGRCPATH: For each element in HGRCPATH:
- if it's a directory, all files ending with .rc are added - if it's a directory, all files ending with .rc are added
- otherwise, the file itself will be added - otherwise, the file itself will be added
HGRCSKIPREPO
When set, the .hg/hgrc from repositories are not read.
HGPLAIN HGPLAIN
When set, this disables any configuration settings that might When set, this disables any configuration settings that might
change Mercurial's default output. This includes encoding, change Mercurial's default output. This includes encoding,
defaults, verbose mode, debug mode, quiet mode, tracebacks, and defaults, verbose mode, debug mode, quiet mode, tracebacks, and
localization. This can be useful when scripting against Mercurial localization. This can be useful when scripting against Mercurial
in the face of existing user configuration. in the face of existing user configuration.
In addition to the features disabled by ``HGPLAIN=``, the following In addition to the features disabled by ``HGPLAIN=``, the following

mercurial/helptext/scripting.txt

value of ``HGRCPATH`` can be set to an explicit file with known good value of ``HGRCPATH`` can be set to an explicit file with known good
configs. In rare cases, the value can be set to an empty file or the configs. In rare cases, the value can be set to an empty file or the
null device (often ``/dev/null``) to bypass loading of any user or null device (often ``/dev/null``) to bypass loading of any user or
system config files. Note that these approaches can have unintended system config files. Note that these approaches can have unintended
consequences, as the user and system config files often define things consequences, as the user and system config files often define things
like the username and extensions that may be required to interface like the username and extensions that may be required to interface
with a repository. with a repository.
HGRCSKIPREPO
When set, the .hg/hgrc from repositories are not read.
Note that not reading the repository's configuration can have
durin42Unsubmitted
Not Done

Awkward. Maybe:

Note that not reading the repository's configuration is likely to have unintended consequences, as the repository config files can define things like extensions that are required for access to the repository.

(I don't love that either. Maybe @krbullock has an idea?)

durin42: Awkward. Maybe: Note that not reading the repository's configuration is likely to have…
unintended consequences, as the repository config files can define
things like extensions that are required for access to the
repository.
Command-line Flags Command-line Flags
================== ==================
Mercurial's default command-line parser is designed for humans, and is not Mercurial's default command-line parser is designed for humans, and is not
robust against malicious input. For instance, you can start a debugger by robust against malicious input. For instance, you can start a debugger by
passing ``--debugger`` as an option value:: passing ``--debugger`` as an option value::
$ REV=--debugger sh -c 'hg log -r "$REV"' $ REV=--debugger sh -c 'hg log -r "$REV"'

mercurial/localrepo.py

config files or settings relevant to the current repository. config files or settings relevant to the current repository.
Returns a bool indicating whether any additional configs were loaded. Returns a bool indicating whether any additional configs were loaded.
Extensions should monkeypatch this function to modify how per-repo Extensions should monkeypatch this function to modify how per-repo
configs are loaded. For example, an extension may wish to pull in configs are loaded. For example, an extension may wish to pull in
configs from alternate files or sources. configs from alternate files or sources.
""" """
if b'HGRCSKIPREPO' in encoding.environ:
return False
try: try:
ui.readconfig(hgvfs.join(b'hgrc'), root=wdirvfs.base) ui.readconfig(hgvfs.join(b'hgrc'), root=wdirvfs.base)
return True return True
except IOError: except IOError:
return False return False
def afterhgrcload(ui, wdirvfs, hgvfs, requirements): def afterhgrcload(ui, wdirvfs, hgvfs, requirements):

tests/test-hgrc.t

$ cat >> $HGRCPATH <<EOF $ cat >> $HGRCPATH <<EOF
> [paths] > [paths]
> foo = bar > foo = bar
> EOF > EOF
$ hg showconfig --debug paths $ hg showconfig --debug paths
plain: True plain: True
read config from: $TESTTMP/hgrc 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
$ cat >> .hg/hgrc <<EOF
> [paths]
> elephant = babar
> EOF
$ hg path
elephant = $TESTTMP/babar
foo = $TESTTMP/bar
$ HGRCSKIPREPO=1 hg path
foo = $TESTTMP/bar