2011-05-30 13:15:25 +04:00
|
|
|
The Mercurial system uses a set of configuration files to control
|
|
|
|
aspects of its behavior.
|
2011-04-18 15:57:22 +04:00
|
|
|
|
2015-09-24 21:45:17 +03:00
|
|
|
Troubleshooting
|
|
|
|
===============
|
|
|
|
|
|
|
|
If you're having problems with your configuration,
|
|
|
|
:hg:`config --debug` can help you understand what is introducing
|
|
|
|
a setting into your environment.
|
|
|
|
|
|
|
|
See :hg:`help config.syntax` and :hg:`help config.files`
|
|
|
|
for information about how and where to override things.
|
|
|
|
|
2015-12-30 20:10:56 +03:00
|
|
|
Structure
|
|
|
|
=========
|
2015-09-24 21:45:17 +03:00
|
|
|
|
2011-05-30 13:15:25 +04:00
|
|
|
The configuration files use a simple ini-file format. A configuration
|
|
|
|
file consists of sections, led by a ``[section]`` header and followed
|
|
|
|
by ``name = value`` entries::
|
2009-11-08 00:12:50 +03:00
|
|
|
|
|
|
|
[ui]
|
|
|
|
username = Firstname Lastname <firstname.lastname@example.net>
|
|
|
|
verbose = True
|
|
|
|
|
2010-04-26 20:03:40 +04:00
|
|
|
The above entries will be referred to as ``ui.username`` and
|
2015-08-28 22:43:14 +03:00
|
|
|
``ui.verbose``, respectively. See :hg:`help config.syntax`.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Files
|
2012-07-25 11:40:38 +04:00
|
|
|
=====
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Mercurial reads configuration data from several files, if they exist.
|
2011-05-30 13:15:25 +04:00
|
|
|
These files do not exist by default and you will have to create the
|
2016-01-10 09:21:40 +03:00
|
|
|
appropriate configuration files yourself:
|
|
|
|
|
|
|
|
Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
|
|
|
|
|
|
|
|
Global configuration like the username setting is typically put into:
|
|
|
|
|
|
|
|
.. container:: windows
|
|
|
|
|
2016-02-01 16:14:06 +03:00
|
|
|
- ``%USERPROFILE%\mercurial.ini`` (on Windows)
|
2016-01-10 09:21:40 +03:00
|
|
|
|
|
|
|
.. container:: unix.plan9
|
|
|
|
|
2016-02-01 16:14:06 +03:00
|
|
|
- ``$HOME/.hgrc`` (on Unix, Plan9)
|
2011-05-30 13:15:25 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
The names of these files depend on the system on which Mercurial is
|
|
|
|
installed. ``*.rc`` files from a single directory are read in
|
|
|
|
alphabetical order, later ones overriding earlier ones. Where multiple
|
|
|
|
paths are given below, settings from earlier paths override later
|
|
|
|
ones.
|
|
|
|
|
2014-10-01 00:55:30 +04:00
|
|
|
.. container:: verbose.unix
|
|
|
|
|
|
|
|
On Unix, the following files are consulted:
|
|
|
|
|
|
|
|
- ``<repo>/.hg/hgrc`` (per-repository)
|
|
|
|
- ``$HOME/.hgrc`` (per-user)
|
2017-02-07 19:33:35 +03:00
|
|
|
- ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user)
|
2014-10-01 00:55:30 +04:00
|
|
|
- ``<install-root>/etc/mercurial/hgrc`` (per-installation)
|
|
|
|
- ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
|
|
|
|
- ``/etc/mercurial/hgrc`` (per-system)
|
|
|
|
- ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
|
2014-09-04 23:36:35 +04:00
|
|
|
- ``<internal>/default.d/*.rc`` (defaults)
|
2014-10-01 00:55:30 +04:00
|
|
|
|
|
|
|
.. container:: verbose.windows
|
|
|
|
|
|
|
|
On Windows, the following files are consulted:
|
|
|
|
|
|
|
|
- ``<repo>/.hg/hgrc`` (per-repository)
|
|
|
|
- ``%USERPROFILE%\.hgrc`` (per-user)
|
|
|
|
- ``%USERPROFILE%\Mercurial.ini`` (per-user)
|
|
|
|
- ``%HOME%\.hgrc`` (per-user)
|
|
|
|
- ``%HOME%\Mercurial.ini`` (per-user)
|
|
|
|
- ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
|
2015-10-12 21:13:12 +03:00
|
|
|
- ``<install-dir>\hgrc.d\*.rc`` (per-installation)
|
|
|
|
- ``<install-dir>\Mercurial.ini`` (per-installation)
|
2014-09-04 23:36:35 +04:00
|
|
|
- ``<internal>/default.d/*.rc`` (defaults)
|
2014-10-01 00:55:30 +04:00
|
|
|
|
|
|
|
.. note::
|
2014-02-19 16:25:28 +04:00
|
|
|
|
|
|
|
The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
|
2013-05-12 13:09:34 +04:00
|
|
|
is used when running 32-bit Python on 64-bit Windows.
|
|
|
|
|
2016-01-16 00:01:37 +03:00
|
|
|
.. container:: windows
|
|
|
|
|
|
|
|
On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
|
|
|
|
|
2014-10-01 00:55:30 +04:00
|
|
|
.. container:: verbose.plan9
|
|
|
|
|
|
|
|
On Plan9, the following files are consulted:
|
|
|
|
|
|
|
|
- ``<repo>/.hg/hgrc`` (per-repository)
|
|
|
|
- ``$home/lib/hgrc`` (per-user)
|
|
|
|
- ``<install-root>/lib/mercurial/hgrc`` (per-installation)
|
|
|
|
- ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
|
|
|
|
- ``/lib/mercurial/hgrc`` (per-system)
|
|
|
|
- ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
|
2014-09-04 23:36:35 +04:00
|
|
|
- ``<internal>/default.d/*.rc`` (defaults)
|
2014-10-01 00:55:30 +04:00
|
|
|
|
|
|
|
Per-repository configuration options only apply in a
|
|
|
|
particular repository. This file is not version-controlled, and
|
|
|
|
will not get transferred during a "clone" operation. Options in
|
2016-01-10 09:08:41 +03:00
|
|
|
this file override options in all other configuration files.
|
|
|
|
|
|
|
|
.. container:: unix.plan9
|
|
|
|
|
|
|
|
On Plan 9 and Unix, most of this file will be ignored if it doesn't
|
|
|
|
belong to a trusted user or to a trusted group. See
|
|
|
|
:hg:`help config.trusted` for more details.
|
2014-10-01 00:55:30 +04:00
|
|
|
|
2016-01-16 00:01:37 +03:00
|
|
|
Per-user configuration file(s) are for the user running Mercurial. Options
|
|
|
|
in these files apply to all Mercurial commands executed by this user in any
|
|
|
|
directory. Options in these files override per-system and per-installation
|
|
|
|
options.
|
2014-10-01 00:55:30 +04:00
|
|
|
|
|
|
|
Per-installation configuration files are searched for in the
|
|
|
|
directory where Mercurial is installed. ``<install-root>`` is the
|
2016-01-10 09:08:41 +03:00
|
|
|
parent directory of the **hg** executable (or symlink) being run.
|
|
|
|
|
|
|
|
.. container:: unix.plan9
|
|
|
|
|
|
|
|
For example, if installed in ``/shared/tools/bin/hg``, Mercurial
|
|
|
|
will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
|
|
|
|
files apply to all Mercurial commands executed by any user in any
|
|
|
|
directory.
|
2014-10-01 00:55:30 +04:00
|
|
|
|
|
|
|
Per-installation configuration files are for the system on
|
|
|
|
which Mercurial is running. Options in these files apply to all
|
|
|
|
Mercurial commands executed by any user in any directory. Registry
|
|
|
|
keys contain PATH-like strings, every part of which must reference
|
|
|
|
a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
|
|
|
|
be read. Mercurial checks each of these locations in the specified
|
|
|
|
order until one or more configuration files are detected.
|
|
|
|
|
|
|
|
Per-system configuration files are for the system on which Mercurial
|
|
|
|
is running. Options in these files apply to all Mercurial commands
|
|
|
|
executed by any user in any directory. Options in these files
|
|
|
|
override per-installation options.
|
|
|
|
|
2014-09-04 23:36:35 +04:00
|
|
|
Mercurial comes with some default configuration. The default configuration
|
|
|
|
files are installed with Mercurial and will be overwritten on upgrades. Default
|
|
|
|
configuration files should never be edited by users or administrators but can
|
|
|
|
be overridden in other configuration files. So far the directory only contains
|
|
|
|
merge tool configuration but packagers can also put other default configuration
|
|
|
|
there.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
Syntax
|
2012-07-25 11:40:38 +04:00
|
|
|
======
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
A configuration file consists of sections, led by a ``[section]`` header
|
|
|
|
and followed by ``name = value`` entries (sometimes called
|
|
|
|
``configuration keys``)::
|
|
|
|
|
|
|
|
[spam]
|
|
|
|
eggs=ham
|
|
|
|
green=
|
|
|
|
eggs
|
|
|
|
|
|
|
|
Each line contains one entry. If the lines that follow are indented,
|
|
|
|
they are treated as continuations of that entry. Leading whitespace is
|
|
|
|
removed from values. Empty lines are skipped. Lines beginning with
|
|
|
|
``#`` or ``;`` are ignored and may be used to provide comments.
|
|
|
|
|
2011-06-16 19:30:44 +04:00
|
|
|
Configuration keys can be set multiple times, in which case Mercurial
|
2011-05-30 12:21:39 +04:00
|
|
|
will use the value that was configured last. As an example::
|
|
|
|
|
|
|
|
[spam]
|
|
|
|
eggs=large
|
|
|
|
ham=serrano
|
|
|
|
eggs=small
|
|
|
|
|
|
|
|
This would set the configuration key named ``eggs`` to ``small``.
|
|
|
|
|
|
|
|
It is also possible to define a section multiple times. A section can
|
2011-06-16 19:30:57 +04:00
|
|
|
be redefined on the same and/or on different configuration files. For
|
|
|
|
example::
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
[foo]
|
|
|
|
eggs=large
|
|
|
|
ham=serrano
|
|
|
|
eggs=small
|
|
|
|
|
|
|
|
[bar]
|
|
|
|
eggs=ham
|
|
|
|
green=
|
|
|
|
eggs
|
|
|
|
|
|
|
|
[foo]
|
|
|
|
ham=prosciutto
|
|
|
|
eggs=medium
|
|
|
|
bread=toasted
|
|
|
|
|
|
|
|
This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
|
|
|
|
of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
|
|
|
|
respectively. As you can see there only thing that matters is the last
|
|
|
|
value that was set for each of the configuration keys.
|
|
|
|
|
|
|
|
If a configuration key is set multiple times in different
|
|
|
|
configuration files the final value will depend on the order in which
|
|
|
|
the different configuration files are read, with settings from earlier
|
|
|
|
paths overriding later ones as described on the ``Files`` section
|
|
|
|
above.
|
|
|
|
|
|
|
|
A line of the form ``%include file`` will include ``file`` into the
|
|
|
|
current configuration file. The inclusion is recursive, which means
|
|
|
|
that included files can include other files. Filenames are relative to
|
|
|
|
the configuration file in which the ``%include`` directive is found.
|
|
|
|
Environment variables and ``~user`` constructs are expanded in
|
|
|
|
``file``. This lets you do something like::
|
|
|
|
|
|
|
|
%include ~/.hgrc.d/$HOST.rc
|
|
|
|
|
|
|
|
to include a different configuration file on each computer you use.
|
|
|
|
|
|
|
|
A line with ``%unset name`` will remove ``name`` from the current
|
|
|
|
section, if it has been set previously.
|
|
|
|
|
|
|
|
The values are either free-form text strings, lists of text strings,
|
|
|
|
or Boolean values. Boolean values can be set to true using any of "1",
|
|
|
|
"yes", "true", or "on" and to false using "0", "no", "false", or "off"
|
|
|
|
(all case insensitive).
|
|
|
|
|
|
|
|
List values are separated by whitespace or comma, except when values are
|
|
|
|
placed in double quotation marks::
|
|
|
|
|
|
|
|
allow_read = "John Doe, PhD", brian, betty
|
|
|
|
|
|
|
|
Quotation marks can be escaped by prefixing them with a backslash. Only
|
|
|
|
quotation marks at the beginning of a word is counted as a quotation
|
|
|
|
(e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
|
|
|
|
|
|
|
|
Sections
|
2012-07-25 11:40:38 +04:00
|
|
|
========
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
This section describes the different sections that may appear in a
|
2011-06-16 19:30:57 +04:00
|
|
|
Mercurial configuration file, the purpose of each section, its possible
|
|
|
|
keys, and their possible values.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
``alias``
|
2012-07-25 11:40:38 +04:00
|
|
|
---------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Defines command aliases.
|
2015-09-02 09:02:58 +03:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
Aliases allow you to define your own commands in terms of other
|
|
|
|
commands (or aliases), optionally including arguments. Positional
|
2015-09-02 09:03:22 +03:00
|
|
|
arguments in the form of ``$1``, ``$2``, etc. in the alias definition
|
2011-05-30 12:21:39 +04:00
|
|
|
are expanded by Mercurial before execution. Positional arguments not
|
|
|
|
already used by ``$N`` in the definition are put at the end of the
|
|
|
|
command to be executed.
|
|
|
|
|
|
|
|
Alias definitions consist of lines of the form::
|
|
|
|
|
2011-06-16 19:42:19 +04:00
|
|
|
<alias> = <command> [<argument>]...
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
For example, this definition::
|
|
|
|
|
|
|
|
latest = log --limit 5
|
|
|
|
|
|
|
|
creates a new command ``latest`` that shows only the five most recent
|
|
|
|
changesets. You can define subsequent aliases using earlier ones::
|
|
|
|
|
|
|
|
stable5 = latest -b stable
|
|
|
|
|
2014-02-19 16:25:28 +04:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
It is possible to create aliases with the same names as
|
2011-05-30 12:21:39 +04:00
|
|
|
existing commands, which will then override the original
|
|
|
|
definitions. This is almost always a bad idea!
|
|
|
|
|
|
|
|
An alias can start with an exclamation point (``!``) to make it a
|
|
|
|
shell alias. A shell alias is executed with the shell and will let you
|
|
|
|
run arbitrary commands. As an example, ::
|
|
|
|
|
2012-04-24 16:34:54 +04:00
|
|
|
echo = !echo $@
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
will let you do ``hg echo foo`` to have ``foo`` printed in your
|
|
|
|
terminal. A better example might be::
|
|
|
|
|
2017-02-17 13:08:36 +03:00
|
|
|
purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
which will make ``hg purge`` delete all unknown files in the
|
|
|
|
repository in the same manner as the purge extension.
|
|
|
|
|
2012-04-24 16:34:54 +04:00
|
|
|
Positional arguments like ``$1``, ``$2``, etc. in the alias definition
|
|
|
|
expand to the command arguments. Unmatched arguments are
|
|
|
|
removed. ``$0`` expands to the alias name and ``$@`` expands to all
|
2014-08-14 10:21:52 +04:00
|
|
|
arguments separated by a space. ``"$@"`` (with quotes) expands to all
|
|
|
|
arguments quoted individually and separated by a space. These expansions
|
|
|
|
happen before the command is passed to the shell.
|
2012-04-24 16:34:54 +04:00
|
|
|
|
|
|
|
Shell aliases are executed in an environment where ``$HG`` expands to
|
2011-05-30 12:21:39 +04:00
|
|
|
the path of the Mercurial that was used to execute the alias. This is
|
|
|
|
useful when you want to call further Mercurial commands in a shell
|
|
|
|
alias, as was done above for the purge alias. In addition,
|
2012-04-24 16:34:54 +04:00
|
|
|
``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
|
2011-05-30 12:21:39 +04:00
|
|
|
echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
|
|
|
|
|
2014-02-19 16:25:28 +04:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
Some global configuration options such as ``-R`` are
|
2011-07-18 23:57:22 +04:00
|
|
|
processed before shell aliases and will thus not be passed to
|
|
|
|
aliases.
|
|
|
|
|
2011-11-18 15:04:31 +04:00
|
|
|
|
|
|
|
``annotate``
|
2012-07-25 11:40:38 +04:00
|
|
|
------------
|
2011-11-18 15:04:31 +04:00
|
|
|
|
|
|
|
Settings used when displaying file annotations. All values are
|
2015-08-28 22:43:14 +03:00
|
|
|
Booleans and default to False. See :hg:`help config.diff` for
|
|
|
|
related options for the diff command.
|
2011-11-18 15:04:31 +04:00
|
|
|
|
|
|
|
``ignorews``
|
|
|
|
Ignore white space when comparing lines.
|
|
|
|
|
|
|
|
``ignorewsamount``
|
|
|
|
Ignore changes in the amount of white space.
|
|
|
|
|
|
|
|
``ignoreblanklines``
|
|
|
|
Ignore changes whose lines are all blank.
|
|
|
|
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``auth``
|
2012-07-25 11:40:38 +04:00
|
|
|
--------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2017-03-10 09:40:52 +03:00
|
|
|
Authentication credentials and other authentication-like configuration
|
|
|
|
for HTTP connections. This section allows you to store usernames and
|
|
|
|
passwords for use when logging *into* HTTP servers. See
|
|
|
|
:hg:`help config.web` if you want to configure *who* can login to
|
|
|
|
your HTTP server.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2017-03-10 09:40:52 +03:00
|
|
|
The following options apply to all hosts.
|
|
|
|
|
|
|
|
``cookiefile``
|
|
|
|
Path to a file containing HTTP cookie lines. Cookies matching a
|
|
|
|
host will be sent automatically.
|
|
|
|
|
|
|
|
The file format uses the Mozilla cookies.txt format, which defines cookies
|
|
|
|
on their own lines. Each line contains 7 fields delimited by the tab
|
|
|
|
character (domain, is_domain_cookie, path, is_secure, expires, name,
|
|
|
|
value). For more info, do an Internet search for "Netscape cookies.txt
|
|
|
|
format."
|
|
|
|
|
|
|
|
Note: the cookies parser does not handle port numbers on domains. You
|
|
|
|
will need to remove ports from the domain for the cookie to be recognized.
|
|
|
|
This could result in a cookie being disclosed to an unwanted server.
|
|
|
|
|
|
|
|
The cookies file is read-only.
|
|
|
|
|
|
|
|
Other options in this section are grouped by name and have the following
|
|
|
|
format::
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
<name>.<argument> = <value>
|
|
|
|
|
|
|
|
where ``<name>`` is used to group arguments into authentication
|
|
|
|
entries. Example::
|
|
|
|
|
2016-02-01 14:36:28 +03:00
|
|
|
foo.prefix = hg.intevation.de/mercurial
|
2011-05-30 12:21:39 +04:00
|
|
|
foo.username = foo
|
|
|
|
foo.password = bar
|
|
|
|
foo.schemes = http https
|
|
|
|
|
|
|
|
bar.prefix = secure.example.org
|
|
|
|
bar.key = path/to/file.key
|
|
|
|
bar.cert = path/to/file.cert
|
|
|
|
bar.schemes = https
|
|
|
|
|
|
|
|
Supported arguments:
|
|
|
|
|
|
|
|
``prefix``
|
|
|
|
Either ``*`` or a URI prefix with or without the scheme part.
|
|
|
|
The authentication entry with the longest matching prefix is used
|
|
|
|
(where ``*`` matches everything and counts as a match of length
|
|
|
|
1). If the prefix doesn't include a scheme, the match is performed
|
|
|
|
against the URI with its scheme stripped as well, and the schemes
|
|
|
|
argument, q.v., is then subsequently consulted.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``username``
|
|
|
|
Optional. Username to authenticate with. If not given, and the
|
|
|
|
remote site requires basic or digest authentication, the user will
|
|
|
|
be prompted for it. Environment variables are expanded in the
|
2011-08-02 01:58:50 +04:00
|
|
|
username letting you do ``foo.username = $USER``. If the URI
|
|
|
|
includes a username, only ``[auth]`` entries with a matching
|
|
|
|
username or without a username will be considered.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``password``
|
|
|
|
Optional. Password to authenticate with. If not given, and the
|
|
|
|
remote site requires basic or digest authentication, the user
|
|
|
|
will be prompted for it.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``key``
|
|
|
|
Optional. PEM encoded client certificate key file. Environment
|
|
|
|
variables are expanded in the filename.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``cert``
|
|
|
|
Optional. PEM encoded client certificate chain file. Environment
|
|
|
|
variables are expanded in the filename.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``schemes``
|
|
|
|
Optional. Space separated list of URI schemes to use this
|
|
|
|
authentication entry with. Only used if the prefix doesn't include
|
|
|
|
a scheme. Supported schemes are http and https. They will match
|
|
|
|
static-http and static-https respectively, as well.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: https)
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
If no suitable authentication entry is found, the user is prompted
|
|
|
|
for credentials as usual if required by the remote.
|
|
|
|
|
2017-02-21 22:04:55 +03:00
|
|
|
``color``
|
|
|
|
---------
|
|
|
|
|
|
|
|
Configure the Mercurial color mode. For details about how to define your custom
|
|
|
|
effect and style see :hg:`help color`.
|
|
|
|
|
|
|
|
``mode``
|
|
|
|
String: control the method used to output color. One of ``auto``, ``ansi``,
|
2017-04-30 23:35:57 +03:00
|
|
|
``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will
|
2017-05-23 05:32:59 +03:00
|
|
|
use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a
|
2017-02-21 22:04:55 +03:00
|
|
|
terminal. Any invalid value will disable color.
|
|
|
|
|
|
|
|
``pagermode``
|
2017-05-04 05:07:47 +03:00
|
|
|
String: optional override of ``color.mode`` used with pager.
|
2017-02-21 22:04:55 +03:00
|
|
|
|
|
|
|
On some systems, terminfo mode may cause problems when using
|
2017-04-30 23:35:57 +03:00
|
|
|
color with ``less -R`` as a pager program. less with the -R option
|
2017-02-21 22:04:55 +03:00
|
|
|
will only display ECMA-48 color codes, and terminfo mode may sometimes
|
|
|
|
emit codes that less doesn't understand. You can work around this by
|
|
|
|
either using ansi mode (or auto mode), or by using less -r (which will
|
|
|
|
pass through all terminal control codes, not just color control
|
|
|
|
codes).
|
|
|
|
|
|
|
|
On some systems (such as MSYS in Windows), the terminal may support
|
2017-04-30 23:35:57 +03:00
|
|
|
a different color mode than the pager program.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2017-03-15 03:43:18 +03:00
|
|
|
``commands``
|
2017-03-23 02:36:53 +03:00
|
|
|
------------
|
2017-03-15 03:43:18 +03:00
|
|
|
|
2017-03-22 03:50:44 +03:00
|
|
|
``status.relative``
|
2017-04-30 23:38:52 +03:00
|
|
|
Make paths in :hg:`status` output relative to the current directory.
|
2017-03-22 03:50:44 +03:00
|
|
|
(default: False)
|
|
|
|
|
2017-03-15 03:43:18 +03:00
|
|
|
``update.requiredest``
|
2017-04-30 23:38:52 +03:00
|
|
|
Require that the user pass a destination when running :hg:`update`.
|
|
|
|
For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
|
2017-03-15 03:43:18 +03:00
|
|
|
will be disallowed.
|
|
|
|
(default: False)
|
|
|
|
|
2014-07-15 18:34:13 +04:00
|
|
|
``committemplate``
|
|
|
|
------------------
|
|
|
|
|
2015-09-04 12:42:21 +03:00
|
|
|
``changeset``
|
|
|
|
String: configuration in this section is used as the template to
|
|
|
|
customize the text shown in the editor when committing.
|
2014-07-15 18:34:13 +04:00
|
|
|
|
|
|
|
In addition to pre-defined template keywords, commit log specific one
|
|
|
|
below can be used for customization:
|
|
|
|
|
|
|
|
``extramsg``
|
|
|
|
String: Extra message (typically 'Leave message empty to abort
|
|
|
|
commit.'). This may be changed by some commands or extensions.
|
|
|
|
|
|
|
|
For example, the template configuration below shows as same text as
|
|
|
|
one shown by default::
|
|
|
|
|
|
|
|
[committemplate]
|
|
|
|
changeset = {desc}\n\n
|
|
|
|
HG: Enter commit message. Lines beginning with 'HG:' are removed.
|
|
|
|
HG: {extramsg}
|
|
|
|
HG: --
|
|
|
|
HG: user: {author}\n{ifeq(p2rev, "-1", "",
|
|
|
|
"HG: branch merge\n")
|
2015-04-15 18:19:36 +03:00
|
|
|
}HG: branch '{branch}'\n{if(activebookmark,
|
|
|
|
"HG: bookmark '{activebookmark}'\n") }{subrepos %
|
2014-07-15 18:34:13 +04:00
|
|
|
"HG: subrepo {subrepo}\n" }{file_adds %
|
|
|
|
"HG: added {file}\n" }{file_mods %
|
|
|
|
"HG: changed {file}\n" }{file_dels %
|
|
|
|
"HG: removed {file}\n" }{if(files, "",
|
|
|
|
"HG: no files changed\n")}
|
|
|
|
|
2017-01-05 07:32:42 +03:00
|
|
|
``diff()``
|
|
|
|
String: show the diff (see :hg:`help templates` for detail)
|
|
|
|
|
|
|
|
Sometimes it is helpful to show the diff of the changeset in the editor without
|
|
|
|
having to prefix 'HG: ' to each line so that highlighting works correctly. For
|
|
|
|
this, Mercurial provides a special string which will ignore everything below
|
|
|
|
it::
|
|
|
|
|
|
|
|
HG: ------------------------ >8 ------------------------
|
|
|
|
|
|
|
|
For example, the template configuration below will show the diff below the
|
|
|
|
extra message::
|
|
|
|
|
|
|
|
[committemplate]
|
|
|
|
changeset = {desc}\n\n
|
|
|
|
HG: Enter commit message. Lines beginning with 'HG:' are removed.
|
|
|
|
HG: {extramsg}
|
|
|
|
HG: ------------------------ >8 ------------------------
|
|
|
|
HG: Do not touch the line above.
|
|
|
|
HG: Everything below will be removed.
|
|
|
|
{diff()}
|
|
|
|
|
2014-07-15 18:34:13 +04:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
For some problematic encodings (see :hg:`help win32mbcs` for
|
|
|
|
detail), this customization should be configured carefully, to
|
|
|
|
avoid showing broken characters.
|
|
|
|
|
2015-09-04 12:40:37 +03:00
|
|
|
For example, if a multibyte character ending with backslash (0x5c) is
|
|
|
|
followed by the ASCII character 'n' in the customized template,
|
|
|
|
the sequence of backslash and 'n' is treated as line-feed unexpectedly
|
|
|
|
(and the multibyte character is broken, too).
|
2014-07-15 18:34:13 +04:00
|
|
|
|
|
|
|
Customized template is used for commands below (``--edit`` may be
|
|
|
|
required):
|
|
|
|
|
|
|
|
- :hg:`backout`
|
|
|
|
- :hg:`commit`
|
|
|
|
- :hg:`fetch` (for merge commit only)
|
|
|
|
- :hg:`graft`
|
|
|
|
- :hg:`histedit`
|
|
|
|
- :hg:`import`
|
|
|
|
- :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
|
|
|
|
- :hg:`rebase`
|
|
|
|
- :hg:`shelve`
|
|
|
|
- :hg:`sign`
|
|
|
|
- :hg:`tag`
|
|
|
|
- :hg:`transplant`
|
|
|
|
|
2014-08-02 16:46:27 +04:00
|
|
|
Configuring items below instead of ``changeset`` allows showing
|
|
|
|
customized message only for specific actions, or showing different
|
2014-10-23 18:28:00 +04:00
|
|
|
messages for each action.
|
2014-08-02 16:46:27 +04:00
|
|
|
|
|
|
|
- ``changeset.backout`` for :hg:`backout`
|
2014-08-16 05:43:59 +04:00
|
|
|
- ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
|
|
|
|
- ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
|
2014-08-16 05:43:59 +04:00
|
|
|
- ``changeset.commit.normal.merge`` for :hg:`commit` on merges
|
|
|
|
- ``changeset.commit.normal.normal`` for :hg:`commit` on other
|
2014-08-02 16:46:27 +04:00
|
|
|
- ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
|
|
|
|
- ``changeset.gpg.sign`` for :hg:`sign`
|
|
|
|
- ``changeset.graft`` for :hg:`graft`
|
|
|
|
- ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
|
|
|
|
- ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
|
|
|
|
- ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
|
|
|
|
- ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
|
|
|
|
- ``changeset.import.bypass`` for :hg:`import --bypass`
|
2014-08-16 05:43:59 +04:00
|
|
|
- ``changeset.import.normal.merge`` for :hg:`import` on merges
|
|
|
|
- ``changeset.import.normal.normal`` for :hg:`import` on other
|
2014-08-02 16:46:27 +04:00
|
|
|
- ``changeset.mq.qnew`` for :hg:`qnew`
|
|
|
|
- ``changeset.mq.qfold`` for :hg:`qfold`
|
|
|
|
- ``changeset.mq.qrefresh`` for :hg:`qrefresh`
|
|
|
|
- ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
|
2014-08-16 05:43:59 +04:00
|
|
|
- ``changeset.rebase.merge`` for :hg:`rebase` on merges
|
|
|
|
- ``changeset.rebase.normal`` for :hg:`rebase` on other
|
2014-08-02 16:46:27 +04:00
|
|
|
- ``changeset.shelve.shelve`` for :hg:`shelve`
|
|
|
|
- ``changeset.tag.add`` for :hg:`tag` without ``--remove``
|
|
|
|
- ``changeset.tag.remove`` for :hg:`tag --remove`
|
2014-08-16 05:43:59 +04:00
|
|
|
- ``changeset.transplant.merge`` for :hg:`transplant` on merges
|
|
|
|
- ``changeset.transplant.normal`` for :hg:`transplant` on other
|
2014-08-02 16:46:27 +04:00
|
|
|
|
|
|
|
These dot-separated lists of names are treated as hierarchical ones.
|
|
|
|
For example, ``changeset.tag.remove`` customizes the commit message
|
|
|
|
only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
|
|
|
|
commit message for :hg:`tag` regardless of ``--remove`` option.
|
|
|
|
|
2015-09-04 12:40:52 +03:00
|
|
|
When the external editor is invoked for a commit, the corresponding
|
|
|
|
dot-separated list of names without the ``changeset.`` prefix
|
|
|
|
(e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
|
|
|
|
variable.
|
2014-08-15 18:05:53 +04:00
|
|
|
|
2014-08-02 16:46:27 +04:00
|
|
|
In this section, items other than ``changeset`` can be referred from
|
|
|
|
others. For example, the configuration to list committed files up
|
|
|
|
below can be referred as ``{listupfiles}``::
|
|
|
|
|
|
|
|
[committemplate]
|
|
|
|
listupfiles = {file_adds %
|
|
|
|
"HG: added {file}\n" }{file_mods %
|
|
|
|
"HG: changed {file}\n" }{file_dels %
|
|
|
|
"HG: removed {file}\n" }{if(files, "",
|
|
|
|
"HG: no files changed\n")}
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``decode/encode``
|
2012-07-25 11:40:38 +04:00
|
|
|
-----------------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Filters for transforming files on checkout/checkin. This would
|
|
|
|
typically be used for newline processing or other
|
|
|
|
localization/canonicalization of files.
|
|
|
|
|
|
|
|
Filters consist of a filter pattern followed by a filter command.
|
|
|
|
Filter patterns are globs by default, rooted at the repository root.
|
|
|
|
For example, to match any file ending in ``.txt`` in the root
|
|
|
|
directory only, use the pattern ``*.txt``. To match any file ending
|
|
|
|
in ``.c`` anywhere in the repository, use the pattern ``**.c``.
|
|
|
|
For each file only the first matching filter applies.
|
|
|
|
|
|
|
|
The filter command can start with a specifier, either ``pipe:`` or
|
|
|
|
``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
|
|
|
|
|
|
|
|
A ``pipe:`` command must accept data on stdin and return the transformed
|
|
|
|
data on stdout.
|
|
|
|
|
|
|
|
Pipe example::
|
|
|
|
|
|
|
|
[encode]
|
|
|
|
# uncompress gzip files on checkin to improve delta compression
|
|
|
|
# note: not necessarily a good idea, just an example
|
|
|
|
*.gz = pipe: gunzip
|
|
|
|
|
|
|
|
[decode]
|
|
|
|
# recompress gzip files when writing them to the working dir (we
|
|
|
|
# can safely omit "pipe:", because it's the default)
|
|
|
|
*.gz = gzip
|
|
|
|
|
|
|
|
A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
|
|
|
|
with the name of a temporary file that contains the data to be
|
|
|
|
filtered by the command. The string ``OUTFILE`` is replaced with the name
|
|
|
|
of an empty temporary file, where the filtered data must be written by
|
|
|
|
the command.
|
|
|
|
|
2016-01-10 09:09:10 +03:00
|
|
|
.. container:: windows
|
2014-02-19 16:25:28 +04:00
|
|
|
|
2016-01-10 09:09:10 +03:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
The tempfile mechanism is recommended for Windows systems,
|
|
|
|
where the standard shell I/O redirection operators often have
|
|
|
|
strange effects and may corrupt the contents of your files.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
This filter mechanism is used internally by the ``eol`` extension to
|
|
|
|
translate line ending characters between Windows (CRLF) and Unix (LF)
|
|
|
|
format. We suggest you use the ``eol`` extension for convenience.
|
|
|
|
|
|
|
|
|
|
|
|
``defaults``
|
2012-07-25 11:40:38 +04:00
|
|
|
------------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2015-09-02 09:03:55 +03:00
|
|
|
(defaults are deprecated. Don't use them. Use aliases instead.)
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Use the ``[defaults]`` section to define command defaults, i.e. the
|
|
|
|
default options/arguments to pass to the specified commands.
|
|
|
|
|
|
|
|
The following example makes :hg:`log` run in verbose mode, and
|
|
|
|
:hg:`status` show only the modified files, by default::
|
|
|
|
|
|
|
|
[defaults]
|
|
|
|
log = -v
|
|
|
|
status = -m
|
|
|
|
|
|
|
|
The actual commands, instead of their aliases, must be used when
|
|
|
|
defining command defaults. The command defaults will also be applied
|
|
|
|
to the aliases of the commands defined.
|
|
|
|
|
|
|
|
|
|
|
|
``diff``
|
2012-07-25 11:40:38 +04:00
|
|
|
--------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2011-11-18 15:04:31 +04:00
|
|
|
Settings used when displaying diffs. Everything except for ``unified``
|
2015-08-28 22:43:14 +03:00
|
|
|
is a Boolean and defaults to False. See :hg:`help config.annotate`
|
|
|
|
for related options for the annotate command.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
``git``
|
|
|
|
Use git extended diff format.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2014-10-01 00:59:07 +04:00
|
|
|
``nobinary``
|
|
|
|
Omit git binary patches.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``nodates``
|
|
|
|
Don't include dates in diff headers.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2014-11-13 11:08:44 +03:00
|
|
|
``noprefix``
|
|
|
|
Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``showfunc``
|
|
|
|
Show which function each change is in.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``ignorews``
|
|
|
|
Ignore white space when comparing lines.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``ignorewsamount``
|
|
|
|
Ignore changes in the amount of white space.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``ignoreblanklines``
|
|
|
|
Ignore changes whose lines are all blank.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``unified``
|
|
|
|
Number of lines of context to show.
|
|
|
|
|
|
|
|
``email``
|
2012-07-25 11:40:38 +04:00
|
|
|
---------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Settings for extensions that send email messages.
|
|
|
|
|
|
|
|
``from``
|
|
|
|
Optional. Email address to use in "From" header and SMTP envelope
|
|
|
|
of outgoing messages.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``to``
|
|
|
|
Optional. Comma-separated list of recipients' email addresses.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``cc``
|
|
|
|
Optional. Comma-separated list of carbon copy recipients'
|
|
|
|
email addresses.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``bcc``
|
|
|
|
Optional. Comma-separated list of blind carbon copy recipients'
|
|
|
|
email addresses.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``method``
|
|
|
|
Optional. Method to use to send email messages. If value is ``smtp``
|
2011-06-16 19:52:37 +04:00
|
|
|
(default), use SMTP (see the ``[smtp]`` section for configuration).
|
2011-05-30 12:21:39 +04:00
|
|
|
Otherwise, use as name of program to run that acts like sendmail
|
|
|
|
(takes ``-f`` option for sender, list of recipients on command line,
|
|
|
|
message on stdin). Normally, setting this to ``sendmail`` or
|
|
|
|
``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``charsets``
|
|
|
|
Optional. Comma-separated list of character sets considered
|
|
|
|
convenient for recipients. Addresses, headers, and parts not
|
|
|
|
containing patches of outgoing messages will be encoded in the
|
|
|
|
first character set to which conversion from local encoding
|
|
|
|
(``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
|
2015-09-02 20:39:46 +03:00
|
|
|
conversion fails, the text in question is sent as is.
|
|
|
|
(default: '')
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Order of outgoing email character sets:
|
|
|
|
|
|
|
|
1. ``us-ascii``: always first, regardless of settings
|
|
|
|
2. ``email.charsets``: in order given by user
|
|
|
|
3. ``ui.fallbackencoding``: if not in email.charsets
|
|
|
|
4. ``$HGENCODING``: if not in email.charsets
|
|
|
|
5. ``utf-8``: always last, regardless of settings
|
|
|
|
|
|
|
|
Email example::
|
|
|
|
|
|
|
|
[email]
|
|
|
|
from = Joseph User <joe.user@example.com>
|
|
|
|
method = /usr/sbin/sendmail
|
|
|
|
# charsets for western Europeans
|
|
|
|
# us-ascii, utf-8 omitted, as they are tried first and last
|
|
|
|
charsets = iso-8859-1, iso-8859-15, windows-1252
|
|
|
|
|
|
|
|
|
|
|
|
``extensions``
|
2012-07-25 11:40:38 +04:00
|
|
|
--------------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Mercurial has an extension mechanism for adding new features. To
|
|
|
|
enable an extension, create an entry for it in this section.
|
|
|
|
|
|
|
|
If you know that the extension is already in Python's search path,
|
|
|
|
you can give the name of the module, followed by ``=``, with nothing
|
|
|
|
after the ``=``.
|
|
|
|
|
|
|
|
Otherwise, give a name that you choose, followed by ``=``, followed by
|
|
|
|
the path to the ``.py`` file (including the file name extension) that
|
|
|
|
defines the extension.
|
|
|
|
|
|
|
|
To explicitly disable an extension that is enabled in an hgrc of
|
|
|
|
broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
|
|
|
|
or ``foo = !`` when path is not supplied.
|
|
|
|
|
|
|
|
Example for ``~/.hgrc``::
|
|
|
|
|
|
|
|
[extensions]
|
2017-02-22 00:53:38 +03:00
|
|
|
# (the churn extension will get loaded from Mercurial's path)
|
|
|
|
churn =
|
2011-05-30 12:21:39 +04:00
|
|
|
# (this extension will get loaded from the file specified)
|
|
|
|
myfeature = ~/.hgext/myfeature.py
|
|
|
|
|
|
|
|
|
|
|
|
``format``
|
2012-07-25 11:40:38 +04:00
|
|
|
----------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2015-11-02 18:59:12 +03:00
|
|
|
``usegeneraldelta``
|
|
|
|
Enable or disable the "generaldelta" repository format which improves
|
|
|
|
repository compression by allowing "revlog" to store delta against arbitrary
|
|
|
|
revision instead of the previous stored one. This provides significant
|
2015-12-30 20:04:08 +03:00
|
|
|
improvement for repositories with branches.
|
|
|
|
|
|
|
|
Repositories with this on-disk format require Mercurial version 1.9.
|
|
|
|
|
|
|
|
Enabled by default.
|
2015-11-02 18:59:12 +03:00
|
|
|
|
2015-12-30 20:06:11 +03:00
|
|
|
``dotencode``
|
|
|
|
Enable or disable the "dotencode" repository format which enhances
|
|
|
|
the "fncache" repository format (which has to be enabled to use
|
|
|
|
dotencode) to avoid issues with filenames starting with ._ on
|
2015-12-30 20:04:08 +03:00
|
|
|
Mac OS X and spaces on Windows.
|
|
|
|
|
|
|
|
Repositories with this on-disk format require Mercurial version 1.7.
|
|
|
|
|
|
|
|
Enabled by default.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
``usefncache``
|
|
|
|
Enable or disable the "fncache" repository format which enhances
|
|
|
|
the "store" repository format (which has to be enabled to use
|
|
|
|
fncache) to allow longer filenames and avoids using Windows
|
2015-12-30 20:04:08 +03:00
|
|
|
reserved names, e.g. "nul".
|
|
|
|
|
|
|
|
Repositories with this on-disk format require Mercurial version 1.1.
|
|
|
|
|
|
|
|
Enabled by default.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2015-12-30 20:06:11 +03:00
|
|
|
``usestore``
|
|
|
|
Enable or disable the "store" repository format which improves
|
|
|
|
compatibility with systems that fold case or otherwise mangle
|
2015-12-30 20:04:08 +03:00
|
|
|
filenames. Disabling this option will allow you to store longer filenames
|
|
|
|
in some situations at the expense of compatibility.
|
|
|
|
|
|
|
|
Repositories with this on-disk format require Mercurial version 0.9.4.
|
|
|
|
|
|
|
|
Enabled by default.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2012-01-22 16:35:26 +04:00
|
|
|
``graph``
|
2012-07-25 11:40:38 +04:00
|
|
|
---------
|
2012-01-22 16:35:26 +04:00
|
|
|
|
2012-02-18 15:30:24 +04:00
|
|
|
Web graph view configuration. This section let you change graph
|
|
|
|
elements display properties by branches, for instance to make the
|
|
|
|
``default`` branch stand out.
|
2012-01-22 16:35:26 +04:00
|
|
|
|
2012-02-18 15:30:24 +04:00
|
|
|
Each line has the following format::
|
2012-01-22 16:35:26 +04:00
|
|
|
|
2012-02-18 15:30:24 +04:00
|
|
|
<branch>.<argument> = <value>
|
|
|
|
|
|
|
|
where ``<branch>`` is the name of the branch being
|
|
|
|
customized. Example::
|
|
|
|
|
|
|
|
[graph]
|
|
|
|
# 2px width
|
|
|
|
default.width = 2
|
|
|
|
# red color
|
|
|
|
default.color = FF0000
|
2012-01-22 16:35:26 +04:00
|
|
|
|
|
|
|
Supported arguments:
|
|
|
|
|
|
|
|
``width``
|
2012-02-18 15:30:24 +04:00
|
|
|
Set branch edges width in pixels.
|
2012-01-22 16:35:26 +04:00
|
|
|
|
2012-01-22 16:47:03 +04:00
|
|
|
``color``
|
2012-02-18 15:30:24 +04:00
|
|
|
Set branch edges color in hexadecimal RGB notation.
|
2012-01-22 16:35:26 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``hooks``
|
2012-07-25 11:40:38 +04:00
|
|
|
---------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Commands or Python functions that get automatically executed by
|
|
|
|
various actions such as starting or finishing a commit. Multiple
|
|
|
|
hooks can be run for the same action by appending a suffix to the
|
|
|
|
action. Overriding a site-wide hook can be done by changing its
|
2012-01-16 00:50:12 +04:00
|
|
|
value or setting it to an empty string. Hooks can be prioritized
|
2015-12-29 18:00:04 +03:00
|
|
|
by adding a prefix of ``priority.`` to the hook name on a new line
|
2015-09-02 09:04:22 +03:00
|
|
|
and setting the priority. The default priority is 0.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Example ``.hg/hgrc``::
|
|
|
|
|
|
|
|
[hooks]
|
|
|
|
# update working directory after adding changesets
|
|
|
|
changegroup.update = hg update
|
|
|
|
# do not use the site-wide hook
|
|
|
|
incoming =
|
|
|
|
incoming.email = /my/email/hook
|
|
|
|
incoming.autobuild = /my/build/hook
|
2012-01-16 00:50:12 +04:00
|
|
|
# force autobuild hook to run before other incoming hooks
|
|
|
|
priority.incoming.autobuild = 1
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Most hooks are run with environment variables set that give useful
|
2017-03-31 12:08:11 +03:00
|
|
|
additional information. For each hook below, the environment variables
|
|
|
|
it is passed are listed with names of the form ``$HG_foo``. The
|
2017-03-31 12:53:56 +03:00
|
|
|
``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
|
|
|
|
their respectively contains the type of hook which triggered the run and
|
|
|
|
the full name of the hooks in the config. In the example about this will
|
|
|
|
be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
``changegroup``
|
2016-01-06 04:37:59 +03:00
|
|
|
Run after a changegroup has been added via push, pull or unbundle. ID of the
|
|
|
|
first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
|
|
|
|
from which changes came is in ``$HG_URL``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``commit``
|
|
|
|
Run after a changeset has been created in the local repository. ID
|
|
|
|
of the newly created changeset is in ``$HG_NODE``. Parent changeset
|
|
|
|
IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``incoming``
|
|
|
|
Run after a changeset has been pulled, pushed, or unbundled into
|
|
|
|
the local repository. The ID of the newly arrived changeset is in
|
|
|
|
``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``outgoing``
|
|
|
|
Run after sending changes from local repository to another. ID of
|
|
|
|
first changeset sent is in ``$HG_NODE``. Source of operation is in
|
2016-02-11 17:15:34 +03:00
|
|
|
``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``post-<command>``
|
|
|
|
Run after successful invocations of the associated command. The
|
|
|
|
contents of the command line are passed as ``$HG_ARGS`` and the result
|
2012-09-29 15:34:37 +04:00
|
|
|
code in ``$HG_RESULT``. Parsed command line arguments are passed as
|
2011-05-30 12:21:39 +04:00
|
|
|
``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
|
2012-09-29 15:34:37 +04:00
|
|
|
the python data internally passed to <command>. ``$HG_OPTS`` is a
|
2011-05-30 12:21:39 +04:00
|
|
|
dictionary of options (with unspecified options set to their defaults).
|
|
|
|
``$HG_PATS`` is a list of arguments. Hook failure is ignored.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2016-04-28 17:37:47 +03:00
|
|
|
``fail-<command>``
|
|
|
|
Run after a failed invocation of an associated command. The contents
|
|
|
|
of the command line are passed as ``$HG_ARGS``. Parsed command line
|
|
|
|
arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
|
|
|
|
string representations of the python data internally passed to
|
|
|
|
<command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
|
|
|
|
options set to their defaults). ``$HG_PATS`` is a list of arguments.
|
|
|
|
Hook failure is ignored.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``pre-<command>``
|
|
|
|
Run before executing the associated command. The contents of the
|
|
|
|
command line are passed as ``$HG_ARGS``. Parsed command line arguments
|
|
|
|
are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
|
|
|
|
representations of the data internally passed to <command>. ``$HG_OPTS``
|
2015-12-29 18:02:13 +03:00
|
|
|
is a dictionary of options (with unspecified options set to their
|
2012-09-29 15:34:37 +04:00
|
|
|
defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
|
2011-05-30 12:21:39 +04:00
|
|
|
failure, the command doesn't execute and Mercurial returns the failure
|
|
|
|
code.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``prechangegroup``
|
|
|
|
Run before a changegroup is added via push, pull or unbundle. Exit
|
|
|
|
status 0 allows the changegroup to proceed. Non-zero status will
|
|
|
|
cause the push, pull or unbundle to fail. URL from which changes
|
|
|
|
will come is in ``$HG_URL``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``precommit``
|
|
|
|
Run before starting a local commit. Exit status 0 allows the
|
|
|
|
commit to proceed. Non-zero status will cause the commit to fail.
|
|
|
|
Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``prelistkeys``
|
|
|
|
Run before listing pushkeys (like bookmarks) in the
|
|
|
|
repository. Non-zero status will cause failure. The key namespace is
|
|
|
|
in ``$HG_NAMESPACE``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``preoutgoing``
|
|
|
|
Run before collecting changes to send from the local repository to
|
|
|
|
another. Non-zero status will cause failure. This lets you prevent
|
|
|
|
pull over HTTP or SSH. Also prevents against local pull, push
|
|
|
|
(outbound) or bundle commands, but not effective, since you can
|
|
|
|
just copy files instead then. Source of operation is in
|
|
|
|
``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
|
|
|
|
SSH or HTTP repository. If "push", "pull" or "bundle", operation
|
|
|
|
is happening on behalf of repository on same system.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``prepushkey``
|
|
|
|
Run before a pushkey (like a bookmark) is added to the
|
|
|
|
repository. Non-zero status will cause the key to be rejected. The
|
|
|
|
key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
|
|
|
|
the old value (if any) is in ``$HG_OLD``, and the new value is in
|
|
|
|
``$HG_NEW``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``pretag``
|
|
|
|
Run before creating a tag. Exit status 0 allows the tag to be
|
|
|
|
created. Non-zero status will cause the tag to fail. ID of
|
|
|
|
changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
|
|
|
|
local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2014-12-11 05:19:49 +03:00
|
|
|
``pretxnopen``
|
|
|
|
Run before any new repository transaction is open. The reason for the
|
2015-04-16 12:41:07 +03:00
|
|
|
transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
|
|
|
|
transaction will be in ``HG_TXNID``. A non-zero status will prevent the
|
|
|
|
transaction from being opened.
|
2014-12-11 05:19:49 +03:00
|
|
|
|
2015-03-10 08:50:49 +03:00
|
|
|
``pretxnclose``
|
2016-01-06 04:37:59 +03:00
|
|
|
Run right before the transaction is actually finalized. Any repository change
|
|
|
|
will be visible to the hook program. This lets you validate the transaction
|
|
|
|
content or change it. Exit status 0 allows the commit to proceed. Non-zero
|
|
|
|
status will cause the transaction to be rolled back. The reason for the
|
|
|
|
transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
|
|
|
|
the transaction will be in ``HG_TXNID``. The rest of the available data will
|
|
|
|
vary according the transaction type. New changesets will add ``$HG_NODE`` (id
|
|
|
|
of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
|
|
|
|
changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
|
|
|
|
changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
|
2015-03-10 08:50:49 +03:00
|
|
|
|
2015-03-10 08:36:56 +03:00
|
|
|
``txnclose``
|
2015-04-19 13:37:29 +03:00
|
|
|
Run after any repository transaction has been committed. At this
|
2015-03-10 08:36:56 +03:00
|
|
|
point, the transaction can no longer be rolled back. The hook will run
|
2016-02-11 17:15:34 +03:00
|
|
|
after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
|
2015-08-28 22:43:14 +03:00
|
|
|
details about available variables.
|
2015-03-10 08:36:56 +03:00
|
|
|
|
2015-04-16 12:36:49 +03:00
|
|
|
``txnabort``
|
2016-02-11 17:15:34 +03:00
|
|
|
Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
|
2015-08-28 22:43:14 +03:00
|
|
|
docs for details about available variables.
|
2015-04-16 12:36:49 +03:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``pretxnchangegroup``
|
2016-01-06 04:37:59 +03:00
|
|
|
Run after a changegroup has been added via push, pull or unbundle, but before
|
|
|
|
the transaction has been committed. Changegroup is visible to hook program.
|
|
|
|
This lets you validate incoming changes before accepting them. Passed the ID
|
|
|
|
of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
|
|
|
|
Exit status 0 allows the transaction to commit. Non-zero status will cause
|
|
|
|
the transaction to be rolled back and the push, pull or unbundle will fail.
|
|
|
|
URL that was source of changes is in ``$HG_URL``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``pretxncommit``
|
|
|
|
Run after a changeset has been created but the transaction not yet
|
|
|
|
committed. Changeset is visible to hook program. This lets you
|
|
|
|
validate commit message and changes. Exit status 0 allows the
|
|
|
|
commit to proceed. Non-zero status will cause the transaction to
|
|
|
|
be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
|
|
|
|
IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``preupdate``
|
|
|
|
Run before updating the working directory. Exit status 0 allows
|
|
|
|
the update to proceed. Non-zero status will prevent the update.
|
|
|
|
Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
|
|
|
|
of second new parent is in ``$HG_PARENT2``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``listkeys``
|
|
|
|
Run after listing pushkeys (like bookmarks) in the repository. The
|
|
|
|
key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
|
|
|
|
dictionary containing the keys and values.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``pushkey``
|
|
|
|
Run after a pushkey (like a bookmark) is added to the
|
|
|
|
repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
|
|
|
|
``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
|
|
|
|
value is in ``$HG_NEW``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``tag``
|
|
|
|
Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
|
|
|
|
Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
|
|
|
|
repository if ``$HG_LOCAL=0``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``update``
|
|
|
|
Run after updating the working directory. Changeset ID of first
|
|
|
|
new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
|
|
|
|
in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
|
|
|
|
update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
|
|
|
|
|
2014-02-19 16:25:28 +04:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
It is generally better to use standard hooks rather than the
|
2011-05-30 12:21:39 +04:00
|
|
|
generic pre- and post- command hooks as they are guaranteed to be
|
|
|
|
called in the appropriate contexts for influencing transactions.
|
|
|
|
Also, hooks like "commit" will be called in all contexts that
|
|
|
|
generate a commit (e.g. tag) and not just the commit command.
|
|
|
|
|
2014-02-19 16:25:28 +04:00
|
|
|
.. note::
|
|
|
|
|
|
|
|
Environment variables with empty values may not be passed to
|
2011-05-30 12:21:39 +04:00
|
|
|
hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
|
|
|
|
will have an empty value under Unix-like platforms for non-merge
|
|
|
|
changesets, while it will not be available at all under Windows.
|
|
|
|
|
|
|
|
The syntax for Python hooks is as follows::
|
|
|
|
|
|
|
|
hookname = python:modulename.submodule.callable
|
|
|
|
hookname = python:/path/to/python/module.py:callable
|
|
|
|
|
|
|
|
Python hooks are run within the Mercurial process. Each hook is
|
|
|
|
called with at least three keyword arguments: a ui object (keyword
|
|
|
|
``ui``), a repository object (keyword ``repo``), and a ``hooktype``
|
|
|
|
keyword that tells what kind of hook is used. Arguments listed as
|
|
|
|
environment variables above are passed as keyword arguments, with no
|
|
|
|
``HG_`` prefix, and names in lower case.
|
|
|
|
|
|
|
|
If a Python hook returns a "true" value or raises an exception, this
|
|
|
|
is treated as a failure.
|
|
|
|
|
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
``hostfingerprints``
|
2012-07-25 11:40:38 +04:00
|
|
|
--------------------
|
2012-02-18 17:27:57 +04:00
|
|
|
|
2016-05-28 22:37:36 +03:00
|
|
|
(Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
|
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
Fingerprints of the certificates of known HTTPS servers.
|
2016-03-13 23:51:01 +03:00
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
A HTTPS connection to a server with a fingerprint configured here will
|
|
|
|
only succeed if the servers certificate matches the fingerprint.
|
|
|
|
This is very similar to how ssh known hosts works.
|
2016-03-13 23:51:01 +03:00
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
The fingerprint is the SHA-1 hash value of the DER encoded certificate.
|
2016-03-14 00:03:58 +03:00
|
|
|
Multiple values can be specified (separated by spaces or commas). This can
|
|
|
|
be used to define both old and new fingerprints while a host transitions
|
|
|
|
to a new certificate.
|
2016-03-13 23:51:01 +03:00
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
The CA chain and web.cacerts is not used for servers with a fingerprint.
|
|
|
|
|
|
|
|
For example::
|
|
|
|
|
|
|
|
[hostfingerprints]
|
2016-02-01 14:36:28 +03:00
|
|
|
hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
|
|
|
|
hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
|
2012-02-18 17:27:57 +04:00
|
|
|
|
2016-05-28 22:37:36 +03:00
|
|
|
``hostsecurity``
|
|
|
|
----------------
|
|
|
|
|
sslutil: config option to specify TLS protocol version
Currently, Mercurial will use TLS 1.0 or newer when connecting to
remote servers, selecting the highest TLS version supported by both
peers. On older Pythons, only TLS 1.0 is available. On newer Pythons,
TLS 1.1 and 1.2 should be available.
Security-minded people may want to not take any risks running
TLS 1.0 (or even TLS 1.1). This patch gives those people a config
option to explicitly control which TLS versions Mercurial should use.
By providing this option, one can require newer TLS versions
before they are formally deprecated by Mercurial/Python/OpenSSL/etc
and lower their security exposure. This option also provides an
easy mechanism to change protocol policies in Mercurial. If there
is a 0-day and TLS 1.0 is completely broken, we can act quickly
without changing much code.
Because setting the minimum TLS protocol is something you'll likely
want to do globally, this patch introduces a global config option under
[hostsecurity] for that purpose.
wrapserversocket() has been taught a hidden config option to define
the explicit protocol to use. This is queried in this function and
not passed as an argument because I don't want to expose this dangerous
option as part of the Python API. There is a risk someone could footgun
themselves. But the config option is a devel option, has a warning
comment, and I doubt most people are using `hg serve` to run a
production HTTPS server (I would have something not Mercurial/Python
handle TLS). If this is problematic, we can go back to using a
custom extension in tests to coerce the server into bad behavior.
2016-07-15 06:47:22 +03:00
|
|
|
Used to specify global and per-host security settings for connecting to
|
|
|
|
other machines.
|
2016-05-28 22:37:36 +03:00
|
|
|
|
sslutil: config option to specify TLS protocol version
Currently, Mercurial will use TLS 1.0 or newer when connecting to
remote servers, selecting the highest TLS version supported by both
peers. On older Pythons, only TLS 1.0 is available. On newer Pythons,
TLS 1.1 and 1.2 should be available.
Security-minded people may want to not take any risks running
TLS 1.0 (or even TLS 1.1). This patch gives those people a config
option to explicitly control which TLS versions Mercurial should use.
By providing this option, one can require newer TLS versions
before they are formally deprecated by Mercurial/Python/OpenSSL/etc
and lower their security exposure. This option also provides an
easy mechanism to change protocol policies in Mercurial. If there
is a 0-day and TLS 1.0 is completely broken, we can act quickly
without changing much code.
Because setting the minimum TLS protocol is something you'll likely
want to do globally, this patch introduces a global config option under
[hostsecurity] for that purpose.
wrapserversocket() has been taught a hidden config option to define
the explicit protocol to use. This is queried in this function and
not passed as an argument because I don't want to expose this dangerous
option as part of the Python API. There is a risk someone could footgun
themselves. But the config option is a devel option, has a warning
comment, and I doubt most people are using `hg serve` to run a
production HTTPS server (I would have something not Mercurial/Python
handle TLS). If this is problematic, we can go back to using a
custom extension in tests to coerce the server into bad behavior.
2016-07-15 06:47:22 +03:00
|
|
|
The following options control default behavior for all hosts.
|
|
|
|
|
2016-07-17 20:59:32 +03:00
|
|
|
``ciphers``
|
|
|
|
Defines the cryptographic ciphers to use for connections.
|
|
|
|
|
|
|
|
Value must be a valid OpenSSL Cipher List Format as documented at
|
|
|
|
https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
|
|
|
|
|
|
|
|
This setting is for advanced users only. Setting to incorrect values
|
|
|
|
can significantly lower connection security or decrease performance.
|
|
|
|
You have been warned.
|
|
|
|
|
|
|
|
This option requires Python 2.7.
|
|
|
|
|
sslutil: config option to specify TLS protocol version
Currently, Mercurial will use TLS 1.0 or newer when connecting to
remote servers, selecting the highest TLS version supported by both
peers. On older Pythons, only TLS 1.0 is available. On newer Pythons,
TLS 1.1 and 1.2 should be available.
Security-minded people may want to not take any risks running
TLS 1.0 (or even TLS 1.1). This patch gives those people a config
option to explicitly control which TLS versions Mercurial should use.
By providing this option, one can require newer TLS versions
before they are formally deprecated by Mercurial/Python/OpenSSL/etc
and lower their security exposure. This option also provides an
easy mechanism to change protocol policies in Mercurial. If there
is a 0-day and TLS 1.0 is completely broken, we can act quickly
without changing much code.
Because setting the minimum TLS protocol is something you'll likely
want to do globally, this patch introduces a global config option under
[hostsecurity] for that purpose.
wrapserversocket() has been taught a hidden config option to define
the explicit protocol to use. This is queried in this function and
not passed as an argument because I don't want to expose this dangerous
option as part of the Python API. There is a risk someone could footgun
themselves. But the config option is a devel option, has a warning
comment, and I doubt most people are using `hg serve` to run a
production HTTPS server (I would have something not Mercurial/Python
handle TLS). If this is problematic, we can go back to using a
custom extension in tests to coerce the server into bad behavior.
2016-07-15 06:47:22 +03:00
|
|
|
``minimumprotocol``
|
|
|
|
Defines the minimum channel encryption protocol to use.
|
|
|
|
|
sslutil: require TLS 1.1+ when supported
Currently, Mercurial will use TLS 1.0 or newer when connecting to
remote servers, selecting the highest TLS version supported by both
peers. On older Pythons, only TLS 1.0 is available. On newer Pythons,
TLS 1.1 and 1.2 should be available.
Security professionals recommend avoiding TLS 1.0 if possible.
PCI DSS 3.1 "strongly encourages" the use of TLS 1.2.
Known attacks like BEAST and POODLE exist against TLS 1.0 (although
mitigations are available and properly configured servers aren't
vulnerable).
I asked Eric Rescorla - Mozilla's resident crypto expert - whether
Mercurial should drop support for TLS 1.0. His response was
"if you can get away with it." Essentially, a number of servers on
the Internet don't support TLS 1.1+. This is why web browsers
continue to support TLS 1.0 despite desires from security experts.
This patch changes Mercurial's default behavior on modern Python
versions to require TLS 1.1+, thus avoiding known security issues
with TLS 1.0 and making Mercurial more secure by default. Rather
than drop TLS 1.0 support wholesale, we still allow TLS 1.0 to be
used if configured. This is a compromise solution - ideally we'd
disallow TLS 1.0. However, since we're not sure how many Mercurial
servers don't support TLS 1.1+ and we're not sure how much user
inconvenience this change will bring, I think it is prudent to ship
an escape hatch that still allows usage of TLS 1.0. In the default
case our users get better security. In the worst case, they are no
worse off than before this patch.
This patch has no effect when running on Python versions that don't
support TLS 1.1+.
As the added test shows, connecting to a server that doesn't
support TLS 1.1+ will display a warning message with a link to
our wiki, where we can guide people to configure their client to
allow less secure connections.
2016-07-14 07:35:54 +03:00
|
|
|
By default, the highest version of TLS supported by both client and server
|
|
|
|
is used.
|
sslutil: config option to specify TLS protocol version
Currently, Mercurial will use TLS 1.0 or newer when connecting to
remote servers, selecting the highest TLS version supported by both
peers. On older Pythons, only TLS 1.0 is available. On newer Pythons,
TLS 1.1 and 1.2 should be available.
Security-minded people may want to not take any risks running
TLS 1.0 (or even TLS 1.1). This patch gives those people a config
option to explicitly control which TLS versions Mercurial should use.
By providing this option, one can require newer TLS versions
before they are formally deprecated by Mercurial/Python/OpenSSL/etc
and lower their security exposure. This option also provides an
easy mechanism to change protocol policies in Mercurial. If there
is a 0-day and TLS 1.0 is completely broken, we can act quickly
without changing much code.
Because setting the minimum TLS protocol is something you'll likely
want to do globally, this patch introduces a global config option under
[hostsecurity] for that purpose.
wrapserversocket() has been taught a hidden config option to define
the explicit protocol to use. This is queried in this function and
not passed as an argument because I don't want to expose this dangerous
option as part of the Python API. There is a risk someone could footgun
themselves. But the config option is a devel option, has a warning
comment, and I doubt most people are using `hg serve` to run a
production HTTPS server (I would have something not Mercurial/Python
handle TLS). If this is problematic, we can go back to using a
custom extension in tests to coerce the server into bad behavior.
2016-07-15 06:47:22 +03:00
|
|
|
|
sslutil: require TLS 1.1+ when supported
Currently, Mercurial will use TLS 1.0 or newer when connecting to
remote servers, selecting the highest TLS version supported by both
peers. On older Pythons, only TLS 1.0 is available. On newer Pythons,
TLS 1.1 and 1.2 should be available.
Security professionals recommend avoiding TLS 1.0 if possible.
PCI DSS 3.1 "strongly encourages" the use of TLS 1.2.
Known attacks like BEAST and POODLE exist against TLS 1.0 (although
mitigations are available and properly configured servers aren't
vulnerable).
I asked Eric Rescorla - Mozilla's resident crypto expert - whether
Mercurial should drop support for TLS 1.0. His response was
"if you can get away with it." Essentially, a number of servers on
the Internet don't support TLS 1.1+. This is why web browsers
continue to support TLS 1.0 despite desires from security experts.
This patch changes Mercurial's default behavior on modern Python
versions to require TLS 1.1+, thus avoiding known security issues
with TLS 1.0 and making Mercurial more secure by default. Rather
than drop TLS 1.0 support wholesale, we still allow TLS 1.0 to be
used if configured. This is a compromise solution - ideally we'd
disallow TLS 1.0. However, since we're not sure how many Mercurial
servers don't support TLS 1.1+ and we're not sure how much user
inconvenience this change will bring, I think it is prudent to ship
an escape hatch that still allows usage of TLS 1.0. In the default
case our users get better security. In the worst case, they are no
worse off than before this patch.
This patch has no effect when running on Python versions that don't
support TLS 1.1+.
As the added test shows, connecting to a server that doesn't
support TLS 1.1+ will display a warning message with a link to
our wiki, where we can guide people to configure their client to
allow less secure connections.
2016-07-14 07:35:54 +03:00
|
|
|
Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
|
|
|
|
|
|
|
|
When running on an old Python version, only ``tls1.0`` is allowed since
|
|
|
|
old versions of Python only support up to TLS 1.0.
|
|
|
|
|
|
|
|
When running a Python that supports modern TLS versions, the default is
|
|
|
|
``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
|
|
|
|
weakens security and should only be used as a feature of last resort if
|
|
|
|
a server does not support TLS 1.1+.
|
sslutil: config option to specify TLS protocol version
Currently, Mercurial will use TLS 1.0 or newer when connecting to
remote servers, selecting the highest TLS version supported by both
peers. On older Pythons, only TLS 1.0 is available. On newer Pythons,
TLS 1.1 and 1.2 should be available.
Security-minded people may want to not take any risks running
TLS 1.0 (or even TLS 1.1). This patch gives those people a config
option to explicitly control which TLS versions Mercurial should use.
By providing this option, one can require newer TLS versions
before they are formally deprecated by Mercurial/Python/OpenSSL/etc
and lower their security exposure. This option also provides an
easy mechanism to change protocol policies in Mercurial. If there
is a 0-day and TLS 1.0 is completely broken, we can act quickly
without changing much code.
Because setting the minimum TLS protocol is something you'll likely
want to do globally, this patch introduces a global config option under
[hostsecurity] for that purpose.
wrapserversocket() has been taught a hidden config option to define
the explicit protocol to use. This is queried in this function and
not passed as an argument because I don't want to expose this dangerous
option as part of the Python API. There is a risk someone could footgun
themselves. But the config option is a devel option, has a warning
comment, and I doubt most people are using `hg serve` to run a
production HTTPS server (I would have something not Mercurial/Python
handle TLS). If this is problematic, we can go back to using a
custom extension in tests to coerce the server into bad behavior.
2016-07-15 06:47:22 +03:00
|
|
|
|
|
|
|
Options in the ``[hostsecurity]`` section can have the form
|
|
|
|
``hostname``:``setting``. This allows multiple settings to be defined on a
|
|
|
|
per-host basis.
|
2016-05-28 22:37:36 +03:00
|
|
|
|
|
|
|
The following per-host settings can be defined.
|
|
|
|
|
2016-07-17 20:59:32 +03:00
|
|
|
``ciphers``
|
|
|
|
This behaves like ``ciphers`` as described above except it only applies
|
|
|
|
to the host on which it is defined.
|
|
|
|
|
2016-05-28 22:37:36 +03:00
|
|
|
``fingerprints``
|
|
|
|
A list of hashes of the DER encoded peer/remote certificate. Values have
|
|
|
|
the form ``algorithm``:``fingerprint``. e.g.
|
|
|
|
``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
|
2017-05-11 10:02:32 +03:00
|
|
|
In addition, colons (``:``) can appear in the fingerprint part.
|
2016-05-28 22:37:36 +03:00
|
|
|
|
|
|
|
The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
|
|
|
|
``sha512``.
|
|
|
|
|
|
|
|
Use of ``sha256`` or ``sha512`` is preferred.
|
|
|
|
|
|
|
|
If a fingerprint is specified, the CA chain is not validated for this
|
|
|
|
host and Mercurial will require the remote certificate to match one
|
|
|
|
of the fingerprints specified. This means if the server updates its
|
|
|
|
certificate, Mercurial will abort until a new fingerprint is defined.
|
|
|
|
This can provide stronger security than traditional CA-based validation
|
|
|
|
at the expense of convenience.
|
|
|
|
|
2016-06-08 06:29:54 +03:00
|
|
|
This option takes precedence over ``verifycertsfile``.
|
|
|
|
|
sslutil: config option to specify TLS protocol version
Currently, Mercurial will use TLS 1.0 or newer when connecting to
remote servers, selecting the highest TLS version supported by both
peers. On older Pythons, only TLS 1.0 is available. On newer Pythons,
TLS 1.1 and 1.2 should be available.
Security-minded people may want to not take any risks running
TLS 1.0 (or even TLS 1.1). This patch gives those people a config
option to explicitly control which TLS versions Mercurial should use.
By providing this option, one can require newer TLS versions
before they are formally deprecated by Mercurial/Python/OpenSSL/etc
and lower their security exposure. This option also provides an
easy mechanism to change protocol policies in Mercurial. If there
is a 0-day and TLS 1.0 is completely broken, we can act quickly
without changing much code.
Because setting the minimum TLS protocol is something you'll likely
want to do globally, this patch introduces a global config option under
[hostsecurity] for that purpose.
wrapserversocket() has been taught a hidden config option to define
the explicit protocol to use. This is queried in this function and
not passed as an argument because I don't want to expose this dangerous
option as part of the Python API. There is a risk someone could footgun
themselves. But the config option is a devel option, has a warning
comment, and I doubt most people are using `hg serve` to run a
production HTTPS server (I would have something not Mercurial/Python
handle TLS). If this is problematic, we can go back to using a
custom extension in tests to coerce the server into bad behavior.
2016-07-15 06:47:22 +03:00
|
|
|
``minimumprotocol``
|
|
|
|
This behaves like ``minimumprotocol`` as described above except it
|
|
|
|
only applies to the host on which it is defined.
|
|
|
|
|
2016-06-08 06:29:54 +03:00
|
|
|
``verifycertsfile``
|
|
|
|
Path to file a containing a list of PEM encoded certificates used to
|
|
|
|
verify the server certificate. Environment variables and ``~user``
|
|
|
|
constructs are expanded in the filename.
|
|
|
|
|
|
|
|
The server certificate or the certificate's certificate authority (CA)
|
|
|
|
must match a certificate from this file or certificate verification
|
|
|
|
will fail and connections to the server will be refused.
|
|
|
|
|
|
|
|
If defined, only certificates provided by this file will be used:
|
|
|
|
``web.cacerts`` and any system/default certificates will not be
|
|
|
|
used.
|
|
|
|
|
|
|
|
This option has no effect if the per-host ``fingerprints`` option
|
|
|
|
is set.
|
|
|
|
|
2016-08-01 00:08:27 +03:00
|
|
|
The format of the file is as follows::
|
2016-06-08 06:29:54 +03:00
|
|
|
|
|
|
|
-----BEGIN CERTIFICATE-----
|
|
|
|
... (certificate in base64 PEM encoding) ...
|
|
|
|
-----END CERTIFICATE-----
|
|
|
|
-----BEGIN CERTIFICATE-----
|
|
|
|
... (certificate in base64 PEM encoding) ...
|
|
|
|
-----END CERTIFICATE-----
|
|
|
|
|
2016-05-28 22:37:36 +03:00
|
|
|
For example::
|
|
|
|
|
|
|
|
[hostsecurity]
|
|
|
|
hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
|
|
|
|
hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
|
2017-05-11 10:02:32 +03:00
|
|
|
hg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2
|
2016-06-08 06:29:54 +03:00
|
|
|
foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
|
2016-05-28 22:37:36 +03:00
|
|
|
|
sslutil: config option to specify TLS protocol version
Currently, Mercurial will use TLS 1.0 or newer when connecting to
remote servers, selecting the highest TLS version supported by both
peers. On older Pythons, only TLS 1.0 is available. On newer Pythons,
TLS 1.1 and 1.2 should be available.
Security-minded people may want to not take any risks running
TLS 1.0 (or even TLS 1.1). This patch gives those people a config
option to explicitly control which TLS versions Mercurial should use.
By providing this option, one can require newer TLS versions
before they are formally deprecated by Mercurial/Python/OpenSSL/etc
and lower their security exposure. This option also provides an
easy mechanism to change protocol policies in Mercurial. If there
is a 0-day and TLS 1.0 is completely broken, we can act quickly
without changing much code.
Because setting the minimum TLS protocol is something you'll likely
want to do globally, this patch introduces a global config option under
[hostsecurity] for that purpose.
wrapserversocket() has been taught a hidden config option to define
the explicit protocol to use. This is queried in this function and
not passed as an argument because I don't want to expose this dangerous
option as part of the Python API. There is a risk someone could footgun
themselves. But the config option is a devel option, has a warning
comment, and I doubt most people are using `hg serve` to run a
production HTTPS server (I would have something not Mercurial/Python
handle TLS). If this is problematic, we can go back to using a
custom extension in tests to coerce the server into bad behavior.
2016-07-15 06:47:22 +03:00
|
|
|
To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
|
|
|
|
when connecting to ``hg.example.com``::
|
|
|
|
|
|
|
|
[hostsecurity]
|
|
|
|
minimumprotocol = tls1.2
|
|
|
|
hg.example.com:minimumprotocol = tls1.1
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``http_proxy``
|
2012-07-25 11:40:38 +04:00
|
|
|
--------------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Used to access web-based Mercurial repositories through a HTTP
|
|
|
|
proxy.
|
|
|
|
|
|
|
|
``host``
|
|
|
|
Host name and (optional) port of the proxy server, for example
|
|
|
|
"myproxy:8000".
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``no``
|
|
|
|
Optional. Comma-separated list of host names that should bypass
|
|
|
|
the proxy.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``passwd``
|
|
|
|
Optional. Password to authenticate with at the proxy server.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``user``
|
|
|
|
Optional. User name to authenticate with at the proxy server.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``always``
|
|
|
|
Optional. Always use the proxy, even for localhost and any entries
|
2015-08-28 22:24:58 +03:00
|
|
|
in ``http_proxy.no``. (default: False)
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2016-02-02 07:28:32 +03:00
|
|
|
``merge``
|
|
|
|
---------
|
|
|
|
|
|
|
|
This section specifies behavior during merges and updates.
|
|
|
|
|
|
|
|
``checkignored``
|
|
|
|
Controls behavior when an ignored file on disk has the same name as a tracked
|
|
|
|
file in the changeset being merged or updated to, and has different
|
|
|
|
contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
|
|
|
|
abort on such files. With ``warn``, warn on such files and back them up as
|
2016-05-01 04:40:34 +03:00
|
|
|
``.orig``. With ``ignore``, don't print a warning and back them up as
|
|
|
|
``.orig``. (default: ``abort``)
|
2016-02-02 07:28:32 +03:00
|
|
|
|
|
|
|
``checkunknown``
|
|
|
|
Controls behavior when an unknown file that isn't ignored has the same name
|
|
|
|
as a tracked file in the changeset being merged or updated to, and has
|
|
|
|
different contents. Similar to ``merge.checkignored``, except for files that
|
|
|
|
are not ignored. (default: ``abort``)
|
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
``merge-patterns``
|
2012-07-25 11:40:38 +04:00
|
|
|
------------------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
This section specifies merge tools to associate with particular file
|
|
|
|
patterns. Tools matched here will take precedence over the default
|
|
|
|
merge tool. Patterns are globs by default, rooted at the repository
|
|
|
|
root.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
Example::
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
[merge-patterns]
|
|
|
|
**.c = kdiff3
|
|
|
|
**.jpg = myimgmerge
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
``merge-tools``
|
2012-07-25 11:40:38 +04:00
|
|
|
---------------
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
This section configures external merge tools to use for file-level
|
2014-05-13 04:40:58 +04:00
|
|
|
merges. This section has likely been preconfigured at install time.
|
|
|
|
Use :hg:`config merge-tools` to check the existing configuration.
|
|
|
|
Also see :hg:`help merge-tools` for more details.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
Example ``~/.hgrc``::
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
[merge-tools]
|
|
|
|
# Override stock tool location
|
|
|
|
kdiff3.executable = ~/bin/kdiff3
|
|
|
|
# Specify command line
|
|
|
|
kdiff3.args = $base $local $other -o $output
|
|
|
|
# Give higher priority
|
|
|
|
kdiff3.priority = 1
|
|
|
|
|
2012-08-02 15:51:34 +04:00
|
|
|
# Changing the priority of preconfigured tool
|
2015-10-14 19:57:33 +03:00
|
|
|
meld.priority = 0
|
|
|
|
|
|
|
|
# Disable a preconfigured tool
|
|
|
|
vimdiff.disabled = yes
|
2012-08-02 15:51:34 +04:00
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
# Define new tool
|
|
|
|
myHtmlTool.args = -m $local $other $base $output
|
|
|
|
myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
|
|
|
|
myHtmlTool.priority = 1
|
|
|
|
|
|
|
|
Supported arguments:
|
|
|
|
|
|
|
|
``priority``
|
|
|
|
The priority in which to evaluate this tool.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: 0)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
``executable``
|
2016-01-10 09:09:10 +03:00
|
|
|
Either just the name of the executable or its pathname.
|
|
|
|
|
|
|
|
.. container:: windows
|
|
|
|
|
|
|
|
On Windows, the path can use environment variables with ${ProgramFiles}
|
|
|
|
syntax.
|
|
|
|
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: the tool name)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
``args``
|
|
|
|
The arguments to pass to the tool executable. You can refer to the
|
|
|
|
files being merged as well as the output file through these
|
2014-05-17 00:15:07 +04:00
|
|
|
variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
|
|
|
|
of ``$local`` and ``$other`` can vary depending on which action is being
|
|
|
|
performed. During and update or merge, ``$local`` represents the original
|
|
|
|
state of the file, while ``$other`` represents the commit you are updating
|
|
|
|
to or the commit you are merging with. During a rebase ``$local``
|
|
|
|
represents the destination of the rebase, and ``$other`` represents the
|
|
|
|
commit being rebased.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: ``$local $base $other``)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
``premerge``
|
|
|
|
Attempt to run internal non-interactive 3-way merge tool before
|
2014-08-05 03:32:41 +04:00
|
|
|
launching external tool. Options are ``true``, ``false``, ``keep`` or
|
|
|
|
``keep-merge3``. The ``keep`` option will leave markers in the file if the
|
|
|
|
premerge fails. The ``keep-merge3`` will do the same but include information
|
2014-10-31 20:43:08 +03:00
|
|
|
about the base of the merge in the marker (see internal :merge3 in
|
|
|
|
:hg:`help merge-tools`).
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: True)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
``binary``
|
2015-09-02 20:39:46 +03:00
|
|
|
This tool can merge binary files. (default: False, unless tool
|
|
|
|
was selected by file pattern match)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
``symlink``
|
2015-09-02 20:39:46 +03:00
|
|
|
This tool can merge symlinks. (default: False)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
``check``
|
2015-09-10 20:45:00 +03:00
|
|
|
A list of merge success-checking options:
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
``changed``
|
|
|
|
Ask whether merge was successful when the merged file shows no changes.
|
|
|
|
``conflicts``
|
|
|
|
Check whether there are conflicts even though the tool reported success.
|
|
|
|
``prompt``
|
|
|
|
Always prompt for merge success, regardless of success reported by tool.
|
|
|
|
|
|
|
|
``fixeol``
|
|
|
|
Attempt to fix up EOL changes caused by the merge tool.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: False)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
``gui``
|
2015-09-02 20:39:46 +03:00
|
|
|
This tool requires a graphical interface to run. (default: False)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
2016-01-10 09:09:10 +03:00
|
|
|
.. container:: windows
|
2012-02-18 17:27:57 +04:00
|
|
|
|
2016-01-10 09:09:10 +03:00
|
|
|
``regkey``
|
|
|
|
Windows registry key which describes install location of this
|
|
|
|
tool. Mercurial will search for this key first under
|
|
|
|
``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
|
|
|
|
(default: None)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
2016-01-10 09:09:10 +03:00
|
|
|
``regkeyalt``
|
|
|
|
An alternate Windows registry key to try if the first key is not
|
|
|
|
found. The alternate key uses the same ``regname`` and ``regappend``
|
|
|
|
semantics of the primary key. The most common use for this key
|
|
|
|
is to search for 32bit applications on 64bit operating systems.
|
|
|
|
(default: None)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
2016-01-10 09:09:10 +03:00
|
|
|
``regname``
|
|
|
|
Name of value to read from specified registry key.
|
|
|
|
(default: the unnamed (default) value)
|
|
|
|
|
|
|
|
``regappend``
|
|
|
|
String to append to the value read from the registry, typically
|
|
|
|
the executable name of the tool.
|
|
|
|
(default: None)
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2017-05-01 17:52:11 +03:00
|
|
|
``pager``
|
|
|
|
---------
|
|
|
|
|
|
|
|
Setting used to control when to paginate and with what external tool. See
|
|
|
|
:hg:`help pager` for details.
|
|
|
|
|
|
|
|
``pager``
|
|
|
|
Define the external tool used as pager.
|
|
|
|
|
|
|
|
If no pager is set, Mercurial uses the environment variable $PAGER.
|
|
|
|
If neither pager.pager, nor $PAGER is set, a default pager will be
|
|
|
|
used, typically `less` on Unix and `more` on Windows. Example::
|
|
|
|
|
|
|
|
[pager]
|
|
|
|
pager = less -FRX
|
|
|
|
|
|
|
|
``ignore``
|
|
|
|
List of commands to disable the pager for. Example::
|
|
|
|
|
|
|
|
[pager]
|
|
|
|
ignore = version, help, update
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
``patch``
|
2012-07-25 11:40:38 +04:00
|
|
|
---------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Settings used when applying patches, for instance through the 'import'
|
|
|
|
command or with Mercurial Queues extension.
|
|
|
|
|
|
|
|
``eol``
|
|
|
|
When set to 'strict' patch content and patched files end of lines
|
|
|
|
are preserved. When set to ``lf`` or ``crlf``, both files end of
|
|
|
|
lines are ignored when patching and the result line endings are
|
|
|
|
normalized to either LF (Unix) or CRLF (Windows). When set to
|
|
|
|
``auto``, end of lines are again ignored while patching but line
|
|
|
|
endings in patched files are normalized to their original setting
|
|
|
|
on a per-file basis. If target file does not exist or has no end
|
|
|
|
of line, patch line endings are preserved.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: strict)
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2015-06-18 23:42:40 +03:00
|
|
|
``fuzz``
|
|
|
|
The number of lines of 'fuzz' to allow when applying patches. This
|
|
|
|
controls how much context the patcher is allowed to ignore when
|
|
|
|
trying to apply a patch.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: 2)
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
``paths``
|
2012-07-25 11:40:38 +04:00
|
|
|
---------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2015-12-06 08:11:04 +03:00
|
|
|
Assigns symbolic names and behavior to repositories.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2015-12-06 08:11:04 +03:00
|
|
|
Options are symbolic names defining the URL or directory that is the
|
|
|
|
location of the repository. Example::
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2015-12-06 08:11:04 +03:00
|
|
|
[paths]
|
|
|
|
my_server = https://example.com/my_repo
|
|
|
|
local_path = /home/me/repo
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2015-12-06 08:11:04 +03:00
|
|
|
These symbolic names can be used from the command line. To pull
|
|
|
|
from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
|
|
|
|
:hg:`push local_path`.
|
|
|
|
|
|
|
|
Options containing colons (``:``) denote sub-options that can influence
|
|
|
|
behavior for that specific path. Example::
|
2012-09-29 15:41:02 +04:00
|
|
|
|
|
|
|
[paths]
|
2015-12-06 08:11:04 +03:00
|
|
|
my_server = https://example.com/my_path
|
|
|
|
my_server:pushurl = ssh://example.com/my_path
|
|
|
|
|
|
|
|
The following sub-options can be defined:
|
2012-09-29 15:41:02 +04:00
|
|
|
|
2015-12-06 08:11:04 +03:00
|
|
|
``pushurl``
|
|
|
|
The URL to use for push operations. If not defined, the location
|
|
|
|
defined by the path's main entry is used.
|
2012-09-29 15:41:02 +04:00
|
|
|
|
2016-06-26 17:59:02 +03:00
|
|
|
``pushrev``
|
|
|
|
A revset defining which revisions to push by default.
|
|
|
|
|
|
|
|
When :hg:`push` is executed without a ``-r`` argument, the revset
|
|
|
|
defined by this sub-option is evaluated to determine what to push.
|
|
|
|
|
|
|
|
For example, a value of ``.`` will push the working directory's
|
|
|
|
revision by default.
|
|
|
|
|
|
|
|
Revsets specifying bookmarks will not result in the bookmark being
|
|
|
|
pushed.
|
|
|
|
|
2015-12-06 08:11:04 +03:00
|
|
|
The following special named paths exist:
|
2012-09-29 15:41:02 +04:00
|
|
|
|
2015-12-06 08:11:04 +03:00
|
|
|
``default``
|
|
|
|
The URL or directory to use when no source or remote is specified.
|
|
|
|
|
|
|
|
:hg:`clone` will automatically define this path to the location the
|
|
|
|
repository was cloned from.
|
|
|
|
|
|
|
|
``default-push``
|
|
|
|
(deprecated) The URL or directory for the default :hg:`push` location.
|
|
|
|
``default:pushurl`` should be used instead.
|
2012-09-29 15:41:02 +04:00
|
|
|
|
2012-01-27 03:54:22 +04:00
|
|
|
``phases``
|
2012-07-25 11:40:38 +04:00
|
|
|
----------
|
2012-01-27 03:54:22 +04:00
|
|
|
|
2012-01-27 18:52:13 +04:00
|
|
|
Specifies default handling of phases. See :hg:`help phases` for more
|
2012-01-27 03:54:22 +04:00
|
|
|
information about working with phases.
|
|
|
|
|
|
|
|
``publish``
|
|
|
|
Controls draft phase behavior when working as a server. When true,
|
|
|
|
pushed changesets are set to public in both client and server and
|
|
|
|
pulled or cloned changesets are set to public in the client.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: True)
|
2012-01-27 03:54:22 +04:00
|
|
|
|
|
|
|
``new-commit``
|
|
|
|
Phase of newly-created commits.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: draft)
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2013-11-13 10:55:30 +04:00
|
|
|
``checksubrepos``
|
2014-01-29 18:16:36 +04:00
|
|
|
Check the phase of the current revision of each subrepository. Allowed
|
|
|
|
values are "ignore", "follow" and "abort". For settings other than
|
|
|
|
"ignore", the phase of the current revision of each subrepository is
|
|
|
|
checked before committing the parent repository. If any of those phases is
|
|
|
|
greater than the phase of the parent repository (e.g. if a subrepo is in a
|
|
|
|
"secret" phase while the parent repo is in "draft" phase), the commit is
|
|
|
|
either aborted (if checksubrepos is set to "abort") or the higher phase is
|
|
|
|
used for the parent repository commit (if set to "follow").
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: follow)
|
2013-11-13 10:55:30 +04:00
|
|
|
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``profiling``
|
2012-07-25 11:40:38 +04:00
|
|
|
-------------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2012-04-10 00:48:45 +04:00
|
|
|
Specifies profiling type, format, and file output. Two profilers are
|
|
|
|
supported: an instrumenting profiler (named ``ls``), and a sampling
|
|
|
|
profiler (named ``stat``).
|
|
|
|
|
|
|
|
In this section description, 'profiling data' stands for the raw data
|
|
|
|
collected during profiling, while 'profiling report' stands for a
|
|
|
|
statistical text report generated from the profiling data. The
|
|
|
|
profiling is done using lsprof.
|
|
|
|
|
2016-08-15 03:51:12 +03:00
|
|
|
``enabled``
|
|
|
|
Enable the profiler.
|
|
|
|
(default: false)
|
|
|
|
|
|
|
|
This is equivalent to passing ``--profile`` on the command line.
|
|
|
|
|
2012-04-10 00:48:45 +04:00
|
|
|
``type``
|
|
|
|
The type of profiler to use.
|
2016-11-05 07:44:25 +03:00
|
|
|
(default: stat)
|
2012-04-10 00:48:45 +04:00
|
|
|
|
|
|
|
``ls``
|
|
|
|
Use Python's built-in instrumenting profiler. This profiler
|
|
|
|
works on all platforms, but each line number it reports is the
|
|
|
|
first line of a function. This restriction makes it difficult to
|
|
|
|
identify the expensive parts of a non-trivial function.
|
|
|
|
``stat``
|
2016-11-05 06:50:38 +03:00
|
|
|
Use a statistical profiler, statprof. This profiler is most
|
2016-11-10 03:04:44 +03:00
|
|
|
useful for profiling commands that run for longer than about 0.1
|
|
|
|
seconds.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
``format``
|
2012-04-10 00:48:45 +04:00
|
|
|
Profiling format. Specific to the ``ls`` instrumenting profiler.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: text)
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
``text``
|
|
|
|
Generate a profiling report. When saving to a file, it should be
|
|
|
|
noted that only the report is saved, and the profiling data is
|
|
|
|
not kept.
|
|
|
|
``kcachegrind``
|
|
|
|
Format profiling data for kcachegrind use: when saving to a
|
|
|
|
file, the generated file can directly be loaded into
|
|
|
|
kcachegrind.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2016-11-05 06:50:38 +03:00
|
|
|
``statformat``
|
|
|
|
Profiling format for the ``stat`` profiler.
|
|
|
|
(default: hotpath)
|
|
|
|
|
|
|
|
``hotpath``
|
|
|
|
Show a tree-based display containing the hot path of execution (where
|
|
|
|
most time was spent).
|
|
|
|
``bymethod``
|
|
|
|
Show a table of methods ordered by how frequently they are active.
|
|
|
|
``byline``
|
|
|
|
Show a table of lines in files ordered by how frequently they are active.
|
|
|
|
``json``
|
|
|
|
Render profiling data as JSON.
|
|
|
|
|
2012-04-10 00:48:45 +04:00
|
|
|
``frequency``
|
|
|
|
Sampling frequency. Specific to the ``stat`` sampling profiler.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: 1000)
|
2012-04-10 00:48:45 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``output``
|
|
|
|
File path where profiling data or report should be saved. If the
|
2015-09-02 20:39:46 +03:00
|
|
|
file exists, it is replaced. (default: None, data is printed on
|
|
|
|
stderr)
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2013-01-29 23:03:51 +04:00
|
|
|
``sort``
|
|
|
|
Sort field. Specific to the ``ls`` instrumenting profiler.
|
|
|
|
One of ``callcount``, ``reccallcount``, ``totaltime`` and
|
|
|
|
``inlinetime``.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: inlinetime)
|
2013-01-29 23:03:51 +04:00
|
|
|
|
2013-02-04 05:46:53 +04:00
|
|
|
``limit``
|
|
|
|
Number of lines to show. Specific to the ``ls`` instrumenting profiler.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: 30)
|
2013-02-04 05:46:53 +04:00
|
|
|
|
2013-01-29 23:03:51 +04:00
|
|
|
``nested``
|
2013-02-09 01:54:48 +04:00
|
|
|
Show at most this number of lines of drill-down info after each main entry.
|
|
|
|
This can help explain the difference between Total and Inline.
|
2013-01-29 23:03:51 +04:00
|
|
|
Specific to the ``ls`` instrumenting profiler.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: 5)
|
2013-01-29 23:03:51 +04:00
|
|
|
|
2017-06-15 21:04:46 +03:00
|
|
|
``showmin``
|
|
|
|
Minimum fraction of samples an entry must have for it to be displayed.
|
|
|
|
Can be specified as a float between ``0.0`` and ``1.0`` or can have a
|
|
|
|
``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
|
|
|
|
|
|
|
|
Only used by the ``stat`` profiler.
|
|
|
|
|
2017-06-15 21:10:51 +03:00
|
|
|
For the ``hotpath`` format, default is ``0.05``.
|
2017-06-15 21:04:46 +03:00
|
|
|
For the ``chrome`` format, default is ``0.005``.
|
|
|
|
|
|
|
|
The option is unused on other formats.
|
|
|
|
|
|
|
|
``showmax``
|
|
|
|
Maximum fraction of samples an entry can have before it is ignored in
|
|
|
|
display. Values format is the same as ``showmin``.
|
|
|
|
|
|
|
|
Only used by the ``stat`` profiler.
|
|
|
|
|
|
|
|
For the ``chrome`` format, default is ``0.999``.
|
|
|
|
|
|
|
|
The option is unused on other formats.
|
|
|
|
|
2015-06-10 21:56:55 +03:00
|
|
|
``progress``
|
|
|
|
------------
|
|
|
|
|
|
|
|
Mercurial commands can draw progress bars that are as informative as
|
|
|
|
possible. Some progress bars only offer indeterminate information, while others
|
|
|
|
have a definite end point.
|
|
|
|
|
|
|
|
``delay``
|
|
|
|
Number of seconds (float) before showing the progress bar. (default: 3)
|
|
|
|
|
|
|
|
``changedelay``
|
|
|
|
Minimum delay before showing a new topic. When set to less than 3 * refresh,
|
|
|
|
that value will be used instead. (default: 1)
|
|
|
|
|
|
|
|
``refresh``
|
|
|
|
Time in seconds between refreshes of the progress bar. (default: 0.1)
|
|
|
|
|
|
|
|
``format``
|
|
|
|
Format of the progress bar.
|
|
|
|
|
|
|
|
Valid entries for the format field are ``topic``, ``bar``, ``number``,
|
2016-01-06 10:17:28 +03:00
|
|
|
``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
|
|
|
|
last 20 characters of the item, but this can be changed by adding either
|
|
|
|
``-<num>`` which would take the last num characters, or ``+<num>`` for the
|
|
|
|
first num characters.
|
2015-06-10 21:56:55 +03:00
|
|
|
|
2016-01-06 10:17:28 +03:00
|
|
|
(default: topic bar number estimate)
|
2015-06-10 21:56:55 +03:00
|
|
|
|
|
|
|
``width``
|
|
|
|
If set, the maximum width of the progress information (that is, min(width,
|
2015-09-02 09:03:55 +03:00
|
|
|
term width) will be used).
|
2015-06-10 21:56:55 +03:00
|
|
|
|
|
|
|
``clear-complete``
|
2015-08-28 22:13:28 +03:00
|
|
|
Clear the progress bar after it's done. (default: True)
|
2015-06-10 21:56:55 +03:00
|
|
|
|
|
|
|
``disable``
|
2015-09-02 09:03:55 +03:00
|
|
|
If true, don't show a progress bar.
|
2015-06-10 21:56:55 +03:00
|
|
|
|
|
|
|
``assume-tty``
|
2015-09-02 09:03:55 +03:00
|
|
|
If true, ALWAYS show a progress bar, unless disable is given.
|
2015-06-10 21:56:55 +03:00
|
|
|
|
2016-01-13 00:43:41 +03:00
|
|
|
``rebase``
|
|
|
|
----------
|
|
|
|
|
|
|
|
``allowdivergence``
|
|
|
|
Default to False, when True allow creating divergence when performing
|
|
|
|
rebase of obsolete changesets.
|
|
|
|
|
2011-06-18 02:14:47 +04:00
|
|
|
``revsetalias``
|
2012-07-25 11:40:38 +04:00
|
|
|
---------------
|
2011-06-18 02:14:47 +04:00
|
|
|
|
|
|
|
Alias definitions for revsets. See :hg:`help revsets` for details.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``server``
|
2012-07-25 11:40:38 +04:00
|
|
|
----------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Controls generic server settings.
|
|
|
|
|
2016-12-25 01:21:46 +03:00
|
|
|
``compressionengines``
|
|
|
|
List of compression engines and their relative priority to advertise
|
|
|
|
to clients.
|
|
|
|
|
|
|
|
The order of compression engines determines their priority, the first
|
|
|
|
having the highest priority. If a compression engine is not listed
|
|
|
|
here, it won't be advertised to clients.
|
|
|
|
|
|
|
|
If not set (the default), built-in defaults are used. Run
|
|
|
|
:hg:`debuginstall` to list available compression engines and their
|
|
|
|
default wire protocol priority.
|
|
|
|
|
|
|
|
Older Mercurial clients only support zlib compression and this setting
|
|
|
|
has no effect for legacy clients.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``uncompressed``
|
|
|
|
Whether to allow clients to clone a repository using the
|
|
|
|
uncompressed streaming protocol. This transfers about 40% more
|
|
|
|
data than a regular clone, but uses less memory and CPU on both
|
|
|
|
server and client. Over a LAN (100 Mbps or better) or a very fast
|
|
|
|
WAN, an uncompressed streaming clone is a lot faster (~10x) than a
|
|
|
|
regular clone. Over most WAN connections (anything slower than
|
|
|
|
about 6 Mbps), uncompressed streaming is slower, because of the
|
|
|
|
extra data transfer overhead. This mode will also temporarily hold
|
|
|
|
the write lock while determining what data to transfer.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: True)
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2017-06-09 20:41:13 +03:00
|
|
|
``uncompressedallowsecret``
|
|
|
|
Whether to allow stream clones when the repository contains secret
|
|
|
|
changesets. (default: False)
|
|
|
|
|
2012-04-04 02:00:47 +04:00
|
|
|
``preferuncompressed``
|
|
|
|
When set, clients will try to use the uncompressed streaming
|
2015-09-02 20:39:46 +03:00
|
|
|
protocol. (default: False)
|
2012-04-04 02:00:47 +04:00
|
|
|
|
2017-05-11 20:50:05 +03:00
|
|
|
``disablefullbundle``
|
|
|
|
When set, servers will refuse attempts to do pull-based clones.
|
|
|
|
If this option is set, ``preferuncompressed`` and/or clone bundles
|
|
|
|
are highly recommended. Partial clones will still be allowed.
|
|
|
|
(default: False)
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``validate``
|
|
|
|
Whether to validate the completeness of pushed changesets by
|
|
|
|
checking that all new file revisions specified in manifests are
|
2015-09-02 20:39:46 +03:00
|
|
|
present. (default: False)
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2015-06-29 19:35:31 +03:00
|
|
|
``maxhttpheaderlen``
|
|
|
|
Instruct HTTP clients not to send request headers longer than this
|
2015-09-02 20:39:46 +03:00
|
|
|
many bytes. (default: 1024)
|
2015-06-29 19:35:31 +03:00
|
|
|
|
2015-12-05 02:12:11 +03:00
|
|
|
``bundle1``
|
|
|
|
Whether to allow clients to push and pull using the legacy bundle1
|
|
|
|
exchange format. (default: True)
|
|
|
|
|
2015-12-20 22:56:24 +03:00
|
|
|
``bundle1gd``
|
2016-01-08 01:03:11 +03:00
|
|
|
Like ``bundle1`` but only used if the repository is using the
|
2015-12-20 22:56:24 +03:00
|
|
|
*generaldelta* storage format. (default: True)
|
|
|
|
|
2015-12-05 02:12:11 +03:00
|
|
|
``bundle1.push``
|
|
|
|
Whether to allow clients to push using the legacy bundle1 exchange
|
|
|
|
format. (default: True)
|
|
|
|
|
2015-12-20 22:56:24 +03:00
|
|
|
``bundle1gd.push``
|
2016-01-08 01:03:11 +03:00
|
|
|
Like ``bundle1.push`` but only used if the repository is using the
|
2015-12-20 22:56:24 +03:00
|
|
|
*generaldelta* storage format. (default: True)
|
|
|
|
|
2015-12-05 02:12:11 +03:00
|
|
|
``bundle1.pull``
|
|
|
|
Whether to allow clients to pull using the legacy bundle1 exchange
|
|
|
|
format. (default: True)
|
|
|
|
|
2015-12-20 22:56:24 +03:00
|
|
|
``bundle1gd.pull``
|
2016-01-08 01:03:11 +03:00
|
|
|
Like ``bundle1.pull`` but only used if the repository is using the
|
2015-12-20 22:56:24 +03:00
|
|
|
*generaldelta* storage format. (default: True)
|
|
|
|
|
2015-12-05 02:12:11 +03:00
|
|
|
Large repositories using the *generaldelta* storage format should
|
|
|
|
consider setting this option because converting *generaldelta*
|
|
|
|
repositories to the exchange format required by the bundle1 data
|
|
|
|
format can consume a lot of CPU.
|
|
|
|
|
2016-08-08 04:09:58 +03:00
|
|
|
``zliblevel``
|
|
|
|
Integer between ``-1`` and ``9`` that controls the zlib compression level
|
|
|
|
for wire protocol commands that send zlib compressed output (notably the
|
|
|
|
commands that send repository history data).
|
|
|
|
|
|
|
|
The default (``-1``) uses the default zlib compression level, which is
|
|
|
|
likely equivalent to ``6``. ``0`` means no compression. ``9`` means
|
|
|
|
maximum compression.
|
|
|
|
|
|
|
|
Setting this option allows server operators to make trade-offs between
|
|
|
|
bandwidth and CPU used. Lowering the compression lowers CPU utilization
|
|
|
|
but sends more bytes to clients.
|
|
|
|
|
|
|
|
This option only impacts the HTTP server.
|
|
|
|
|
protocol: send application/mercurial-0.2 responses to capable clients
With this commit, the HTTP transport now parses the X-HgProto-<N>
header to determine what media type and compression engine to use for
responses. So far, we only compress responses that are already being
compressed with zlib today (stream response types to specific
commands). We can expand things to cover additional response types
later.
The practical side-effect of this commit is that non-zlib compression
engines will be used if both ends support them. This means if both
ends have zstd support, zstd - not zlib - will be used to compress
data!
When cloning the mozilla-unified repository between a local HTTP
server and client, the benefits of non-zlib compression are quite
noticeable:
engine server CPU (s) client CPU (s) bundle size
zlib (l=6) 174.1 283.2 1,148,547,026
zstd (l=1) 99.2 267.3 1,127,513,841
zstd (l=3) 103.1 266.9 1,018,861,363
zstd (l=7) 128.3 269.7 919,190,278
zstd (l=10) 162.0 - 894,547,179
none 95.3 277.2 4,097,566,064
The default zstd compression level is 3. So if you deploy zstd
capable Mercurial to your clients and servers and CPU time on
your server is dominated by "getbundle" requests (clients cloning
and pulling) - and my experience at Mozilla tells me this is often
the case - this commit could drastically reduce your server-side
CPU usage *and* save on bandwidth costs!
Another benefit of this change is that server operators can install
*any* compression engine. While it isn't enabled by default, the
"none" compression engine can now be used to disable wire protocol
compression completely. Previously, commands like "getbundle" always
zlib compressed output, adding considerable overhead to generating
responses. If you are on a high speed network and your server is under
high load, it might be advantageous to trade bandwidth for CPU.
Although, zstd at level 1 doesn't use that much CPU, so I'm not
convinced that disabling compression wholesale is worthwhile. And, my
data seems to indicate a slow down on the client without compression.
I suspect this is due to a lack of buffering resulting in an increase
in socket read() calls and/or the fact we're transferring an extra 3 GB
of data (parsing HTTP chunked transfer and processing extra TCP packets
can add up). This is definitely worth investigating and optimizing. But
since the "none" compressor isn't enabled by default, I'm inclined to
punt on this issue.
This commit introduces tons of tests. Some of these should arguably
have been implemented on previous commits. But it was difficult to
test without the server functionality in place.
2016-12-25 01:29:32 +03:00
|
|
|
``zstdlevel``
|
|
|
|
Integer between ``1`` and ``22`` that controls the zstd compression level
|
|
|
|
for wire protocol commands. ``1`` is the minimal amount of compression and
|
|
|
|
``22`` is the highest amount of compression.
|
|
|
|
|
|
|
|
The default (``3``) should be significantly faster than zlib while likely
|
|
|
|
delivering better compression ratios.
|
|
|
|
|
|
|
|
This option only impacts the HTTP server.
|
|
|
|
|
|
|
|
See also ``server.zliblevel``.
|
|
|
|
|
2012-02-18 17:27:57 +04:00
|
|
|
``smtp``
|
2012-07-25 11:40:38 +04:00
|
|
|
--------
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
Configuration for extensions that need to send email messages.
|
|
|
|
|
|
|
|
``host``
|
|
|
|
Host name of mail server, e.g. "mail.example.com".
|
|
|
|
|
|
|
|
``port``
|
2015-09-02 20:39:46 +03:00
|
|
|
Optional. Port to connect to on mail server. (default: 465 if
|
|
|
|
``tls`` is smtps; 25 otherwise)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
``tls``
|
|
|
|
Optional. Method to enable TLS when connecting to mail server: starttls,
|
2015-09-02 20:39:46 +03:00
|
|
|
smtps or none. (default: none)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
``username``
|
|
|
|
Optional. User name for authenticating with the SMTP server.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: None)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
``password``
|
|
|
|
Optional. Password for authenticating with the SMTP server. If not
|
|
|
|
specified, interactive sessions will prompt the user for a
|
2015-09-02 20:39:46 +03:00
|
|
|
password; non-interactive sessions will fail. (default: None)
|
2012-02-18 17:27:57 +04:00
|
|
|
|
|
|
|
``local_hostname``
|
2015-09-02 09:05:04 +03:00
|
|
|
Optional. The hostname that the sender can use to identify
|
2012-02-18 17:27:57 +04:00
|
|
|
itself to the MTA.
|
|
|
|
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``subpaths``
|
2012-07-25 11:40:38 +04:00
|
|
|
------------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2012-04-30 14:45:44 +04:00
|
|
|
Subrepository source URLs can go stale if a remote server changes name
|
|
|
|
or becomes temporarily unavailable. This section lets you define
|
|
|
|
rewrite rules of the form::
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
<pattern> = <replacement>
|
|
|
|
|
2012-04-30 14:45:44 +04:00
|
|
|
where ``pattern`` is a regular expression matching a subrepository
|
|
|
|
source URL and ``replacement`` is the replacement string used to
|
|
|
|
rewrite it. Groups can be matched in ``pattern`` and referenced in
|
|
|
|
``replacements``. For instance::
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
http://server/(.*)-hg/ = http://hg.server/\1/
|
|
|
|
|
|
|
|
rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
|
|
|
|
|
2012-07-26 04:54:13 +04:00
|
|
|
Relative subrepository paths are first made absolute, and the
|
2016-06-16 19:15:12 +03:00
|
|
|
rewrite rules are then applied on the full (absolute) path. If ``pattern``
|
|
|
|
doesn't match the full path, an attempt is made to apply it on the
|
|
|
|
relative path alone. The rules are applied in definition order.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
2016-03-27 14:59:36 +03:00
|
|
|
``templatealias``
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
Alias definitions for templates. See :hg:`help templates` for details.
|
|
|
|
|
2016-08-08 17:47:42 +03:00
|
|
|
``templates``
|
|
|
|
-------------
|
|
|
|
|
|
|
|
Use the ``[templates]`` section to define template strings.
|
|
|
|
See :hg:`help templates` for details.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``trusted``
|
2012-07-25 11:40:38 +04:00
|
|
|
-----------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Mercurial will not use the settings in the
|
|
|
|
``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
|
|
|
|
user or to a trusted group, as various hgrc features allow arbitrary
|
|
|
|
commands to be run. This issue is often encountered when configuring
|
|
|
|
hooks or extensions for shared repositories or servers. However,
|
|
|
|
the web interface will use some safe settings from the ``[web]``
|
|
|
|
section.
|
|
|
|
|
|
|
|
This section specifies what users and groups are trusted. The
|
|
|
|
current user is always trusted. To trust everybody, list a user or a
|
|
|
|
group with name ``*``. These settings must be placed in an
|
|
|
|
*already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
|
|
|
|
user or service running Mercurial.
|
|
|
|
|
|
|
|
``users``
|
|
|
|
Comma-separated list of trusted users.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``groups``
|
|
|
|
Comma-separated list of trusted groups.
|
|
|
|
|
|
|
|
|
|
|
|
``ui``
|
2012-07-25 11:40:38 +04:00
|
|
|
------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
User interface controls.
|
|
|
|
|
|
|
|
``archivemeta``
|
|
|
|
Whether to include the .hg_archival.txt file containing meta data
|
|
|
|
(hashes for the repository base and for tip) in archives created
|
|
|
|
by the :hg:`archive` command or downloaded via hgweb.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: True)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``askusername``
|
|
|
|
Whether to prompt for a username when committing. If True, and
|
|
|
|
neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
|
|
|
|
be prompted to enter a username. If no username is entered, the
|
|
|
|
default ``USER@HOST`` is used instead.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: False)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2016-01-08 21:58:04 +03:00
|
|
|
``clonebundles``
|
|
|
|
Whether the "clone bundles" feature is enabled.
|
|
|
|
|
|
|
|
When enabled, :hg:`clone` may download and apply a server-advertised
|
|
|
|
bundle file from a URL instead of using the normal exchange mechanism.
|
|
|
|
|
|
|
|
This can likely result in faster and more reliable clones.
|
|
|
|
|
|
|
|
(default: True)
|
|
|
|
|
clonebundles: support for seeding clones from pre-generated bundles
Cloning can be an expensive operation for servers because the server
generates a bundle from existing repository data at request time. For
a large repository like mozilla-central, this consumes 4+ minutes
of CPU time on the server. It also results in significant network
utilization. Multiplied by hundreds or even thousands of clients and
the ensuing load can result in difficulties scaling the Mercurial server.
Despite generation of bundles being deterministic until the next
changeset is added, the generation of bundles to service a clone request
is not cached. Each clone thus performs redundant work. This is
wasteful.
This patch introduces the "clonebundles" extension and related
client-side functionality to help alleviate this deficiency. The
client-side feature is behind an experimental flag and is not enabled by
default.
It works as follows:
1) Server operator generates a bundle and makes it available on a
server (likely HTTP).
2) Server operator defines the URL of a bundle file in a
.hg/clonebundles.manifest file.
3) Client `hg clone`ing sees the server is advertising bundle URLs.
4) Client fetches and applies the advertised bundle.
5) Client performs equivalent of `hg pull` to fetch changes made since
the bundle was created.
Essentially, the server performs the expensive work of generating a
bundle once and all subsequent clones fetch a static file from
somewhere. Scaling static file serving is a much more manageable
problem than scaling a Python application like Mercurial. Assuming your
repository grows less than 1% per day, the end result is 99+% of CPU
and network load from clones is eliminated, allowing Mercurial servers
to scale more easily. Serving static files also means data can be
transferred to clients as fast as they can consume it, rather than as
fast as servers can generate it. This makes clones faster.
Mozilla has implemented similar functionality of this patch on
hg.mozilla.org using a custom extension. We are hosting bundle files in
Amazon S3 and CloudFront (a CDN) and have successfully offloaded
>1 TB/day in data transfer from hg.mozilla.org, freeing up significant
bandwidth and CPU resources. The positive impact has been stellar and
I believe it has proved its value to be included in Mercurial core. I
feel it is important for the client-side support to be enabled in core
by default because it means that clients will get faster, more reliable
clones and will enable server operators to reduce load without
requiring any client-side configuration changes (assuming clients are
up to date, of course).
The scope of this feature is narrowly and specifically tailored to
cloning, despite "serve pulls from pre-generated bundles" being a valid
and useful feature. I would eventually like for Mercurial servers to
support transferring *all* repository data via statically hosted files.
You could imagine a server that siphons all pushed data to bundle files
and instructs clients to apply a stream of bundles to reconstruct all
repository data. This feature, while useful and powerful, is
significantly more work to implement because it requires the server
component have awareness of discovery and a mapping of which changesets
are in which files. Full, clone bundles, by contrast, are much simpler.
The wire protocol command is named "clonebundles" instead of something
more generic like "staticbundles" to leave the door open for a new, more
powerful and more generic server-side component with minimal backwards
compatibility implications. The name "bundleclone" is used by Mozilla's
extension and would cause problems since there are subtle differences
in Mozilla's extension.
Mozilla's experience with this idea has taught us that some form of
"content negotiation" is required. Not all clients will support all
bundle formats or even URLs (advanced TLS requirements, etc). To ensure
the highest uptake possible, a server needs to advertise multiple
versions of bundles and clients need to be able to choose the most
appropriate from that list one. The "attributes" in each
server-advertised entry facilitate this filtering and sorting. Their
use will become apparent in subsequent patches.
Initial inspiration and credit for the idea of cloning from static files
belongs to Augie Fackler and his "lookaside clone" extension proof of
concept.
2015-10-09 21:22:01 +03:00
|
|
|
``clonebundlefallback``
|
|
|
|
Whether failure to apply an advertised "clone bundle" from a server
|
|
|
|
should result in fallback to a regular clone.
|
|
|
|
|
|
|
|
This is disabled by default because servers advertising "clone
|
|
|
|
bundles" often do so to reduce server load. If advertised bundles
|
|
|
|
start mass failing and clients automatically fall back to a regular
|
|
|
|
clone, this would add significant and unexpected load to the server
|
|
|
|
since the server is expecting clone operations to be offloaded to
|
|
|
|
pre-generated bundles. Failing fast (the default behavior) ensures
|
|
|
|
clients don't overwhelm the server when "clone bundle" application
|
|
|
|
fails.
|
|
|
|
|
|
|
|
(default: False)
|
|
|
|
|
2016-01-08 21:57:01 +03:00
|
|
|
``clonebundleprefers``
|
|
|
|
Defines preferences for which "clone bundles" to use.
|
|
|
|
|
|
|
|
Servers advertising "clone bundles" may advertise multiple available
|
|
|
|
bundles. Each bundle may have different attributes, such as the bundle
|
|
|
|
type and compression format. This option is used to prefer a particular
|
|
|
|
bundle over another.
|
|
|
|
|
|
|
|
The following keys are defined by Mercurial:
|
|
|
|
|
|
|
|
BUNDLESPEC
|
|
|
|
A bundle type specifier. These are strings passed to :hg:`bundle -t`.
|
|
|
|
e.g. ``gzip-v2`` or ``bzip2-v1``.
|
|
|
|
|
|
|
|
COMPRESSION
|
|
|
|
The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
|
|
|
|
|
|
|
|
Server operators may define custom keys.
|
|
|
|
|
|
|
|
Example values: ``COMPRESSION=bzip2``,
|
|
|
|
``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
|
|
|
|
|
|
|
|
By default, the first bundle advertised by the server is used.
|
|
|
|
|
2017-02-21 22:04:55 +03:00
|
|
|
``color``
|
2017-05-02 21:01:54 +03:00
|
|
|
When to colorize output. Possible value are Boolean ("yes" or "no"), or
|
2017-05-02 21:19:09 +03:00
|
|
|
"debug", or "always". (default: "yes"). "yes" will use color whenever it
|
|
|
|
seems possible. See :hg:`help color` for details.
|
2017-02-21 22:04:55 +03:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``commitsubrepos``
|
|
|
|
Whether to commit modified subrepositories when committing the
|
|
|
|
parent repository. If False and one subrepository has uncommitted
|
|
|
|
changes, abort the commit.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: False)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``debug``
|
2015-08-28 22:24:58 +03:00
|
|
|
Print debugging information. (default: False)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``editor``
|
2015-09-02 20:39:46 +03:00
|
|
|
The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``fallbackencoding``
|
|
|
|
Encoding to try if it's not possible to decode the changelog using
|
2015-09-02 20:39:46 +03:00
|
|
|
UTF-8. (default: ISO-8859-1)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2015-11-14 11:25:43 +03:00
|
|
|
``graphnodetemplate``
|
|
|
|
The template used to print changeset nodes in an ASCII revision graph.
|
|
|
|
(default: ``{graphnode}``)
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``ignore``
|
|
|
|
A file to read per-user ignore patterns from. This file should be
|
2014-12-17 01:34:53 +03:00
|
|
|
in the same format as a repository-wide .hgignore file. Filenames
|
|
|
|
are relative to the repository root. This option supports hook syntax,
|
|
|
|
so if you want to specify multiple ignore files, you can do so by
|
|
|
|
setting something like ``ignore.other = ~/.hgignore2``. For details
|
|
|
|
of the ignore file format, see the ``hgignore(5)`` man page.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``interactive``
|
2015-08-28 22:24:58 +03:00
|
|
|
Allow to prompt the user. (default: True)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2016-03-14 18:01:27 +03:00
|
|
|
``interface``
|
|
|
|
Select the default interface for interactive features (default: text).
|
|
|
|
Possible values are 'text' and 'curses'.
|
|
|
|
|
|
|
|
``interface.chunkselector``
|
2016-08-01 00:08:27 +03:00
|
|
|
Select the interface for change recording (e.g. :hg:`commit -i`).
|
2016-03-14 18:01:27 +03:00
|
|
|
Possible values are 'text' and 'curses'.
|
|
|
|
This config overrides the interface specified by ui.interface.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``logtemplate``
|
|
|
|
Template string for commands that print changesets.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``merge``
|
|
|
|
The conflict resolution program to use during a manual merge.
|
|
|
|
For more information on merge tools see :hg:`help merge-tools`.
|
2011-06-16 19:52:37 +04:00
|
|
|
For configuring merge tools see the ``[merge-tools]`` section.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2014-05-09 03:50:22 +04:00
|
|
|
``mergemarkers``
|
filemerge: use 'basic' as the default of '[ui] mergemarkers' for safety
Before this patch, 'detailed' is used as the default of '[ui]
mergemarkers'. This embeds non-ASCII characters in tags, branches,
bookmarks, author and/or commit descriptions into merged files in the
encoding specified by '--encoding' global option, 'HGENCODING' or
other locale setting environment variables.
But, if files to be merged use another encoding, this behavior breaks
consistency of encoding in merged files.
For example, ISO-2022-JP or EUC-JP are sometimes used as the file
encoding for Japanese characters, because of historical and/or
environmental reasons, even though UTF-8 or Shift-JIS are ordinarily
used as the terminal encoding.
This can't be resolved automatically, because Mercurial doesn't aware
encoding of managed files.
This patch uses 'basic' as the default of '[ui] mergemarkers' to avoid
embedding encoding sensitive characters for safety.
This patch puts '[ui] mergemarkers = detailed' into default hgrc file
for tests, to reduce changes for tests in this patch.
2014-07-05 21:56:41 +04:00
|
|
|
Sets the merge conflict marker label styling. The ``detailed``
|
2014-05-09 03:50:22 +04:00
|
|
|
style uses the ``mergemarkertemplate`` setting to style the labels.
|
|
|
|
The ``basic`` style just uses 'local' and 'other' as the marker label.
|
|
|
|
One of ``basic`` or ``detailed``.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: ``basic``)
|
2014-05-09 03:50:22 +04:00
|
|
|
|
|
|
|
``mergemarkertemplate``
|
|
|
|
The template used to print the commit description next to each conflict
|
|
|
|
marker during merge conflicts. See :hg:`help templates` for the template
|
|
|
|
format.
|
2015-09-02 09:02:58 +03:00
|
|
|
|
2014-05-09 03:50:22 +04:00
|
|
|
Defaults to showing the hash, tags, branches, bookmarks, author, and
|
|
|
|
the first line of the commit description.
|
2015-09-02 09:02:58 +03:00
|
|
|
|
2015-03-31 21:58:14 +03:00
|
|
|
If you use non-ASCII characters in names for tags, branches, bookmarks,
|
|
|
|
authors, and/or commit descriptions, you must pay attention to encodings of
|
|
|
|
managed files. At template expansion, non-ASCII characters use the encoding
|
|
|
|
specified by the ``--encoding`` global option, ``HGENCODING`` or other
|
|
|
|
environment variables that govern your locale. If the encoding of the merge
|
|
|
|
markers is different from the encoding of the merged files,
|
|
|
|
serious problems may occur.
|
2014-05-09 03:50:22 +04:00
|
|
|
|
2015-11-13 01:56:06 +03:00
|
|
|
``origbackuppath``
|
|
|
|
The path to a directory used to store generated .orig files. If the path is
|
|
|
|
not a directory, one will be created.
|
|
|
|
|
2017-05-01 17:36:50 +03:00
|
|
|
``paginate``
|
|
|
|
Control the pagination of command output (default: True). See :hg:`help pager`
|
|
|
|
for details.
|
|
|
|
|
2015-06-23 20:47:42 +03:00
|
|
|
``patch``
|
|
|
|
An optional external tool that ``hg import`` and some extensions
|
|
|
|
will use for applying patches. By default Mercurial uses an
|
|
|
|
internal patch utility. The external tool must work as the common
|
|
|
|
Unix ``patch`` program. In particular, it must accept a ``-p``
|
|
|
|
argument to strip patch headers, a ``-d`` argument to specify the
|
|
|
|
current directory, a file name to patch, and a patch file to take
|
|
|
|
from stdin.
|
|
|
|
|
|
|
|
It is possible to specify a patch tool together with extra
|
|
|
|
arguments. For example, setting this option to ``patch --merge``
|
|
|
|
will use the ``patch`` program with its 2-way merge option.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``portablefilenames``
|
|
|
|
Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: ``warn``)
|
2016-01-10 08:04:49 +03:00
|
|
|
|
|
|
|
``warn``
|
|
|
|
Print a warning message on POSIX platforms, if a file with a non-portable
|
|
|
|
filename is added (e.g. a file with a name that can't be created on
|
|
|
|
Windows because it contains reserved parts like ``AUX``, reserved
|
|
|
|
characters like ``:``, or would cause a case collision with an existing
|
|
|
|
file).
|
|
|
|
|
|
|
|
``ignore``
|
|
|
|
Don't print a warning.
|
|
|
|
|
|
|
|
``abort``
|
|
|
|
The command is aborted.
|
|
|
|
|
|
|
|
``true``
|
|
|
|
Alias for ``warn``.
|
|
|
|
|
|
|
|
``false``
|
|
|
|
Alias for ``ignore``.
|
|
|
|
|
2016-01-10 09:09:10 +03:00
|
|
|
.. container:: windows
|
2016-01-10 08:04:49 +03:00
|
|
|
|
|
|
|
On Windows, this configuration option is ignored and the command aborted.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``quiet``
|
2016-01-10 08:58:02 +03:00
|
|
|
Reduce the amount of output printed.
|
|
|
|
(default: False)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``remotecmd``
|
2016-01-10 08:58:02 +03:00
|
|
|
Remote command to use for clone/push/pull operations.
|
|
|
|
(default: ``hg``)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``report_untrusted``
|
|
|
|
Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
|
2016-01-10 08:58:02 +03:00
|
|
|
trusted user or group.
|
|
|
|
(default: True)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``slash``
|
|
|
|
Display paths using a slash (``/``) as the path separator. This
|
|
|
|
only makes a difference on systems where the default path
|
|
|
|
separator is not the slash character (e.g. Windows uses the
|
|
|
|
backslash character (``\``)).
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: False)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2015-03-24 23:25:57 +03:00
|
|
|
``statuscopies``
|
|
|
|
Display copies in the status command.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``ssh``
|
2015-08-28 22:13:28 +03:00
|
|
|
Command to use for SSH connections. (default: ``ssh``)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``strict``
|
|
|
|
Require exact command names, instead of allowing unambiguous
|
2015-08-28 22:24:58 +03:00
|
|
|
abbreviations. (default: False)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``style``
|
|
|
|
Name of style to use for command output.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2015-09-11 22:45:19 +03:00
|
|
|
``supportcontact``
|
2015-09-22 23:10:24 +03:00
|
|
|
A URL where users should report a Mercurial traceback. Use this if you are a
|
|
|
|
large organisation with its own Mercurial deployment process and crash
|
|
|
|
reports should be addressed to your internal support.
|
2015-09-11 22:45:19 +03:00
|
|
|
|
2016-05-04 20:18:24 +03:00
|
|
|
``textwidth``
|
|
|
|
Maximum width of help text. A longer line generated by ``hg help`` or
|
|
|
|
``hg subcommand --help`` will be broken after white space to get this
|
|
|
|
width or the terminal width, whichever comes first.
|
|
|
|
A non-positive value will disable this and the terminal width will be
|
|
|
|
used. (default: 78)
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``timeout``
|
|
|
|
The timeout used when a lock is held (in seconds), a negative value
|
2015-09-02 20:39:46 +03:00
|
|
|
means no timeout. (default: 600)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``traceback``
|
|
|
|
Mercurial always prints a traceback when an unknown exception
|
|
|
|
occurs. Setting this to True will make Mercurial print a traceback
|
|
|
|
on all exceptions, even those recognized by Mercurial (such as
|
2015-09-02 20:39:46 +03:00
|
|
|
IOError or MemoryError). (default: False)
|
2017-06-15 03:56:34 +03:00
|
|
|
|
|
|
|
``tweakdefaults``
|
|
|
|
|
|
|
|
By default Mercurial's behavior changes very little from release
|
|
|
|
to release, but over time the recommended config settings
|
|
|
|
shift. Enable this config to opt in to get automatic tweaks to
|
|
|
|
Mercurial's behavior over time. This config setting will have no
|
|
|
|
effet if ``HGPLAIN` is set or ``HGPLAINEXCEPT`` is set and does
|
|
|
|
not include ``tweakdefaults``. (default: False)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``username``
|
|
|
|
The committer of a changeset created when running "commit".
|
|
|
|
Typically a person's name and email address, e.g. ``Fred Widget
|
2015-09-02 20:39:46 +03:00
|
|
|
<fred@example.com>``. Environment variables in the
|
2011-05-30 12:21:39 +04:00
|
|
|
username are expanded.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: ``$EMAIL`` or ``username@hostname``. If the username in
|
2015-12-29 18:02:13 +03:00
|
|
|
hgrc is empty, e.g. if the system admin set ``username =`` in the
|
2015-09-02 20:39:46 +03:00
|
|
|
system hgrc, it has to be specified manually or in a different
|
|
|
|
hgrc file)
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``verbose``
|
2015-08-28 22:24:58 +03:00
|
|
|
Increase the amount of output printed. (default: False)
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
|
|
|
|
``web``
|
2012-07-25 11:40:38 +04:00
|
|
|
-------
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
Web interface configuration. The settings in this section apply to
|
|
|
|
both the builtin webserver (started by :hg:`serve`) and the script you
|
|
|
|
run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
|
|
|
|
and WSGI).
|
|
|
|
|
|
|
|
The Mercurial webserver does no authentication (it does not prompt for
|
|
|
|
usernames and passwords to validate *who* users are), but it does do
|
|
|
|
authorization (it grants or denies access for *authenticated users*
|
|
|
|
based on settings in this section). You must either configure your
|
|
|
|
webserver to do authentication for you, or disable the authorization
|
|
|
|
checks.
|
|
|
|
|
|
|
|
For a quick setup in a trusted environment, e.g., a private LAN, where
|
|
|
|
you want it to accept pushes from anybody, you can use the following
|
|
|
|
command line::
|
|
|
|
|
|
|
|
$ hg --config web.allow_push=* --config web.push_ssl=False serve
|
|
|
|
|
|
|
|
Note that this will allow anybody to push anything to the server and
|
|
|
|
that this should not be used for public servers.
|
|
|
|
|
|
|
|
The full set of options is:
|
|
|
|
|
|
|
|
``accesslog``
|
2015-09-02 20:39:46 +03:00
|
|
|
Where to output the access log. (default: stdout)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``address``
|
2015-09-02 20:39:46 +03:00
|
|
|
Interface address to bind to. (default: all)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``allow_archive``
|
|
|
|
List of archive format (bz2, gz, zip) allowed for downloading.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: empty)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``allowbz2``
|
|
|
|
(DEPRECATED) Whether to allow .tar.bz2 downloading of repository
|
|
|
|
revisions.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: False)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``allowgz``
|
|
|
|
(DEPRECATED) Whether to allow .tar.gz downloading of repository
|
|
|
|
revisions.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: False)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``allowpull``
|
2015-09-02 20:39:46 +03:00
|
|
|
Whether to allow pulling from the repository. (default: True)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``allow_push``
|
|
|
|
Whether to allow pushing to the repository. If empty or not set,
|
2015-09-02 09:05:32 +03:00
|
|
|
pushing is not allowed. If the special value ``*``, any remote
|
|
|
|
user can push, including unauthenticated users. Otherwise, the
|
|
|
|
remote user must have been authenticated, and the authenticated
|
|
|
|
user name must be present in this list. The contents of the
|
|
|
|
allow_push list are examined after the deny_push list.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``allow_read``
|
|
|
|
If the user has not already been denied repository access due to
|
|
|
|
the contents of deny_read, this list determines whether to grant
|
|
|
|
repository access to the user. If this list is not empty, and the
|
|
|
|
user is unauthenticated or not present in the list, then access is
|
|
|
|
denied for the user. If the list is empty or not set, then access
|
|
|
|
is permitted to all users by default. Setting allow_read to the
|
|
|
|
special value ``*`` is equivalent to it not being set (i.e. access
|
|
|
|
is permitted to all users). The contents of the allow_read list are
|
|
|
|
examined after the deny_read list.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``allowzip``
|
|
|
|
(DEPRECATED) Whether to allow .zip downloading of repository
|
2015-09-02 20:39:46 +03:00
|
|
|
revisions. This feature creates temporary files.
|
|
|
|
(default: False)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2012-10-29 18:53:46 +04:00
|
|
|
``archivesubrepos``
|
2015-09-02 20:39:46 +03:00
|
|
|
Whether to recurse into subrepositories when archiving.
|
|
|
|
(default: False)
|
2012-10-29 18:53:46 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``baseurl``
|
|
|
|
Base URL to use when publishing URLs in other locations, so
|
|
|
|
third-party tools like email notification hooks can construct
|
|
|
|
URLs. Example: ``http://hgserver/repos/``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``cacerts``
|
|
|
|
Path to file containing a list of PEM encoded certificate
|
|
|
|
authority certificates. Environment variables and ``~user``
|
|
|
|
constructs are expanded in the filename. If specified on the
|
|
|
|
client, then it will verify the identity of remote HTTPS servers
|
2012-04-13 05:22:18 +04:00
|
|
|
with these certificates.
|
2011-05-30 12:21:39 +04:00
|
|
|
|
|
|
|
To disable SSL verification temporarily, specify ``--insecure`` from
|
|
|
|
command line.
|
2011-05-30 12:30:46 +04:00
|
|
|
|
2012-04-13 05:22:18 +04:00
|
|
|
You can use OpenSSL's CA certificate file if your platform has
|
|
|
|
one. On most Linux systems this will be
|
|
|
|
``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
|
|
|
|
generate this file manually. The form must be as follows::
|
|
|
|
|
|
|
|
-----BEGIN CERTIFICATE-----
|
|
|
|
... (certificate in base64 PEM encoding) ...
|
|
|
|
-----END CERTIFICATE-----
|
|
|
|
-----BEGIN CERTIFICATE-----
|
|
|
|
... (certificate in base64 PEM encoding) ...
|
|
|
|
-----END CERTIFICATE-----
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``cache``
|
2015-09-02 20:39:46 +03:00
|
|
|
Whether to support caching in hgweb. (default: True)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2015-07-18 22:18:31 +03:00
|
|
|
``certificate``
|
|
|
|
Certificate to use when running :hg:`serve`.
|
|
|
|
|
2012-05-03 03:07:22 +04:00
|
|
|
``collapse``
|
|
|
|
With ``descend`` enabled, repositories in subdirectories are shown at
|
|
|
|
a single level alongside repositories in the current path. With
|
|
|
|
``collapse`` also enabled, repositories residing at a deeper level than
|
|
|
|
the current path are grouped behind navigable directory entries that
|
|
|
|
lead to the locations of these repositories. In effect, this setting
|
|
|
|
collapses each collection of repositories found within a subdirectory
|
2015-09-02 20:39:46 +03:00
|
|
|
into a single entry for that subdirectory. (default: False)
|
2012-05-03 03:07:22 +04:00
|
|
|
|
2012-07-29 21:37:25 +04:00
|
|
|
``comparisoncontext``
|
|
|
|
Number of lines of context to show in side-by-side file comparison. If
|
2015-09-02 20:39:46 +03:00
|
|
|
negative or the value ``full``, whole files are shown. (default: 5)
|
|
|
|
|
2012-07-29 21:37:25 +04:00
|
|
|
This setting can be overridden by a ``context`` request parameter to the
|
|
|
|
``comparison`` command, taking the same values.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``contact``
|
|
|
|
Name or email address of the person in charge of the repository.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
hgweb: support Content Security Policy
Content-Security-Policy (CSP) is a web security feature that allows
servers to declare what loaded content is allowed to do. For example,
a policy can prevent loading of images, JavaScript, CSS, etc unless
the source of that content is whitelisted (by hostname, URI scheme,
hashes of content, etc). It's a nifty security feature that provides
extra mitigation against some attacks, notably XSS.
Mitigation against these attacks is important for Mercurial because
hgweb renders repository data, which is commonly untrusted. While we
make attempts to escape things, etc, there's the possibility that
malicious data could be injected into the site content. If this happens
today, the full power of the web browser is available to that
malicious content. A restrictive CSP policy (defined by the server
operator and sent in an HTTP header which is outside the control of
malicious content), could restrict browser capabilities and mitigate
security problems posed by malicious data.
CSP works by emitting an HTTP header declaring the policy that browsers
should apply. Ideally, this header would be emitted by a layer above
Mercurial (likely the HTTP server doing the WSGI "proxying"). This
works for some CSP policies, but not all.
For example, policies to allow inline JavaScript may require setting
a "nonce" attribute on <script>. This attribute value must be unique
and non-guessable. And, the value must be present in the HTTP header
and the HTML body. This means that coordinating the value between
Mercurial and another HTTP server could be difficult: it is much
easier to generate and emit the nonce in a central location.
This commit introduces support for emitting a
Content-Security-Policy header from hgweb. A config option defines
the header value. If present, the header is emitted. A special
"%nonce%" syntax in the value triggers generation of a nonce and
inclusion in <script> elements in templates. The inclusion of a
nonce does not occur unless "%nonce%" is present. This makes this
commit completely backwards compatible and the feature opt-in.
The nonce is a type 4 UUID, which is the flavor that is randomly
generated. It has 122 random bits, which should be plenty to satisfy
the guarantees of a nonce.
2017-01-11 10:37:08 +03:00
|
|
|
``csp``
|
|
|
|
Send a ``Content-Security-Policy`` HTTP header with this value.
|
|
|
|
|
|
|
|
The value may contain a special string ``%nonce%``, which will be replaced
|
|
|
|
by a randomly-generated one-time use value. If the value contains
|
|
|
|
``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
|
|
|
|
one-time property of the nonce. This nonce will also be inserted into
|
|
|
|
``<script>`` elements containing inline JavaScript.
|
|
|
|
|
|
|
|
Note: lots of HTML content sent by the server is derived from repository
|
|
|
|
data. Please consider the potential for malicious repository data to
|
|
|
|
"inject" itself into generated HTML content as part of your security
|
|
|
|
threat model.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``deny_push``
|
|
|
|
Whether to deny pushing to the repository. If empty or not set,
|
|
|
|
push is not denied. If the special value ``*``, all remote users are
|
|
|
|
denied push. Otherwise, unauthenticated users are all denied, and
|
|
|
|
any authenticated user name present in this list is also denied. The
|
|
|
|
contents of the deny_push list are examined before the allow_push list.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``deny_read``
|
|
|
|
Whether to deny reading/viewing of the repository. If this list is
|
|
|
|
not empty, unauthenticated users are all denied, and any
|
|
|
|
authenticated user name present in this list is also denied access to
|
|
|
|
the repository. If set to the special value ``*``, all remote users
|
|
|
|
are denied access (rarely needed ;). If deny_read is empty or not set,
|
|
|
|
the determination of repository access depends on the presence and
|
|
|
|
content of the allow_read list (see description). If both
|
|
|
|
deny_read and allow_read are empty or not set, then access is
|
|
|
|
permitted to all users by default. If the repository is being
|
|
|
|
served via hgwebdir, denied users will not be able to see it in
|
|
|
|
the list of repositories. The contents of the deny_read list have
|
|
|
|
priority over (are examined before) the contents of the allow_read
|
|
|
|
list.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``descend``
|
|
|
|
hgwebdir indexes will not descend into subdirectories. Only repositories
|
|
|
|
directly in the current path will be shown (other repositories are still
|
|
|
|
available from the index corresponding to their containing path).
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``description``
|
|
|
|
Textual description of the repository's purpose or contents.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: "unknown")
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``encoding``
|
2015-09-02 20:39:46 +03:00
|
|
|
Character encoding name. (default: the current locale charset)
|
2015-09-02 09:03:55 +03:00
|
|
|
Example: "UTF-8".
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``errorlog``
|
2015-09-02 20:39:46 +03:00
|
|
|
Where to output the error log. (default: stderr)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2012-07-29 21:37:25 +04:00
|
|
|
``guessmime``
|
|
|
|
Control MIME types for raw download of file content.
|
|
|
|
Set to True to let hgweb guess the content type from the file
|
|
|
|
extension. This will serve HTML files as ``text/html`` and might
|
|
|
|
allow cross-site scripting attacks when serving untrusted
|
2015-09-02 20:39:46 +03:00
|
|
|
repositories. (default: False)
|
2012-07-08 19:17:02 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``hidden``
|
|
|
|
Whether to hide the repository in the hgwebdir index.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: False)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``ipv6``
|
2015-09-02 20:39:46 +03:00
|
|
|
Whether to use IPv6. (default: False)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2016-07-01 04:59:53 +03:00
|
|
|
``labels``
|
|
|
|
List of string *labels* associated with the repository.
|
|
|
|
|
|
|
|
Labels are exposed as a template keyword and can be used to customize
|
|
|
|
output. e.g. the ``index`` template can group or filter repositories
|
|
|
|
by labels and the ``summary`` template can display additional content
|
|
|
|
if a specific label is present.
|
|
|
|
|
2011-07-25 10:28:37 +04:00
|
|
|
``logoimg``
|
|
|
|
File name of the logo image that some templates display on each page.
|
|
|
|
The file name is relative to ``staticurl``. That is, the full path to
|
|
|
|
the logo image is "staticurl/logoimg".
|
|
|
|
If unset, ``hglogo.png`` will be used.
|
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``logourl``
|
2015-09-30 23:43:49 +03:00
|
|
|
Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
|
2011-05-30 12:21:39 +04:00
|
|
|
will be used.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``maxchanges``
|
2015-09-02 20:39:46 +03:00
|
|
|
Maximum number of changes to list on the changelog. (default: 10)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``maxfiles``
|
2015-09-02 20:39:46 +03:00
|
|
|
Maximum number of files to list per changeset. (default: 10)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2012-07-29 21:44:57 +04:00
|
|
|
``maxshortchanges``
|
|
|
|
Maximum number of changes to list on the shortlog, graph or filelog
|
2015-09-02 20:39:46 +03:00
|
|
|
pages. (default: 60)
|
2012-07-29 21:44:57 +04:00
|
|
|
|
2012-07-29 21:37:25 +04:00
|
|
|
``name``
|
2015-09-02 20:39:46 +03:00
|
|
|
Repository name to use in the web interface.
|
|
|
|
(default: current working directory)
|
2012-07-29 21:37:25 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``port``
|
2015-09-02 20:39:46 +03:00
|
|
|
Port to listen on. (default: 8000)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``prefix``
|
2015-09-02 20:39:46 +03:00
|
|
|
Prefix path to serve from. (default: '' (server root))
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``push_ssl``
|
|
|
|
Whether to require that inbound pushes be transported over SSL to
|
2015-09-02 20:39:46 +03:00
|
|
|
prevent password sniffing. (default: True)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2015-08-23 08:59:51 +03:00
|
|
|
``refreshinterval``
|
|
|
|
How frequently directory listings re-scan the filesystem for new
|
|
|
|
repositories, in seconds. This is relevant when wildcards are used
|
|
|
|
to define paths. Depending on how much filesystem traversal is
|
|
|
|
required, refreshing may negatively impact performance.
|
|
|
|
|
2015-09-02 20:39:46 +03:00
|
|
|
Values less than or equal to 0 always refresh.
|
|
|
|
(default: 20)
|
2015-08-23 08:59:51 +03:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``staticurl``
|
|
|
|
Base URL to use for static files. If unset, static files (e.g. the
|
|
|
|
hgicon.png favicon) will be served by the CGI script itself. Use
|
|
|
|
this setting to serve them directly with the HTTP server.
|
|
|
|
Example: ``http://hgserver/static/``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``stripes``
|
2012-08-16 00:38:42 +04:00
|
|
|
How many lines a "zebra stripe" should span in multi-line output.
|
2015-09-02 20:39:46 +03:00
|
|
|
Set to 0 to disable. (default: 1)
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``style``
|
2014-09-21 01:16:39 +04:00
|
|
|
Which template map style to use. The available options are the names of
|
2015-09-02 20:39:46 +03:00
|
|
|
subdirectories in the HTML templates path. (default: ``paper``)
|
|
|
|
Example: ``monoblue``.
|
2011-05-30 12:35:43 +04:00
|
|
|
|
2011-05-30 12:21:39 +04:00
|
|
|
``templates``
|
2014-09-21 01:16:39 +04:00
|
|
|
Where to find the HTML templates. The default path to the HTML templates
|
|
|
|
can be obtained from ``hg debuginstall``.
|
2013-02-10 03:51:26 +04:00
|
|
|
|
2013-02-09 19:48:21 +04:00
|
|
|
``websub``
|
|
|
|
----------
|
|
|
|
|
|
|
|
Web substitution filter definition. You can use this section to
|
|
|
|
define a set of regular expression substitution patterns which
|
|
|
|
let you automatically modify the hgweb server output.
|
|
|
|
|
|
|
|
The default hgweb templates only apply these substitution patterns
|
|
|
|
on the revision description fields. You can apply them anywhere
|
|
|
|
you want when you create your own templates by adding calls to the
|
|
|
|
"websub" filter (usually after calling the "escape" filter).
|
|
|
|
|
|
|
|
This can be used, for example, to convert issue references to links
|
|
|
|
to your issue tracker, or to convert "markdown-like" syntax into
|
|
|
|
HTML (see the examples below).
|
|
|
|
|
|
|
|
Each entry in this section names a substitution filter.
|
|
|
|
The value of each entry defines the substitution expression itself.
|
|
|
|
The websub expressions follow the old interhg extension syntax,
|
|
|
|
which in turn imitates the Unix sed replacement syntax::
|
|
|
|
|
2013-04-15 03:37:23 +04:00
|
|
|
patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
|
2013-02-09 19:48:21 +04:00
|
|
|
|
|
|
|
You can use any separator other than "/". The final "i" is optional
|
|
|
|
and indicates that the search must be case insensitive.
|
|
|
|
|
|
|
|
Examples::
|
|
|
|
|
|
|
|
[websub]
|
|
|
|
issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
|
|
|
|
italic = s/\b_(\S+)_\b/<i>\1<\/i>/
|
|
|
|
bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
|
2013-02-11 04:17:50 +04:00
|
|
|
|
2013-02-10 03:51:26 +04:00
|
|
|
``worker``
|
|
|
|
----------
|
|
|
|
|
|
|
|
Parallel master/worker configuration. We currently perform working
|
|
|
|
directory updates in parallel on Unix-like systems, which greatly
|
|
|
|
helps performance.
|
|
|
|
|
|
|
|
``numcpus``
|
2015-09-02 20:39:46 +03:00
|
|
|
Number of CPUs to use for parallel operations. A zero or
|
2013-02-10 03:51:26 +04:00
|
|
|
negative value is treated as ``use the default``.
|
2015-09-02 20:39:46 +03:00
|
|
|
(default: 4 or the number of CPUs on the system, whichever is larger)
|
2016-01-15 00:34:59 +03:00
|
|
|
|
|
|
|
``backgroundclose``
|
|
|
|
Whether to enable closing file handles on background threads during certain
|
|
|
|
operations. Some platforms aren't very efficient at closing file
|
2016-02-05 21:40:57 +03:00
|
|
|
handles that have been written or appended to. By performing file closing
|
2016-01-15 00:34:59 +03:00
|
|
|
on background threads, file write rate can increase substantially.
|
|
|
|
(default: true on Windows, false elsewhere)
|
|
|
|
|
|
|
|
``backgroundcloseminfilecount``
|
|
|
|
Minimum number of files required to trigger background file closing.
|
|
|
|
Operations not writing this many files won't start background close
|
|
|
|
threads.
|
|
|
|
(default: 2048)
|
|
|
|
|
|
|
|
``backgroundclosemaxqueue``
|
|
|
|
The maximum number of opened file handles waiting to be closed in the
|
|
|
|
background. This option only has an effect if ``backgroundclose`` is
|
|
|
|
enabled.
|
|
|
|
(default: 384)
|
|
|
|
|
|
|
|
``backgroundclosethreadcount``
|
|
|
|
Number of threads to process background file closes. Only relevant if
|
|
|
|
``backgroundclose`` is enabled.
|
|
|
|
(default: 4)
|