mercurial/help/config.txt
author Gregory Szorc <gregory.szorc@gmail.com>
Thu, 15 Jun 2017 11:04:46 -0700
changeset 32850 e33c9a47b0db
parent 32744 33b7283a3828
child 32851 cb6436e051ca
permissions -rw-r--r--
config: document profiling.show{min,max}
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
     1
The Mercurial system uses a set of configuration files to control
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
     2
aspects of its behavior.
9785
b52f0f221325 help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
     3
26365
33af0c53aeff help: add config.troubleshooting section at the top
timeless@mozdev.org
parents: 26313
diff changeset
     4
Troubleshooting
33af0c53aeff help: add config.troubleshooting section at the top
timeless@mozdev.org
parents: 26313
diff changeset
     5
===============
33af0c53aeff help: add config.troubleshooting section at the top
timeless@mozdev.org
parents: 26313
diff changeset
     6
33af0c53aeff help: add config.troubleshooting section at the top
timeless@mozdev.org
parents: 26313
diff changeset
     7
If you're having problems with your configuration,
33af0c53aeff help: add config.troubleshooting section at the top
timeless@mozdev.org
parents: 26313
diff changeset
     8
:hg:`config --debug` can help you understand what is introducing
33af0c53aeff help: add config.troubleshooting section at the top
timeless@mozdev.org
parents: 26313
diff changeset
     9
a setting into your environment.
33af0c53aeff help: add config.troubleshooting section at the top
timeless@mozdev.org
parents: 26313
diff changeset
    10
33af0c53aeff help: add config.troubleshooting section at the top
timeless@mozdev.org
parents: 26313
diff changeset
    11
See :hg:`help config.syntax` and :hg:`help config.files`
33af0c53aeff help: add config.troubleshooting section at the top
timeless@mozdev.org
parents: 26313
diff changeset
    12
for information about how and where to override things.
33af0c53aeff help: add config.troubleshooting section at the top
timeless@mozdev.org
parents: 26313
diff changeset
    13
27607
ee27d461bf5b help: rename the Format section to Structure
timeless <timeless@mozdev.org>
parents: 27606
diff changeset
    14
Structure
ee27d461bf5b help: rename the Format section to Structure
timeless <timeless@mozdev.org>
parents: 27606
diff changeset
    15
=========
26365
33af0c53aeff help: add config.troubleshooting section at the top
timeless@mozdev.org
parents: 26313
diff changeset
    16
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
    17
The configuration files use a simple ini-file format. A configuration
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
    18
file consists of sections, led by a ``[section]`` header and followed
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
    19
by ``name = value`` entries::
9785
b52f0f221325 help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
    20
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
    21
  [ui]
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
    22
  username = Firstname Lastname <firstname.lastname@example.net>
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
    23
  verbose = True
9785
b52f0f221325 help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
    24
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
    25
The above entries will be referred to as ``ui.username`` and
26280
5edf3dccb6f7 help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents: 26279
diff changeset
    26
``ui.verbose``, respectively. See :hg:`help config.syntax`.
9785
b52f0f221325 help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
    27
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
    28
Files
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
    29
=====
9785
b52f0f221325 help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff changeset
    30
14460
d5f616132c10 doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents: 14458
diff changeset
    31
Mercurial reads configuration data from several files, if they exist.
13955
86b5cc1e8be8 help config: explain that config files do not exist by default
Martin Geisler <mg@lazybytes.net>
parents: 11408
diff changeset
    32
These files do not exist by default and you will have to create the
27762
70e7bfebba46 help: split config user settings file by platform
timeless <timeless@mozdev.org>
parents: 27761
diff changeset
    33
appropriate configuration files yourself:
70e7bfebba46 help: split config user settings file by platform
timeless <timeless@mozdev.org>
parents: 27761
diff changeset
    34
70e7bfebba46 help: split config user settings file by platform
timeless <timeless@mozdev.org>
parents: 27761
diff changeset
    35
Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
70e7bfebba46 help: split config user settings file by platform
timeless <timeless@mozdev.org>
parents: 27761
diff changeset
    36
70e7bfebba46 help: split config user settings file by platform
timeless <timeless@mozdev.org>
parents: 27761
diff changeset
    37
Global configuration like the username setting is typically put into:
70e7bfebba46 help: split config user settings file by platform
timeless <timeless@mozdev.org>
parents: 27761
diff changeset
    38
70e7bfebba46 help: split config user settings file by platform
timeless <timeless@mozdev.org>
parents: 27761
diff changeset
    39
.. container:: windows
70e7bfebba46 help: split config user settings file by platform
timeless <timeless@mozdev.org>
parents: 27761
diff changeset
    40
27960
0ec12435b78b doc: itemize text blocks to increase readability in HTML format
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 27949
diff changeset
    41
  - ``%USERPROFILE%\mercurial.ini`` (on Windows)
27762
70e7bfebba46 help: split config user settings file by platform
timeless <timeless@mozdev.org>
parents: 27761
diff changeset
    42
70e7bfebba46 help: split config user settings file by platform
timeless <timeless@mozdev.org>
parents: 27761
diff changeset
    43
.. container:: unix.plan9
70e7bfebba46 help: split config user settings file by platform
timeless <timeless@mozdev.org>
parents: 27761
diff changeset
    44
27960
0ec12435b78b doc: itemize text blocks to increase readability in HTML format
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 27949
diff changeset
    45
  - ``$HOME/.hgrc`` (on Unix, Plan9)
13955
86b5cc1e8be8 help config: explain that config files do not exist by default
Martin Geisler <mg@lazybytes.net>
parents: 11408
diff changeset
    46
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
    47
The names of these files depend on the system on which Mercurial is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
    48
installed. ``*.rc`` files from a single directory are read in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
    49
alphabetical order, later ones overriding earlier ones. Where multiple
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
    50
paths are given below, settings from earlier paths override later
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
    51
ones.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
    52
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    53
.. container:: verbose.unix
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
    54
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    55
  On Unix, the following files are consulted:
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
    56
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    57
  - ``<repo>/.hg/hgrc`` (per-repository)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    58
  - ``$HOME/.hgrc`` (per-user)
30941
354020079723 hg: allow usage of XDG_CONFIG_HOME/hg/hgrc
David Demelier <demelier.david@gmail.com>
parents: 30766
diff changeset
    59
  - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user)
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    60
  - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    61
  - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    62
  - ``/etc/mercurial/hgrc`` (per-system)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    63
  - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
23142
c4ce077588d0 config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents: 23121
diff changeset
    64
  - ``<internal>/default.d/*.rc`` (defaults)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
    65
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    66
.. container:: verbose.windows
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
    67
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    68
  On Windows, the following files are consulted:
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
    69
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    70
  - ``<repo>/.hg/hgrc`` (per-repository)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    71
  - ``%USERPROFILE%\.hgrc`` (per-user)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    72
  - ``%USERPROFILE%\Mercurial.ini`` (per-user)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    73
  - ``%HOME%\.hgrc`` (per-user)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    74
  - ``%HOME%\Mercurial.ini`` (per-user)
26625
adae8928fe09 windows: read all global config files, not just the first (issue4491) (BC)
Mads Kiilerich <madski@unity3d.com>
parents: 26623
diff changeset
    75
  - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    76
  - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
26625
adae8928fe09 windows: read all global config files, not just the first (issue4491) (BC)
Mads Kiilerich <madski@unity3d.com>
parents: 26623
diff changeset
    77
  - ``<install-dir>\Mercurial.ini`` (per-installation)
23142
c4ce077588d0 config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents: 23121
diff changeset
    78
  - ``<internal>/default.d/*.rc`` (defaults)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
    79
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    80
  .. note::
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
    81
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
    82
   The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
19183
9d88916fb56f help/config: note 64-bit Windows registry key used with 32-bit Python
Mike Williams <mrw@eandem.co.uk>
parents: 19050
diff changeset
    83
   is used when running 32-bit Python on 64-bit Windows.
9d88916fb56f help/config: note 64-bit Windows registry key used with 32-bit Python
Mike Williams <mrw@eandem.co.uk>
parents: 19050
diff changeset
    84
27889
88aa4da0cba8 help: move Windows 9x information to appropriate place
Danek Duvall <danek.duvall@oracle.com>
parents: 27762
diff changeset
    85
.. container:: windows
88aa4da0cba8 help: move Windows 9x information to appropriate place
Danek Duvall <danek.duvall@oracle.com>
parents: 27762
diff changeset
    86
88aa4da0cba8 help: move Windows 9x information to appropriate place
Danek Duvall <danek.duvall@oracle.com>
parents: 27762
diff changeset
    87
  On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
88aa4da0cba8 help: move Windows 9x information to appropriate place
Danek Duvall <danek.duvall@oracle.com>
parents: 27762
diff changeset
    88
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    89
.. container:: verbose.plan9
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    90
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    91
  On Plan9, the following files are consulted:
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    92
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    93
  - ``<repo>/.hg/hgrc`` (per-repository)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    94
  - ``$home/lib/hgrc`` (per-user)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    95
  - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    96
  - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    97
  - ``/lib/mercurial/hgrc`` (per-system)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
    98
  - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
23142
c4ce077588d0 config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents: 23121
diff changeset
    99
  - ``<internal>/default.d/*.rc`` (defaults)
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   100
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   101
Per-repository configuration options only apply in a
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   102
particular repository. This file is not version-controlled, and
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   103
will not get transferred during a "clone" operation. Options in
27760
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   104
this file override options in all other configuration files.
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   105
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   106
.. container:: unix.plan9
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   107
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   108
  On Plan 9 and Unix, most of this file will be ignored if it doesn't
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   109
  belong to a trusted user or to a trusted group. See
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   110
  :hg:`help config.trusted` for more details.
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   111
27889
88aa4da0cba8 help: move Windows 9x information to appropriate place
Danek Duvall <danek.duvall@oracle.com>
parents: 27762
diff changeset
   112
Per-user configuration file(s) are for the user running Mercurial.  Options
88aa4da0cba8 help: move Windows 9x information to appropriate place
Danek Duvall <danek.duvall@oracle.com>
parents: 27762
diff changeset
   113
in these files apply to all Mercurial commands executed by this user in any
88aa4da0cba8 help: move Windows 9x information to appropriate place
Danek Duvall <danek.duvall@oracle.com>
parents: 27762
diff changeset
   114
directory. Options in these files override per-system and per-installation
88aa4da0cba8 help: move Windows 9x information to appropriate place
Danek Duvall <danek.duvall@oracle.com>
parents: 27762
diff changeset
   115
options.
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   116
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   117
Per-installation configuration files are searched for in the
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   118
directory where Mercurial is installed. ``<install-root>`` is the
27760
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   119
parent directory of the **hg** executable (or symlink) being run.
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   120
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   121
.. container:: unix.plan9
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   122
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   123
  For example, if installed in ``/shared/tools/bin/hg``, Mercurial
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   124
  will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   125
  files apply to all Mercurial commands executed by any user in any
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
   126
  directory.
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   127
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   128
Per-installation configuration files are for the system on
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   129
which Mercurial is running. Options in these files apply to all
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   130
Mercurial commands executed by any user in any directory. Registry
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   131
keys contain PATH-like strings, every part of which must reference
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   132
a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   133
be read.  Mercurial checks each of these locations in the specified
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   134
order until one or more configuration files are detected.
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   135
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   136
Per-system configuration files are for the system on which Mercurial
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   137
is running. Options in these files apply to all Mercurial commands
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   138
executed by any user in any directory. Options in these files
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   139
override per-installation options.
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
   140
23142
c4ce077588d0 config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents: 23121
diff changeset
   141
Mercurial comes with some default configuration. The default configuration
c4ce077588d0 config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents: 23121
diff changeset
   142
files are installed with Mercurial and will be overwritten on upgrades. Default
c4ce077588d0 config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents: 23121
diff changeset
   143
configuration files should never be edited by users or administrators but can
c4ce077588d0 config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents: 23121
diff changeset
   144
be overridden in other configuration files. So far the directory only contains
c4ce077588d0 config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents: 23121
diff changeset
   145
merge tool configuration but packagers can also put other default configuration
c4ce077588d0 config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents: 23121
diff changeset
   146
there.
c4ce077588d0 config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents: 23121
diff changeset
   147
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   148
Syntax
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   149
======
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   150
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   151
A configuration file consists of sections, led by a ``[section]`` header
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   152
and followed by ``name = value`` entries (sometimes called
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   153
``configuration keys``)::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   154
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   155
    [spam]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   156
    eggs=ham
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   157
    green=
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   158
       eggs
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   159
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   160
Each line contains one entry. If the lines that follow are indented,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   161
they are treated as continuations of that entry. Leading whitespace is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   162
removed from values. Empty lines are skipped. Lines beginning with
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   163
``#`` or ``;`` are ignored and may be used to provide comments.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   164
14651
e9e4e9ab62bd help/config: fix 'Mercurial' casing
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14460
diff changeset
   165
Configuration keys can be set multiple times, in which case Mercurial
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   166
will use the value that was configured last. As an example::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   167
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   168
    [spam]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   169
    eggs=large
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   170
    ham=serrano
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   171
    eggs=small
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   172
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   173
This would set the configuration key named ``eggs`` to ``small``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   174
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   175
It is also possible to define a section multiple times. A section can
14652
73cb35f6fd78 help/config: do not refer to config files as hgrc files
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14651
diff changeset
   176
be redefined on the same and/or on different configuration files. For
73cb35f6fd78 help/config: do not refer to config files as hgrc files
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14651
diff changeset
   177
example::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   178
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   179
    [foo]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   180
    eggs=large
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   181
    ham=serrano
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   182
    eggs=small
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   183
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   184
    [bar]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   185
    eggs=ham
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   186
    green=
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   187
       eggs
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   188
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   189
    [foo]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   190
    ham=prosciutto
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   191
    eggs=medium
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   192
    bread=toasted
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   193
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   194
This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   195
of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   196
respectively. As you can see there only thing that matters is the last
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   197
value that was set for each of the configuration keys.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   198
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   199
If a configuration key is set multiple times in different
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   200
configuration files the final value will depend on the order in which
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   201
the different configuration files are read, with settings from earlier
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   202
paths overriding later ones as described on the ``Files`` section
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   203
above.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   204
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   205
A line of the form ``%include file`` will include ``file`` into the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   206
current configuration file. The inclusion is recursive, which means
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   207
that included files can include other files. Filenames are relative to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   208
the configuration file in which the ``%include`` directive is found.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   209
Environment variables and ``~user`` constructs are expanded in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   210
``file``. This lets you do something like::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   211
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   212
  %include ~/.hgrc.d/$HOST.rc
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   213
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   214
to include a different configuration file on each computer you use.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   215
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   216
A line with ``%unset name`` will remove ``name`` from the current
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   217
section, if it has been set previously.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   218
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   219
The values are either free-form text strings, lists of text strings,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   220
or Boolean values. Boolean values can be set to true using any of "1",
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   221
"yes", "true", or "on" and to false using "0", "no", "false", or "off"
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   222
(all case insensitive).
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   223
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   224
List values are separated by whitespace or comma, except when values are
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   225
placed in double quotation marks::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   226
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   227
  allow_read = "John Doe, PhD", brian, betty
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   228
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   229
Quotation marks can be escaped by prefixing them with a backslash. Only
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   230
quotation marks at the beginning of a word is counted as a quotation
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   231
(e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   232
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   233
Sections
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   234
========
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   235
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   236
This section describes the different sections that may appear in a
14652
73cb35f6fd78 help/config: do not refer to config files as hgrc files
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14651
diff changeset
   237
Mercurial configuration file, the purpose of each section, its possible
73cb35f6fd78 help/config: do not refer to config files as hgrc files
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14651
diff changeset
   238
keys, and their possible values.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   239
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   240
``alias``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   241
---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   242
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   243
Defines command aliases.
26172
e05e5c6ccd2f help/config: add blank lines
timeless@mozdev.org
parents: 26169
diff changeset
   244
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   245
Aliases allow you to define your own commands in terms of other
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   246
commands (or aliases), optionally including arguments. Positional
26176
3fb59f43a430 help/config: alias, ui.mergemarkertemplate add period for etc.
timeless@mozdev.org
parents: 26172
diff changeset
   247
arguments in the form of ``$1``, ``$2``, etc. in the alias definition
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   248
are expanded by Mercurial before execution. Positional arguments not
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   249
already used by ``$N`` in the definition are put at the end of the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   250
command to be executed.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   251
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   252
Alias definitions consist of lines of the form::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   253
14653
6f96c7a908bd help/config: fix small typo
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14652
diff changeset
   254
    <alias> = <command> [<argument>]...
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   255
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   256
For example, this definition::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   257
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   258
    latest = log --limit 5
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   259
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   260
creates a new command ``latest`` that shows only the five most recent
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   261
changesets. You can define subsequent aliases using earlier ones::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   262
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   263
    stable5 = latest -b stable
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   264
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
   265
.. note::
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
   266
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
   267
   It is possible to create aliases with the same names as
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   268
   existing commands, which will then override the original
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   269
   definitions. This is almost always a bad idea!
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   270
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   271
An alias can start with an exclamation point (``!``) to make it a
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   272
shell alias. A shell alias is executed with the shell and will let you
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   273
run arbitrary commands. As an example, ::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   274
16513
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
   275
   echo = !echo $@
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   276
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   277
will let you do ``hg echo foo`` to have ``foo`` printed in your
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   278
terminal. A better example might be::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   279
31001
e7eca6e1372e doc: correct example concerning "hg purge" alias in man page "hgrc.5"
Rainer Woitok <Rainer.Woitok@Gmail.Com>
parents: 30941
diff changeset
   280
   purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   281
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   282
which will make ``hg purge`` delete all unknown files in the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   283
repository in the same manner as the purge extension.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   284
16513
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
   285
Positional arguments like ``$1``, ``$2``, etc. in the alias definition
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
   286
expand to the command arguments. Unmatched arguments are
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
   287
removed. ``$0`` expands to the alias name and ``$@`` expands to all
22158
bc2132dfc0a4 alias: expand "$@" as list of parameters quoted individually (BC) (issue4200)
Siddharth Agarwal <sid0@fb.com>
parents: 22032
diff changeset
   288
arguments separated by a space. ``"$@"`` (with quotes) expands to all
bc2132dfc0a4 alias: expand "$@" as list of parameters quoted individually (BC) (issue4200)
Siddharth Agarwal <sid0@fb.com>
parents: 22032
diff changeset
   289
arguments quoted individually and separated by a space. These expansions
bc2132dfc0a4 alias: expand "$@" as list of parameters quoted individually (BC) (issue4200)
Siddharth Agarwal <sid0@fb.com>
parents: 22032
diff changeset
   290
happen before the command is passed to the shell.
16513
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
   291
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
   292
Shell aliases are executed in an environment where ``$HG`` expands to
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   293
the path of the Mercurial that was used to execute the alias. This is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   294
useful when you want to call further Mercurial commands in a shell
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   295
alias, as was done above for the purge alias. In addition,
16513
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
   296
``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   297
echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   298
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
   299
.. note::
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
   300
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
   301
   Some global configuration options such as ``-R`` are
14891
62122c1c830b alias: note interaction of shell aliases with early opts in help
Matt Mackall <mpm@selenic.com>
parents: 14691
diff changeset
   302
   processed before shell aliases and will thus not be passed to
62122c1c830b alias: note interaction of shell aliases with early opts in help
Matt Mackall <mpm@selenic.com>
parents: 14691
diff changeset
   303
   aliases.
62122c1c830b alias: note interaction of shell aliases with early opts in help
Matt Mackall <mpm@selenic.com>
parents: 14691
diff changeset
   304
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   305
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   306
``annotate``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   307
------------
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   308
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   309
Settings used when displaying file annotations. All values are
26280
5edf3dccb6f7 help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents: 26279
diff changeset
   310
Booleans and default to False. See :hg:`help config.diff` for
5edf3dccb6f7 help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents: 26279
diff changeset
   311
related options for the diff command.
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   312
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   313
``ignorews``
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   314
    Ignore white space when comparing lines.
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   315
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   316
``ignorewsamount``
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   317
    Ignore changes in the amount of white space.
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   318
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   319
``ignoreblanklines``
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   320
    Ignore changes whose lines are all blank.
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   321
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   322
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   323
``auth``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   324
--------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   325
31936
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   326
Authentication credentials and other authentication-like configuration
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   327
for HTTP connections. This section allows you to store usernames and
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   328
passwords for use when logging *into* HTTP servers. See
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   329
:hg:`help config.web` if you want to configure *who* can login to
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   330
your HTTP server.
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   331
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   332
The following options apply to all hosts.
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   333
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   334
``cookiefile``
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   335
    Path to a file containing HTTP cookie lines. Cookies matching a
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   336
    host will be sent automatically.
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   337
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   338
    The file format uses the Mozilla cookies.txt format, which defines cookies
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   339
    on their own lines. Each line contains 7 fields delimited by the tab
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   340
    character (domain, is_domain_cookie, path, is_secure, expires, name,
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   341
    value). For more info, do an Internet search for "Netscape cookies.txt
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   342
    format."
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   343
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   344
    Note: the cookies parser does not handle port numbers on domains. You
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   345
    will need to remove ports from the domain for the cookie to be recognized.
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   346
    This could result in a cookie being disclosed to an unwanted server.
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   347
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   348
    The cookies file is read-only.
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   349
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   350
Other options in this section are grouped by name and have the following
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   351
format::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   352
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   353
    <name>.<argument> = <value>
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   354
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   355
where ``<name>`` is used to group arguments into authentication
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   356
entries. Example::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   357
28191
535f2900d078 help: hg.intevation.de is new primary name of hg.intevation.de (and new cert)
Thomas Arendsen Hein <thomas@intevation.de>
parents: 28057
diff changeset
   358
    foo.prefix = hg.intevation.de/mercurial
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   359
    foo.username = foo
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   360
    foo.password = bar
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   361
    foo.schemes = http https
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   362
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   363
    bar.prefix = secure.example.org
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   364
    bar.key = path/to/file.key
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   365
    bar.cert = path/to/file.cert
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   366
    bar.schemes = https
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   367
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   368
Supported arguments:
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   369
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   370
``prefix``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   371
    Either ``*`` or a URI prefix with or without the scheme part.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   372
    The authentication entry with the longest matching prefix is used
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   373
    (where ``*`` matches everything and counts as a match of length
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   374
    1). If the prefix doesn't include a scheme, the match is performed
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   375
    against the URI with its scheme stripped as well, and the schemes
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   376
    argument, q.v., is then subsequently consulted.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   377
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   378
``username``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   379
    Optional. Username to authenticate with. If not given, and the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   380
    remote site requires basic or digest authentication, the user will
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   381
    be prompted for it. Environment variables are expanded in the
15005
4a43e23b8c55 hgweb: do not ignore [auth] if url has a username (issue2822)
Patrick Mezard <pmezard@gmail.com>
parents: 15004
diff changeset
   382
    username letting you do ``foo.username = $USER``. If the URI
4a43e23b8c55 hgweb: do not ignore [auth] if url has a username (issue2822)
Patrick Mezard <pmezard@gmail.com>
parents: 15004
diff changeset
   383
    includes a username, only ``[auth]`` entries with a matching
4a43e23b8c55 hgweb: do not ignore [auth] if url has a username (issue2822)
Patrick Mezard <pmezard@gmail.com>
parents: 15004
diff changeset
   384
    username or without a username will be considered.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   385
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   386
``password``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   387
    Optional. Password to authenticate with. If not given, and the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   388
    remote site requires basic or digest authentication, the user
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   389
    will be prompted for it.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   390
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   391
``key``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   392
    Optional. PEM encoded client certificate key file. Environment
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   393
    variables are expanded in the filename.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   394
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   395
``cert``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   396
    Optional. PEM encoded client certificate chain file. Environment
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   397
    variables are expanded in the filename.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   398
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   399
``schemes``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   400
    Optional. Space separated list of URI schemes to use this
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   401
    authentication entry with. Only used if the prefix doesn't include
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   402
    a scheme. Supported schemes are http and https. They will match
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   403
    static-http and static-https respectively, as well.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
   404
    (default: https)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   405
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   406
If no suitable authentication entry is found, the user is prompted
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   407
for credentials as usual if required by the remote.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   408
31123
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   409
``color``
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   410
---------
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   411
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   412
Configure the Mercurial color mode. For details about how to define your custom
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   413
effect and style see :hg:`help color`.
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   414
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   415
``mode``
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   416
    String: control the method used to output color. One of ``auto``, ``ansi``,
32081
a6865b35a10d help: use mercurial as a subject of colorization and pagination
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 32033
diff changeset
   417
    ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will
32666
dd0bdeb0feee help: update the color documentation for Windows 10 ANSI support
Matt Harbison <matt_harbison@yahoo.com>
parents: 32274
diff changeset
   418
    use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a
31123
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   419
    terminal. Any invalid value will disable color.
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   420
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   421
``pagermode``
32139
de86a6872d06 help: spelling fixes
Matt Harbison <matt_harbison@yahoo.com>
parents: 32104
diff changeset
   422
    String: optional override of ``color.mode`` used with pager.
31123
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   423
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   424
    On some systems, terminfo mode may cause problems when using
32081
a6865b35a10d help: use mercurial as a subject of colorization and pagination
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 32033
diff changeset
   425
    color with ``less -R`` as a pager program. less with the -R option
31123
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   426
    will only display ECMA-48 color codes, and terminfo mode may sometimes
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   427
    emit codes that less doesn't understand. You can work around this by
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   428
    either using ansi mode (or auto mode), or by using less -r (which will
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   429
    pass through all terminal control codes, not just color control
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   430
    codes).
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   431
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   432
    On some systems (such as MSYS in Windows), the terminal may support
32081
a6865b35a10d help: use mercurial as a subject of colorization and pagination
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 32033
diff changeset
   433
    a different color mode than the pager program.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   434
31557
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
   435
``commands``
31591
2c02bb7fd7fc help: format ``commands`` heading correctly
Martin von Zweigbergk <martinvonz@google.com>
parents: 31589
diff changeset
   436
------------
31557
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
   437
31589
7e3b145f8247 status: support commands.status.relative config
Martin von Zweigbergk <martinvonz@google.com>
parents: 31557
diff changeset
   438
``status.relative``
32082
202b86a509e0 help: use hg role of mini reST to make hyper link in HTML page
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 32081
diff changeset
   439
    Make paths in :hg:`status` output relative to the current directory.
31589
7e3b145f8247 status: support commands.status.relative config
Martin von Zweigbergk <martinvonz@google.com>
parents: 31557
diff changeset
   440
    (default: False)
7e3b145f8247 status: support commands.status.relative config
Martin von Zweigbergk <martinvonz@google.com>
parents: 31557
diff changeset
   441
31557
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
   442
``update.requiredest``
32082
202b86a509e0 help: use hg role of mini reST to make hyper link in HTML page
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 32081
diff changeset
   443
    Require that the user pass a destination when running :hg:`update`.
202b86a509e0 help: use hg role of mini reST to make hyper link in HTML page
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 32081
diff changeset
   444
    For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
31557
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
   445
    will be disallowed.
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
   446
    (default: False)
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
   447
21924
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   448
``committemplate``
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   449
------------------
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   450
26169
ea888285311f help: config indent committemplate.changeset section
timeless@mozdev.org
parents: 26072
diff changeset
   451
``changeset``
ea888285311f help: config indent committemplate.changeset section
timeless@mozdev.org
parents: 26072
diff changeset
   452
    String: configuration in this section is used as the template to
ea888285311f help: config indent committemplate.changeset section
timeless@mozdev.org
parents: 26072
diff changeset
   453
    customize the text shown in the editor when committing.
21924
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   454
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   455
In addition to pre-defined template keywords, commit log specific one
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   456
below can be used for customization:
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   457
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   458
``extramsg``
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   459
    String: Extra message (typically 'Leave message empty to abort
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   460
    commit.'). This may be changed by some commands or extensions.
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   461
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   462
For example, the template configuration below shows as same text as
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   463
one shown by default::
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   464
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   465
    [committemplate]
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   466
    changeset = {desc}\n\n
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   467
        HG: Enter commit message.  Lines beginning with 'HG:' are removed.
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   468
        HG: {extramsg}
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   469
        HG: --
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   470
        HG: user: {author}\n{ifeq(p2rev, "-1", "",
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   471
       "HG: branch merge\n")
25014
7e5d5160073b templatekw: replace currentbookmark with activebookmark keyword
Ryan McElroy <rmcelroy@fb.com>
parents: 24830
diff changeset
   472
       }HG: branch '{branch}'\n{if(activebookmark,
7e5d5160073b templatekw: replace currentbookmark with activebookmark keyword
Ryan McElroy <rmcelroy@fb.com>
parents: 24830
diff changeset
   473
       "HG: bookmark '{activebookmark}'\n")   }{subrepos %
21924
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   474
       "HG: subrepo {subrepo}\n"              }{file_adds %
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   475
       "HG: added {file}\n"                   }{file_mods %
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   476
       "HG: changed {file}\n"                 }{file_dels %
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   477
       "HG: removed {file}\n"                 }{if(files, "",
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   478
       "HG: no files changed\n")}
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   479
30704
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   480
``diff()``
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   481
    String: show the diff (see :hg:`help templates` for detail)
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   482
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   483
Sometimes it is helpful to show the diff of the changeset in the editor without
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   484
having to prefix 'HG: ' to each line so that highlighting works correctly. For
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   485
this, Mercurial provides a special string which will ignore everything below
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   486
it::
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   487
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   488
     HG: ------------------------ >8 ------------------------
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   489
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   490
For example, the template configuration below will show the diff below the
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   491
extra message::
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   492
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   493
    [committemplate]
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   494
    changeset = {desc}\n\n
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   495
        HG: Enter commit message.  Lines beginning with 'HG:' are removed.
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   496
        HG: {extramsg}
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   497
        HG: ------------------------ >8 ------------------------
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   498
        HG: Do not touch the line above.
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   499
        HG: Everything below will be removed.
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   500
        {diff()}
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   501
21924
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   502
.. note::
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   503
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   504
   For some problematic encodings (see :hg:`help win32mbcs` for
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   505
   detail), this customization should be configured carefully, to
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   506
   avoid showing broken characters.
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   507
26281
5cac3bdb3c67 help/config: reword committemplate multibyte character text
timeless@mozdev.org
parents: 26280
diff changeset
   508
   For example, if a multibyte character ending with backslash (0x5c) is
5cac3bdb3c67 help/config: reword committemplate multibyte character text
timeless@mozdev.org
parents: 26280
diff changeset
   509
   followed by the ASCII character 'n' in the customized template,
5cac3bdb3c67 help/config: reword committemplate multibyte character text
timeless@mozdev.org
parents: 26280
diff changeset
   510
   the sequence of backslash and 'n' is treated as line-feed unexpectedly
5cac3bdb3c67 help/config: reword committemplate multibyte character text
timeless@mozdev.org
parents: 26280
diff changeset
   511
   (and the multibyte character is broken, too).
21924
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   512
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   513
Customized template is used for commands below (``--edit`` may be
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   514
required):
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   515
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   516
- :hg:`backout`
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   517
- :hg:`commit`
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   518
- :hg:`fetch` (for merge commit only)
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   519
- :hg:`graft`
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   520
- :hg:`histedit`
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   521
- :hg:`import`
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   522
- :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   523
- :hg:`rebase`
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   524
- :hg:`shelve`
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   525
- :hg:`sign`
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   526
- :hg:`tag`
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   527
- :hg:`transplant`
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   528
22012
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   529
Configuring items below instead of ``changeset`` allows showing
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   530
customized message only for specific actions, or showing different
23075
2b3189ec3d14 help/config: fix typo
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 22607
diff changeset
   531
messages for each action.
22012
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   532
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   533
- ``changeset.backout`` for :hg:`backout`
22249
f5ff18f65b73 commit: change "editform" to distinguish merge commits from other (--amend)
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22248
diff changeset
   534
- ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
f5ff18f65b73 commit: change "editform" to distinguish merge commits from other (--amend)
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22248
diff changeset
   535
- ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
22248
75618a223e18 commit: change "editform" to distinguish merge commits from others
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22205
diff changeset
   536
- ``changeset.commit.normal.merge`` for :hg:`commit` on merges
75618a223e18 commit: change "editform" to distinguish merge commits from others
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22205
diff changeset
   537
- ``changeset.commit.normal.normal`` for :hg:`commit` on other
22012
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   538
- ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   539
- ``changeset.gpg.sign`` for :hg:`sign`
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   540
- ``changeset.graft`` for :hg:`graft`
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   541
- ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   542
- ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   543
- ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   544
- ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   545
- ``changeset.import.bypass`` for :hg:`import --bypass`
22250
f3200bf460a8 import: change "editform" to distinguish merge commits from others
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22249
diff changeset
   546
- ``changeset.import.normal.merge`` for :hg:`import` on merges
f3200bf460a8 import: change "editform" to distinguish merge commits from others
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22249
diff changeset
   547
- ``changeset.import.normal.normal`` for :hg:`import` on other
22012
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   548
- ``changeset.mq.qnew`` for :hg:`qnew`
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   549
- ``changeset.mq.qfold`` for :hg:`qfold`
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   550
- ``changeset.mq.qrefresh`` for :hg:`qrefresh`
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   551
- ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
22251
d0d3e5c6eb3c rebase: change "editform" to distinguish merge commits from others
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22250
diff changeset
   552
- ``changeset.rebase.merge`` for :hg:`rebase` on merges
d0d3e5c6eb3c rebase: change "editform" to distinguish merge commits from others
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22250
diff changeset
   553
- ``changeset.rebase.normal`` for :hg:`rebase` on other
22012
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   554
- ``changeset.shelve.shelve`` for :hg:`shelve`
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   555
- ``changeset.tag.add`` for :hg:`tag` without ``--remove``
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   556
- ``changeset.tag.remove`` for :hg:`tag --remove`
22252
de783f2403c4 transplant: change "editform" to distinguish merge commits from others
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22251
diff changeset
   557
- ``changeset.transplant.merge`` for :hg:`transplant` on merges
de783f2403c4 transplant: change "editform" to distinguish merge commits from others
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22251
diff changeset
   558
- ``changeset.transplant.normal`` for :hg:`transplant` on other
22012
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   559
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   560
These dot-separated lists of names are treated as hierarchical ones.
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   561
For example, ``changeset.tag.remove`` customizes the commit message
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   562
only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   563
commit message for :hg:`tag` regardless of ``--remove`` option.
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   564
26282
436f5ab16079 help/config: reword committemplate external editor text
timeless@mozdev.org
parents: 26281
diff changeset
   565
When the external editor is invoked for a commit, the corresponding
436f5ab16079 help/config: reword committemplate external editor text
timeless@mozdev.org
parents: 26281
diff changeset
   566
dot-separated list of names without the ``changeset.`` prefix
436f5ab16079 help/config: reword committemplate external editor text
timeless@mozdev.org
parents: 26281
diff changeset
   567
(e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
436f5ab16079 help/config: reword committemplate external editor text
timeless@mozdev.org
parents: 26281
diff changeset
   568
variable.
22205
9fa429723f26 ui: invoke editor for committing with HGEDITFORM environment variable
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22158
diff changeset
   569
22013
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   570
In this section, items other than ``changeset`` can be referred from
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   571
others. For example, the configuration to list committed files up
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   572
below can be referred as ``{listupfiles}``::
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   573
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   574
    [committemplate]
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   575
    listupfiles = {file_adds %
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   576
       "HG: added {file}\n"     }{file_mods %
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   577
       "HG: changed {file}\n"   }{file_dels %
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   578
       "HG: removed {file}\n"   }{if(files, "",
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   579
       "HG: no files changed\n")}
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   580
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   581
``decode/encode``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   582
-----------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   583
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   584
Filters for transforming files on checkout/checkin. This would
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   585
typically be used for newline processing or other
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   586
localization/canonicalization of files.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   587
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   588
Filters consist of a filter pattern followed by a filter command.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   589
Filter patterns are globs by default, rooted at the repository root.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   590
For example, to match any file ending in ``.txt`` in the root
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   591
directory only, use the pattern ``*.txt``. To match any file ending
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   592
in ``.c`` anywhere in the repository, use the pattern ``**.c``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   593
For each file only the first matching filter applies.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   594
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   595
The filter command can start with a specifier, either ``pipe:`` or
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   596
``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   597
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   598
A ``pipe:`` command must accept data on stdin and return the transformed
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   599
data on stdout.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   600
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   601
Pipe example::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   602
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   603
  [encode]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   604
  # uncompress gzip files on checkin to improve delta compression
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   605
  # note: not necessarily a good idea, just an example
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   606
  *.gz = pipe: gunzip
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   607
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   608
  [decode]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   609
  # recompress gzip files when writing them to the working dir (we
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   610
  # can safely omit "pipe:", because it's the default)
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   611
  *.gz = gzip
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   612
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   613
A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   614
with the name of a temporary file that contains the data to be
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   615
filtered by the command. The string ``OUTFILE`` is replaced with the name
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   616
of an empty temporary file, where the filtered data must be written by
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   617
the command.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   618
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
   619
.. container:: windows
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
   620
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
   621
   .. note::
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
   622
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
   623
     The tempfile mechanism is recommended for Windows systems,
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
   624
     where the standard shell I/O redirection operators often have
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
   625
     strange effects and may corrupt the contents of your files.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   626
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   627
This filter mechanism is used internally by the ``eol`` extension to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   628
translate line ending characters between Windows (CRLF) and Unix (LF)
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   629
format. We suggest you use the ``eol`` extension for convenience.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   630
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   631
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   632
``defaults``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   633
------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   634
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
   635
(defaults are deprecated. Don't use them. Use aliases instead.)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   636
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   637
Use the ``[defaults]`` section to define command defaults, i.e. the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   638
default options/arguments to pass to the specified commands.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   639
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   640
The following example makes :hg:`log` run in verbose mode, and
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   641
:hg:`status` show only the modified files, by default::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   642
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   643
  [defaults]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   644
  log = -v
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   645
  status = -m
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   646
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   647
The actual commands, instead of their aliases, must be used when
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   648
defining command defaults. The command defaults will also be applied
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   649
to the aliases of the commands defined.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   650
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   651
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   652
``diff``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   653
--------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   654
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   655
Settings used when displaying diffs. Everything except for ``unified``
26280
5edf3dccb6f7 help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents: 26279
diff changeset
   656
is a Boolean and defaults to False. See :hg:`help config.annotate`
5edf3dccb6f7 help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents: 26279
diff changeset
   657
for related options for the annotate command.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   658
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   659
``git``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   660
    Use git extended diff format.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   661
22602
551d776a0a9a diff: document the nobinary option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 21924
diff changeset
   662
``nobinary``
551d776a0a9a diff: document the nobinary option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 21924
diff changeset
   663
    Omit git binary patches.
551d776a0a9a diff: document the nobinary option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 21924
diff changeset
   664
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   665
``nodates``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   666
    Don't include dates in diff headers.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   667
23297
d7abae94a7a0 patch.diffopts: add support for noprefix
Siddharth Agarwal <sid0@fb.com>
parents: 23142
diff changeset
   668
``noprefix``
d7abae94a7a0 patch.diffopts: add support for noprefix
Siddharth Agarwal <sid0@fb.com>
parents: 23142
diff changeset
   669
    Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
d7abae94a7a0 patch.diffopts: add support for noprefix
Siddharth Agarwal <sid0@fb.com>
parents: 23142
diff changeset
   670
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   671
``showfunc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   672
    Show which function each change is in.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   673
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   674
``ignorews``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   675
    Ignore white space when comparing lines.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   676
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   677
``ignorewsamount``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   678
    Ignore changes in the amount of white space.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   679
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   680
``ignoreblanklines``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   681
    Ignore changes whose lines are all blank.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   682
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   683
``unified``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   684
    Number of lines of context to show.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   685
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   686
``email``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   687
---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   688
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   689
Settings for extensions that send email messages.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   690
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   691
``from``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   692
    Optional. Email address to use in "From" header and SMTP envelope
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   693
    of outgoing messages.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   694
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   695
``to``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   696
    Optional. Comma-separated list of recipients' email addresses.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   697
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   698
``cc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   699
    Optional. Comma-separated list of carbon copy recipients'
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   700
    email addresses.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   701
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   702
``bcc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   703
    Optional. Comma-separated list of blind carbon copy recipients'
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   704
    email addresses.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   705
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   706
``method``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   707
    Optional. Method to use to send email messages. If value is ``smtp``
14654
e21fd445c297 help/config: quote config section names consistently
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14653
diff changeset
   708
    (default), use SMTP (see the ``[smtp]`` section for configuration).
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   709
    Otherwise, use as name of program to run that acts like sendmail
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   710
    (takes ``-f`` option for sender, list of recipients on command line,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   711
    message on stdin). Normally, setting this to ``sendmail`` or
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   712
    ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   713
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   714
``charsets``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   715
    Optional. Comma-separated list of character sets considered
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   716
    convenient for recipients. Addresses, headers, and parts not
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   717
    containing patches of outgoing messages will be encoded in the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   718
    first character set to which conversion from local encoding
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   719
    (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
   720
    conversion fails, the text in question is sent as is.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
   721
    (default: '')
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   722
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   723
    Order of outgoing email character sets:
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   724
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   725
    1. ``us-ascii``: always first, regardless of settings
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   726
    2. ``email.charsets``: in order given by user
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   727
    3. ``ui.fallbackencoding``: if not in email.charsets
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   728
    4. ``$HGENCODING``: if not in email.charsets
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   729
    5. ``utf-8``: always last, regardless of settings
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   730
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   731
Email example::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   732
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   733
  [email]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   734
  from = Joseph User <joe.user@example.com>
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   735
  method = /usr/sbin/sendmail
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   736
  # charsets for western Europeans
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   737
  # us-ascii, utf-8 omitted, as they are tried first and last
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   738
  charsets = iso-8859-1, iso-8859-15, windows-1252
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   739
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   740
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   741
``extensions``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   742
--------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   743
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   744
Mercurial has an extension mechanism for adding new features. To
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   745
enable an extension, create an entry for it in this section.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   746
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   747
If you know that the extension is already in Python's search path,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   748
you can give the name of the module, followed by ``=``, with nothing
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   749
after the ``=``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   750
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   751
Otherwise, give a name that you choose, followed by ``=``, followed by
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   752
the path to the ``.py`` file (including the file name extension) that
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   753
defines the extension.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   754
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   755
To explicitly disable an extension that is enabled in an hgrc of
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   756
broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   757
or ``foo = !`` when path is not supplied.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   758
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   759
Example for ``~/.hgrc``::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   760
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   761
  [extensions]
31125
01a0ea04c372 help: use 'churn' instead of 'color' as an example extension
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31123
diff changeset
   762
  # (the churn extension will get loaded from Mercurial's path)
01a0ea04c372 help: use 'churn' instead of 'color' as an example extension
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31123
diff changeset
   763
  churn =
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   764
  # (this extension will get loaded from the file specified)
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   765
  myfeature = ~/.hgext/myfeature.py
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   766
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   767
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   768
``format``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   769
----------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   770
26907
dfab6edb98e3 format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26730
diff changeset
   771
``usegeneraldelta``
dfab6edb98e3 format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26730
diff changeset
   772
    Enable or disable the "generaldelta" repository format which improves
dfab6edb98e3 format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26730
diff changeset
   773
    repository compression by allowing "revlog" to store delta against arbitrary
dfab6edb98e3 format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26730
diff changeset
   774
    revision instead of the previous stored one. This provides significant
27606
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   775
    improvement for repositories with branches.
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   776
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   777
    Repositories with this on-disk format require Mercurial version 1.9.
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   778
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   779
    Enabled by default.
26907
dfab6edb98e3 format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26730
diff changeset
   780
27605
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
   781
``dotencode``
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
   782
    Enable or disable the "dotencode" repository format which enhances
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
   783
    the "fncache" repository format (which has to be enabled to use
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
   784
    dotencode) to avoid issues with filenames starting with ._ on
27606
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   785
    Mac OS X and spaces on Windows.
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   786
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   787
    Repositories with this on-disk format require Mercurial version 1.7.
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   788
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   789
    Enabled by default.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   790
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   791
``usefncache``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   792
    Enable or disable the "fncache" repository format which enhances
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   793
    the "store" repository format (which has to be enabled to use
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   794
    fncache) to allow longer filenames and avoids using Windows
27606
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   795
    reserved names, e.g. "nul".
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   796
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   797
    Repositories with this on-disk format require Mercurial version 1.1.
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   798
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   799
    Enabled by default.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   800
27605
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
   801
``usestore``
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
   802
    Enable or disable the "store" repository format which improves
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
   803
    compatibility with systems that fold case or otherwise mangle
27606
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   804
    filenames. Disabling this option will allow you to store longer filenames
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   805
    in some situations at the expense of compatibility.
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   806
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   807
    Repositories with this on-disk format require Mercurial version 0.9.4.
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   808
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   809
    Enabled by default.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   810
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   811
``graph``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   812
---------
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   813
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   814
Web graph view configuration. This section let you change graph
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   815
elements display properties by branches, for instance to make the
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   816
``default`` branch stand out.
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   817
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   818
Each line has the following format::
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   819
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   820
    <branch>.<argument> = <value>
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   821
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   822
where ``<branch>`` is the name of the branch being
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   823
customized. Example::
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   824
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   825
    [graph]
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   826
    # 2px width
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   827
    default.width = 2
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   828
    # red color
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   829
    default.color = FF0000
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   830
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   831
Supported arguments:
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   832
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   833
``width``
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   834
    Set branch edges width in pixels.
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   835
16130
33f702e52906 graph: in hgrc specify line color for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16129
diff changeset
   836
``color``
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   837
    Set branch edges color in hexadecimal RGB notation.
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   838
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   839
``hooks``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   840
---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   841
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   842
Commands or Python functions that get automatically executed by
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   843
various actions such as starting or finishing a commit. Multiple
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   844
hooks can be run for the same action by appending a suffix to the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   845
action. Overriding a site-wide hook can be done by changing its
15896
30c34fde40cc hooks: prioritize run order of hooks
Matt Zuba <matt.zuba@goodwillaz.org>
parents: 15612
diff changeset
   846
value or setting it to an empty string.  Hooks can be prioritized
27551
822927d4d930 help: clarify that the config hook priority prefix includes a period
timeless <timeless@mozdev.org>
parents: 27266
diff changeset
   847
by adding a prefix of ``priority.`` to the hook name on a new line
26178
457c60653c18 help/config: simplify default text
timeless@mozdev.org
parents: 26177
diff changeset
   848
and setting the priority. The default priority is 0.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   849
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   850
Example ``.hg/hgrc``::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   851
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   852
  [hooks]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   853
  # update working directory after adding changesets
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   854
  changegroup.update = hg update
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   855
  # do not use the site-wide hook
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   856
  incoming =
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   857
  incoming.email = /my/email/hook
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   858
  incoming.autobuild = /my/build/hook
15896
30c34fde40cc hooks: prioritize run order of hooks
Matt Zuba <matt.zuba@goodwillaz.org>
parents: 15612
diff changeset
   859
  # force autobuild hook to run before other incoming hooks
30c34fde40cc hooks: prioritize run order of hooks
Matt Zuba <matt.zuba@goodwillaz.org>
parents: 15612
diff changeset
   860
  priority.incoming.autobuild = 1
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   861
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   862
Most hooks are run with environment variables set that give useful
31746
0fa30fbccc34 hook: provide hook type information to external hook
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31591
diff changeset
   863
additional information. For each hook below, the environment variables
0fa30fbccc34 hook: provide hook type information to external hook
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31591
diff changeset
   864
it is passed are listed with names of the form ``$HG_foo``. The
31747
aff7b32b3c05 hook: add hook name information to external hook
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31746
diff changeset
   865
``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
aff7b32b3c05 hook: add hook name information to external hook
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31746
diff changeset
   866
their respectively contains the type of hook which triggered the run and
aff7b32b3c05 hook: add hook name information to external hook
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31746
diff changeset
   867
the full name of the hooks in the config. In the example about this will
aff7b32b3c05 hook: add hook name information to external hook
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31746
diff changeset
   868
be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   869
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   870
``changegroup``
27739
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   871
  Run after a changegroup has been added via push, pull or unbundle.  ID of the
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   872
  first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   873
  from which changes came is in ``$HG_URL``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   874
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   875
``commit``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   876
  Run after a changeset has been created in the local repository. ID
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   877
  of the newly created changeset is in ``$HG_NODE``. Parent changeset
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   878
  IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   879
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   880
``incoming``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   881
  Run after a changeset has been pulled, pushed, or unbundled into
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   882
  the local repository. The ID of the newly arrived changeset is in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   883
  ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   884
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   885
``outgoing``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   886
  Run after sending changes from local repository to another. ID of
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   887
  first changeset sent is in ``$HG_NODE``. Source of operation is in
28077
27ae22a4f9f9 doc: describe full help document hierarchy to create a valid link in HTML
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 28023
diff changeset
   888
  ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   889
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   890
``post-<command>``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   891
  Run after successful invocations of the associated command. The
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   892
  contents of the command line are passed as ``$HG_ARGS`` and the result
17680
16ec37411db5 help: removing trailing spaces
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17424
diff changeset
   893
  code in ``$HG_RESULT``. Parsed command line arguments are passed as
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   894
  ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
17680
16ec37411db5 help: removing trailing spaces
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17424
diff changeset
   895
  the python data internally passed to <command>. ``$HG_OPTS`` is a
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   896
  dictionary of options (with unspecified options set to their defaults).
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   897
  ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   898
29129
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
   899
``fail-<command>``
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
   900
  Run after a failed invocation of an associated command. The contents
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
   901
  of the command line are passed as ``$HG_ARGS``. Parsed command line
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
   902
  arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
   903
  string representations of the python data internally passed to
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
   904
  <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
   905
  options set to their defaults). ``$HG_PATS`` is a list of arguments.
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
   906
  Hook failure is ignored.
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
   907
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   908
``pre-<command>``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   909
  Run before executing the associated command. The contents of the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   910
  command line are passed as ``$HG_ARGS``. Parsed command line arguments
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   911
  are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   912
  representations of the data internally passed to <command>. ``$HG_OPTS``
27552
20589d3bda6d help: remove stray double spaces from config help
timeless <timeless@mozdev.org>
parents: 27551
diff changeset
   913
  is a dictionary of options (with unspecified options set to their
17680
16ec37411db5 help: removing trailing spaces
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17424
diff changeset
   914
  defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   915
  failure, the command doesn't execute and Mercurial returns the failure
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   916
  code.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   917
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   918
``prechangegroup``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   919
  Run before a changegroup is added via push, pull or unbundle. Exit
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   920
  status 0 allows the changegroup to proceed. Non-zero status will
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   921
  cause the push, pull or unbundle to fail. URL from which changes
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   922
  will come is in ``$HG_URL``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   923
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   924
``precommit``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   925
  Run before starting a local commit. Exit status 0 allows the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   926
  commit to proceed. Non-zero status will cause the commit to fail.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   927
  Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   928
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   929
``prelistkeys``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   930
  Run before listing pushkeys (like bookmarks) in the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   931
  repository. Non-zero status will cause failure. The key namespace is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   932
  in ``$HG_NAMESPACE``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   933
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   934
``preoutgoing``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   935
  Run before collecting changes to send from the local repository to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   936
  another. Non-zero status will cause failure. This lets you prevent
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   937
  pull over HTTP or SSH. Also prevents against local pull, push
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   938
  (outbound) or bundle commands, but not effective, since you can
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   939
  just copy files instead then. Source of operation is in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   940
  ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   941
  SSH or HTTP repository. If "push", "pull" or "bundle", operation
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   942
  is happening on behalf of repository on same system.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   943
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   944
``prepushkey``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   945
  Run before a pushkey (like a bookmark) is added to the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   946
  repository. Non-zero status will cause the key to be rejected. The
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   947
  key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   948
  the old value (if any) is in ``$HG_OLD``, and the new value is in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   949
  ``$HG_NEW``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   950
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   951
``pretag``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   952
  Run before creating a tag. Exit status 0 allows the tag to be
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   953
  created. Non-zero status will cause the tag to fail. ID of
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   954
  changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   955
  local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   956
24281
e9ede9b4c2f8 hook: have a generic hook for transaction opening
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 23629
diff changeset
   957
``pretxnopen``
e9ede9b4c2f8 hook: have a generic hook for transaction opening
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 23629
diff changeset
   958
  Run before any new repository transaction is open. The reason for the
24791
89c5881d692c help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24663
diff changeset
   959
  transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
89c5881d692c help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24663
diff changeset
   960
  transaction will be in ``HG_TXNID``. A non-zero status will prevent the
89c5881d692c help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24663
diff changeset
   961
  transaction from being opened.
24281
e9ede9b4c2f8 hook: have a generic hook for transaction opening
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 23629
diff changeset
   962
24284
ff14b26fe5f4 hook: add a generic hook right before we commit a transaction
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24282
diff changeset
   963
``pretxnclose``
27739
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   964
  Run right before the transaction is actually finalized. Any repository change
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   965
  will be visible to the hook program. This lets you validate the transaction
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   966
  content or change it. Exit status 0 allows the commit to proceed. Non-zero
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   967
  status will cause the transaction to be rolled back. The reason for the
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   968
  transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   969
  the transaction will be in ``HG_TXNID``. The rest of the available data will
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   970
  vary according the transaction type. New changesets will add ``$HG_NODE`` (id
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   971
  of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   972
  changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   973
  changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
24284
ff14b26fe5f4 hook: add a generic hook right before we commit a transaction
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24282
diff changeset
   974
24282
db8679812f84 hook: add a generic hook after transaction has been closed
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24281
diff changeset
   975
``txnclose``
24814
60e4258b2052 help: fix typo commited -> committed
Javi Merino <merino.jav@gmail.com>
parents: 24792
diff changeset
   976
  Run after any repository transaction has been committed. At this
24282
db8679812f84 hook: add a generic hook after transaction has been closed
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24281
diff changeset
   977
  point, the transaction can no longer be rolled back. The hook will run
28077
27ae22a4f9f9 doc: describe full help document hierarchy to create a valid link in HTML
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 28023
diff changeset
   978
  after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
26280
5edf3dccb6f7 help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents: 26279
diff changeset
   979
  details about available variables.
24282
db8679812f84 hook: add a generic hook after transaction has been closed
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24281
diff changeset
   980
24792
7d0421de8de3 hooks: add a 'txnabort' hook
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24791
diff changeset
   981
``txnabort``
28077
27ae22a4f9f9 doc: describe full help document hierarchy to create a valid link in HTML
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 28023
diff changeset
   982
  Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
26280
5edf3dccb6f7 help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents: 26279
diff changeset
   983
  docs for details about available variables.
24792
7d0421de8de3 hooks: add a 'txnabort' hook
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24791
diff changeset
   984
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   985
``pretxnchangegroup``
27739
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   986
  Run after a changegroup has been added via push, pull or unbundle, but before
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   987
  the transaction has been committed. Changegroup is visible to hook program.
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   988
  This lets you validate incoming changes before accepting them. Passed the ID
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   989
  of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   990
  Exit status 0 allows the transaction to commit. Non-zero status will cause
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   991
  the transaction to be rolled back and the push, pull or unbundle will fail.
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   992
  URL that was source of changes is in ``$HG_URL``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   993
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   994
``pretxncommit``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   995
  Run after a changeset has been created but the transaction not yet
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   996
  committed. Changeset is visible to hook program. This lets you
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   997
  validate commit message and changes. Exit status 0 allows the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   998
  commit to proceed. Non-zero status will cause the transaction to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   999
  be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1000
  IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1001
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1002
``preupdate``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1003
  Run before updating the working directory. Exit status 0 allows
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1004
  the update to proceed. Non-zero status will prevent the update.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1005
  Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1006
  of second new parent is in ``$HG_PARENT2``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1007
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1008
``listkeys``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1009
  Run after listing pushkeys (like bookmarks) in the repository. The
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1010
  key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1011
  dictionary containing the keys and values.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1012
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1013
``pushkey``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1014
  Run after a pushkey (like a bookmark) is added to the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1015
  repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1016
  ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1017
  value is in ``$HG_NEW``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1018
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1019
``tag``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1020
  Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1021
  Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1022
  repository if ``$HG_LOCAL=0``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1023
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1024
``update``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1025
  Run after updating the working directory. Changeset ID of first
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1026
  new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1027
  in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1028
  update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1029
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
  1030
.. note::
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
  1031
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
  1032
   It is generally better to use standard hooks rather than the
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1033
   generic pre- and post- command hooks as they are guaranteed to be
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1034
   called in the appropriate contexts for influencing transactions.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1035
   Also, hooks like "commit" will be called in all contexts that
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1036
   generate a commit (e.g. tag) and not just the commit command.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1037
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
  1038
.. note::
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
  1039
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
  1040
   Environment variables with empty values may not be passed to
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1041
   hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1042
   will have an empty value under Unix-like platforms for non-merge
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1043
   changesets, while it will not be available at all under Windows.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1044
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1045
The syntax for Python hooks is as follows::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1046
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1047
  hookname = python:modulename.submodule.callable
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1048
  hookname = python:/path/to/python/module.py:callable
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1049
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1050
Python hooks are run within the Mercurial process. Each hook is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1051
called with at least three keyword arguments: a ui object (keyword
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1052
``ui``), a repository object (keyword ``repo``), and a ``hooktype``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1053
keyword that tells what kind of hook is used. Arguments listed as
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1054
environment variables above are passed as keyword arguments, with no
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1055
``HG_`` prefix, and names in lower case.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1056
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1057
If a Python hook returns a "true" value or raises an exception, this
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1058
is treated as a failure.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1059
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1060
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1061
``hostfingerprints``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1062
--------------------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1063
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1064
(Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1065
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1066
Fingerprints of the certificates of known HTTPS servers.
28524
ce1160ae2150 help: add empty lines to hostfingerprints section
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28218
diff changeset
  1067
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1068
A HTTPS connection to a server with a fingerprint configured here will
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1069
only succeed if the servers certificate matches the fingerprint.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1070
This is very similar to how ssh known hosts works.
28524
ce1160ae2150 help: add empty lines to hostfingerprints section
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28218
diff changeset
  1071
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1072
The fingerprint is the SHA-1 hash value of the DER encoded certificate.
28525
dfb21c34e07d sslutil: allow multiple fingerprints per host
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28524
diff changeset
  1073
Multiple values can be specified (separated by spaces or commas). This can
dfb21c34e07d sslutil: allow multiple fingerprints per host
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28524
diff changeset
  1074
be used to define both old and new fingerprints while a host transitions
dfb21c34e07d sslutil: allow multiple fingerprints per host
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28524
diff changeset
  1075
to a new certificate.
28524
ce1160ae2150 help: add empty lines to hostfingerprints section
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28218
diff changeset
  1076
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1077
The CA chain and web.cacerts is not used for servers with a fingerprint.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1078
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1079
For example::
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1080
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1081
    [hostfingerprints]
28191
535f2900d078 help: hg.intevation.de is new primary name of hg.intevation.de (and new cert)
Thomas Arendsen Hein <thomas@intevation.de>
parents: 28057
diff changeset
  1082
    hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
535f2900d078 help: hg.intevation.de is new primary name of hg.intevation.de (and new cert)
Thomas Arendsen Hein <thomas@intevation.de>
parents: 28057
diff changeset
  1083
    hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1084
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1085
``hostsecurity``
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1086
----------------
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1087
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1088
Used to specify global and per-host security settings for connecting to
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1089
other machines.
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1090
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1091
The following options control default behavior for all hosts.
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1092
29577
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1093
``ciphers``
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1094
    Defines the cryptographic ciphers to use for connections.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1095
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1096
    Value must be a valid OpenSSL Cipher List Format as documented at
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1097
    https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1098
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1099
    This setting is for advanced users only. Setting to incorrect values
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1100
    can significantly lower connection security or decrease performance.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1101
    You have been warned.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1102
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1103
    This option requires Python 2.7.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1104
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1105
``minimumprotocol``
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1106
    Defines the minimum channel encryption protocol to use.
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1107
29560
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1108
    By default, the highest version of TLS supported by both client and server
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1109
    is used.
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1110
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1111
    Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1112
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1113
    When running on an old Python version, only ``tls1.0`` is allowed since
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1114
    old versions of Python only support up to TLS 1.0.
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1115
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1116
    When running a Python that supports modern TLS versions, the default is
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1117
    ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1118
    weakens security and should only be used as a feature of last resort if
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1119
    a server does not support TLS 1.1+.
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1120
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1121
Options in the ``[hostsecurity]`` section can have the form
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1122
``hostname``:``setting``. This allows multiple settings to be defined on a
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1123
per-host basis.
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1124
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1125
The following per-host settings can be defined.
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1126
29577
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1127
``ciphers``
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1128
    This behaves like ``ciphers`` as described above except it only applies
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1129
    to the host on which it is defined.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1130
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1131
``fingerprints``
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1132
    A list of hashes of the DER encoded peer/remote certificate. Values have
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1133
    the form ``algorithm``:``fingerprint``. e.g.
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1134
    ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
32274
2b017d22fe97 help: clarify that colons are allowed in fingerprints values
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32260
diff changeset
  1135
    In addition, colons (``:``) can appear in the fingerprint part.
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1136
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1137
    The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1138
    ``sha512``.
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1139
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1140
    Use of ``sha256`` or ``sha512`` is preferred.
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1141
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1142
    If a fingerprint is specified, the CA chain is not validated for this
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1143
    host and Mercurial will require the remote certificate to match one
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1144
    of the fingerprints specified. This means if the server updates its
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1145
    certificate, Mercurial will abort until a new fingerprint is defined.
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1146
    This can provide stronger security than traditional CA-based validation
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1147
    at the expense of convenience.
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1148
29334
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1149
    This option takes precedence over ``verifycertsfile``.
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1150
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1151
``minimumprotocol``
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1152
    This behaves like ``minimumprotocol`` as described above except it
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1153
    only applies to the host on which it is defined.
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1154
29334
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1155
``verifycertsfile``
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1156
    Path to file a containing a list of PEM encoded certificates used to
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1157
    verify the server certificate. Environment variables and ``~user``
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1158
    constructs are expanded in the filename.
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1159
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1160
    The server certificate or the certificate's certificate authority (CA)
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1161
    must match a certificate from this file or certificate verification
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1162
    will fail and connections to the server will be refused.
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1163
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1164
    If defined, only certificates provided by this file will be used:
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1165
    ``web.cacerts`` and any system/default certificates will not be
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1166
    used.
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1167
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1168
    This option has no effect if the per-host ``fingerprints`` option
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1169
    is set.
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1170
29649
512611246ea4 doc: make previous line of certificate example end with "::"
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 29648
diff changeset
  1171
    The format of the file is as follows::
29334
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1172
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1173
        -----BEGIN CERTIFICATE-----
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1174
        ... (certificate in base64 PEM encoding) ...
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1175
        -----END CERTIFICATE-----
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1176
        -----BEGIN CERTIFICATE-----
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1177
        ... (certificate in base64 PEM encoding) ...
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1178
        -----END CERTIFICATE-----
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1179
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1180
For example::
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1181
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1182
    [hostsecurity]
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1183
    hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1184
    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
32274
2b017d22fe97 help: clarify that colons are allowed in fingerprints values
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32260
diff changeset
  1185
    hg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2
29334
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1186
    foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1187
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1188
To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1189
when connecting to ``hg.example.com``::
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1190
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1191
    [hostsecurity]
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1192
    minimumprotocol = tls1.2
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1193
    hg.example.com:minimumprotocol = tls1.1
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1194
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1195
``http_proxy``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1196
--------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1197
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1198
Used to access web-based Mercurial repositories through a HTTP
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1199
proxy.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1200
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1201
``host``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1202
    Host name and (optional) port of the proxy server, for example
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1203
    "myproxy:8000".
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1204
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1205
``no``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1206
    Optional. Comma-separated list of host names that should bypass
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1207
    the proxy.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1208
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1209
``passwd``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1210
    Optional. Password to authenticate with at the proxy server.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1211
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1212
``user``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1213
    Optional. User name to authenticate with at the proxy server.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1214
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1215
``always``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1216
    Optional. Always use the proxy, even for localhost and any entries
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
  1217
    in ``http_proxy.no``. (default: False)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1218
28023
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1219
``merge``
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1220
---------
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1221
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1222
This section specifies behavior during merges and updates.
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1223
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1224
``checkignored``
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1225
   Controls behavior when an ignored file on disk has the same name as a tracked
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1226
   file in the changeset being merged or updated to, and has different
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1227
   contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1228
   abort on such files. With ``warn``, warn on such files and back them up as
29060
db74d95299af help: wrap ".orig" in rst quotes
Sean Farley <sean@farley.io>
parents: 28957
diff changeset
  1229
   ``.orig``. With ``ignore``, don't print a warning and back them up as
db74d95299af help: wrap ".orig" in rst quotes
Sean Farley <sean@farley.io>
parents: 28957
diff changeset
  1230
   ``.orig``. (default: ``abort``)
28023
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1231
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1232
``checkunknown``
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1233
   Controls behavior when an unknown file that isn't ignored has the same name
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1234
   as a tracked file in the changeset being merged or updated to, and has
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1235
   different contents. Similar to ``merge.checkignored``, except for files that
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1236
   are not ignored. (default: ``abort``)
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1237
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1238
``merge-patterns``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1239
------------------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1240
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1241
This section specifies merge tools to associate with particular file
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1242
patterns. Tools matched here will take precedence over the default
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1243
merge tool. Patterns are globs by default, rooted at the repository
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1244
root.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1245
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1246
Example::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1247
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1248
  [merge-patterns]
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1249
  **.c = kdiff3
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1250
  **.jpg = myimgmerge
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1251
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1252
``merge-tools``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1253
---------------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1254
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1255
This section configures external merge tools to use for file-level
21402
c915d066bcac help: add additional information in the merge-tools section of config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 20532
diff changeset
  1256
merges. This section has likely been preconfigured at install time.
c915d066bcac help: add additional information in the merge-tools section of config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 20532
diff changeset
  1257
Use :hg:`config merge-tools` to check the existing configuration.
c915d066bcac help: add additional information in the merge-tools section of config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 20532
diff changeset
  1258
Also see :hg:`help merge-tools` for more details.
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1259
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1260
Example ``~/.hgrc``::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1261
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1262
  [merge-tools]
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1263
  # Override stock tool location
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1264
  kdiff3.executable = ~/bin/kdiff3
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1265
  # Specify command line
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1266
  kdiff3.args = $base $local $other -o $output
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1267
  # Give higher priority
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1268
  kdiff3.priority = 1
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1269
21403
3db723e2dc20 doc: improves merge-tools example with an overwrite of existing config
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 21402
diff changeset
  1270
  # Changing the priority of preconfigured tool
26730
a1e43e85d294 merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents: 26625
diff changeset
  1271
  meld.priority = 0
a1e43e85d294 merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents: 26625
diff changeset
  1272
a1e43e85d294 merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents: 26625
diff changeset
  1273
  # Disable a preconfigured tool
a1e43e85d294 merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents: 26625
diff changeset
  1274
  vimdiff.disabled = yes
21403
3db723e2dc20 doc: improves merge-tools example with an overwrite of existing config
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 21402
diff changeset
  1275
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1276
  # Define new tool
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1277
  myHtmlTool.args = -m $local $other $base $output
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1278
  myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1279
  myHtmlTool.priority = 1
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1280
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1281
Supported arguments:
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1282
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1283
``priority``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1284
  The priority in which to evaluate this tool.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1285
  (default: 0)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1286
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1287
``executable``
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1288
  Either just the name of the executable or its pathname.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1289
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1290
  .. container:: windows
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1291
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1292
    On Windows, the path can use environment variables with ${ProgramFiles}
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1293
    syntax.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1294
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1295
  (default: the tool name)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1296
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1297
``args``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1298
  The arguments to pass to the tool executable. You can refer to the
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1299
  files being merged as well as the output file through these
21527
1f05a7bcde50 help: add local/other description to merge tool description
Durham Goode <durham@fb.com>
parents: 21519
diff changeset
  1300
  variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1f05a7bcde50 help: add local/other description to merge tool description
Durham Goode <durham@fb.com>
parents: 21519
diff changeset
  1301
  of ``$local`` and ``$other`` can vary depending on which action is being
1f05a7bcde50 help: add local/other description to merge tool description
Durham Goode <durham@fb.com>
parents: 21519
diff changeset
  1302
  performed. During and update or merge, ``$local`` represents the original
1f05a7bcde50 help: add local/other description to merge tool description
Durham Goode <durham@fb.com>
parents: 21519
diff changeset
  1303
  state of the file, while ``$other`` represents the commit you are updating
1f05a7bcde50 help: add local/other description to merge tool description
Durham Goode <durham@fb.com>
parents: 21519
diff changeset
  1304
  to or the commit you are merging with. During a rebase ``$local``
1f05a7bcde50 help: add local/other description to merge tool description
Durham Goode <durham@fb.com>
parents: 21519
diff changeset
  1305
  represents the destination of the rebase, and ``$other`` represents the
1f05a7bcde50 help: add local/other description to merge tool description
Durham Goode <durham@fb.com>
parents: 21519
diff changeset
  1306
  commit being rebased.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1307
  (default: ``$local $base $other``)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1308
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1309
``premerge``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1310
  Attempt to run internal non-interactive 3-way merge tool before
22032
d7f25834ffbb merge-tools: add a `premerge=keep-merge3` config option
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 22013
diff changeset
  1311
  launching external tool.  Options are ``true``, ``false``, ``keep`` or
d7f25834ffbb merge-tools: add a `premerge=keep-merge3` config option
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 22013
diff changeset
  1312
  ``keep-merge3``. The ``keep`` option will leave markers in the file if the
d7f25834ffbb merge-tools: add a `premerge=keep-merge3` config option
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 22013
diff changeset
  1313
  premerge fails. The ``keep-merge3`` will do the same but include information
23111
0dae9147c3b6 help: refer ":merge3" instead of "internal:merge3"
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 23075
diff changeset
  1314
  about the base of the merge in the marker (see internal :merge3 in
0dae9147c3b6 help: refer ":merge3" instead of "internal:merge3"
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 23075
diff changeset
  1315
  :hg:`help merge-tools`).
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1316
  (default: True)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1317
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1318
``binary``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1319
  This tool can merge binary files. (default: False, unless tool
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1320
  was selected by file pattern match)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1321
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1322
``symlink``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1323
  This tool can merge symlinks. (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1324
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1325
``check``
26225
e257df7a9974 help/config: back out 5f2a1ebd6e78
Augie Fackler <augie@google.com>
parents: 26182
diff changeset
  1326
  A list of merge success-checking options:
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1327
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1328
  ``changed``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1329
    Ask whether merge was successful when the merged file shows no changes.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1330
  ``conflicts``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1331
    Check whether there are conflicts even though the tool reported success.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1332
  ``prompt``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1333
    Always prompt for merge success, regardless of success reported by tool.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1334
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1335
``fixeol``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1336
  Attempt to fix up EOL changes caused by the merge tool.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1337
  (default: False)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1338
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1339
``gui``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1340
  This tool requires a graphical interface to run. (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1341
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1342
.. container:: windows
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1343
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1344
  ``regkey``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1345
    Windows registry key which describes install location of this
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1346
    tool. Mercurial will search for this key first under
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1347
    ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1348
    (default: None)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1349
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1350
  ``regkeyalt``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1351
    An alternate Windows registry key to try if the first key is not
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1352
    found.  The alternate key uses the same ``regname`` and ``regappend``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1353
    semantics of the primary key.  The most common use for this key
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1354
    is to search for 32bit applications on 64bit operating systems.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1355
    (default: None)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1356
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1357
  ``regname``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1358
    Name of value to read from specified registry key.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1359
    (default: the unnamed (default) value)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1360
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1361
  ``regappend``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1362
    String to append to the value read from the registry, typically
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1363
    the executable name of the tool.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1364
    (default: None)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1365
32099
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1366
``pager``
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1367
---------
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1368
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1369
Setting used to control when to paginate and with what external tool. See
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1370
:hg:`help pager` for details.
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1371
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1372
``pager``
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1373
    Define the external tool used as pager.
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1374
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1375
    If no pager is set, Mercurial uses the environment variable $PAGER.
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1376
    If neither pager.pager, nor $PAGER is set, a default pager will be
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1377
    used, typically `less` on Unix and `more` on Windows. Example::
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1378
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1379
      [pager]
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1380
      pager = less -FRX
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1381
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1382
``ignore``
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1383
    List of commands to disable the pager for. Example::
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1384
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1385
      [pager]
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1386
      ignore = version, help, update
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1387
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1388
``patch``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1389
---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1390
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1391
Settings used when applying patches, for instance through the 'import'
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1392
command or with Mercurial Queues extension.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1393
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1394
``eol``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1395
    When set to 'strict' patch content and patched files end of lines
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1396
    are preserved. When set to ``lf`` or ``crlf``, both files end of
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1397
    lines are ignored when patching and the result line endings are
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1398
    normalized to either LF (Unix) or CRLF (Windows). When set to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1399
    ``auto``, end of lines are again ignored while patching but line
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1400
    endings in patched files are normalized to their original setting
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1401
    on a per-file basis. If target file does not exist or has no end
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1402
    of line, patch line endings are preserved.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1403
    (default: strict)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1404
25631
2748bf78a5bf patch: add fuzz config flag (issue4697)
Matt Mackall <mpm@selenic.com>
parents: 25523
diff changeset
  1405
``fuzz``
2748bf78a5bf patch: add fuzz config flag (issue4697)
Matt Mackall <mpm@selenic.com>
parents: 25523
diff changeset
  1406
    The number of lines of 'fuzz' to allow when applying patches. This
2748bf78a5bf patch: add fuzz config flag (issue4697)
Matt Mackall <mpm@selenic.com>
parents: 25523
diff changeset
  1407
    controls how much context the patcher is allowed to ignore when
2748bf78a5bf patch: add fuzz config flag (issue4697)
Matt Mackall <mpm@selenic.com>
parents: 25523
diff changeset
  1408
    trying to apply a patch.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1409
    (default: 2)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1410
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1411
``paths``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1412
---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1413
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1414
Assigns symbolic names and behavior to repositories.
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1415
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1416
Options are symbolic names defining the URL or directory that is the
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1417
location of the repository. Example::
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1418
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1419
    [paths]
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1420
    my_server = https://example.com/my_repo
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1421
    local_path = /home/me/repo
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1422
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1423
These symbolic names can be used from the command line. To pull
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1424
from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1425
:hg:`push local_path`.
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1426
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1427
Options containing colons (``:``) denote sub-options that can influence
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1428
behavior for that specific path. Example::
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1429
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1430
    [paths]
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1431
    my_server = https://example.com/my_path
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1432
    my_server:pushurl = ssh://example.com/my_path
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1433
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1434
The following sub-options can be defined:
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1435
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1436
``pushurl``
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1437
   The URL to use for push operations. If not defined, the location
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1438
   defined by the path's main entry is used.
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1439
29413
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1440
``pushrev``
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1441
   A revset defining which revisions to push by default.
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1442
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1443
   When :hg:`push` is executed without a ``-r`` argument, the revset
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1444
   defined by this sub-option is evaluated to determine what to push.
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1445
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1446
   For example, a value of ``.`` will push the working directory's
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1447
   revision by default.
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1448
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1449
   Revsets specifying bookmarks will not result in the bookmark being
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1450
   pushed.
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1451
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1452
The following special named paths exist:
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1453
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1454
``default``
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1455
   The URL or directory to use when no source or remote is specified.
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1456
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1457
   :hg:`clone` will automatically define this path to the location the
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1458
   repository was cloned from.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1459
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1460
``default-push``
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1461
   (deprecated) The URL or directory for the default :hg:`push` location.
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1462
   ``default:pushurl`` should be used instead.
17685
8fcef9614150 help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents: 17680
diff changeset
  1463
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1464
``phases``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1465
----------
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1466
16005
591f258ae630 help/config: fix help command markup
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 15999
diff changeset
  1467
Specifies default handling of phases. See :hg:`help phases` for more
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1468
information about working with phases.
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1469
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1470
``publish``
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1471
    Controls draft phase behavior when working as a server. When true,
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1472
    pushed changesets are set to public in both client and server and
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1473
    pulled or cloned changesets are set to public in the client.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1474
    (default: True)
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1475
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1476
``new-commit``
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1477
    Phase of newly-created commits.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1478
    (default: draft)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1479
20176
4c96c50ef937 subrepo: check phase of state in each subrepositories before committing
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 20142
diff changeset
  1480
``checksubrepos``
20333
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
  1481
    Check the phase of the current revision of each subrepository. Allowed
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
  1482
    values are "ignore", "follow" and "abort". For settings other than
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
  1483
    "ignore", the phase of the current revision of each subrepository is
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
  1484
    checked before committing the parent repository. If any of those phases is
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
  1485
    greater than the phase of the parent repository (e.g. if a subrepo is in a
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
  1486
    "secret" phase while the parent repo is in "draft" phase), the commit is
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
  1487
    either aborted (if checksubrepos is set to "abort") or the higher phase is
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
  1488
    used for the parent repository commit (if set to "follow").
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1489
    (default: follow)
20176
4c96c50ef937 subrepo: check phase of state in each subrepositories before committing
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 20142
diff changeset
  1490
4c96c50ef937 subrepo: check phase of state in each subrepositories before committing
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 20142
diff changeset
  1491
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1492
``profiling``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1493
-------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1494
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1495
Specifies profiling type, format, and file output. Two profilers are
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1496
supported: an instrumenting profiler (named ``ls``), and a sampling
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1497
profiler (named ``stat``).
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1498
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1499
In this section description, 'profiling data' stands for the raw data
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1500
collected during profiling, while 'profiling report' stands for a
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1501
statistical text report generated from the profiling data. The
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1502
profiling is done using lsprof.
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1503
29784
e3501546f7e4 profiling: add a context manager that no-ops if profiling isn't enabled
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29780
diff changeset
  1504
``enabled``
e3501546f7e4 profiling: add a context manager that no-ops if profiling isn't enabled
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29780
diff changeset
  1505
    Enable the profiler.
e3501546f7e4 profiling: add a context manager that no-ops if profiling isn't enabled
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29780
diff changeset
  1506
    (default: false)
e3501546f7e4 profiling: add a context manager that no-ops if profiling isn't enabled
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29780
diff changeset
  1507
e3501546f7e4 profiling: add a context manager that no-ops if profiling isn't enabled
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29780
diff changeset
  1508
    This is equivalent to passing ``--profile`` on the command line.
e3501546f7e4 profiling: add a context manager that no-ops if profiling isn't enabled
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29780
diff changeset
  1509
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1510
``type``
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1511
    The type of profiler to use.
30317
3fd53cc1aad8 profiling: make statprof the default profiler (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30316
diff changeset
  1512
    (default: stat)
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1513
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1514
    ``ls``
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1515
      Use Python's built-in instrumenting profiler. This profiler
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1516
      works on all platforms, but each line number it reports is the
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1517
      first line of a function. This restriction makes it difficult to
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1518
      identify the expensive parts of a non-trivial function.
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1519
    ``stat``
30316
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1520
      Use a statistical profiler, statprof. This profiler is most
30347
494d5cec0b07 help: fix double word usage
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30317
diff changeset
  1521
      useful for profiling commands that run for longer than about 0.1
494d5cec0b07 help: fix double word usage
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30317
diff changeset
  1522
      seconds.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1523
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1524
``format``
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1525
    Profiling format.  Specific to the ``ls`` instrumenting profiler.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1526
    (default: text)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1527
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1528
    ``text``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1529
      Generate a profiling report. When saving to a file, it should be
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1530
      noted that only the report is saved, and the profiling data is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1531
      not kept.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1532
    ``kcachegrind``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1533
      Format profiling data for kcachegrind use: when saving to a
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1534
      file, the generated file can directly be loaded into
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1535
      kcachegrind.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1536
30316
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1537
``statformat``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1538
    Profiling format for the ``stat`` profiler.
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1539
    (default: hotpath)
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1540
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1541
    ``hotpath``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1542
      Show a tree-based display containing the hot path of execution (where
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1543
      most time was spent).
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1544
    ``bymethod``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1545
      Show a table of methods ordered by how frequently they are active.
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1546
    ``byline``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1547
      Show a table of lines in files ordered by how frequently they are active.
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1548
    ``json``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1549
      Render profiling data as JSON.
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1550
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1551
``frequency``
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1552
    Sampling frequency.  Specific to the ``stat`` sampling profiler.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1553
    (default: 1000)
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1554
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1555
``output``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1556
    File path where profiling data or report should be saved. If the
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1557
    file exists, it is replaced. (default: None, data is printed on
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1558
    stderr)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1559
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1560
``sort``
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1561
    Sort field.  Specific to the ``ls`` instrumenting profiler.
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1562
    One of ``callcount``, ``reccallcount``, ``totaltime`` and
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1563
    ``inlinetime``.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1564
    (default: inlinetime)
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1565
18548
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
  1566
``limit``
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
  1567
    Number of lines to show. Specific to the ``ls`` instrumenting profiler.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1568
    (default: 30)
18548
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
  1569
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1570
``nested``
18642
a40d608e2a7b profiling: replace '+' markup of nested lines with indentation
Mads Kiilerich <mads@kiilerich.com>
parents: 18636
diff changeset
  1571
    Show at most this number of lines of drill-down info after each main entry.
a40d608e2a7b profiling: replace '+' markup of nested lines with indentation
Mads Kiilerich <mads@kiilerich.com>
parents: 18636
diff changeset
  1572
    This can help explain the difference between Total and Inline.
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1573
    Specific to the ``ls`` instrumenting profiler.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1574
    (default: 5)
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1575
32850
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1576
``showmin``
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1577
    Minimum fraction of samples an entry must have for it to be displayed.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1578
    Can be specified as a float between ``0.0`` and ``1.0`` or can have a
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1579
    ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1580
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1581
    Only used by the ``stat`` profiler.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1582
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1583
    For the ``chrome`` format, default is ``0.005``.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1584
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1585
    The option is unused on other formats.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1586
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1587
``showmax``
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1588
    Maximum fraction of samples an entry can have before it is ignored in
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1589
    display. Values format is the same as ``showmin``.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1590
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1591
    Only used by the ``stat`` profiler.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1592
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1593
    For the ``chrome`` format, default is ``0.999``.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1594
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1595
    The option is unused on other formats.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1596
25520
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1597
``progress``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1598
------------
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1599
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1600
Mercurial commands can draw progress bars that are as informative as
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1601
possible. Some progress bars only offer indeterminate information, while others
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1602
have a definite end point.
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1603
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1604
``delay``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1605
    Number of seconds (float) before showing the progress bar. (default: 3)
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1606
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1607
``changedelay``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1608
    Minimum delay before showing a new topic. When set to less than 3 * refresh,
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1609
    that value will be used instead. (default: 1)
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1610
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1611
``refresh``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1612
    Time in seconds between refreshes of the progress bar. (default: 0.1)
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1613
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1614
``format``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1615
    Format of the progress bar.
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1616
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1617
    Valid entries for the format field are ``topic``, ``bar``, ``number``,
27665
72a25271e294 help: use backticks for progress.format keywords, correct letter case
Anton Shestakov <av6@dwimlabs.net>
parents: 27657
diff changeset
  1618
    ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
72a25271e294 help: use backticks for progress.format keywords, correct letter case
Anton Shestakov <av6@dwimlabs.net>
parents: 27657
diff changeset
  1619
    last 20 characters of the item, but this can be changed by adding either
72a25271e294 help: use backticks for progress.format keywords, correct letter case
Anton Shestakov <av6@dwimlabs.net>
parents: 27657
diff changeset
  1620
    ``-<num>`` which would take the last num characters, or ``+<num>`` for the
72a25271e294 help: use backticks for progress.format keywords, correct letter case
Anton Shestakov <av6@dwimlabs.net>
parents: 27657
diff changeset
  1621
    first num characters.
25520
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1622
27665
72a25271e294 help: use backticks for progress.format keywords, correct letter case
Anton Shestakov <av6@dwimlabs.net>
parents: 27657
diff changeset
  1623
    (default: topic bar number estimate)
25520
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1624
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1625
``width``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1626
    If set, the maximum width of the progress information (that is, min(width,
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
  1627
    term width) will be used).
25520
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1628
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1629
``clear-complete``
26278
be44d23cb9f1 help/config: capitalize items
timeless@mozdev.org
parents: 26263
diff changeset
  1630
    Clear the progress bar after it's done. (default: True)
25520
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1631
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1632
``disable``
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
  1633
    If true, don't show a progress bar.
25520
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1634
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1635
``assume-tty``
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
  1636
    If true, ALWAYS show a progress bar, unless disable is given.
25520
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1637
27746
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1638
``rebase``
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1639
----------
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1640
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1641
``allowdivergence``
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1642
    Default to False, when True allow creating divergence when performing
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1643
    rebase of obsolete changesets.
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1644
14691
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
  1645
``revsetalias``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1646
---------------
14691
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
  1647
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
  1648
Alias definitions for revsets. See :hg:`help revsets` for details.
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
  1649
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1650
``server``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1651
----------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1652
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1653
Controls generic server settings.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1654
30762
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1655
``compressionengines``
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1656
    List of compression engines and their relative priority to advertise
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1657
    to clients.
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1658
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1659
    The order of compression engines determines their priority, the first
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1660
    having the highest priority. If a compression engine is not listed
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1661
    here, it won't be advertised to clients.
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1662
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1663
    If not set (the default), built-in defaults are used. Run
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1664
    :hg:`debuginstall` to list available compression engines and their
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1665
    default wire protocol priority.
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1666
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1667
    Older Mercurial clients only support zlib compression and this setting
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1668
    has no effect for legacy clients.
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1669
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1670
``uncompressed``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1671
    Whether to allow clients to clone a repository using the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1672
    uncompressed streaming protocol. This transfers about 40% more
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1673
    data than a regular clone, but uses less memory and CPU on both
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1674
    server and client. Over a LAN (100 Mbps or better) or a very fast
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1675
    WAN, an uncompressed streaming clone is a lot faster (~10x) than a
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1676
    regular clone. Over most WAN connections (anything slower than
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1677
    about 6 Mbps), uncompressed streaming is slower, because of the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1678
    extra data transfer overhead. This mode will also temporarily hold
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1679
    the write lock while determining what data to transfer.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1680
    (default: True)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1681
32744
33b7283a3828 streamclone: consider secret changesets (BC) (issue5589)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32666
diff changeset
  1682
``uncompressedallowsecret``
33b7283a3828 streamclone: consider secret changesets (BC) (issue5589)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32666
diff changeset
  1683
    Whether to allow stream clones when the repository contains secret
33b7283a3828 streamclone: consider secret changesets (BC) (issue5589)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32666
diff changeset
  1684
    changesets. (default: False)
33b7283a3828 streamclone: consider secret changesets (BC) (issue5589)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32666
diff changeset
  1685
16361
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
  1686
``preferuncompressed``
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
  1687
    When set, clients will try to use the uncompressed streaming
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1688
    protocol. (default: False)
16361
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
  1689
32260
d0d9a4fca59b clone: add a server-side option to disable full getbundles (pull-based clones)
Siddharth Agarwal <sid0@fb.com>
parents: 32139
diff changeset
  1690
``disablefullbundle``
d0d9a4fca59b clone: add a server-side option to disable full getbundles (pull-based clones)
Siddharth Agarwal <sid0@fb.com>
parents: 32139
diff changeset
  1691
    When set, servers will refuse attempts to do pull-based clones.
d0d9a4fca59b clone: add a server-side option to disable full getbundles (pull-based clones)
Siddharth Agarwal <sid0@fb.com>
parents: 32139
diff changeset
  1692
    If this option is set, ``preferuncompressed`` and/or clone bundles
d0d9a4fca59b clone: add a server-side option to disable full getbundles (pull-based clones)
Siddharth Agarwal <sid0@fb.com>
parents: 32139
diff changeset
  1693
    are highly recommended. Partial clones will still be allowed.
d0d9a4fca59b clone: add a server-side option to disable full getbundles (pull-based clones)
Siddharth Agarwal <sid0@fb.com>
parents: 32139
diff changeset
  1694
    (default: False)
d0d9a4fca59b clone: add a server-side option to disable full getbundles (pull-based clones)
Siddharth Agarwal <sid0@fb.com>
parents: 32139
diff changeset
  1695
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1696
``validate``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1697
    Whether to validate the completeness of pushed changesets by
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1698
    checking that all new file revisions specified in manifests are
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1699
    present. (default: False)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1700
25691
5cda0ce05c42 wireproto: add config knob for http header length limit
Mike Edgar <adgar@google.com>
parents: 25649
diff changeset
  1701
``maxhttpheaderlen``
5cda0ce05c42 wireproto: add config knob for http header length limit
Mike Edgar <adgar@google.com>
parents: 25649
diff changeset
  1702
    Instruct HTTP clients not to send request headers longer than this
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1703
    many bytes. (default: 1024)
25691
5cda0ce05c42 wireproto: add config knob for http header length limit
Mike Edgar <adgar@google.com>
parents: 25649
diff changeset
  1704
27246
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1705
``bundle1``
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1706
    Whether to allow clients to push and pull using the legacy bundle1
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1707
    exchange format. (default: True)
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1708
27633
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
  1709
``bundle1gd``
27683
76fc5ac23473 help: fix quoting for bundle1 options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27665
diff changeset
  1710
    Like ``bundle1`` but only used if the repository is using the
27633
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
  1711
    *generaldelta* storage format. (default: True)
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
  1712
27246
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1713
``bundle1.push``
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1714
    Whether to allow clients to push using the legacy bundle1 exchange
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1715
    format. (default: True)
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1716
27633
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
  1717
``bundle1gd.push``
27683
76fc5ac23473 help: fix quoting for bundle1 options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27665
diff changeset
  1718
    Like ``bundle1.push`` but only used if the repository is using the
27633
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
  1719
    *generaldelta* storage format. (default: True)
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
  1720
27246
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1721
``bundle1.pull``
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1722
    Whether to allow clients to pull using the legacy bundle1 exchange
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1723
    format. (default: True)
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1724
27633
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
  1725
``bundle1gd.pull``
27683
76fc5ac23473 help: fix quoting for bundle1 options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27665
diff changeset
  1726
    Like ``bundle1.pull`` but only used if the repository is using the
27633
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
  1727
    *generaldelta* storage format. (default: True)
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
  1728
27246
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1729
    Large repositories using the *generaldelta* storage format should
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1730
    consider setting this option because converting *generaldelta*
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1731
    repositories to the exchange format required by the bundle1 data
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1732
    format can consume a lot of CPU.
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1733
29748
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1734
``zliblevel``
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1735
    Integer between ``-1`` and ``9`` that controls the zlib compression level
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1736
    for wire protocol commands that send zlib compressed output (notably the
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1737
    commands that send repository history data).
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1738
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1739
    The default (``-1``) uses the default zlib compression level, which is
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1740
    likely equivalent to ``6``. ``0`` means no compression. ``9`` means
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1741
    maximum compression.
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1742
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1743
    Setting this option allows server operators to make trade-offs between
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1744
    bandwidth and CPU used. Lowering the compression lowers CPU utilization
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1745
    but sends more bytes to clients.
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1746
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1747
    This option only impacts the HTTP server.
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1748
30764
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1749
``zstdlevel``
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1750
    Integer between ``1`` and ``22`` that controls the zstd compression level
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1751
    for wire protocol commands. ``1`` is the minimal amount of compression and
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1752
    ``22`` is the highest amount of compression.
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1753
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1754
    The default (``3``) should be significantly faster than zlib while likely
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1755
    delivering better compression ratios.
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1756
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1757
    This option only impacts the HTTP server.
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1758
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1759
    See also ``server.zliblevel``.
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1760
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1761
``smtp``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1762
--------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1763
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1764
Configuration for extensions that need to send email messages.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1765
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1766
``host``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1767
    Host name of mail server, e.g. "mail.example.com".
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1768
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1769
``port``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1770
    Optional. Port to connect to on mail server. (default: 465 if
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1771
    ``tls`` is smtps; 25 otherwise)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1772
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1773
``tls``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1774
    Optional. Method to enable TLS when connecting to mail server: starttls,
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1775
    smtps or none. (default: none)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1776
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1777
``username``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1778
    Optional. User name for authenticating with the SMTP server.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1779
    (default: None)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1780
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1781
``password``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1782
    Optional. Password for authenticating with the SMTP server. If not
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1783
    specified, interactive sessions will prompt the user for a
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1784
    password; non-interactive sessions will fail. (default: None)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1785
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1786
``local_hostname``
26180
b1caa076fc3b help/config: change local_hostname help style
timeless@mozdev.org
parents: 26179
diff changeset
  1787
    Optional. The hostname that the sender can use to identify
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1788
    itself to the MTA.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1789
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1790
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1791
``subpaths``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1792
------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1793
16549
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
  1794
Subrepository source URLs can go stale if a remote server changes name
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
  1795
or becomes temporarily unavailable. This section lets you define
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
  1796
rewrite rules of the form::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1797
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1798
    <pattern> = <replacement>
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1799
16549
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
  1800
where ``pattern`` is a regular expression matching a subrepository
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
  1801
source URL and ``replacement`` is the replacement string used to
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
  1802
rewrite it. Groups can be matched in ``pattern`` and referenced in
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
  1803
``replacements``. For instance::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1804
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1805
    http://server/(.*)-hg/ = http://hg.server/\1/
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1806
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1807
rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1808
17251
98166640b356 help: fix some instances of 'the the'
Mads Kiilerich <mads@kiilerich.com>
parents: 17202
diff changeset
  1809
Relative subrepository paths are first made absolute, and the
29368
dd9175ca81dc help: document that [subpaths] may rewrite relative paths
Mike Miller <mike@mtmxr.com>
parents: 28957
diff changeset
  1810
rewrite rules are then applied on the full (absolute) path. If ``pattern``
dd9175ca81dc help: document that [subpaths] may rewrite relative paths
Mike Miller <mike@mtmxr.com>
parents: 28957
diff changeset
  1811
doesn't match the full path, an attempt is made to apply it on the
dd9175ca81dc help: document that [subpaths] may rewrite relative paths
Mike Miller <mike@mtmxr.com>
parents: 28957
diff changeset
  1812
relative path alone. The rules are applied in definition order.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1813
28957
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
  1814
``templatealias``
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
  1815
-----------------
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
  1816
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
  1817
Alias definitions for templates. See :hg:`help templates` for details.
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
  1818
29717
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
  1819
``templates``
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
  1820
-------------
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
  1821
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
  1822
Use the ``[templates]`` section to define template strings.
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
  1823
See :hg:`help templates` for details.
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
  1824
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1825
``trusted``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1826
-----------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1827
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1828
Mercurial will not use the settings in the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1829
``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1830
user or to a trusted group, as various hgrc features allow arbitrary
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1831
commands to be run. This issue is often encountered when configuring
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1832
hooks or extensions for shared repositories or servers. However,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1833
the web interface will use some safe settings from the ``[web]``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1834
section.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1835
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1836
This section specifies what users and groups are trusted. The
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1837
current user is always trusted. To trust everybody, list a user or a
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1838
group with name ``*``. These settings must be placed in an
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1839
*already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1840
user or service running Mercurial.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1841
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1842
``users``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1843
  Comma-separated list of trusted users.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1844
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1845
``groups``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1846
  Comma-separated list of trusted groups.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1847
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1848
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1849
``ui``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1850
------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1851
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1852
User interface controls.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1853
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1854
``archivemeta``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1855
    Whether to include the .hg_archival.txt file containing meta data
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1856
    (hashes for the repository base and for tip) in archives created
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1857
    by the :hg:`archive` command or downloaded via hgweb.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1858
    (default: True)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1859
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1860
``askusername``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1861
    Whether to prompt for a username when committing. If True, and
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1862
    neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1863
    be prompted to enter a username. If no username is entered, the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1864
    default ``USER@HOST`` is used instead.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1865
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1866
27738
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1867
``clonebundles``
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1868
    Whether the "clone bundles" feature is enabled.
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1869
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1870
    When enabled, :hg:`clone` may download and apply a server-advertised
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1871
    bundle file from a URL instead of using the normal exchange mechanism.
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1872
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1873
    This can likely result in faster and more reliable clones.
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1874
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1875
    (default: True)
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1876
26623
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1877
``clonebundlefallback``
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1878
    Whether failure to apply an advertised "clone bundle" from a server
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1879
    should result in fallback to a regular clone.
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1880
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1881
    This is disabled by default because servers advertising "clone
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1882
    bundles" often do so to reduce server load. If advertised bundles
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1883
    start mass failing and clients automatically fall back to a regular
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1884
    clone, this would add significant and unexpected load to the server
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1885
    since the server is expecting clone operations to be offloaded to
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1886
    pre-generated bundles. Failing fast (the default behavior) ensures
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1887
    clients don't overwhelm the server when "clone bundle" application
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1888
    fails.
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1889
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1890
    (default: False)
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1891
27737
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1892
``clonebundleprefers``
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1893
    Defines preferences for which "clone bundles" to use.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1894
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1895
    Servers advertising "clone bundles" may advertise multiple available
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1896
    bundles. Each bundle may have different attributes, such as the bundle
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1897
    type and compression format. This option is used to prefer a particular
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1898
    bundle over another.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1899
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1900
    The following keys are defined by Mercurial:
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1901
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1902
    BUNDLESPEC
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1903
       A bundle type specifier. These are strings passed to :hg:`bundle -t`.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1904
       e.g. ``gzip-v2`` or ``bzip2-v1``.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1905
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1906
    COMPRESSION
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1907
       The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1908
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1909
    Server operators may define custom keys.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1910
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1911
    Example values: ``COMPRESSION=bzip2``,
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1912
    ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1913
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1914
    By default, the first bundle advertised by the server is used.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1915
31123
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
  1916
``color``
32102
9a85ea1daf49 color: turn 'ui.color' into a boolean (auto or off)
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32101
diff changeset
  1917
    When to colorize output. Possible value are Boolean ("yes" or "no"), or
32103
9a98023ac8db color: special case 'always' in 'ui.color'
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32102
diff changeset
  1918
    "debug", or "always". (default: "yes"). "yes" will use color whenever it
9a98023ac8db color: special case 'always' in 'ui.color'
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32102
diff changeset
  1919
    seems possible. See :hg:`help color` for details.
31123
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
  1920
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1921
``commitsubrepos``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1922
    Whether to commit modified subrepositories when committing the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1923
    parent repository. If False and one subrepository has uncommitted
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1924
    changes, abort the commit.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1925
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1926
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1927
``debug``
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
  1928
    Print debugging information. (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1929
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1930
``editor``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1931
    The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1932
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1933
``fallbackencoding``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1934
    Encoding to try if it's not possible to decode the changelog using
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1935
    UTF-8. (default: ISO-8859-1)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1936
27216
8117e2cd959e graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents: 27093
diff changeset
  1937
``graphnodetemplate``
8117e2cd959e graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents: 27093
diff changeset
  1938
    The template used to print changeset nodes in an ASCII revision graph.
8117e2cd959e graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents: 27093
diff changeset
  1939
    (default: ``{graphnode}``)
8117e2cd959e graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents: 27093
diff changeset
  1940
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1941
``ignore``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1942
    A file to read per-user ignore patterns from. This file should be
23629
a04c7b74b3d5 ignore: resolve ignore files relative to repo root (issue4473) (BC)
Siddharth Agarwal <sid0@fb.com>
parents: 23297
diff changeset
  1943
    in the same format as a repository-wide .hgignore file. Filenames
a04c7b74b3d5 ignore: resolve ignore files relative to repo root (issue4473) (BC)
Siddharth Agarwal <sid0@fb.com>
parents: 23297
diff changeset
  1944
    are relative to the repository root. This option supports hook syntax,
a04c7b74b3d5 ignore: resolve ignore files relative to repo root (issue4473) (BC)
Siddharth Agarwal <sid0@fb.com>
parents: 23297
diff changeset
  1945
    so if you want to specify multiple ignore files, you can do so by
a04c7b74b3d5 ignore: resolve ignore files relative to repo root (issue4473) (BC)
Siddharth Agarwal <sid0@fb.com>
parents: 23297
diff changeset
  1946
    setting something like ``ignore.other = ~/.hgignore2``. For details
a04c7b74b3d5 ignore: resolve ignore files relative to repo root (issue4473) (BC)
Siddharth Agarwal <sid0@fb.com>
parents: 23297
diff changeset
  1947
    of the ignore file format, see the ``hgignore(5)`` man page.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1948
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1949
``interactive``
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
  1950
    Allow to prompt the user. (default: True)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1951
28542
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1952
``interface``
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1953
    Select the default interface for interactive features (default: text).
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1954
    Possible values are 'text' and 'curses'.
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1955
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1956
``interface.chunkselector``
29648
94c5273c7d5d doc: fix incorrect use of rst hg role in help text
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 29577
diff changeset
  1957
    Select the interface for change recording (e.g. :hg:`commit -i`).
28542
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1958
    Possible values are 'text' and 'curses'.
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1959
    This config overrides the interface specified by ui.interface.
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1960
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1961
``logtemplate``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1962
    Template string for commands that print changesets.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1963
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1964
``merge``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1965
    The conflict resolution program to use during a manual merge.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1966
    For more information on merge tools see :hg:`help merge-tools`.
14654
e21fd445c297 help/config: quote config section names consistently
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14653
diff changeset
  1967
    For configuring merge tools see the ``[merge-tools]`` section.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1968
21519
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1969
``mergemarkers``
21918
10abc3a5c6b2 filemerge: use 'basic' as the default of '[ui] mergemarkers' for safety
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21527
diff changeset
  1970
    Sets the merge conflict marker label styling. The ``detailed``
21519
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1971
    style uses the ``mergemarkertemplate`` setting to style the labels.
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1972
    The ``basic`` style just uses 'local' and 'other' as the marker label.
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1973
    One of ``basic`` or ``detailed``.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1974
    (default: ``basic``)
21519
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1975
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1976
``mergemarkertemplate``
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1977
    The template used to print the commit description next to each conflict
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1978
    marker during merge conflicts. See :hg:`help templates` for the template
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1979
    format.
26172
e05e5c6ccd2f help/config: add blank lines
timeless@mozdev.org
parents: 26169
diff changeset
  1980
21519
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1981
    Defaults to showing the hash, tags, branches, bookmarks, author, and
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1982
    the first line of the commit description.
26172
e05e5c6ccd2f help/config: add blank lines
timeless@mozdev.org
parents: 26169
diff changeset
  1983
24536
d09262d6ec23 filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents: 23629
diff changeset
  1984
    If you use non-ASCII characters in names for tags, branches, bookmarks,
d09262d6ec23 filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents: 23629
diff changeset
  1985
    authors, and/or commit descriptions, you must pay attention to encodings of
d09262d6ec23 filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents: 23629
diff changeset
  1986
    managed files. At template expansion, non-ASCII characters use the encoding
d09262d6ec23 filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents: 23629
diff changeset
  1987
    specified by the ``--encoding`` global option, ``HGENCODING`` or other
d09262d6ec23 filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents: 23629
diff changeset
  1988
    environment variables that govern your locale. If the encoding of the merge
d09262d6ec23 filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents: 23629
diff changeset
  1989
    markers is different from the encoding of the merged files,
d09262d6ec23 filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents: 23629
diff changeset
  1990
    serious problems may occur.
21519
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1991
26937
dda0aa3baedd cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents: 26907
diff changeset
  1992
``origbackuppath``
dda0aa3baedd cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents: 26907
diff changeset
  1993
    The path to a directory used to store generated .orig files. If the path is
dda0aa3baedd cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents: 26907
diff changeset
  1994
    not a directory, one will be created.
dda0aa3baedd cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents: 26907
diff changeset
  1995
32104
f06d23af6cdf pager: rename 'pager.enable' to 'ui.paginate'
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32103
diff changeset
  1996
``paginate``
f06d23af6cdf pager: rename 'pager.enable' to 'ui.paginate'
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32103
diff changeset
  1997
  Control the pagination of command output (default: True). See :hg:`help pager`
f06d23af6cdf pager: rename 'pager.enable' to 'ui.paginate'
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32103
diff changeset
  1998
  for details.
f06d23af6cdf pager: rename 'pager.enable' to 'ui.paginate'
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32103
diff changeset
  1999
25649
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2000
``patch``
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2001
    An optional external tool that ``hg import`` and some extensions
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2002
    will use for applying patches. By default Mercurial uses an
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2003
    internal patch utility. The external tool must work as the common
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2004
    Unix ``patch`` program. In particular, it must accept a ``-p``
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2005
    argument to strip patch headers, a ``-d`` argument to specify the
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2006
    current directory, a file name to patch, and a patch file to take
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2007
    from stdin.
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2008
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2009
    It is possible to specify a patch tool together with extra
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2010
    arguments. For example, setting this option to ``patch --merge``
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2011
    will use the ``patch`` program with its 2-way merge option.
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2012
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2013
``portablefilenames``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2014
    Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2015
    (default: ``warn``)
27758
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2016
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2017
    ``warn``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2018
      Print a warning message on POSIX platforms, if a file with a non-portable
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2019
      filename is added (e.g. a file with a name that can't be created on
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2020
      Windows because it contains reserved parts like ``AUX``, reserved
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2021
      characters like ``:``, or would cause a case collision with an existing
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2022
      file).
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2023
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2024
    ``ignore``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2025
      Don't print a warning.
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2026
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2027
    ``abort``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2028
      The command is aborted.
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2029
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2030
    ``true``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2031
      Alias for ``warn``.
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2032
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2033
    ``false``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2034
      Alias for ``ignore``.
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2035
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  2036
    .. container:: windows
27758
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2037
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2038
      On Windows, this configuration option is ignored and the command aborted.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2039
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2040
``quiet``
27759
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
  2041
    Reduce the amount of output printed.
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
  2042
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2043
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2044
``remotecmd``
27759
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
  2045
    Remote command to use for clone/push/pull operations.
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
  2046
    (default: ``hg``)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2047
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2048
``report_untrusted``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2049
    Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
27759
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
  2050
    trusted user or group.
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
  2051
    (default: True)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2052
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2053
``slash``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2054
    Display paths using a slash (``/``) as the path separator. This
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2055
    only makes a difference on systems where the default path
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2056
    separator is not the slash character (e.g. Windows uses the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2057
    backslash character (``\``)).
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2058
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2059
24663
7d01371e6358 commands: add ui.statuscopies config knob
Mathias De Maré <mathias.demare@gmail.com>
parents: 24542
diff changeset
  2060
``statuscopies``
7d01371e6358 commands: add ui.statuscopies config knob
Mathias De Maré <mathias.demare@gmail.com>
parents: 24542
diff changeset
  2061
    Display copies in the status command.
7d01371e6358 commands: add ui.statuscopies config knob
Mathias De Maré <mathias.demare@gmail.com>
parents: 24542
diff changeset
  2062
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2063
``ssh``
26278
be44d23cb9f1 help/config: capitalize items
timeless@mozdev.org
parents: 26263
diff changeset
  2064
    Command to use for SSH connections. (default: ``ssh``)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2065
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2066
``strict``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2067
    Require exact command names, instead of allowing unambiguous
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
  2068
    abbreviations. (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2069
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2070
``style``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2071
    Name of style to use for command output.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2072
26263
bf2bfc6f45fb traceback: allow providing a local support contact point
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26225
diff changeset
  2073
``supportcontact``
26313
e8afd380c576 help: copy-edit description of ui.supportcontact
Kevin Bullock <kbullock@ringworld.org>
parents: 26282
diff changeset
  2074
    A URL where users should report a Mercurial traceback. Use this if you are a
e8afd380c576 help: copy-edit description of ui.supportcontact
Kevin Bullock <kbullock@ringworld.org>
parents: 26282
diff changeset
  2075
    large organisation with its own Mercurial deployment process and crash
e8afd380c576 help: copy-edit description of ui.supportcontact
Kevin Bullock <kbullock@ringworld.org>
parents: 26282
diff changeset
  2076
    reports should be addressed to your internal support.
26263
bf2bfc6f45fb traceback: allow providing a local support contact point
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26225
diff changeset
  2077
29070
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
  2078
``textwidth``
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
  2079
    Maximum width of help text. A longer line generated by ``hg help`` or
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
  2080
    ``hg subcommand --help`` will be broken after white space to get this
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
  2081
    width or the terminal width, whichever comes first.
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
  2082
    A non-positive value will disable this and the terminal width will be
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
  2083
    used. (default: 78)
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
  2084
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2085
``timeout``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2086
    The timeout used when a lock is held (in seconds), a negative value
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2087
    means no timeout. (default: 600)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2088
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2089
``traceback``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2090
    Mercurial always prints a traceback when an unknown exception
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2091
    occurs. Setting this to True will make Mercurial print a traceback
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2092
    on all exceptions, even those recognized by Mercurial (such as
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2093
    IOError or MemoryError). (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2094
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2095
``username``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2096
    The committer of a changeset created when running "commit".
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2097
    Typically a person's name and email address, e.g. ``Fred Widget
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2098
    <fred@example.com>``. Environment variables in the
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2099
    username are expanded.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2100
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2101
    (default: ``$EMAIL`` or ``username@hostname``. If the username in
27552
20589d3bda6d help: remove stray double spaces from config help
timeless <timeless@mozdev.org>
parents: 27551
diff changeset
  2102
    hgrc is empty, e.g. if the system admin set ``username =`` in the
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2103
    system hgrc, it has to be specified manually or in a different
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2104
    hgrc file)
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2105
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2106
``verbose``
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
  2107
    Increase the amount of output printed. (default: False)
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2108
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2109
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2110
``web``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  2111
-------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2112
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2113
Web interface configuration. The settings in this section apply to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2114
both the builtin webserver (started by :hg:`serve`) and the script you
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2115
run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2116
and WSGI).
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2117
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2118
The Mercurial webserver does no authentication (it does not prompt for
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2119
usernames and passwords to validate *who* users are), but it does do
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2120
authorization (it grants or denies access for *authenticated users*
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2121
based on settings in this section). You must either configure your
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2122
webserver to do authentication for you, or disable the authorization
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2123
checks.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2124
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2125
For a quick setup in a trusted environment, e.g., a private LAN, where
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2126
you want it to accept pushes from anybody, you can use the following
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2127
command line::
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2128
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2129
    $ hg --config web.allow_push=* --config web.push_ssl=False serve
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2130
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2131
Note that this will allow anybody to push anything to the server and
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2132
that this should not be used for public servers.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2133
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2134
The full set of options is:
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2135
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2136
``accesslog``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2137
    Where to output the access log. (default: stdout)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2138
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2139
``address``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2140
    Interface address to bind to. (default: all)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2141
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2142
``allow_archive``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2143
    List of archive format (bz2, gz, zip) allowed for downloading.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2144
    (default: empty)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2145
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2146
``allowbz2``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2147
    (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2148
    revisions.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2149
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2150
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2151
``allowgz``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2152
    (DEPRECATED) Whether to allow .tar.gz downloading of repository
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2153
    revisions.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2154
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2155
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2156
``allowpull``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2157
    Whether to allow pulling from the repository. (default: True)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2158
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2159
``allow_push``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2160
    Whether to allow pushing to the repository. If empty or not set,
26181
c16f071f048e help/config: reword allow_push to fix grammar
timeless@mozdev.org
parents: 26180
diff changeset
  2161
    pushing is not allowed. If the special value ``*``, any remote
c16f071f048e help/config: reword allow_push to fix grammar
timeless@mozdev.org
parents: 26180
diff changeset
  2162
    user can push, including unauthenticated users. Otherwise, the
c16f071f048e help/config: reword allow_push to fix grammar
timeless@mozdev.org
parents: 26180
diff changeset
  2163
    remote user must have been authenticated, and the authenticated
c16f071f048e help/config: reword allow_push to fix grammar
timeless@mozdev.org
parents: 26180
diff changeset
  2164
    user name must be present in this list. The contents of the
c16f071f048e help/config: reword allow_push to fix grammar
timeless@mozdev.org
parents: 26180
diff changeset
  2165
    allow_push list are examined after the deny_push list.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2166
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2167
``allow_read``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2168
    If the user has not already been denied repository access due to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2169
    the contents of deny_read, this list determines whether to grant
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2170
    repository access to the user. If this list is not empty, and the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2171
    user is unauthenticated or not present in the list, then access is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2172
    denied for the user. If the list is empty or not set, then access
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2173
    is permitted to all users by default. Setting allow_read to the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2174
    special value ``*`` is equivalent to it not being set (i.e. access
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2175
    is permitted to all users). The contents of the allow_read list are
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2176
    examined after the deny_read list.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2177
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2178
``allowzip``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2179
    (DEPRECATED) Whether to allow .zip downloading of repository
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2180
    revisions. This feature creates temporary files.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2181
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2182
17933
8243dd66e0e3 webcommands: allow hgweb's archive to recurse into subrepos
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 17685
diff changeset
  2183
``archivesubrepos``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2184
    Whether to recurse into subrepositories when archiving.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2185
    (default: False)
17933
8243dd66e0e3 webcommands: allow hgweb's archive to recurse into subrepos
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 17685
diff changeset
  2186
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2187
``baseurl``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2188
    Base URL to use when publishing URLs in other locations, so
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2189
    third-party tools like email notification hooks can construct
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2190
    URLs. Example: ``http://hgserver/repos/``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2191
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2192
``cacerts``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2193
    Path to file containing a list of PEM encoded certificate
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2194
    authority certificates. Environment variables and ``~user``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2195
    constructs are expanded in the filename. If specified on the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2196
    client, then it will verify the identity of remote HTTPS servers
16399
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2197
    with these certificates.
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2198
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2199
    To disable SSL verification temporarily, specify ``--insecure`` from
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2200
    command line.
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2201
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2202
    You can use OpenSSL's CA certificate file if your platform has
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2203
    one. On most Linux systems this will be
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2204
    ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2205
    generate this file manually. The form must be as follows::
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2206
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2207
        -----BEGIN CERTIFICATE-----
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2208
        ... (certificate in base64 PEM encoding) ...
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2209
        -----END CERTIFICATE-----
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2210
        -----BEGIN CERTIFICATE-----
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2211
        ... (certificate in base64 PEM encoding) ...
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2212
        -----END CERTIFICATE-----
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2213
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2214
``cache``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2215
    Whether to support caching in hgweb. (default: True)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2216
25853
81802d1355ac hgweb: document web.certificates option
Matt Mackall <mpm@selenic.com>
parents: 25691
diff changeset
  2217
``certificate``
81802d1355ac hgweb: document web.certificates option
Matt Mackall <mpm@selenic.com>
parents: 25691
diff changeset
  2218
    Certificate to use when running :hg:`serve`.
81802d1355ac hgweb: document web.certificates option
Matt Mackall <mpm@selenic.com>
parents: 25691
diff changeset
  2219
16570
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
  2220
``collapse``
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
  2221
    With ``descend`` enabled, repositories in subdirectories are shown at
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
  2222
    a single level alongside repositories in the current path. With
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
  2223
    ``collapse`` also enabled, repositories residing at a deeper level than
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
  2224
    the current path are grouped behind navigable directory entries that
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
  2225
    lead to the locations of these repositories. In effect, this setting
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
  2226
    collapses each collection of repositories found within a subdirectory
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2227
    into a single entry for that subdirectory. (default: False)
16570
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
  2228
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2229
``comparisoncontext``
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2230
    Number of lines of context to show in side-by-side file comparison. If
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2231
    negative or the value ``full``, whole files are shown. (default: 5)
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2232
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2233
    This setting can be overridden by a ``context`` request parameter to the
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2234
    ``comparison`` command, taking the same values.
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2235
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2236
``contact``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2237
    Name or email address of the person in charge of the repository.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2238
    (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2239
30766
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2240
``csp``
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2241
    Send a ``Content-Security-Policy`` HTTP header with this value.
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2242
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2243
    The value may contain a special string ``%nonce%``, which will be replaced
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2244
    by a randomly-generated one-time use value. If the value contains
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2245
    ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2246
    one-time property of the nonce. This nonce will also be inserted into
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2247
    ``<script>`` elements containing inline JavaScript.
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2248
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2249
    Note: lots of HTML content sent by the server is derived from repository
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2250
    data. Please consider the potential for malicious repository data to
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2251
    "inject" itself into generated HTML content as part of your security
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2252
    threat model.
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2253
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2254
``deny_push``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2255
    Whether to deny pushing to the repository. If empty or not set,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2256
    push is not denied. If the special value ``*``, all remote users are
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2257
    denied push. Otherwise, unauthenticated users are all denied, and
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2258
    any authenticated user name present in this list is also denied. The
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2259
    contents of the deny_push list are examined before the allow_push list.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2260
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2261
``deny_read``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2262
    Whether to deny reading/viewing of the repository. If this list is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2263
    not empty, unauthenticated users are all denied, and any
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2264
    authenticated user name present in this list is also denied access to
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2265
    the repository. If set to the special value ``*``, all remote users
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2266
    are denied access (rarely needed ;). If deny_read is empty or not set,
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2267
    the determination of repository access depends on the presence and
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2268
    content of the allow_read list (see description). If both
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2269
    deny_read and allow_read are empty or not set, then access is
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2270
    permitted to all users by default. If the repository is being
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2271
    served via hgwebdir, denied users will not be able to see it in
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2272
    the list of repositories. The contents of the deny_read list have
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2273
    priority over (are examined before) the contents of the allow_read
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2274
    list.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2275
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2276
``descend``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2277
    hgwebdir indexes will not descend into subdirectories. Only repositories
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2278
    directly in the current path will be shown (other repositories are still
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2279
    available from the index corresponding to their containing path).
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2280
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2281
``description``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2282
    Textual description of the repository's purpose or contents.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2283
    (default: "unknown")
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2284
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2285
``encoding``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2286
    Character encoding name. (default: the current locale charset)
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
  2287
    Example: "UTF-8".
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2288
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2289
``errorlog``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2290
    Where to output the error log. (default: stderr)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2291
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2292
``guessmime``
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2293
    Control MIME types for raw download of file content.
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2294
    Set to True to let hgweb guess the content type from the file
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2295
    extension. This will serve HTML files as ``text/html`` and might
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2296
    allow cross-site scripting attacks when serving untrusted
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2297
    repositories. (default: False)
17202
1ae119269ddc hgweb: side-by-side comparison functionality
wujek srujek
parents: 16585
diff changeset
  2298
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2299
``hidden``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2300
    Whether to hide the repository in the hgwebdir index.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2301
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2302
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2303
``ipv6``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2304
    Whether to use IPv6. (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2305
29471
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
  2306
``labels``
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
  2307
    List of string *labels* associated with the repository.
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
  2308
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
  2309
    Labels are exposed as a template keyword and can be used to customize
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
  2310
    output. e.g. the ``index`` template can group or filter repositories
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
  2311
    by labels and the ``summary`` template can display additional content
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
  2312
    if a specific label is present.
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
  2313
14938
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
  2314
``logoimg``
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
  2315
    File name of the logo image that some templates display on each page.
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
  2316
    The file name is relative to ``staticurl``. That is, the full path to
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
  2317
    the logo image is "staticurl/logoimg".
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
  2318
    If unset, ``hglogo.png`` will be used.
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
  2319
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2320
``logourl``
26421
4b0fc75f9403 urls: bulk-change primary website URLs
Matt Mackall <mpm@selenic.com>
parents: 26365
diff changeset
  2321
    Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2322
    will be used.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2323
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2324
``maxchanges``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2325
    Maximum number of changes to list on the changelog. (default: 10)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2326
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2327
``maxfiles``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2328
    Maximum number of files to list per changeset. (default: 10)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2329
17317
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
  2330
``maxshortchanges``
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
  2331
    Maximum number of changes to list on the shortlog, graph or filelog
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2332
    pages. (default: 60)
17317
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
  2333
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2334
``name``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2335
    Repository name to use in the web interface.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2336
    (default: current working directory)
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2337
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2338
``port``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2339
    Port to listen on. (default: 8000)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2340
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2341
``prefix``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2342
    Prefix path to serve from. (default: '' (server root))
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2343
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2344
``push_ssl``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2345
    Whether to require that inbound pushes be transported over SSL to
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2346
    prevent password sniffing. (default: True)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2347
26072
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
  2348
``refreshinterval``
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
  2349
    How frequently directory listings re-scan the filesystem for new
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
  2350
    repositories, in seconds. This is relevant when wildcards are used
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
  2351
    to define paths. Depending on how much filesystem traversal is
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
  2352
    required, refreshing may negatively impact performance.
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
  2353
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2354
    Values less than or equal to 0 always refresh.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2355
    (default: 20)
26072
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
  2356
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2357
``staticurl``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2358
    Base URL to use for static files. If unset, static files (e.g. the
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2359
    hgicon.png favicon) will be served by the CGI script itself. Use
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2360
    this setting to serve them directly with the HTTP server.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2361
    Example: ``http://hgserver/static/``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2362
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2363
``stripes``
17424
e7cfe3587ea4 fix trivial spelling errors
Mads Kiilerich <mads@kiilerich.com>
parents: 17317
diff changeset
  2364
    How many lines a "zebra stripe" should span in multi-line output.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2365
    Set to 0 to disable. (default: 1)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2366
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2367
``style``
22549
b1fc7ea5bb01 help: update help for hgweb template and style (issue4373)
Arun Chandrasekaran <visionofarun@gmail.com>
parents: 22252
diff changeset
  2368
    Which template map style to use. The available options are the names of
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2369
    subdirectories in the HTML templates path. (default: ``paper``)
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2370
    Example: ``monoblue``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2371
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2372
``templates``
22549
b1fc7ea5bb01 help: update help for hgweb template and style (issue4373)
Arun Chandrasekaran <visionofarun@gmail.com>
parents: 22252
diff changeset
  2373
    Where to find the HTML templates. The default path to the HTML templates
b1fc7ea5bb01 help: update help for hgweb template and style (issue4373)
Arun Chandrasekaran <visionofarun@gmail.com>
parents: 22252
diff changeset
  2374
    can be obtained from ``hg debuginstall``.
18628
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2375
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2376
``websub``
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2377
----------
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2378
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2379
Web substitution filter definition. You can use this section to
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2380
define a set of regular expression substitution patterns which
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2381
let you automatically modify the hgweb server output.
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2382
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2383
The default hgweb templates only apply these substitution patterns
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2384
on the revision description fields. You can apply them anywhere
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2385
you want when you create your own templates by adding calls to the
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2386
"websub" filter (usually after calling the "escape" filter).
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2387
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2388
This can be used, for example, to convert issue references to links
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2389
to your issue tracker, or to convert "markdown-like" syntax into
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2390
HTML (see the examples below).
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2391
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2392
Each entry in this section names a substitution filter.
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2393
The value of each entry defines the substitution expression itself.
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2394
The websub expressions follow the old interhg extension syntax,
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2395
which in turn imitates the Unix sed replacement syntax::
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2396
18958
c3b920980f22 spelling: fix typos and spelling errors
Mads Kiilerich <madski@unity3d.com>
parents: 18888
diff changeset
  2397
    patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
18628
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2398
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2399
You can use any separator other than "/". The final "i" is optional
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2400
and indicates that the search must be case insensitive.
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2401
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2402
Examples::
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2403
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2404
    [websub]
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2405
    issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2406
    italic = s/\b_(\S+)_\b/<i>\1<\/i>/
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2407
    bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
18652
a5e94bee77ed merge crew and main
Benoit Boissinot <benoit.boissinot@ens-lyon.org>
parents: 18642 18628
diff changeset
  2408
18636
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2409
``worker``
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2410
----------
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2411
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2412
Parallel master/worker configuration. We currently perform working
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2413
directory updates in parallel on Unix-like systems, which greatly
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2414
helps performance.
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2415
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2416
``numcpus``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2417
    Number of CPUs to use for parallel operations. A zero or
18636
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2418
    negative value is treated as ``use the default``.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2419
    (default: 4 or the number of CPUs on the system, whichever is larger)
27895
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2420
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2421
``backgroundclose``
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2422
    Whether to enable closing file handles on background threads during certain
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2423
    operations. Some platforms aren't very efficient at closing file
27986
a58378983687 help: fix typo in backgroundclose documentation
André Sintzoff <andre.sintzoff@gmail.com>
parents: 27960
diff changeset
  2424
    handles that have been written or appended to. By performing file closing
27895
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2425
    on background threads, file write rate can increase substantially.
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2426
    (default: true on Windows, false elsewhere)
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2427
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2428
``backgroundcloseminfilecount``
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2429
    Minimum number of files required to trigger background file closing.
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2430
    Operations not writing this many files won't start background close
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2431
    threads.
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2432
    (default: 2048)
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2433
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2434
``backgroundclosemaxqueue``
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2435
    The maximum number of opened file handles waiting to be closed in the
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2436
    background. This option only has an effect if ``backgroundclose`` is
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2437
    enabled.
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2438
    (default: 384)
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2439
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2440
``backgroundclosethreadcount``
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2441
    Number of threads to process background file closes. Only relevant if
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2442
    ``backgroundclose`` is enabled.
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2443
    (default: 4)