##// END OF EJS Templates
manifestctx: add _revlog() function...
manifestctx: add _revlog() function The `self._repo.manifestlog._revlog` code is getting copy and pasted a lot in manifestctx. Let's make it a function so it can be reused. This will make future patches cleaner too.

File last commit:

r30317:3fd53cc1 default
r30341:3dfb5a01 default
Show More
config.txt
2254 lines | 78.5 KiB | text/plain | TextLexer
Martin Geisler
doc: improve merge between hgrc.5 and config help topic
r14460 The Mercurial system uses a set of configuration files to control
aspects of its behavior.
Dan Villiom Podlaski Christiansen
setup: install translation files as package data...
r9999
timeless@mozdev.org
help: add config.troubleshooting section at the top
r26365 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.
timeless
help: rename the Format section to Structure...
r27607 Structure
=========
timeless@mozdev.org
help: add config.troubleshooting section at the top
r26365
Martin Geisler
doc: improve merge between hgrc.5 and config help topic
r14460 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::
Dan Villiom Podlaski Christiansen
setup: install translation files as package data...
r9999
Martin Geisler
doc: improve merge between hgrc.5 and config help topic
r14460 [ui]
username = Firstname Lastname <firstname.lastname@example.net>
verbose = True
Dan Villiom Podlaski Christiansen
setup: install translation files as package data...
r9999
Martin Geisler
doc: improve merge between hgrc.5 and config help topic
r14460 The above entries will be referred to as ``ui.username`` and
timeless@mozdev.org
help/config: use :hg:`help config....` notation
r26280 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
Dan Villiom Podlaski Christiansen
setup: install translation files as package data...
r9999
Martin Geisler
doc: improve merge between hgrc.5 and config help topic
r14460 Files
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 =====
Dan Villiom Podlaski Christiansen
setup: install translation files as package data...
r9999
Martin Geisler
doc: improve merge between hgrc.5 and config help topic
r14460 Mercurial reads configuration data from several files, if they exist.
Martin Geisler
help config: explain that config files do not exist by default...
r13955 These files do not exist by default and you will have to create the
timeless
help: split config user settings file by platform
r27762 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
FUJIWARA Katsunori
doc: itemize text blocks to increase readability in HTML format...
r27960 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
timeless
help: split config user settings file by platform
r27762
.. container:: unix.plan9
FUJIWARA Katsunori
doc: itemize text blocks to increase readability in HTML format...
r27960 - ``$HOME/.hgrc`` (on Unix, Plan9)
Martin Geisler
help config: explain that config files do not exist by default...
r13955
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 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.
Matt Mackall
help: use OS containers for config file lists
r22586 .. container:: verbose.unix
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Matt Mackall
help: use OS containers for config file lists
r22586 On Unix, the following files are consulted:
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Matt Mackall
help: use OS containers for config file lists
r22586 - ``<repo>/.hg/hgrc`` (per-repository)
- ``$HOME/.hgrc`` (per-user)
- ``<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)
Mads Kiilerich
config: introduce "built-in" default configuration settings in default.d...
r23142 - ``<internal>/default.d/*.rc`` (defaults)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Matt Mackall
help: use OS containers for config file lists
r22586 .. container:: verbose.windows
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Matt Mackall
help: use OS containers for config file lists
r22586 On Windows, the following files are consulted:
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Matt Mackall
help: use OS containers for config file lists
r22586 - ``<repo>/.hg/hgrc`` (per-repository)
- ``%USERPROFILE%\.hgrc`` (per-user)
- ``%USERPROFILE%\Mercurial.ini`` (per-user)
- ``%HOME%\.hgrc`` (per-user)
- ``%HOME%\Mercurial.ini`` (per-user)
Mads Kiilerich
windows: read all global config files, not just the first (issue4491) (BC)...
r26625 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
Matt Mackall
help: use OS containers for config file lists
r22586 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
Mads Kiilerich
windows: read all global config files, not just the first (issue4491) (BC)...
r26625 - ``<install-dir>\Mercurial.ini`` (per-installation)
Mads Kiilerich
config: introduce "built-in" default configuration settings in default.d...
r23142 - ``<internal>/default.d/*.rc`` (defaults)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Matt Mackall
help: use OS containers for config file lists
r22586 .. note::
Simon Heimberg
help: remove last occurrences of ".. note::" without two newlines...
r20532
The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
Mike Williams
help/config: note 64-bit Windows registry key used with 32-bit Python...
r19183 is used when running 32-bit Python on 64-bit Windows.
Danek Duvall
help: move Windows 9x information to appropriate place
r27889 .. container:: windows
On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
Matt Mackall
help: use OS containers for config file lists
r22586 .. 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)
Mads Kiilerich
config: introduce "built-in" default configuration settings in default.d...
r23142 - ``<internal>/default.d/*.rc`` (defaults)
Matt Mackall
help: use OS containers for config file lists
r22586
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
timeless
help: split out unix/plan9 config help
r27760 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.
Matt Mackall
help: use OS containers for config file lists
r22586
Danek Duvall
help: move Windows 9x information to appropriate place
r27889 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.
Matt Mackall
help: use OS containers for config file lists
r22586
Per-installation configuration files are searched for in the
directory where Mercurial is installed. ``<install-root>`` is the
timeless
help: split out unix/plan9 config help
r27760 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.
Matt Mackall
help: use OS containers for config file lists
r22586
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.
Mads Kiilerich
config: introduce "built-in" default configuration settings in default.d...
r23142 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.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 Syntax
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ======
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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.
Wagner Bruna
help/config: fix 'Mercurial' casing
r14651 Configuration keys can be set multiple times, in which case Mercurial
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 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
Wagner Bruna
help/config: do not refer to config files as hgrc files
r14652 be redefined on the same and/or on different configuration files. For
example::
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
[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
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ========
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
This section describes the different sections that may appear in a
Wagner Bruna
help/config: do not refer to config files as hgrc files
r14652 Mercurial configuration file, the purpose of each section, its possible
keys, and their possible values.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
``alias``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ---------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Defines command aliases.
timeless@mozdev.org
help/config: add blank lines
r26172
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 Aliases allow you to define your own commands in terms of other
commands (or aliases), optionally including arguments. Positional
timeless@mozdev.org
help/config: alias, ui.mergemarkertemplate add period for etc.
r26176 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 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::
Wagner Bruna
help/config: fix small typo
r14653 <alias> = <command> [<argument>]...
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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
Simon Heimberg
help: remove last occurrences of ".. note::" without two newlines...
r20532 .. note::
It is possible to create aliases with the same names as
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 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, ::
Patrick Mezard
alias: fix shell alias documentation (issue3374)...
r16513 echo = !echo $@
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
will let you do ``hg echo foo`` to have ``foo`` printed in your
terminal. A better example might be::
Rainer Woitok
doc: correct example concerning "hg purge" alias in man page "hgrc.5"...
r28057 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
which will make ``hg purge`` delete all unknown files in the
repository in the same manner as the purge extension.
Patrick Mezard
alias: fix shell alias documentation (issue3374)...
r16513 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
Siddharth Agarwal
alias: expand "$@" as list of parameters quoted individually (BC) (issue4200)...
r22158 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.
Patrick Mezard
alias: fix shell alias documentation (issue3374)...
r16513
Shell aliases are executed in an environment where ``$HG`` expands to
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 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,
Patrick Mezard
alias: fix shell alias documentation (issue3374)...
r16513 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
Simon Heimberg
help: remove last occurrences of ".. note::" without two newlines...
r20532 .. note::
Some global configuration options such as ``-R`` are
Matt Mackall
alias: note interaction of shell aliases with early opts in help
r14891 processed before shell aliases and will thus not be passed to
aliases.
Patrick Mezard
annotate: support diff whitespace filtering flags (issue3030)...
r15528
``annotate``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ------------
Patrick Mezard
annotate: support diff whitespace filtering flags (issue3030)...
r15528
Settings used when displaying file annotations. All values are
timeless@mozdev.org
help/config: use :hg:`help config....` notation
r26280 Booleans and default to False. See :hg:`help config.diff` for
related options for the diff command.
Patrick Mezard
annotate: support diff whitespace filtering flags (issue3030)...
r15528
``ignorews``
Ignore white space when comparing lines.
``ignorewsamount``
Ignore changes in the amount of white space.
``ignoreblanklines``
Ignore changes whose lines are all blank.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``auth``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 --------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Authentication credentials for HTTP authentication. This section
allows you to store usernames and passwords for use when logging
timeless@mozdev.org
help/config: use :hg:`help config....` notation
r26280 *into* HTTP servers. See :hg:`help config.web` if
Wagner Bruna
help/config: quote config section names consistently
r14654 you want to configure *who* can login to your HTTP server.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Each line has the following format::
<name>.<argument> = <value>
where ``<name>`` is used to group arguments into authentication
entries. Example::
Thomas Arendsen Hein
help: hg.intevation.de is new primary name of hg.intevation.de (and new cert)...
r28191 foo.prefix = hg.intevation.de/mercurial
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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
Patrick Mezard
hgweb: do not ignore [auth] if url has a username (issue2822)...
r15005 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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``key``
Optional. PEM encoded client certificate key file. Environment
variables are expanded in the filename.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``cert``
Optional. PEM encoded client certificate chain file. Environment
variables are expanded in the filename.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: https)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
If no suitable authentication entry is found, the user is prompted
for credentials as usual if required by the remote.
FUJIWARA Katsunori
cmdutil: make commit message shown in text editor customizable by template...
r21924 ``committemplate``
------------------
timeless@mozdev.org
help: config indent committemplate.changeset section
r26169 ``changeset``
String: configuration in this section is used as the template to
customize the text shown in the editor when committing.
FUJIWARA Katsunori
cmdutil: make commit message shown in text editor customizable by template...
r21924
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")
Ryan McElroy
templatekw: replace currentbookmark with activebookmark keyword...
r25014 }HG: branch '{branch}'\n{if(activebookmark,
"HG: bookmark '{activebookmark}'\n") }{subrepos %
FUJIWARA Katsunori
cmdutil: make commit message shown in text editor customizable by template...
r21924 "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")}
.. note::
For some problematic encodings (see :hg:`help win32mbcs` for
detail), this customization should be configured carefully, to
avoid showing broken characters.
timeless@mozdev.org
help/config: reword committemplate multibyte character text
r26281 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).
FUJIWARA Katsunori
cmdutil: make commit message shown in text editor customizable by template...
r21924
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`
FUJIWARA Katsunori
cmdutil: look commit template definition up by specified 'editform'...
r22012 Configuring items below instead of ``changeset`` allows showing
customized message only for specific actions, or showing different
Wagner Bruna
help/config: fix typo
r23075 messages for each action.
FUJIWARA Katsunori
cmdutil: look commit template definition up by specified 'editform'...
r22012
- ``changeset.backout`` for :hg:`backout`
FUJIWARA Katsunori
commit: change "editform" to distinguish merge commits from other (--amend)...
r22249 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
- ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
FUJIWARA Katsunori
commit: change "editform" to distinguish merge commits from others...
r22248 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
- ``changeset.commit.normal.normal`` for :hg:`commit` on other
FUJIWARA Katsunori
cmdutil: look commit template definition up by specified 'editform'...
r22012 - ``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`
FUJIWARA Katsunori
import: change "editform" to distinguish merge commits from others...
r22250 - ``changeset.import.normal.merge`` for :hg:`import` on merges
- ``changeset.import.normal.normal`` for :hg:`import` on other
FUJIWARA Katsunori
cmdutil: look commit template definition up by specified 'editform'...
r22012 - ``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`
FUJIWARA Katsunori
rebase: change "editform" to distinguish merge commits from others...
r22251 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
- ``changeset.rebase.normal`` for :hg:`rebase` on other
FUJIWARA Katsunori
cmdutil: look commit template definition up by specified 'editform'...
r22012 - ``changeset.shelve.shelve`` for :hg:`shelve`
- ``changeset.tag.add`` for :hg:`tag` without ``--remove``
- ``changeset.tag.remove`` for :hg:`tag --remove`
FUJIWARA Katsunori
transplant: change "editform" to distinguish merge commits from others...
r22252 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
- ``changeset.transplant.normal`` for :hg:`transplant` on other
FUJIWARA Katsunori
cmdutil: look commit template definition up by specified 'editform'...
r22012
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.
timeless@mozdev.org
help/config: reword committemplate external editor text
r26282 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.
FUJIWARA Katsunori
ui: invoke editor for committing with HGEDITFORM environment variable...
r22205
FUJIWARA Katsunori
cmdutil: use '[committemplate]' section like as map file for style definition...
r22013 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")}
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``decode/encode``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 -----------------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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.
timeless
help: label windows config help
r27761 .. container:: windows
.. note::
Simon Heimberg
help: remove last occurrences of ".. note::" without two newlines...
r20532
timeless
help: label windows config help
r27761 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.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ------------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
timeless@mozdev.org
help/config: add trailing periods
r26177 (defaults are deprecated. Don't use them. Use aliases instead.)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 --------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Patrick Mezard
annotate: support diff whitespace filtering flags (issue3030)...
r15528 Settings used when displaying diffs. Everything except for ``unified``
timeless@mozdev.org
help/config: use :hg:`help config....` notation
r26280 is a Boolean and defaults to False. See :hg:`help config.annotate`
for related options for the annotate command.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
``git``
Use git extended diff format.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Jordi Gutiérrez Hermoso
diff: document the nobinary option...
r22602 ``nobinary``
Omit git binary patches.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``nodates``
Don't include dates in diff headers.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Siddharth Agarwal
patch.diffopts: add support for noprefix...
r23297 ``noprefix``
Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``showfunc``
Show which function each change is in.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``ignorews``
Ignore white space when comparing lines.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``ignorewsamount``
Ignore changes in the amount of white space.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``ignoreblanklines``
Ignore changes whose lines are all blank.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``unified``
Number of lines of context to show.
``email``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ---------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Settings for extensions that send email messages.
``from``
Optional. Email address to use in "From" header and SMTP envelope
of outgoing messages.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``to``
Optional. Comma-separated list of recipients' email addresses.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``cc``
Optional. Comma-separated list of carbon copy recipients'
email addresses.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``bcc``
Optional. Comma-separated list of blind carbon copy recipients'
email addresses.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``method``
Optional. Method to use to send email messages. If value is ``smtp``
Wagner Bruna
help/config: quote config section names consistently
r14654 (default), use SMTP (see the ``[smtp]`` section for configuration).
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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
timeless@mozdev.org
help/config: make defaults consistent
r26182 conversion fails, the text in question is sent as is.
(default: '')
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 --------------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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]
Pierre-Yves David
help: use 'color' as an example (instead of 'progress')...
r25523 # (the color extension will get loaded from Mercurial's path)
color =
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 # (this extension will get loaded from the file specified)
myfeature = ~/.hgext/myfeature.py
``format``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ----------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Pierre-Yves David
format: introduce 'format.usegeneraldelta`...
r26907 ``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
timeless
help: refactor version/defaults from format section...
r27606 improvement for repositories with branches.
Repositories with this on-disk format require Mercurial version 1.9.
Enabled by default.
Pierre-Yves David
format: introduce 'format.usegeneraldelta`...
r26907
timeless
help: sort format section from newest to oldest
r27605 ``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
timeless
help: refactor version/defaults from format section...
r27606 Mac OS X and spaces on Windows.
Repositories with this on-disk format require Mercurial version 1.7.
Enabled by default.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
``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
timeless
help: refactor version/defaults from format section...
r27606 reserved names, e.g. "nul".
Repositories with this on-disk format require Mercurial version 1.1.
Enabled by default.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
timeless
help: sort format section from newest to oldest
r27605 ``usestore``
Enable or disable the "store" repository format which improves
compatibility with systems that fold case or otherwise mangle
timeless
help: refactor version/defaults from format section...
r27606 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.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Constantine Linnick
graph: in hgrc specify line width for main branch...
r16129 ``graph``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ---------
Constantine Linnick
graph: in hgrc specify line width for main branch...
r16129
Patrick Mezard
doc: minor fixes to [graph] section documentation
r16139 Web graph view configuration. This section let you change graph
elements display properties by branches, for instance to make the
``default`` branch stand out.
Constantine Linnick
graph: in hgrc specify line width for main branch...
r16129
Patrick Mezard
doc: minor fixes to [graph] section documentation
r16139 Each line has the following format::
<branch>.<argument> = <value>
Constantine Linnick
graph: in hgrc specify line width for main branch...
r16129
Patrick Mezard
doc: minor fixes to [graph] section documentation
r16139 where ``<branch>`` is the name of the branch being
customized. Example::
[graph]
# 2px width
default.width = 2
# red color
default.color = FF0000
Constantine Linnick
graph: in hgrc specify line width for main branch...
r16129
Supported arguments:
``width``
Patrick Mezard
doc: minor fixes to [graph] section documentation
r16139 Set branch edges width in pixels.
Constantine Linnick
graph: in hgrc specify line width for main branch...
r16129
Constantine Linnick
graph: in hgrc specify line color for main branch...
r16130 ``color``
Patrick Mezard
doc: minor fixes to [graph] section documentation
r16139 Set branch edges color in hexadecimal RGB notation.
Constantine Linnick
graph: in hgrc specify line width for main branch...
r16129
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``hooks``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ---------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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
Matt Zuba
hooks: prioritize run order of hooks...
r15896 value or setting it to an empty string. Hooks can be prioritized
timeless
help: clarify that the config hook priority prefix includes a period
r27551 by adding a prefix of ``priority.`` to the hook name on a new line
timeless@mozdev.org
help/config: simplify default text
r26178 and setting the priority. The default priority is 0.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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
Matt Zuba
hooks: prioritize run order of hooks...
r15896 # force autobuild hook to run before other incoming hooks
priority.incoming.autobuild = 1
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Most hooks are run with environment variables set that give useful
additional information. For each hook below, the environment
variables it is passed are listed with names of the form ``$HG_foo``.
``changegroup``
Mateusz Kwapich
hooks: add HG_NODE_LAST to txnclose and changegroup hook environments...
r27739 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``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``outgoing``
Run after sending changes from local repository to another. ID of
first changeset sent is in ``$HG_NODE``. Source of operation is in
FUJIWARA Katsunori
doc: describe full help document hierarchy to create a valid link in HTML...
r28077 ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``post-<command>``
Run after successful invocations of the associated command. The
contents of the command line are passed as ``$HG_ARGS`` and the result
Juan Pablo Carbajal (desktop)
help: removing trailing spaces
r17680 code in ``$HG_RESULT``. Parsed command line arguments are passed as
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
Juan Pablo Carbajal (desktop)
help: removing trailing spaces
r17680 the python data internally passed to <command>. ``$HG_OPTS`` is a
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 dictionary of options (with unspecified options set to their defaults).
``$HG_PATS`` is a list of arguments. Hook failure is ignored.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Jordi Gutiérrez Hermoso
dispatch: add fail-* family of hooks...
r29129 ``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.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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``
timeless
help: remove stray double spaces from config help
r27552 is a dictionary of options (with unspecified options set to their
Juan Pablo Carbajal (desktop)
help: removing trailing spaces
r17680 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 failure, the command doesn't execute and Mercurial returns the failure
code.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``prelistkeys``
Run before listing pushkeys (like bookmarks) in the
repository. Non-zero status will cause failure. The key namespace is
in ``$HG_NAMESPACE``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Pierre-Yves David
hook: have a generic hook for transaction opening...
r24281 ``pretxnopen``
Run before any new repository transaction is open. The reason for the
Pierre-Yves David
help: document the ''HG_TXNID'' environment variable during hooks...
r24791 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.
Pierre-Yves David
hook: have a generic hook for transaction opening...
r24281
Pierre-Yves David
hook: add a generic hook right before we commit a transaction...
r24284 ``pretxnclose``
Mateusz Kwapich
hooks: add HG_NODE_LAST to txnclose and changegroup hook environments...
r27739 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.
Pierre-Yves David
hook: add a generic hook right before we commit a transaction...
r24284
Pierre-Yves David
hook: add a generic hook after transaction has been closed...
r24282 ``txnclose``
Javi Merino
help: fix typo commited -> committed
r24814 Run after any repository transaction has been committed. At this
Pierre-Yves David
hook: add a generic hook after transaction has been closed...
r24282 point, the transaction can no longer be rolled back. The hook will run
FUJIWARA Katsunori
doc: describe full help document hierarchy to create a valid link in HTML...
r28077 after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
timeless@mozdev.org
help/config: use :hg:`help config....` notation
r26280 details about available variables.
Pierre-Yves David
hook: add a generic hook after transaction has been closed...
r24282
Pierre-Yves David
hooks: add a 'txnabort' hook...
r24792 ``txnabort``
FUJIWARA Katsunori
doc: describe full help document hierarchy to create a valid link in HTML...
r28077 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
timeless@mozdev.org
help/config: use :hg:`help config....` notation
r26280 docs for details about available variables.
Pierre-Yves David
hooks: add a 'txnabort' hook...
r24792
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``pretxnchangegroup``
Mateusz Kwapich
hooks: add HG_NODE_LAST to txnclose and changegroup hook environments...
r27739 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``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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``.
Simon Heimberg
help: remove last occurrences of ".. note::" without two newlines...
r20532 .. note::
It is generally better to use standard hooks rather than the
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 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.
Simon Heimberg
help: remove last occurrences of ".. note::" without two newlines...
r20532 .. note::
Environment variables with empty values may not be passed to
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 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.
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 ``hostfingerprints``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 --------------------
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
Gregory Szorc
sslutil: allow fingerprints to be specified in [hostsecurity]...
r29267 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 Fingerprints of the certificates of known HTTPS servers.
Gregory Szorc
help: add empty lines to hostfingerprints section...
r28524
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 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.
Gregory Szorc
help: add empty lines to hostfingerprints section...
r28524
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
Gregory Szorc
sslutil: allow multiple fingerprints per host...
r28525 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.
Gregory Szorc
help: add empty lines to hostfingerprints section...
r28524
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 The CA chain and web.cacerts is not used for servers with a fingerprint.
For example::
[hostfingerprints]
Thomas Arendsen Hein
help: hg.intevation.de is new primary name of hg.intevation.de (and new cert)...
r28191 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
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
Gregory Szorc
sslutil: allow fingerprints to be specified in [hostsecurity]...
r29267 ``hostsecurity``
----------------
Gregory Szorc
sslutil: config option to specify TLS protocol version...
r29559 Used to specify global and per-host security settings for connecting to
other machines.
The following options control default behavior for all hosts.
Gregory Szorc
sslutil: support defining cipher list...
r29577 ``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.
Gregory Szorc
sslutil: config option to specify TLS protocol version...
r29559 ``minimumprotocol``
Defines the minimum channel encryption protocol to use.
Gregory Szorc
sslutil: require TLS 1.1+ when supported...
r29560 By default, the highest version of TLS supported by both client and server
is used.
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+.
Gregory Szorc
sslutil: config option to specify TLS protocol version...
r29559
Options in the ``[hostsecurity]`` section can have the form
``hostname``:``setting``. This allows multiple settings to be defined on a
per-host basis.
Gregory Szorc
sslutil: allow fingerprints to be specified in [hostsecurity]...
r29267
The following per-host settings can be defined.
Gregory Szorc
sslutil: support defining cipher list...
r29577 ``ciphers``
This behaves like ``ciphers`` as described above except it only applies
to the host on which it is defined.
Gregory Szorc
sslutil: allow fingerprints to be specified in [hostsecurity]...
r29267 ``fingerprints``
A list of hashes of the DER encoded peer/remote certificate. Values have
the form ``algorithm``:``fingerprint``. e.g.
``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
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.
Gregory Szorc
sslutil: per-host config option to define certificates...
r29334 This option takes precedence over ``verifycertsfile``.
Gregory Szorc
sslutil: config option to specify TLS protocol version...
r29559 ``minimumprotocol``
This behaves like ``minimumprotocol`` as described above except it
only applies to the host on which it is defined.
Gregory Szorc
sslutil: per-host config option to define certificates...
r29334 ``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.
FUJIWARA Katsunori
doc: make previous line of certificate example end with "::"...
r29649 The format of the file is as follows::
Gregory Szorc
sslutil: per-host config option to define certificates...
r29334
-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----
Gregory Szorc
sslutil: allow fingerprints to be specified in [hostsecurity]...
r29267 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
Gregory Szorc
sslutil: per-host config option to define certificates...
r29334 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
Gregory Szorc
sslutil: allow fingerprints to be specified in [hostsecurity]...
r29267
Gregory Szorc
sslutil: config option to specify TLS protocol version...
r29559 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
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``http_proxy``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 --------------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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".
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``no``
Optional. Comma-separated list of host names that should bypass
the proxy.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``passwd``
Optional. Password to authenticate with at the proxy server.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``user``
Optional. User name to authenticate with at the proxy server.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``always``
Optional. Always use the proxy, even for localhost and any entries
timeless@mozdev.org
help/config: omit True or False
r26279 in ``http_proxy.no``. (default: False)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Siddharth Agarwal
merge: document checkignored and checkunknown configs again...
r28023 ``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
Sean Farley
help: wrap ".orig" in rst quotes...
r29060 ``.orig``. With ``ignore``, don't print a warning and back them up as
``.orig``. (default: ``abort``)
Siddharth Agarwal
merge: document checkignored and checkunknown configs again...
r28023
``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``)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 ``merge-patterns``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ------------------
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
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.
Example::
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 [merge-patterns]
**.c = kdiff3
**.jpg = myimgmerge
``merge-tools``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ---------------
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
This section configures external merge tools to use for file-level
Pierre-Yves David
help: add additional information in the merge-tools section of config help...
r21402 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.
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
Example ``~/.hgrc``::
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 [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
Pierre-Yves David
doc: improves merge-tools example with an overwrite of existing config...
r21403 # Changing the priority of preconfigured tool
Augie Fackler
merge-tools: allow marking a mergetool as completely disabled...
r26730 meld.priority = 0
# Disable a preconfigured tool
vimdiff.disabled = yes
Pierre-Yves David
doc: improves merge-tools example with an overwrite of existing config...
r21403
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 # Define new tool
myHtmlTool.args = -m $local $other $base $output
myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
myHtmlTool.priority = 1
Supported arguments:
Martin Geisler
help/config: separate terms with a blank line...
r14458
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 ``priority``
The priority in which to evaluate this tool.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: 0)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
``executable``
timeless
help: label windows config help
r27761 Either just the name of the executable or its pathname.
.. container:: windows
On Windows, the path can use environment variables with ${ProgramFiles}
syntax.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: the tool name)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
``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
Durham Goode
help: add local/other description to merge tool description...
r21527 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.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: ``$local $base $other``)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 ``premerge``
Attempt to run internal non-interactive 3-way merge tool before
Pierre-Yves David
merge-tools: add a `premerge=keep-merge3` config option...
r22032 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
FUJIWARA Katsunori
help: refer ":merge3" instead of "internal:merge3"...
r23111 about the base of the merge in the marker (see internal :merge3 in
:hg:`help merge-tools`).
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: True)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
``binary``
timeless@mozdev.org
help/config: make defaults consistent
r26182 This tool can merge binary files. (default: False, unless tool
was selected by file pattern match)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
``symlink``
timeless@mozdev.org
help/config: make defaults consistent
r26182 This tool can merge symlinks. (default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 ``check``
Augie Fackler
help/config: back out 5f2a1ebd6e78...
r26225 A list of merge success-checking options:
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
``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.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: False)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
``gui``
timeless@mozdev.org
help/config: make defaults consistent
r26182 This tool requires a graphical interface to run. (default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
timeless
help: label windows config help
r27761 .. container:: windows
``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)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
timeless
help: label windows config help
r27761 ``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)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
timeless
help: label windows config help
r27761 ``regname``
Name of value to read from specified registry key.
(default: the unnamed (default) value)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
timeless
help: label windows config help
r27761 ``regappend``
String to append to the value read from the registry, typically
the executable name of the tool.
(default: None)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
``patch``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ---------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: strict)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Matt Mackall
patch: add fuzz config flag (issue4697)
r25631 ``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.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: 2)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
``paths``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ---------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Gregory Szorc
ui: support declaring path push urls as sub-options...
r27266 Assigns symbolic names and behavior to repositories.
Options are symbolic names defining the URL or directory that is the
location of the repository. Example::
[paths]
my_server = https://example.com/my_repo
local_path = /home/me/repo
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::
[paths]
my_server = https://example.com/my_path
my_server:pushurl = ssh://example.com/my_path
The following sub-options can be defined:
``pushurl``
The URL to use for push operations. If not defined, the location
defined by the path's main entry is used.
Gregory Szorc
ui: path option to declare which revisions to push by default...
r29413 ``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.
Gregory Szorc
ui: support declaring path push urls as sub-options...
r27266 The following special named paths exist:
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
``default``
Gregory Szorc
ui: support declaring path push urls as sub-options...
r27266 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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``default-push``
Gregory Szorc
ui: support declaring path push urls as sub-options...
r27266 (deprecated) The URL or directory for the default :hg:`push` location.
``default:pushurl`` should be used instead.
Juan Pablo Carbajal (desktop)
help: add example of paths other than default in hgrc
r17685
Matt Mackall
help: add missing phase config items to config topic
r15999 ``phases``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ----------
Matt Mackall
help: add missing phase config items to config topic
r15999
Wagner Bruna
help/config: fix help command markup
r16005 Specifies default handling of phases. See :hg:`help phases` for more
Matt Mackall
help: add missing phase config items to config topic
r15999 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.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: True)
Matt Mackall
help: add missing phase config items to config topic
r15999
``new-commit``
Phase of newly-created commits.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: draft)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
FUJIWARA Katsunori
subrepo: check phase of state in each subrepositories before committing...
r20176 ``checksubrepos``
Angel Ezquerra
help: improve description of phases.checksubrepos setting...
r20333 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").
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: follow)
FUJIWARA Katsunori
subrepo: check phase of state in each subrepositories before committing...
r20176
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``profiling``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 -------------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Bryan O'Sullivan
dispatch: add support for statprof as a profiler...
r16392 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.
Gregory Szorc
profiling: add a context manager that no-ops if profiling isn't enabled...
r29784 ``enabled``
Enable the profiler.
(default: false)
This is equivalent to passing ``--profile`` on the command line.
Bryan O'Sullivan
dispatch: add support for statprof as a profiler...
r16392 ``type``
The type of profiler to use.
Gregory Szorc
profiling: make statprof the default profiler (BC)...
r30317 (default: stat)
Bryan O'Sullivan
dispatch: add support for statprof as a profiler...
r16392
``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``
Gregory Szorc
profiling: use vendored statprof and upstream enhancements (BC)...
r30316 Use a statistical profiler, statprof. This profiler is most
most useful for profiling commands that run for longer than
about 0.1 seconds.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
``format``
Bryan O'Sullivan
dispatch: add support for statprof as a profiler...
r16392 Profiling format. Specific to the ``ls`` instrumenting profiler.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: text)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
``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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Gregory Szorc
profiling: use vendored statprof and upstream enhancements (BC)...
r30316 ``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.
Bryan O'Sullivan
dispatch: add support for statprof as a profiler...
r16392 ``frequency``
Sampling frequency. Specific to the ``stat`` sampling profiler.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: 1000)
Bryan O'Sullivan
dispatch: add support for statprof as a profiler...
r16392
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``output``
File path where profiling data or report should be saved. If the
timeless@mozdev.org
help/config: make defaults consistent
r26182 file exists, it is replaced. (default: None, data is printed on
stderr)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Mads Kiilerich
profiling: add documentation of lsprof 'sort' and 'nested'
r18502 ``sort``
Sort field. Specific to the ``ls`` instrumenting profiler.
One of ``callcount``, ``reccallcount``, ``totaltime`` and
``inlinetime``.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: inlinetime)
Mads Kiilerich
profiling: add documentation of lsprof 'sort' and 'nested'
r18502
Mads Kiilerich
profiling: introduce limit configuration option...
r18548 ``limit``
Number of lines to show. Specific to the ``ls`` instrumenting profiler.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: 30)
Mads Kiilerich
profiling: introduce limit configuration option...
r18548
Mads Kiilerich
profiling: add documentation of lsprof 'sort' and 'nested'
r18502 ``nested``
Mads Kiilerich
profiling: replace '+' markup of nested lines with indentation...
r18642 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.
Mads Kiilerich
profiling: add documentation of lsprof 'sort' and 'nested'
r18502 Specific to the ``ls`` instrumenting profiler.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: 5)
Mads Kiilerich
profiling: add documentation of lsprof 'sort' and 'nested'
r18502
Pierre-Yves David
progress: move config help into core config help...
r25520 ``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``,
av6
help: use backticks for progress.format keywords, correct letter case
r27665 ``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.
Pierre-Yves David
progress: move config help into core config help...
r25520
av6
help: use backticks for progress.format keywords, correct letter case
r27665 (default: topic bar number estimate)
Pierre-Yves David
progress: move config help into core config help...
r25520
``width``
If set, the maximum width of the progress information (that is, min(width,
timeless@mozdev.org
help/config: add trailing periods
r26177 term width) will be used).
Pierre-Yves David
progress: move config help into core config help...
r25520
``clear-complete``
timeless@mozdev.org
help/config: capitalize items
r26278 Clear the progress bar after it's done. (default: True)
Pierre-Yves David
progress: move config help into core config help...
r25520
``disable``
timeless@mozdev.org
help/config: add trailing periods
r26177 If true, don't show a progress bar.
Pierre-Yves David
progress: move config help into core config help...
r25520
``assume-tty``
timeless@mozdev.org
help/config: add trailing periods
r26177 If true, ALWAYS show a progress bar, unless disable is given.
Pierre-Yves David
progress: move config help into core config help...
r25520
Laurent Charignon
rebase: prevent creating divergence...
r27746 ``rebase``
----------
``allowdivergence``
Default to False, when True allow creating divergence when performing
rebase of obsolete changesets.
Wagner Bruna
help/config: mention [revsetalias] section
r14691 ``revsetalias``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ---------------
Wagner Bruna
help/config: mention [revsetalias] section
r14691
Alias definitions for revsets. See :hg:`help revsets` for details.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``server``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ----------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Controls generic server settings.
``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.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: True)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Benoit Allard
protocol: Add the stream-preferred capability...
r16361 ``preferuncompressed``
When set, clients will try to use the uncompressed streaming
timeless@mozdev.org
help/config: make defaults consistent
r26182 protocol. (default: False)
Benoit Allard
protocol: Add the stream-preferred capability...
r16361
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``validate``
Whether to validate the completeness of pushed changesets by
checking that all new file revisions specified in manifests are
timeless@mozdev.org
help/config: make defaults consistent
r26182 present. (default: False)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Mike Edgar
wireproto: add config knob for http header length limit...
r25691 ``maxhttpheaderlen``
Instruct HTTP clients not to send request headers longer than this
timeless@mozdev.org
help/config: make defaults consistent
r26182 many bytes. (default: 1024)
Mike Edgar
wireproto: add config knob for http header length limit...
r25691
Gregory Szorc
wireproto: config options to disable bundle1...
r27246 ``bundle1``
Whether to allow clients to push and pull using the legacy bundle1
exchange format. (default: True)
Gregory Szorc
wireproto: support disabling bundle1 only if repo is generaldelta...
r27633 ``bundle1gd``
Gregory Szorc
help: fix quoting for bundle1 options
r27683 Like ``bundle1`` but only used if the repository is using the
Gregory Szorc
wireproto: support disabling bundle1 only if repo is generaldelta...
r27633 *generaldelta* storage format. (default: True)
Gregory Szorc
wireproto: config options to disable bundle1...
r27246 ``bundle1.push``
Whether to allow clients to push using the legacy bundle1 exchange
format. (default: True)
Gregory Szorc
wireproto: support disabling bundle1 only if repo is generaldelta...
r27633 ``bundle1gd.push``
Gregory Szorc
help: fix quoting for bundle1 options
r27683 Like ``bundle1.push`` but only used if the repository is using the
Gregory Szorc
wireproto: support disabling bundle1 only if repo is generaldelta...
r27633 *generaldelta* storage format. (default: True)
Gregory Szorc
wireproto: config options to disable bundle1...
r27246 ``bundle1.pull``
Whether to allow clients to pull using the legacy bundle1 exchange
format. (default: True)
Gregory Szorc
wireproto: support disabling bundle1 only if repo is generaldelta...
r27633 ``bundle1gd.pull``
Gregory Szorc
help: fix quoting for bundle1 options
r27683 Like ``bundle1.pull`` but only used if the repository is using the
Gregory Szorc
wireproto: support disabling bundle1 only if repo is generaldelta...
r27633 *generaldelta* storage format. (default: True)
Gregory Szorc
wireproto: config options to disable bundle1...
r27246 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.
Gregory Szorc
hgweb: config option to control zlib compression level...
r29748 ``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.
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 ``smtp``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 --------
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
Configuration for extensions that need to send email messages.
``host``
Host name of mail server, e.g. "mail.example.com".
``port``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Optional. Port to connect to on mail server. (default: 465 if
``tls`` is smtps; 25 otherwise)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
``tls``
Optional. Method to enable TLS when connecting to mail server: starttls,
timeless@mozdev.org
help/config: make defaults consistent
r26182 smtps or none. (default: none)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
``username``
Optional. User name for authenticating with the SMTP server.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: None)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
``password``
Optional. Password for authenticating with the SMTP server. If not
specified, interactive sessions will prompt the user for a
timeless@mozdev.org
help/config: make defaults consistent
r26182 password; non-interactive sessions will fail. (default: None)
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140
``local_hostname``
timeless@mozdev.org
help/config: change local_hostname help style
r26180 Optional. The hostname that the sender can use to identify
Michal Sznajder
help: sort hgrc related "Sections" chapters alphabetically
r16140 itself to the MTA.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``subpaths``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ------------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Martin Geisler
help/config: expand [subpaths] help...
r16549 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::
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
<pattern> = <replacement>
Martin Geisler
help/config: expand [subpaths] help...
r16549 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::
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
http://server/(.*)-hg/ = http://hg.server/\1/
rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
Mads Kiilerich
help: fix some instances of 'the the'
r17251 Relative subrepository paths are first made absolute, and the
Mike Miller
help: document that [subpaths] may rewrite relative paths...
r29368 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.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
Yuya Nishihara
templater: load and expand aliases by template engine (API) (issue4842)...
r28957 ``templatealias``
-----------------
Alias definitions for templates. See :hg:`help templates` for details.
Mathias De Maré
help: add example of '[templates]' usage...
r29717 ``templates``
-------------
Use the ``[templates]`` section to define template strings.
See :hg:`help templates` for details.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``trusted``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 -----------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``groups``
Comma-separated list of trusted groups.
``ui``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 ------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: True)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Gregory Szorc
exchange: make clone bundles non-experimental and enabled by default...
r27738 ``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)
Gregory Szorc
clonebundles: support for seeding clones from pre-generated bundles...
r26623 ``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)
Gregory Szorc
exchange: make clonebundleprefers non-experimental...
r27737 ``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.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``commitsubrepos``
Whether to commit modified subrepositories when committing the
parent repository. If False and one subrepository has uncommitted
changes, abort the commit.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``debug``
timeless@mozdev.org
help/config: omit True or False
r26279 Print debugging information. (default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``editor``
timeless@mozdev.org
help/config: make defaults consistent
r26182 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``fallbackencoding``
Encoding to try if it's not possible to decode the changelog using
timeless@mozdev.org
help/config: make defaults consistent
r26182 UTF-8. (default: ISO-8859-1)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yuya Nishihara
graphlog: make node symbol templatable by ui.graphnodetemplate option...
r27216 ``graphnodetemplate``
The template used to print changeset nodes in an ASCII revision graph.
(default: ``{graphnode}``)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``ignore``
A file to read per-user ignore patterns from. This file should be
Siddharth Agarwal
ignore: resolve ignore files relative to repo root (issue4473) (BC)...
r23629 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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``interactive``
timeless@mozdev.org
help/config: omit True or False
r26279 Allow to prompt the user. (default: True)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Simon Farnsworth
ui: add new config flag for interface selection...
r28542 ``interface``
Select the default interface for interactive features (default: text).
Possible values are 'text' and 'curses'.
``interface.chunkselector``
FUJIWARA Katsunori
doc: fix incorrect use of rst hg role in help text
r29648 Select the interface for change recording (e.g. :hg:`commit -i`).
Simon Farnsworth
ui: add new config flag for interface selection...
r28542 Possible values are 'text' and 'curses'.
This config overrides the interface specified by ui.interface.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``logtemplate``
Template string for commands that print changesets.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``merge``
The conflict resolution program to use during a manual merge.
For more information on merge tools see :hg:`help merge-tools`.
Wagner Bruna
help/config: quote config section names consistently
r14654 For configuring merge tools see the ``[merge-tools]`` section.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Durham Goode
merge: add conflict marker formatter (BC)...
r21519 ``mergemarkers``
FUJIWARA Katsunori
filemerge: use 'basic' as the default of '[ui] mergemarkers' for safety...
r21918 Sets the merge conflict marker label styling. The ``detailed``
Durham Goode
merge: add conflict marker formatter (BC)...
r21519 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``.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: ``basic``)
Durham Goode
merge: add conflict marker formatter (BC)...
r21519
``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.
timeless@mozdev.org
help/config: add blank lines
r26172
Durham Goode
merge: add conflict marker formatter (BC)...
r21519 Defaults to showing the hash, tags, branches, bookmarks, author, and
the first line of the commit description.
timeless@mozdev.org
help/config: add blank lines
r26172
Nathan Goldbaum
filemerge: clean up language in mergemarkertemplate help
r24536 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.
Durham Goode
merge: add conflict marker formatter (BC)...
r21519
Christian Delahousse
cmdutil: add origbackuppath helper
r26937 ``origbackuppath``
The path to a directory used to store generated .orig files. If the path is
not a directory, one will be created.
Jordi Gutiérrez Hermoso
doc: document the ui.patch option...
r25649 ``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.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``portablefilenames``
Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: ``warn``)
timeless
help: split config ui.portablefilenames
r27758
``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``.
timeless
help: label windows config help
r27761 .. container:: windows
timeless
help: split config ui.portablefilenames
r27758
On Windows, this configuration option is ignored and the command aborted.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``quiet``
timeless
help: move config default marking to its own line
r27759 Reduce the amount of output printed.
(default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``remotecmd``
timeless
help: move config default marking to its own line
r27759 Remote command to use for clone/push/pull operations.
(default: ``hg``)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``report_untrusted``
Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
timeless
help: move config default marking to its own line
r27759 trusted user or group.
(default: True)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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 (``\``)).
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Mathias De Maré
commands: add ui.statuscopies config knob...
r24663 ``statuscopies``
Display copies in the status command.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``ssh``
timeless@mozdev.org
help/config: capitalize items
r26278 Command to use for SSH connections. (default: ``ssh``)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``strict``
Require exact command names, instead of allowing unambiguous
timeless@mozdev.org
help/config: omit True or False
r26279 abbreviations. (default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``style``
Name of style to use for command output.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Pierre-Yves David
traceback: allow providing a local support contact point...
r26263 ``supportcontact``
Kevin Bullock
help: copy-edit description of ui.supportcontact
r26313 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.
Pierre-Yves David
traceback: allow providing a local support contact point...
r26263
Jun Wu
ui: add new config option for help text width...
r29070 ``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)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``timeout``
The timeout used when a lock is held (in seconds), a negative value
timeless@mozdev.org
help/config: make defaults consistent
r26182 means no timeout. (default: 600)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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
timeless@mozdev.org
help/config: make defaults consistent
r26182 IOError or MemoryError). (default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``username``
The committer of a changeset created when running "commit".
Typically a person's name and email address, e.g. ``Fred Widget
timeless@mozdev.org
help/config: make defaults consistent
r26182 <fred@example.com>``. Environment variables in the
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 username are expanded.
Martin Geisler
help/config: separate terms with a blank line...
r14458
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: ``$EMAIL`` or ``username@hostname``. If the username in
timeless
help: remove stray double spaces from config help
r27552 hgrc is empty, e.g. if the system admin set ``username =`` in the
timeless@mozdev.org
help/config: make defaults consistent
r26182 system hgrc, it has to be specified manually or in a different
hgrc file)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``verbose``
timeless@mozdev.org
help/config: omit True or False
r26279 Increase the amount of output printed. (default: False)
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
``web``
FUJIWARA Katsunori
doc: unify section level between help topics...
r17267 -------
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
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``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Where to output the access log. (default: stdout)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``address``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Interface address to bind to. (default: all)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``allow_archive``
List of archive format (bz2, gz, zip) allowed for downloading.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: empty)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``allowbz2``
(DEPRECATED) Whether to allow .tar.bz2 downloading of repository
revisions.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``allowgz``
(DEPRECATED) Whether to allow .tar.gz downloading of repository
revisions.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``allowpull``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Whether to allow pulling from the repository. (default: True)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``allow_push``
Whether to allow pushing to the repository. If empty or not set,
timeless@mozdev.org
help/config: reword allow_push to fix grammar
r26181 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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``allowzip``
(DEPRECATED) Whether to allow .zip downloading of repository
timeless@mozdev.org
help/config: make defaults consistent
r26182 revisions. This feature creates temporary files.
(default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Jordi Gutiérrez Hermoso
webcommands: allow hgweb's archive to recurse into subrepos...
r17933 ``archivesubrepos``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Whether to recurse into subrepositories when archiving.
(default: False)
Jordi Gutiérrez Hermoso
webcommands: allow hgweb's archive to recurse into subrepos...
r17933
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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/``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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
Matt Mackall
help: fix indentation on cacert (issue3350)...
r16399 with these certificates.
To disable SSL verification temporarily, specify ``--insecure`` from
command line.
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::
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456
-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----
``cache``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Whether to support caching in hgweb. (default: True)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Matt Mackall
hgweb: document web.certificates option
r25853 ``certificate``
Certificate to use when running :hg:`serve`.
Paul Boddie
help: added description for the web.collapse setting...
r16570 ``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
timeless@mozdev.org
help/config: make defaults consistent
r26182 into a single entry for that subdirectory. (default: False)
Paul Boddie
help: added description for the web.collapse setting...
r16570
Patrick Mezard
help/config.txt: reorder [web] options
r17316 ``comparisoncontext``
Number of lines of context to show in side-by-side file comparison. If
timeless@mozdev.org
help/config: make defaults consistent
r26182 negative or the value ``full``, whole files are shown. (default: 5)
Patrick Mezard
help/config.txt: reorder [web] options
r17316 This setting can be overridden by a ``context`` request parameter to the
``comparison`` command, taking the same values.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``contact``
Name or email address of the person in charge of the repository.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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).
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``description``
Textual description of the repository's purpose or contents.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: "unknown")
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``encoding``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Character encoding name. (default: the current locale charset)
timeless@mozdev.org
help/config: add trailing periods
r26177 Example: "UTF-8".
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``errorlog``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Where to output the error log. (default: stderr)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Patrick Mezard
help/config.txt: reorder [web] options
r17316 ``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
timeless@mozdev.org
help/config: make defaults consistent
r26182 repositories. (default: False)
wujek srujek
hgweb: side-by-side comparison functionality...
r17202
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``hidden``
Whether to hide the repository in the hgwebdir index.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``ipv6``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Whether to use IPv6. (default: False)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Gregory Szorc
hgweb: expose list of per-repo labels to templates...
r29471 ``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.
Angel Ezquerra
help: add "web/logoimg" setting description
r14938 ``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.
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``logourl``
Matt Mackall
urls: bulk-change primary website URLs
r26421 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 will be used.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``maxchanges``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Maximum number of changes to list on the changelog. (default: 10)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``maxfiles``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Maximum number of files to list per changeset. (default: 10)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Patrick Mezard
help/config.txt: document web.maxshortchanges
r17317 ``maxshortchanges``
Maximum number of changes to list on the shortlog, graph or filelog
timeless@mozdev.org
help/config: make defaults consistent
r26182 pages. (default: 60)
Patrick Mezard
help/config.txt: document web.maxshortchanges
r17317
Patrick Mezard
help/config.txt: reorder [web] options
r17316 ``name``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Repository name to use in the web interface.
(default: current working directory)
Patrick Mezard
help/config.txt: reorder [web] options
r17316
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``port``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Port to listen on. (default: 8000)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``prefix``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Prefix path to serve from. (default: '' (server root))
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``push_ssl``
Whether to require that inbound pushes be transported over SSL to
timeless@mozdev.org
help/config: make defaults consistent
r26182 prevent password sniffing. (default: True)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Gregory Szorc
hgweb: make refresh interval configurable...
r26072 ``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.
timeless@mozdev.org
help/config: make defaults consistent
r26182 Values less than or equal to 0 always refresh.
(default: 20)
Gregory Szorc
hgweb: make refresh interval configurable...
r26072
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``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/``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``stripes``
Mads Kiilerich
fix trivial spelling errors
r17424 How many lines a "zebra stripe" should span in multi-line output.
timeless@mozdev.org
help/config: make defaults consistent
r26182 Set to 0 to disable. (default: 1)
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``style``
Arun Chandrasekaran
help: update help for hgweb template and style (issue4373)
r22549 Which template map style to use. The available options are the names of
timeless@mozdev.org
help/config: make defaults consistent
r26182 subdirectories in the HTML templates path. (default: ``paper``)
Example: ``monoblue``.
Martin Geisler
help/config: separate terms with a blank line...
r14458
Yun Lee
help: move part of hgrc.5 man page config help topic
r14456 ``templates``
Arun Chandrasekaran
help: update help for hgweb template and style (issue4373)
r22549 Where to find the HTML templates. The default path to the HTML templates
can be obtained from ``hg debuginstall``.
Angel Ezquerra
hgweb: apply the websub filter to revision descriptions...
r18628
``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::
Mads Kiilerich
spelling: fix typos and spelling errors
r18958 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
Angel Ezquerra
hgweb: apply the websub filter to revision descriptions...
r18628
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>/
Benoit Boissinot
merge crew and main
r18652
Bryan O'Sullivan
worker: estimate whether it's worth running a task in parallel...
r18636 ``worker``
----------
Parallel master/worker configuration. We currently perform working
directory updates in parallel on Unix-like systems, which greatly
helps performance.
``numcpus``
timeless@mozdev.org
help/config: make defaults consistent
r26182 Number of CPUs to use for parallel operations. A zero or
Bryan O'Sullivan
worker: estimate whether it's worth running a task in parallel...
r18636 negative value is treated as ``use the default``.
timeless@mozdev.org
help/config: make defaults consistent
r26182 (default: 4 or the number of CPUs on the system, whichever is larger)
Gregory Szorc
scmutil: support background file closing...
r27895
``backgroundclose``
Whether to enable closing file handles on background threads during certain
operations. Some platforms aren't very efficient at closing file
André Sintzoff
help: fix typo in backgroundclose documentation
r27986 handles that have been written or appended to. By performing file closing
Gregory Szorc
scmutil: support background file closing...
r27895 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)