mercurial/help/config.txt
author Mark Thomas <mbthomas@fb.com>
Mon, 11 Sep 2017 17:49:49 +0000
changeset 34146 9e4f82bc2b0b
parent 34013 da07367d683b
child 34314 a667f0ca1d5f
permissions -rw-r--r--
scmutil: don't append .orig to backups in origbackuppath (BC) When ui.origbackuppath is set, .orig files are stored outside of the working copy, however they still have a .orig suffix appended to them. This can cause unexpected conflicts, particularly when tracked files or directories have .orig at the end. This change removes the .orig suffix from files stored in an out-of-tree origbackuppath. Test Plan: Update and run unit tests. Differential Revision: https://phab.mercurial-scm.org/D679
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
34013
da07367d683b mdiff: add a --ignore-space-at-eol option
David Soria Parra <davidsp@fb.com>
parents: 33260
diff changeset
   316
``ignorewseol``
da07367d683b mdiff: add a --ignore-space-at-eol option
David Soria Parra <davidsp@fb.com>
parents: 33260
diff changeset
   317
    Ignore white space at the end of a line when comparing lines.
da07367d683b mdiff: add a --ignore-space-at-eol option
David Soria Parra <davidsp@fb.com>
parents: 33260
diff changeset
   318
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   319
``ignorewsamount``
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   320
    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
   321
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   322
``ignoreblanklines``
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   323
    Ignore changes whose lines are all blank.
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   324
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   325
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   326
``auth``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   327
--------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   328
31936
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   329
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
   330
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
   331
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
   332
: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
   333
your HTTP server.
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   334
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   335
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
   336
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   337
``cookiefile``
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   338
    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
   339
    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
   340
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   341
    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
   342
    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
   343
    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
   344
    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
   345
    format."
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   346
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   347
    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
   348
    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
   349
    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
   350
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   351
    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
   352
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
   353
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
   354
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
   355
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   356
    <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
   357
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   358
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
   359
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
   360
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
   361
    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
   362
    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
   363
    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
   364
    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
   365
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.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
   367
    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
   368
    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
   369
    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
   370
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   371
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
   372
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   373
``prefix``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   374
    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
   375
    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
   376
    (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
   377
    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
   378
    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
   379
    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
   380
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   381
``username``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   382
    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
   383
    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
   384
    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
   385
    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
   386
    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
   387
    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
   388
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   389
``password``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   390
    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
   391
    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
   392
    will be prompted for it.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   393
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   394
``key``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   395
    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
   396
    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
   397
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   398
``cert``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   399
    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
   400
    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
   401
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   402
``schemes``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   403
    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
   404
    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
   405
    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
   406
    static-http and static-https respectively, as well.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
   407
    (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
   408
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   409
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
   410
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
   411
31123
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   412
``color``
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   413
---------
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
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
   416
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
   417
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   418
``mode``
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   419
    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
   420
    ``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
   421
    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
   422
    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
   423
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   424
``pagermode``
32139
de86a6872d06 help: spelling fixes
Matt Harbison <matt_harbison@yahoo.com>
parents: 32104
diff changeset
   425
    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
   426
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   427
    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
   428
    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
   429
    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
   430
    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
   431
    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
   432
    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
   433
    codes).
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   434
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
   435
    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
   436
    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
   437
31557
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
   438
``commands``
31591
2c02bb7fd7fc help: format ``commands`` heading correctly
Martin von Zweigbergk <martinvonz@google.com>
parents: 31589
diff changeset
   439
------------
31557
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
   440
31589
7e3b145f8247 status: support commands.status.relative config
Martin von Zweigbergk <martinvonz@google.com>
parents: 31557
diff changeset
   441
``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
   442
    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
   443
    (default: False)
7e3b145f8247 status: support commands.status.relative config
Martin von Zweigbergk <martinvonz@google.com>
parents: 31557
diff changeset
   444
31557
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
   445
``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
   446
    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
   447
    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
   448
    will be disallowed.
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
   449
    (default: False)
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
   450
21924
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   451
``committemplate``
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   452
------------------
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   453
26169
ea888285311f help: config indent committemplate.changeset section
timeless@mozdev.org
parents: 26072
diff changeset
   454
``changeset``
ea888285311f help: config indent committemplate.changeset section
timeless@mozdev.org
parents: 26072
diff changeset
   455
    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
   456
    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
   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
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
   459
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
   460
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   461
``extramsg``
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   462
    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
   463
    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
   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
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
   466
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
   467
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   468
    [committemplate]
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   469
    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
   470
        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
   471
        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
   472
        HG: --
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   473
        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
   474
       "HG: branch merge\n")
25014
7e5d5160073b templatekw: replace currentbookmark with activebookmark keyword
Ryan McElroy <rmcelroy@fb.com>
parents: 24830
diff changeset
   475
       }HG: branch '{branch}'\n{if(activebookmark,
7e5d5160073b templatekw: replace currentbookmark with activebookmark keyword
Ryan McElroy <rmcelroy@fb.com>
parents: 24830
diff changeset
   476
       "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
   477
       "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
   478
       "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
   479
       "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
   480
       "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
   481
       "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
   482
30704
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   483
``diff()``
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   484
    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
   485
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   486
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
   487
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
   488
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
   489
it::
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   490
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   491
     HG: ------------------------ >8 ------------------------
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
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
   494
extra message::
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   495
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   496
    [committemplate]
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   497
    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
   498
        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
   499
        HG: {extramsg}
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   500
        HG: ------------------------ >8 ------------------------
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   501
        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
   502
        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
   503
        {diff()}
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
   504
21924
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   505
.. note::
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   506
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   507
   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
   508
   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
   509
   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
   510
26281
5cac3bdb3c67 help/config: reword committemplate multibyte character text
timeless@mozdev.org
parents: 26280
diff changeset
   511
   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
   512
   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
   513
   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
   514
   (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
   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
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
   517
required):
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
   518
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:`backout`
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:`commit`
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:`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
   522
- :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
   523
- :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
   524
- :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
   525
- :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
   526
- :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
   527
- :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
   528
- :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
   529
- :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
   530
- :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
   531
22012
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   532
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
   533
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
   534
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
   535
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   536
- ``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
   537
- ``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
   538
- ``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
   539
- ``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
   540
- ``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
   541
- ``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
   542
- ``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
   543
- ``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
   544
- ``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
   545
- ``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
   546
- ``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
   547
- ``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
   548
- ``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
   549
- ``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
   550
- ``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
   551
- ``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
   552
- ``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
   553
- ``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
   554
- ``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
   555
- ``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
   556
- ``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
   557
- ``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
   558
- ``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
   559
- ``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
   560
- ``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
   561
- ``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
   562
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
   563
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
   564
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
   565
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
   566
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
   567
26282
436f5ab16079 help/config: reword committemplate external editor text
timeless@mozdev.org
parents: 26281
diff changeset
   568
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
   569
dot-separated list of names without the ``changeset.`` prefix
436f5ab16079 help/config: reword committemplate external editor text
timeless@mozdev.org
parents: 26281
diff changeset
   570
(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
   571
variable.
22205
9fa429723f26 ui: invoke editor for committing with HGEDITFORM environment variable
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22158
diff changeset
   572
22013
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   573
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
   574
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
   575
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
   576
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   577
    [committemplate]
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
   578
    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
   579
       "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
   580
       "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
   581
       "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
   582
       "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
   583
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   584
``decode/encode``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   585
-----------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   586
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   587
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
   588
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
   589
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
   590
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   591
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
   592
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
   593
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
   594
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
   595
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
   596
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
   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
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
   599
``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
   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
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
   602
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
   603
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   604
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
   605
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   606
  [encode]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   607
  # 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
   608
  # 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
   609
  *.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
   610
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   611
  [decode]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   612
  # 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
   613
  # 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
   614
  *.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
   615
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   616
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
   617
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
   618
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
   619
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
   620
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
   621
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
   622
.. container:: windows
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
   623
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
   624
   .. note::
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
   625
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
   626
     The tempfile mechanism is recommended for Windows systems,
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
   627
     where the standard shell I/O redirection operators often have
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
   628
     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
   629
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   630
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
   631
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
   632
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
   633
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   634
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   635
``defaults``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   636
------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   637
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
   638
(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
   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
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
   641
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
   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
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
   644
: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
   645
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   646
  [defaults]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   647
  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
   648
  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
   649
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   650
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
   651
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
   652
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
   653
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   654
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   655
``diff``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   656
--------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   657
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
   658
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
   659
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
   660
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
   661
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   662
``git``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   663
    Use git extended diff format.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   664
22602
551d776a0a9a diff: document the nobinary option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 21924
diff changeset
   665
``nobinary``
551d776a0a9a diff: document the nobinary option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 21924
diff changeset
   666
    Omit git binary patches.
551d776a0a9a diff: document the nobinary option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 21924
diff changeset
   667
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   668
``nodates``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   669
    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
   670
23297
d7abae94a7a0 patch.diffopts: add support for noprefix
Siddharth Agarwal <sid0@fb.com>
parents: 23142
diff changeset
   671
``noprefix``
d7abae94a7a0 patch.diffopts: add support for noprefix
Siddharth Agarwal <sid0@fb.com>
parents: 23142
diff changeset
   672
    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
   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
``showfunc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   675
    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
   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
``ignorews``
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 white space when comparing lines.
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
``ignorewsamount``
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 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
   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
``ignoreblanklines``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   684
    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
   685
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   686
``unified``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   687
    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
   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
``email``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   690
---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   691
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   692
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
   693
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   694
``from``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   695
    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
   696
    of outgoing messages.
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
``to``
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 recipients' email addresses.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   700
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   701
``cc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   702
    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
   703
    email addresses.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   704
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   705
``bcc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   706
    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
   707
    email addresses.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   708
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
``method``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   710
    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
   711
    (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
   712
    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
   713
    (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
   714
    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
   715
    ``/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
   716
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   717
``charsets``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   718
    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
   719
    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
   720
    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
   721
    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
   722
    (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
   723
    conversion fails, the text in question is sent as is.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
   724
    (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
   725
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   726
    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
   727
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   728
    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
   729
    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
   730
    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
   731
    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
   732
    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
   733
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   734
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
   735
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   736
  [email]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   737
  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
   738
  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
   739
  # 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
   740
  # 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
   741
  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
   742
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
``extensions``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   745
--------------
14456
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
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
   748
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
   749
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   750
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
   751
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
   752
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
   753
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   754
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
   755
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
   756
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
   757
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   758
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
   759
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
   760
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
   761
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   762
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
   763
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   764
  [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
   765
  # (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
   766
  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
   767
  # (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
   768
  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
   769
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   770
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   771
``format``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   772
----------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   773
26907
dfab6edb98e3 format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26730
diff changeset
   774
``usegeneraldelta``
dfab6edb98e3 format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26730
diff changeset
   775
    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
   776
    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
   777
    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
   778
    improvement for repositories with branches.
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   779
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   780
    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
   781
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   782
    Enabled by default.
26907
dfab6edb98e3 format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26730
diff changeset
   783
27605
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
   784
``dotencode``
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
   785
    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
   786
    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
   787
    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
   788
    Mac OS X and spaces on Windows.
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   789
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   790
    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
   791
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   792
    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
   793
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   794
``usefncache``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   795
    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
   796
    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
   797
    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
   798
    reserved names, e.g. "nul".
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   799
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   800
    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
   801
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   802
    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
   803
27605
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
   804
``usestore``
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
   805
    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
   806
    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
   807
    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
   808
    in some situations at the expense of compatibility.
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   809
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   810
    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
   811
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
   812
    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
   813
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   814
``graph``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   815
---------
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   816
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   817
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
   818
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
   819
``default`` branch stand out.
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   820
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   821
Each line has the following format::
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   822
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   823
    <branch>.<argument> = <value>
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   824
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   825
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
   826
customized. Example::
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   827
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   828
    [graph]
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   829
    # 2px width
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   830
    default.width = 2
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   831
    # red color
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   832
    default.color = FF0000
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   833
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   834
Supported arguments:
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   835
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
   836
``width``
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   837
    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
   838
16130
33f702e52906 graph: in hgrc specify line color for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16129
diff changeset
   839
``color``
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
   840
    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
   841
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   842
``hooks``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
   843
---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   844
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   845
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
   846
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
   847
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
   848
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
   849
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
   850
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
   851
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
   852
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   853
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
   854
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   855
  [hooks]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   856
  # 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
   857
  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
   858
  # 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
   859
  incoming =
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   860
  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
   861
  incoming.autobuild = /my/build/hook
15896
30c34fde40cc hooks: prioritize run order of hooks
Matt Zuba <matt.zuba@goodwillaz.org>
parents: 15612
diff changeset
   862
  # 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
   863
  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
   864
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   865
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
   866
additional information. For each hook below, the environment variables
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   867
it is passed are listed with names in 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
   868
``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   869
They contain the type of hook which triggered the run and the full name
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   870
of the hook in the config, respectively. In the example above, this will
31747
aff7b32b3c05 hook: add hook name information to external hook
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31746
diff changeset
   871
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
   872
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   873
``changegroup``
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   874
  Run after a changegroup has been added via push, pull or unbundle.  The ID of
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   875
  the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   876
  The URL 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
   877
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   878
``commit``
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   879
  Run after a changeset has been created in the local repository. The ID
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
  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
   881
  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
   882
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   883
``incoming``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   884
  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
   885
  the local repository. The ID of the newly arrived changeset is in
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   886
  ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   887
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   888
``outgoing``
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   889
  Run after sending changes from the local repository to another. The ID of
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   890
  first changeset sent is in ``$HG_NODE``. The source of operation is in
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   891
  ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   892
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   893
``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
   894
  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
   895
  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
   896
  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
   897
  ``$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
   898
  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
   899
  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
   900
  ``$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
   901
29129
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
   902
``fail-<command>``
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
   903
  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
   904
  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
   905
  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
   906
  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
   907
  <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
   908
  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
   909
  Hook failure is ignored.
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
   910
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   911
``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
   912
  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
   913
  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
   914
  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
   915
  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
   916
  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
   917
  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
   918
  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
   919
  code.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   920
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   921
``prechangegroup``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   922
  Run before a changegroup is added via push, pull or unbundle. Exit
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   923
  status 0 allows the changegroup to proceed. A non-zero status will
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   924
  cause the push, pull or unbundle to fail. The URL from which changes
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   925
  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
   926
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   927
``precommit``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   928
  Run before starting a local commit. Exit status 0 allows the
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   929
  commit to proceed. A non-zero status will cause the commit to fail.
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   930
  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
   931
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   932
``prelistkeys``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   933
  Run before listing pushkeys (like bookmarks) in the
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   934
  repository. A non-zero status will cause failure. The key namespace is
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   935
  in ``$HG_NAMESPACE``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   936
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   937
``preoutgoing``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   938
  Run before collecting changes to send from the local repository to
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   939
  another. A non-zero status will cause failure. This lets you prevent
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   940
  pull over HTTP or SSH. It can also prevent propagating commits (via
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   941
  local pull, push (outbound) or bundle commands), but not completely,
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   942
  since you can just copy files instead. The source of operation is in
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   943
  ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   944
  SSH or HTTP repository. If "push", "pull" or "bundle", the operation
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   945
  is happening on behalf of a repository on same system.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   946
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   947
``prepushkey``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   948
  Run before a pushkey (like a bookmark) is added to the
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   949
  repository. A non-zero status will cause the key to be rejected. 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
   950
  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
   951
  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
   952
  ``$HG_NEW``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   953
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   954
``pretag``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   955
  Run before creating a tag. Exit status 0 allows the tag to be
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   956
  created. A non-zero status will cause the tag to fail. The ID of the
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   957
  changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   958
  tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
   959
24281
e9ede9b4c2f8 hook: have a generic hook for transaction opening
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 23629
diff changeset
   960
``pretxnopen``
e9ede9b4c2f8 hook: have a generic hook for transaction opening
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 23629
diff changeset
   961
  Run before any new repository transaction is open. The reason for the
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   962
  transaction will be in ``$HG_TXNNAME``, and a unique identifier 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
   963
  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
   964
  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
   965
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
   966
``pretxnclose``
27739
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   967
  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
   968
  will be visible to the hook program. This lets you validate the transaction
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   969
  content or change it. Exit status 0 allows the commit to proceed. A non-zero
27739
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   970
  status will cause the transaction to be rolled back. The reason for the
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   971
  transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
27739
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   972
  the transaction will be in ``HG_TXNID``. The rest of the available data will
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   973
  vary according the transaction type. New changesets will add ``$HG_NODE``
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   974
  (the ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   975
  added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables.  Bookmark and
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   976
  phase changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   977
  respectively, 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
   978
24282
db8679812f84 hook: add a generic hook after transaction has been closed
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24281
diff changeset
   979
``txnclose``
24814
60e4258b2052 help: fix typo commited -> committed
Javi Merino <merino.jav@gmail.com>
parents: 24792
diff changeset
   980
  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
   981
  point, the transaction can no longer be rolled back. The hook will run
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   982
  after the lock is released. See :hg:`help config.hooks.pretxnclose` for
26280
5edf3dccb6f7 help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents: 26279
diff changeset
   983
  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
   984
24792
7d0421de8de3 hooks: add a 'txnabort' hook
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24791
diff changeset
   985
``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
   986
  Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   987
  for details about available variables.
24792
7d0421de8de3 hooks: add a 'txnabort' hook
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24791
diff changeset
   988
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   989
``pretxnchangegroup``
27739
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
   990
  Run after a changegroup has been added via push, pull or unbundle, but before
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   991
  the transaction has been committed. The changegroup is visible to the hook
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   992
  program. This allows validation of incoming changes before accepting them.
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   993
  The ID of the first new changeset is in ``$HG_NODE`` and last is in
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   994
  ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   995
  status will cause the transaction to be rolled back, and the push, pull or
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   996
  unbundle will fail. The URL that was the 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
   997
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
   998
``pretxncommit``
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
   999
  Run after a changeset has been created, but before the transaction is
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1000
  committed. The changeset is visible to the hook program. This allows
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1001
  validation of the commit message and changes. Exit status 0 allows the
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1002
  commit to proceed. A non-zero status will cause the transaction to
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1003
  be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1004
  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
  1005
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1006
``preupdate``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1007
  Run before updating the working directory. Exit status 0 allows
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1008
  the update to proceed. A non-zero status will prevent the update.
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1009
  The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1010
  merge, the ID 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
  1011
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1012
``listkeys``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1013
  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
  1014
  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
  1015
  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
  1016
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1017
``pushkey``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1018
  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
  1019
  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
  1020
  ``$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
  1021
  value is in ``$HG_NEW``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1022
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1023
``tag``
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1024
  Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1025
  The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1026
  the repository if ``$HG_LOCAL=0``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1027
14456
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``
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1029
  Run after updating the working directory. The changeset ID of first
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1030
  new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1031
  parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1032
  update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=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
  1033
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
  1034
.. note::
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
  1035
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
  1036
   It is generally better to use standard hooks rather than the
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
  1037
   generic pre- and post- command hooks, as they are guaranteed to be
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1038
   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
  1039
   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
  1040
   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
  1041
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
  1042
.. note::
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
  1043
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
  1044
   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
  1045
   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
  1046
   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
  1047
   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
  1048
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1049
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
  1050
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1051
  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
  1052
  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
  1053
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1054
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
  1055
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
  1056
``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
  1057
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
  1058
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
  1059
``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
  1060
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1061
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
  1062
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
  1063
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1064
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1065
``hostfingerprints``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1066
--------------------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1067
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1068
(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
  1069
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1070
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
  1071
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1072
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
  1073
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
  1074
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
  1075
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1076
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
  1077
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
  1078
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
  1079
to a new certificate.
28524
ce1160ae2150 help: add empty lines to hostfingerprints section
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28218
diff changeset
  1080
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1081
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
  1082
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1083
For example::
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1084
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1085
    [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
  1086
    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
  1087
    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
  1088
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1089
``hostsecurity``
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1090
----------------
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1091
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1092
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
  1093
other machines.
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1094
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1095
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
  1096
29577
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1097
``ciphers``
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1098
    Defines the cryptographic ciphers to use for connections.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1099
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1100
    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
  1101
    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
  1102
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1103
    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
  1104
    can significantly lower connection security or decrease performance.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1105
    You have been warned.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1106
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1107
    This option requires Python 2.7.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1108
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1109
``minimumprotocol``
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1110
    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
  1111
29560
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1112
    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
  1113
    is used.
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1114
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1115
    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
  1116
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1117
    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
  1118
    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
  1119
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
  1120
    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
  1121
    ``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
  1122
    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
  1123
    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
  1124
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1125
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
  1126
``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
  1127
per-host basis.
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1128
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1129
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
  1130
29577
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1131
``ciphers``
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1132
    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
  1133
    to the host on which it is defined.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
  1134
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1135
``fingerprints``
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1136
    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
  1137
    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
  1138
    ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
32274
2b017d22fe97 help: clarify that colons are allowed in fingerprints values
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32260
diff changeset
  1139
    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
  1140
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1141
    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
  1142
    ``sha512``.
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1143
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1144
    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
  1145
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1146
    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
  1147
    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
  1148
    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
  1149
    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
  1150
    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
  1151
    at the expense of convenience.
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1152
29334
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1153
    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
  1154
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1155
``minimumprotocol``
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1156
    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
  1157
    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
  1158
29334
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1159
``verifycertsfile``
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1160
    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
  1161
    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
  1162
    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
  1163
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1164
    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
  1165
    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
  1166
    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
  1167
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1168
    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
  1169
    ``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
  1170
    used.
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1171
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1172
    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
  1173
    is set.
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1174
29649
512611246ea4 doc: make previous line of certificate example end with "::"
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 29648
diff changeset
  1175
    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
  1176
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1177
        -----BEGIN CERTIFICATE-----
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1178
        ... (certificate in base64 PEM encoding) ...
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1179
        -----END CERTIFICATE-----
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1180
        -----BEGIN CERTIFICATE-----
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1181
        ... (certificate in base64 PEM encoding) ...
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1182
        -----END CERTIFICATE-----
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
  1183
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1184
For example::
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1185
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1186
    [hostsecurity]
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
  1187
    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
  1188
    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
  1189
    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
  1190
    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
  1191
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1192
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
  1193
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
  1194
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1195
    [hostsecurity]
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1196
    minimumprotocol = tls1.2
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
  1197
    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
  1198
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1199
``http_proxy``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1200
--------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1201
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1202
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
  1203
proxy.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1204
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1205
``host``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1206
    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
  1207
    "myproxy:8000".
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
``no``
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. 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
  1211
    the proxy.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1212
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1213
``passwd``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1214
    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
  1215
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1216
``user``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1217
    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
  1218
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1219
``always``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1220
    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
  1221
    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
  1222
28023
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1223
``merge``
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1224
---------
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1225
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1226
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
  1227
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1228
``checkignored``
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1229
   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
  1230
   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
  1231
   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
  1232
   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
  1233
   ``.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
  1234
   ``.orig``. (default: ``abort``)
28023
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1235
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1236
``checkunknown``
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1237
   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
  1238
   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
  1239
   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
  1240
   are not ignored. (default: ``abort``)
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
  1241
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1242
``merge-patterns``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1243
------------------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1244
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1245
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
  1246
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
  1247
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
  1248
root.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1249
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1250
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
  1251
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1252
  [merge-patterns]
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1253
  **.c = kdiff3
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1254
  **.jpg = myimgmerge
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1255
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1256
``merge-tools``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1257
---------------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1258
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1259
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
  1260
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
  1261
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
  1262
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
  1263
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1264
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
  1265
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1266
  [merge-tools]
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1267
  # Override stock tool location
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1268
  kdiff3.executable = ~/bin/kdiff3
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1269
  # Specify command line
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1270
  kdiff3.args = $base $local $other -o $output
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1271
  # Give higher priority
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1272
  kdiff3.priority = 1
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1273
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
  1274
  # 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
  1275
  meld.priority = 0
a1e43e85d294 merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents: 26625
diff changeset
  1276
a1e43e85d294 merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents: 26625
diff changeset
  1277
  # Disable a preconfigured tool
a1e43e85d294 merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents: 26625
diff changeset
  1278
  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
  1279
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1280
  # Define new tool
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1281
  myHtmlTool.args = -m $local $other $base $output
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1282
  myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1283
  myHtmlTool.priority = 1
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1284
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1285
Supported arguments:
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1286
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1287
``priority``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1288
  The priority in which to evaluate this tool.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1289
  (default: 0)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1290
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1291
``executable``
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1292
  Either just the name of the executable or its pathname.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1293
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1294
  .. container:: windows
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1295
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1296
    On Windows, the path can use environment variables with ${ProgramFiles}
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1297
    syntax.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1298
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1299
  (default: the tool name)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1300
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1301
``args``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1302
  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
  1303
  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
  1304
  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
  1305
  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
  1306
  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
  1307
  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
  1308
  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
  1309
  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
  1310
  commit being rebased.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1311
  (default: ``$local $base $other``)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1312
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1313
``premerge``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1314
  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
  1315
  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
  1316
  ``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
  1317
  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
  1318
  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
  1319
  :hg:`help merge-tools`).
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1320
  (default: True)
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
``binary``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1323
  This tool can merge binary files. (default: False, unless tool
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1324
  was selected by file pattern match)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1325
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1326
``symlink``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1327
  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
  1328
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1329
``check``
26225
e257df7a9974 help/config: back out 5f2a1ebd6e78
Augie Fackler <augie@google.com>
parents: 26182
diff changeset
  1330
  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
  1331
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1332
  ``changed``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1333
    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
  1334
  ``conflicts``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1335
    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
  1336
  ``prompt``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1337
    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
  1338
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1339
``fixeol``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1340
  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
  1341
  (default: False)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1342
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1343
``gui``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1344
  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
  1345
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1346
.. container:: windows
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1347
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1348
  ``regkey``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1349
    Windows registry key which describes install location of this
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1350
    tool. Mercurial will search for this key first under
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1351
    ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1352
    (default: None)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1353
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1354
  ``regkeyalt``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1355
    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
  1356
    found.  The alternate key uses the same ``regname`` and ``regappend``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1357
    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
  1358
    is to search for 32bit applications on 64bit operating systems.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1359
    (default: None)
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
  ``regname``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1362
    Name of value to read from specified registry key.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1363
    (default: the unnamed (default) value)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1364
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1365
  ``regappend``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1366
    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
  1367
    the executable name of the tool.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  1368
    (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
  1369
32099
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1370
``pager``
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
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1373
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
  1374
: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
  1375
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1376
``pager``
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1377
    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
  1378
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1379
    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
  1380
    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
  1381
    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
  1382
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1383
      [pager]
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1384
      pager = less -FRX
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1385
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1386
``ignore``
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1387
    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
  1388
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1389
      [pager]
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
  1390
      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
  1391
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1392
``patch``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1393
---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1394
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1395
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
  1396
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
  1397
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1398
``eol``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1399
    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
  1400
    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
  1401
    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
  1402
    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
  1403
    ``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
  1404
    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
  1405
    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
  1406
    of line, patch line endings are preserved.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1407
    (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
  1408
25631
2748bf78a5bf patch: add fuzz config flag (issue4697)
Matt Mackall <mpm@selenic.com>
parents: 25523
diff changeset
  1409
``fuzz``
2748bf78a5bf patch: add fuzz config flag (issue4697)
Matt Mackall <mpm@selenic.com>
parents: 25523
diff changeset
  1410
    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
  1411
    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
  1412
    trying to apply a patch.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1413
    (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
  1414
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1415
``paths``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1416
---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1417
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1418
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
  1419
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1420
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
  1421
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
  1422
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1423
    [paths]
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1424
    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
  1425
    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
  1426
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1427
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
  1428
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
  1429
:hg:`push local_path`.
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1430
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1431
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
  1432
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
  1433
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1434
    [paths]
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1435
    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
  1436
    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
  1437
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1438
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
  1439
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1440
``pushurl``
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1441
   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
  1442
   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
  1443
29413
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1444
``pushrev``
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1445
   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
  1446
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1447
   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
  1448
   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
  1449
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1450
   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
  1451
   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
  1452
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1453
   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
  1454
   pushed.
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
  1455
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1456
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
  1457
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1458
``default``
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1459
   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
  1460
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1461
   :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
  1462
   repository was cloned from.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1463
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1464
``default-push``
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
  1465
   (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
  1466
   ``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
  1467
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1468
``phases``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1469
----------
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1470
16005
591f258ae630 help/config: fix help command markup
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 15999
diff changeset
  1471
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
  1472
information about working with phases.
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1473
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1474
``publish``
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1475
    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
  1476
    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
  1477
    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
  1478
    (default: True)
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1479
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1480
``new-commit``
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
  1481
    Phase of newly-created commits.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1482
    (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
  1483
20176
4c96c50ef937 subrepo: check phase of state in each subrepositories before committing
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 20142
diff changeset
  1484
``checksubrepos``
20333
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
  1485
    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
  1486
    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
  1487
    "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
  1488
    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
  1489
    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
  1490
    "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
  1491
    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
  1492
    used for the parent repository commit (if set to "follow").
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1493
    (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
  1494
4c96c50ef937 subrepo: check phase of state in each subrepositories before committing
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 20142
diff changeset
  1495
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1496
``profiling``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1497
-------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1498
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1499
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
  1500
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
  1501
profiler (named ``stat``).
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1502
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1503
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
  1504
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
  1505
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
  1506
profiling is done using lsprof.
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1507
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
  1508
``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
  1509
    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
  1510
    (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
  1511
e3501546f7e4 profiling: add a context manager that no-ops if profiling isn't enabled
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29780
diff changeset
  1512
    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
  1513
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1514
``type``
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1515
    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
  1516
    (default: stat)
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1517
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1518
    ``ls``
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1519
      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
  1520
      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
  1521
      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
  1522
      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
  1523
    ``stat``
30316
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1524
      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
  1525
      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
  1526
      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
  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
``format``
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1529
    Profiling format.  Specific to the ``ls`` instrumenting profiler.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1530
    (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
  1531
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1532
    ``text``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1533
      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
  1534
      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
  1535
      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
  1536
    ``kcachegrind``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1537
      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
  1538
      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
  1539
      kcachegrind.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1540
30316
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1541
``statformat``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1542
    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
  1543
    (default: hotpath)
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1544
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1545
    ``hotpath``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1546
      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
  1547
      most time was spent).
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1548
    ``bymethod``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1549
      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
  1550
    ``byline``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1551
      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
  1552
    ``json``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1553
      Render profiling data as JSON.
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
  1554
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1555
``frequency``
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1556
    Sampling frequency.  Specific to the ``stat`` sampling profiler.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1557
    (default: 1000)
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
  1558
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
``output``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1560
    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
  1561
    file exists, it is replaced. (default: None, data is printed on
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1562
    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
  1563
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1564
``sort``
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1565
    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
  1566
    One of ``callcount``, ``reccallcount``, ``totaltime`` and
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1567
    ``inlinetime``.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1568
    (default: inlinetime)
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1569
18548
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
  1570
``limit``
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
  1571
    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
  1572
    (default: 30)
18548
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
  1573
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1574
``nested``
18642
a40d608e2a7b profiling: replace '+' markup of nested lines with indentation
Mads Kiilerich <mads@kiilerich.com>
parents: 18636
diff changeset
  1575
    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
  1576
    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
  1577
    Specific to the ``ls`` instrumenting profiler.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1578
    (default: 5)
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
  1579
32850
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1580
``showmin``
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1581
    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
  1582
    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
  1583
    ``%`` 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
  1584
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1585
    Only used by the ``stat`` profiler.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1586
32851
cb6436e051ca profiling: allow configuring minimum display threshold for hotpath
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32850
diff changeset
  1587
    For the ``hotpath`` format, default is ``0.05``.
32850
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1588
    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
  1589
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1590
    The option is unused on other formats.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1591
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1592
``showmax``
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1593
    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
  1594
    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
  1595
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1596
    Only used by the ``stat`` profiler.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1597
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1598
    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
  1599
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1600
    The option is unused on other formats.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
  1601
25520
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1602
``progress``
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
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1605
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
  1606
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
  1607
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
  1608
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1609
``delay``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1610
    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
  1611
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1612
``changedelay``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1613
    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
  1614
    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
  1615
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1616
``refresh``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1617
    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
  1618
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1619
``format``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1620
    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
  1621
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1622
    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
  1623
    ``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
  1624
    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
  1625
    ``-<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
  1626
    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
  1627
27665
72a25271e294 help: use backticks for progress.format keywords, correct letter case
Anton Shestakov <av6@dwimlabs.net>
parents: 27657
diff changeset
  1628
    (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
  1629
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1630
``width``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1631
    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
  1632
    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
  1633
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1634
``clear-complete``
26278
be44d23cb9f1 help/config: capitalize items
timeless@mozdev.org
parents: 26263
diff changeset
  1635
    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
  1636
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1637
``disable``
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
  1638
    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
  1639
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
  1640
``assume-tty``
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
  1641
    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
  1642
27746
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1643
``rebase``
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1644
----------
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1645
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1646
``allowdivergence``
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1647
    Default to False, when True allow creating divergence when performing
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1648
    rebase of obsolete changesets.
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
  1649
14691
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
  1650
``revsetalias``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1651
---------------
14691
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
  1652
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
  1653
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
  1654
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1655
``server``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1656
----------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1657
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1658
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
  1659
30762
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1660
``compressionengines``
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1661
    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
  1662
    to clients.
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1663
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1664
    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
  1665
    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
  1666
    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
  1667
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1668
    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
  1669
    :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
  1670
    default wire protocol priority.
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1671
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
  1672
    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
  1673
    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
  1674
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1675
``uncompressed``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1676
    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
  1677
    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
  1678
    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
  1679
    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
  1680
    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
  1681
    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
  1682
    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
  1683
    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
  1684
    the write lock while determining what data to transfer.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1685
    (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
  1686
32744
33b7283a3828 streamclone: consider secret changesets (BC) (issue5589)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32666
diff changeset
  1687
``uncompressedallowsecret``
33b7283a3828 streamclone: consider secret changesets (BC) (issue5589)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32666
diff changeset
  1688
    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
  1689
    changesets. (default: False)
33b7283a3828 streamclone: consider secret changesets (BC) (issue5589)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32666
diff changeset
  1690
16361
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
  1691
``preferuncompressed``
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
  1692
    When set, clients will try to use the uncompressed streaming
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1693
    protocol. (default: False)
16361
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
  1694
32260
d0d9a4fca59b clone: add a server-side option to disable full getbundles (pull-based clones)
Siddharth Agarwal <sid0@fb.com>
parents: 32139
diff changeset
  1695
``disablefullbundle``
d0d9a4fca59b clone: add a server-side option to disable full getbundles (pull-based clones)
Siddharth Agarwal <sid0@fb.com>
parents: 32139
diff changeset
  1696
    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
  1697
    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
  1698
    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
  1699
    (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
  1700
32892
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
  1701
``concurrent-push-mode``
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
  1702
    Level of allowed race condition between two pushing clients.
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
  1703
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
  1704
    - 'strict': push is abort if another client touched the repository
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
  1705
      while the push was preparing. (default)
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
  1706
    - 'check-related': push is only aborted if it affects head that got also
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
  1707
      affected while the push was preparing.
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
  1708
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
  1709
    This requires compatible client (version 4.3 and later). Old client will
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
  1710
    use 'strict'.
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
  1711
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1712
``validate``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1713
    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
  1714
    checking that all new file revisions specified in manifests are
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1715
    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
  1716
25691
5cda0ce05c42 wireproto: add config knob for http header length limit
Mike Edgar <adgar@google.com>
parents: 25649
diff changeset
  1717
``maxhttpheaderlen``
5cda0ce05c42 wireproto: add config knob for http header length limit
Mike Edgar <adgar@google.com>
parents: 25649
diff changeset
  1718
    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
  1719
    many bytes. (default: 1024)
25691
5cda0ce05c42 wireproto: add config knob for http header length limit
Mike Edgar <adgar@google.com>
parents: 25649
diff changeset
  1720
27246
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1721
``bundle1``
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1722
    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
  1723
    exchange 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``
27683
76fc5ac23473 help: fix quoting for bundle1 options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27665
diff changeset
  1726
    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
  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
``bundle1.push``
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1730
    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
  1731
    format. (default: True)
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1732
27633
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
  1733
``bundle1gd.push``
27683
76fc5ac23473 help: fix quoting for bundle1 options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27665
diff changeset
  1734
    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
  1735
    *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
  1736
27246
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1737
``bundle1.pull``
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1738
    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
  1739
    format. (default: True)
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1740
27633
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
  1741
``bundle1gd.pull``
27683
76fc5ac23473 help: fix quoting for bundle1 options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27665
diff changeset
  1742
    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
  1743
    *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
  1744
27246
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1745
    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
  1746
    consider setting this option because converting *generaldelta*
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1747
    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
  1748
    format can consume a lot of CPU.
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
  1749
29748
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1750
``zliblevel``
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1751
    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
  1752
    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
  1753
    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
  1754
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1755
    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
  1756
    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
  1757
    maximum compression.
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1758
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1759
    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
  1760
    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
  1761
    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
  1762
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
  1763
    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
  1764
30764
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1765
``zstdlevel``
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1766
    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
  1767
    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
  1768
    ``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
  1769
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1770
    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
  1771
    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
  1772
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1773
    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
  1774
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
  1775
    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
  1776
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1777
``smtp``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1778
--------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1779
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1780
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
  1781
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1782
``host``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1783
    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
  1784
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1785
``port``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1786
    Optional. Port to connect to on mail server. (default: 465 if
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1787
    ``tls`` is smtps; 25 otherwise)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1788
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1789
``tls``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1790
    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
  1791
    smtps or none. (default: none)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1792
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1793
``username``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1794
    Optional. User name for authenticating with the SMTP server.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1795
    (default: None)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1796
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1797
``password``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1798
    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
  1799
    specified, interactive sessions will prompt the user for a
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1800
    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
  1801
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1802
``local_hostname``
26180
b1caa076fc3b help/config: change local_hostname help style
timeless@mozdev.org
parents: 26179
diff changeset
  1803
    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
  1804
    itself to the MTA.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1805
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
  1806
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1807
``subpaths``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1808
------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1809
16549
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
  1810
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
  1811
or becomes temporarily unavailable. This section lets you define
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
  1812
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
  1813
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1814
    <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
  1815
16549
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
  1816
where ``pattern`` is a regular expression matching a subrepository
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
  1817
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
  1818
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
  1819
``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
  1820
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1821
    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
  1822
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1823
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
  1824
17251
98166640b356 help: fix some instances of 'the the'
Mads Kiilerich <mads@kiilerich.com>
parents: 17202
diff changeset
  1825
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
  1826
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
  1827
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
  1828
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
  1829
28957
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
  1830
``templatealias``
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
  1831
-----------------
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
  1832
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
  1833
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
  1834
29717
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
  1835
``templates``
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
  1836
-------------
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
  1837
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
  1838
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
  1839
See :hg:`help templates` for details.
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
  1840
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1841
``trusted``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1842
-----------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1843
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1844
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
  1845
``.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
  1846
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
  1847
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
  1848
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
  1849
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
  1850
section.
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
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
  1853
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
  1854
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
  1855
*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
  1856
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
  1857
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1858
``users``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1859
  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
  1860
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1861
``groups``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1862
  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
  1863
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1864
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1865
``ui``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
  1866
------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1867
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1868
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
  1869
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1870
``archivemeta``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1871
    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
  1872
    (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
  1873
    by the :hg:`archive` command or downloaded via hgweb.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1874
    (default: True)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1875
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1876
``askusername``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1877
    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
  1878
    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
  1879
    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
  1880
    default ``USER@HOST`` is used instead.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1881
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1882
27738
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1883
``clonebundles``
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1884
    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
  1885
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1886
    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
  1887
    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
  1888
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1889
    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
  1890
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1891
    (default: True)
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
  1892
26623
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1893
``clonebundlefallback``
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1894
    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
  1895
    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
  1896
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1897
    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
  1898
    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
  1899
    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
  1900
    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
  1901
    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
  1902
    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
  1903
    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
  1904
    fails.
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1905
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1906
    (default: False)
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
  1907
27737
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1908
``clonebundleprefers``
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1909
    Defines preferences for which "clone bundles" to use.
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
    Servers advertising "clone bundles" may advertise multiple available
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1912
    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
  1913
    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
  1914
    bundle over another.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1915
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1916
    The following keys are defined by Mercurial:
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1917
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1918
    BUNDLESPEC
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1919
       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
  1920
       e.g. ``gzip-v2`` or ``bzip2-v1``.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1921
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1922
    COMPRESSION
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1923
       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
  1924
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1925
    Server operators may define custom keys.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1926
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1927
    Example values: ``COMPRESSION=bzip2``,
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1928
    ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1929
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
  1930
    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
  1931
31123
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
  1932
``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
  1933
    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
  1934
    "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
  1935
    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
  1936
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1937
``commitsubrepos``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1938
    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
  1939
    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
  1940
    changes, abort the commit.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1941
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1942
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1943
``debug``
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
  1944
    Print debugging information. (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  1945
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1946
``editor``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1947
    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
  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
``fallbackencoding``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1950
    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
  1951
    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
  1952
27216
8117e2cd959e graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents: 27093
diff changeset
  1953
``graphnodetemplate``
8117e2cd959e graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents: 27093
diff changeset
  1954
    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
  1955
    (default: ``{graphnode}``)
8117e2cd959e graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents: 27093
diff changeset
  1956
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1957
``ignore``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1958
    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
  1959
    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
  1960
    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
  1961
    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
  1962
    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
  1963
    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
  1964
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1965
``interactive``
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
  1966
    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
  1967
28542
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1968
``interface``
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1969
    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
  1970
    Possible values are 'text' and 'curses'.
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1971
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1972
``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
  1973
    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
  1974
    Possible values are 'text' and 'curses'.
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
  1975
    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
  1976
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1977
``logtemplate``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1978
    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
  1979
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1980
``merge``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  1981
    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
  1982
    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
  1983
    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
  1984
21519
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1985
``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
  1986
    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
  1987
    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
  1988
    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
  1989
    One of ``basic`` or ``detailed``.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  1990
    (default: ``basic``)
21519
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1991
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1992
``mergemarkertemplate``
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1993
    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
  1994
    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
  1995
    format.
26172
e05e5c6ccd2f help/config: add blank lines
timeless@mozdev.org
parents: 26169
diff changeset
  1996
21519
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  1997
    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
  1998
    the first line of the commit description.
26172
e05e5c6ccd2f help/config: add blank lines
timeless@mozdev.org
parents: 26169
diff changeset
  1999
24536
d09262d6ec23 filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents: 23629
diff changeset
  2000
    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
  2001
    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
  2002
    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
  2003
    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
  2004
    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
  2005
    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
  2006
    serious problems may occur.
21519
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
  2007
26937
dda0aa3baedd cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents: 26907
diff changeset
  2008
``origbackuppath``
dda0aa3baedd cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents: 26907
diff changeset
  2009
    The path to a directory used to store generated .orig files. If the path is
34146
9e4f82bc2b0b scmutil: don't append .orig to backups in origbackuppath (BC)
Mark Thomas <mbthomas@fb.com>
parents: 34013
diff changeset
  2010
    not a directory, one will be created.  If set, files stored in this
9e4f82bc2b0b scmutil: don't append .orig to backups in origbackuppath (BC)
Mark Thomas <mbthomas@fb.com>
parents: 34013
diff changeset
  2011
    directory have the same name as the original file and do not have a .orig
9e4f82bc2b0b scmutil: don't append .orig to backups in origbackuppath (BC)
Mark Thomas <mbthomas@fb.com>
parents: 34013
diff changeset
  2012
    suffix.
26937
dda0aa3baedd cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents: 26907
diff changeset
  2013
32104
f06d23af6cdf pager: rename 'pager.enable' to 'ui.paginate'
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32103
diff changeset
  2014
``paginate``
f06d23af6cdf pager: rename 'pager.enable' to 'ui.paginate'
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32103
diff changeset
  2015
  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
  2016
  for details.
f06d23af6cdf pager: rename 'pager.enable' to 'ui.paginate'
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32103
diff changeset
  2017
25649
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2018
``patch``
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2019
    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
  2020
    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
  2021
    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
  2022
    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
  2023
    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
  2024
    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
  2025
    from stdin.
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2026
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
  2027
    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
  2028
    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
  2029
    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
  2030
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2031
``portablefilenames``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2032
    Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2033
    (default: ``warn``)
27758
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2034
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2035
    ``warn``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2036
      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
  2037
      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
  2038
      Windows because it contains reserved parts like ``AUX``, reserved
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2039
      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
  2040
      file).
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2041
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2042
    ``ignore``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2043
      Don't print a warning.
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2044
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2045
    ``abort``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2046
      The command is aborted.
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2047
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2048
    ``true``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2049
      Alias for ``warn``.
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2050
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2051
    ``false``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2052
      Alias for ``ignore``.
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2053
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
  2054
    .. container:: windows
27758
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2055
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
  2056
      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
  2057
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2058
``quiet``
27759
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
  2059
    Reduce the amount of output printed.
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
  2060
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2061
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2062
``remotecmd``
27759
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
  2063
    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
  2064
    (default: ``hg``)
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
``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
  2067
    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
  2068
    trusted user or group.
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
  2069
    (default: True)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2070
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2071
``slash``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2072
    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
  2073
    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
  2074
    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
  2075
    backslash character (``\``)).
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2076
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2077
24663
7d01371e6358 commands: add ui.statuscopies config knob
Mathias De Maré <mathias.demare@gmail.com>
parents: 24542
diff changeset
  2078
``statuscopies``
7d01371e6358 commands: add ui.statuscopies config knob
Mathias De Maré <mathias.demare@gmail.com>
parents: 24542
diff changeset
  2079
    Display copies in the status command.
7d01371e6358 commands: add ui.statuscopies config knob
Mathias De Maré <mathias.demare@gmail.com>
parents: 24542
diff changeset
  2080
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2081
``ssh``
26278
be44d23cb9f1 help/config: capitalize items
timeless@mozdev.org
parents: 26263
diff changeset
  2082
    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
  2083
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2084
``strict``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2085
    Require exact command names, instead of allowing unambiguous
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
  2086
    abbreviations. (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2087
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2088
``style``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2089
    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
  2090
26263
bf2bfc6f45fb traceback: allow providing a local support contact point
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26225
diff changeset
  2091
``supportcontact``
26313
e8afd380c576 help: copy-edit description of ui.supportcontact
Kevin Bullock <kbullock@ringworld.org>
parents: 26282
diff changeset
  2092
    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
  2093
    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
  2094
    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
  2095
29070
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
  2096
``textwidth``
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
  2097
    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
  2098
    ``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
  2099
    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
  2100
    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
  2101
    used. (default: 78)
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
  2102
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2103
``timeout``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2104
    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
  2105
    means no timeout. (default: 600)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2106
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2107
``traceback``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2108
    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
  2109
    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
  2110
    on all exceptions, even those recognized by Mercurial (such as
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2111
    IOError or MemoryError). (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2112
32872
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
  2113
``tweakdefaults``
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
  2114
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
  2115
    By default Mercurial's behavior changes very little from release
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
  2116
    to release, but over time the recommended config settings
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
  2117
    shift. Enable this config to opt in to get automatic tweaks to
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
  2118
    Mercurial's behavior over time. This config setting will have no
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
  2119
    effet if ``HGPLAIN` is set or ``HGPLAINEXCEPT`` is set and does
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
  2120
    not include ``tweakdefaults``. (default: False)
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
  2121
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2122
``username``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2123
    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
  2124
    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
  2125
    <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
  2126
    username are expanded.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2127
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2128
    (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
  2129
    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
  2130
    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
  2131
    hgrc file)
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2132
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2133
``verbose``
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
  2134
    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
  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
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2137
``web``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
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
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2140
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
  2141
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
  2142
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
  2143
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
  2144
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2145
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
  2146
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
  2147
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
  2148
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
  2149
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
  2150
checks.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2151
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2152
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
  2153
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
  2154
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
  2155
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2156
    $ 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
  2157
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2158
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
  2159
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
  2160
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2161
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
  2162
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2163
``accesslog``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2164
    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
  2165
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2166
``address``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2167
    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
  2168
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2169
``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
  2170
    List of archive format (bz2, gz, zip) allowed for downloading.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2171
    (default: empty)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2172
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2173
``allowbz2``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2174
    (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
  2175
    revisions.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2176
    (default: False)
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
``allowgz``
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 .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
  2180
    revisions.
26182
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
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2183
``allowpull``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2184
    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
  2185
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2186
``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
  2187
    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
  2188
    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
  2189
    user can push, including unauthenticated users. Otherwise, the
c16f071f048e help/config: reword allow_push to fix grammar
timeless@mozdev.org
parents: 26180
diff changeset
  2190
    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
  2191
    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
  2192
    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
  2193
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2194
``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
  2195
    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
  2196
    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
  2197
    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
  2198
    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
  2199
    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
  2200
    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
  2201
    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
  2202
    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
  2203
    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
  2204
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2205
``allowzip``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2206
    (DEPRECATED) Whether to allow .zip downloading of repository
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2207
    revisions. This feature creates temporary files.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2208
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2209
17933
8243dd66e0e3 webcommands: allow hgweb's archive to recurse into subrepos
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 17685
diff changeset
  2210
``archivesubrepos``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2211
    Whether to recurse into subrepositories when archiving.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2212
    (default: False)
17933
8243dd66e0e3 webcommands: allow hgweb's archive to recurse into subrepos
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 17685
diff changeset
  2213
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2214
``baseurl``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2215
    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
  2216
    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
  2217
    URLs. Example: ``http://hgserver/repos/``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2218
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2219
``cacerts``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2220
    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
  2221
    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
  2222
    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
  2223
    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
  2224
    with these certificates.
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2225
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2226
    To disable SSL verification temporarily, specify ``--insecure`` from
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2227
    command line.
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2228
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2229
    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
  2230
    one. On most Linux systems this will be
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
  2231
    ``/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
  2232
    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
  2233
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2234
        -----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
  2235
        ... (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
  2236
        -----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
  2237
        -----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
  2238
        ... (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
  2239
        -----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
  2240
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2241
``cache``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2242
    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
  2243
25853
81802d1355ac hgweb: document web.certificates option
Matt Mackall <mpm@selenic.com>
parents: 25691
diff changeset
  2244
``certificate``
81802d1355ac hgweb: document web.certificates option
Matt Mackall <mpm@selenic.com>
parents: 25691
diff changeset
  2245
    Certificate to use when running :hg:`serve`.
81802d1355ac hgweb: document web.certificates option
Matt Mackall <mpm@selenic.com>
parents: 25691
diff changeset
  2246
16570
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
  2247
``collapse``
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
  2248
    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
  2249
    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
  2250
    ``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
  2251
    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
  2252
    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
  2253
    collapses each collection of repositories found within a subdirectory
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2254
    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
  2255
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2256
``comparisoncontext``
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2257
    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
  2258
    negative or the value ``full``, whole files are shown. (default: 5)
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2259
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2260
    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
  2261
    ``comparison`` command, taking the same values.
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2262
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2263
``contact``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2264
    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
  2265
    (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
  2266
30766
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2267
``csp``
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2268
    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
  2269
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2270
    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
  2271
    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
  2272
    ``%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
  2273
    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
  2274
    ``<script>`` elements containing inline JavaScript.
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2275
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
  2276
    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
  2277
    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
  2278
    "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
  2279
    threat model.
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
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
``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
  2282
    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
  2283
    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
  2284
    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
  2285
    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
  2286
    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
  2287
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2288
``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
  2289
    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
  2290
    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
  2291
    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
  2292
    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
  2293
    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
  2294
    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
  2295
    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
  2296
    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
  2297
    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
  2298
    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
  2299
    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
  2300
    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
  2301
    list.
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
``descend``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2304
    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
  2305
    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
  2306
    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
  2307
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2308
``description``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2309
    Textual description of the repository's purpose or contents.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2310
    (default: "unknown")
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2311
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2312
``encoding``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2313
    Character encoding name. (default: the current locale charset)
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
  2314
    Example: "UTF-8".
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2315
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2316
``errorlog``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2317
    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
  2318
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2319
``guessmime``
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2320
    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
  2321
    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
  2322
    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
  2323
    allow cross-site scripting attacks when serving untrusted
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2324
    repositories. (default: False)
17202
1ae119269ddc hgweb: side-by-side comparison functionality
wujek srujek
parents: 16585
diff changeset
  2325
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2326
``hidden``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2327
    Whether to hide the repository in the hgwebdir index.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2328
    (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2329
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2330
``ipv6``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2331
    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
  2332
29471
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
  2333
``labels``
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
  2334
    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
  2335
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
  2336
    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
  2337
    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
  2338
    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
  2339
    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
  2340
14938
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
  2341
``logoimg``
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
  2342
    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
  2343
    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
  2344
    the logo image is "staticurl/logoimg".
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
  2345
    If unset, ``hglogo.png`` will be used.
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
  2346
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2347
``logourl``
26421
4b0fc75f9403 urls: bulk-change primary website URLs
Matt Mackall <mpm@selenic.com>
parents: 26365
diff changeset
  2348
    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
  2349
    will be used.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2350
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2351
``maxchanges``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2352
    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
  2353
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2354
``maxfiles``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2355
    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
  2356
17317
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
  2357
``maxshortchanges``
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
  2358
    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
  2359
    pages. (default: 60)
17317
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
  2360
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2361
``name``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2362
    Repository name to use in the web interface.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2363
    (default: current working directory)
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
  2364
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2365
``port``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2366
    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
  2367
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2368
``prefix``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2369
    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
  2370
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2371
``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
  2372
    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
  2373
    prevent password sniffing. (default: True)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2374
26072
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
  2375
``refreshinterval``
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
  2376
    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
  2377
    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
  2378
    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
  2379
    required, refreshing may negatively impact performance.
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
  2380
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2381
    Values less than or equal to 0 always refresh.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2382
    (default: 20)
26072
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
  2383
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2384
``staticurl``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2385
    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
  2386
    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
  2387
    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
  2388
    Example: ``http://hgserver/static/``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2389
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2390
``stripes``
17424
e7cfe3587ea4 fix trivial spelling errors
Mads Kiilerich <mads@kiilerich.com>
parents: 17317
diff changeset
  2391
    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
  2392
    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
  2393
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2394
``style``
22549
b1fc7ea5bb01 help: update help for hgweb template and style (issue4373)
Arun Chandrasekaran <visionofarun@gmail.com>
parents: 22252
diff changeset
  2395
    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
  2396
    subdirectories in the HTML templates path. (default: ``paper``)
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2397
    Example: ``monoblue``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
  2398
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
  2399
``templates``
22549
b1fc7ea5bb01 help: update help for hgweb template and style (issue4373)
Arun Chandrasekaran <visionofarun@gmail.com>
parents: 22252
diff changeset
  2400
    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
  2401
    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
  2402
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2403
``websub``
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2404
----------
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2405
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2406
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
  2407
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
  2408
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
  2409
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2410
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
  2411
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
  2412
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
  2413
"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
  2414
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2415
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
  2416
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
  2417
HTML (see the examples below).
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2418
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2419
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
  2420
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
  2421
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
  2422
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
  2423
18958
c3b920980f22 spelling: fix typos and spelling errors
Mads Kiilerich <madski@unity3d.com>
parents: 18888
diff changeset
  2424
    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
  2425
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2426
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
  2427
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
  2428
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2429
Examples::
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2430
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2431
    [websub]
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
  2432
    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
  2433
    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
  2434
    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
  2435
18636
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2436
``worker``
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2437
----------
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2438
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2439
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
  2440
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
  2441
helps performance.
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2442
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
  2443
``numcpus``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2444
    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
  2445
    negative value is treated as ``use the default``.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
  2446
    (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
  2447
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2448
``backgroundclose``
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2449
    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
  2450
    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
  2451
    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
  2452
    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
  2453
    (default: true on Windows, false elsewhere)
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2454
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2455
``backgroundcloseminfilecount``
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2456
    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
  2457
    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
  2458
    threads.
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2459
    (default: 2048)
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2460
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2461
``backgroundclosemaxqueue``
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2462
    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
  2463
    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
  2464
    enabled.
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2465
    (default: 384)
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2466
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2467
``backgroundclosethreadcount``
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2468
    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
  2469
    ``backgroundclose`` is enabled.
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
  2470
    (default: 4)