annotate mercurial/helptext/config.txt @ 48727:6e5ab1673020 stable

help: make the help for `safe-mismatch` real section The extra new lines mean the minirst engine were not seeing them as section… meaning they could not be addressed directly. Differential Revision: https://phab.mercurial-scm.org/D12161
author Pierre-Yves David <pierre-yves.david@octobus.net>
date Wed, 09 Feb 2022 16:07:50 +0100
parents b6a0c1015ee2
children 3199b575375d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
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,
47071
3e381eb557f3 config: add --source option to include source of value
Martin von Zweigbergk <martinvonz@google.com>
parents: 46972
diff changeset
8 :hg:`config --source` can help you understand what is introducing
26365
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
46007
aa4440e59c44 helptext: mention in `hg help config` that `.hg/hgrc-not-shared` is consulted
Pulkit Goyal <7895pulkit@gmail.com>
parents: 45866
diff changeset
57 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
58 - ``<repo>/.hg/hgrc`` (per-repository)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
59 - ``$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
60 - ``${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
61 - ``<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
62 - ``<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
63 - ``/etc/mercurial/hgrc`` (per-system)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
64 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
43669
8273680059b2 help: remove references to default.d/ from user-facing docs
Martin von Zweigbergk <martinvonz@google.com>
parents: 43632
diff changeset
65 - ``<internal>/*.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
66
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
67 .. 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
68
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
69 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
70
46007
aa4440e59c44 helptext: mention in `hg help config` that `.hg/hgrc-not-shared` is consulted
Pulkit Goyal <7895pulkit@gmail.com>
parents: 45866
diff changeset
71 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
72 - ``<repo>/.hg/hgrc`` (per-repository)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
73 - ``%USERPROFILE%\.hgrc`` (per-user)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
74 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
75 - ``%HOME%\.hgrc`` (per-user)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
76 - ``%HOME%\Mercurial.ini`` (per-user)
43952
14d282b57e24 help: clarify that the Windows registry key for hgrc files is systemwide
Matt Harbison <matt_harbison@yahoo.com>
parents: 43951
diff changeset
77 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-system)
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
78 - ``<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
79 - ``<install-dir>\Mercurial.ini`` (per-installation)
43951
1ccf340acf14 windows: add a global equivalent to /etc/mercurial for *.rc processing
Matt Harbison <matt_harbison@yahoo.com>
parents: 43873
diff changeset
80 - ``%PROGRAMDATA%\Mercurial\hgrc`` (per-system)
1ccf340acf14 windows: add a global equivalent to /etc/mercurial for *.rc processing
Matt Harbison <matt_harbison@yahoo.com>
parents: 43873
diff changeset
81 - ``%PROGRAMDATA%\Mercurial\Mercurial.ini`` (per-system)
1ccf340acf14 windows: add a global equivalent to /etc/mercurial for *.rc processing
Matt Harbison <matt_harbison@yahoo.com>
parents: 43873
diff changeset
82 - ``%PROGRAMDATA%\Mercurial\hgrc.d\*.rc`` (per-system)
43669
8273680059b2 help: remove references to default.d/ from user-facing docs
Martin von Zweigbergk <martinvonz@google.com>
parents: 43632
diff changeset
83 - ``<internal>/*.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
84
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
85 .. note::
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
86
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
87 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
88 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
89
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
90 .. container:: verbose.plan9
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
91
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
92 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
93
46007
aa4440e59c44 helptext: mention in `hg help config` that `.hg/hgrc-not-shared` is consulted
Pulkit Goyal <7895pulkit@gmail.com>
parents: 45866
diff changeset
94 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
95 - ``<repo>/.hg/hgrc`` (per-repository)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
96 - ``$home/lib/hgrc`` (per-user)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
97 - ``<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
98 - ``<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
99 - ``/lib/mercurial/hgrc`` (per-system)
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
100 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
43669
8273680059b2 help: remove references to default.d/ from user-facing docs
Martin von Zweigbergk <martinvonz@google.com>
parents: 43632
diff changeset
101 - ``<internal>/*.rc`` (defaults)
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
102
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
103 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
104 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
105 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
106 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
107
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
108 .. container:: unix.plan9
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
109
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
110 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
111 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
112 :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
113
27889
88aa4da0cba8 help: move Windows 9x information to appropriate place
Danek Duvall <danek.duvall@oracle.com>
parents: 27762
diff changeset
114 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
115 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
116 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
117 options.
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
118
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
119 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
120 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
121 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
122
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
123 .. container:: unix.plan9
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
124
df4894651532 help: split out unix/plan9 config help
timeless <timeless@mozdev.org>
parents: 27759
diff changeset
125 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
126 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
127 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
128 directory.
22586
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
129
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
130 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
131 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
132 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
133 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
134 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
135 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
136 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
137
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
138 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
139 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
140 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
141 override per-installation options.
6e5657ce9e8c help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents: 22550
diff changeset
142
23142
c4ce077588d0 config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents: 23121
diff changeset
143 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
144 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
145 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
146 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
147 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
148 there.
c4ce077588d0 config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents: 23121
diff changeset
149
46345
043781c0ffd6 doc: remove the section about share-safe from its verbose gating
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46344
diff changeset
150 On versions 5.7 and later, if share-safe functionality is enabled,
043781c0ffd6 doc: remove the section about share-safe from its verbose gating
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46344
diff changeset
151 shares will read config file of share source too.
043781c0ffd6 doc: remove the section about share-safe from its verbose gating
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46344
diff changeset
152 `<share-source/.hg/hgrc>` is read before reading `<repo/.hg/hgrc>`.
043781c0ffd6 doc: remove the section about share-safe from its verbose gating
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46344
diff changeset
153
043781c0ffd6 doc: remove the section about share-safe from its verbose gating
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46344
diff changeset
154 For configs which should not be shared, `<repo/.hg/hgrc-not-shared>`
043781c0ffd6 doc: remove the section about share-safe from its verbose gating
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46344
diff changeset
155 should be used.
46008
ecef004c6410 helptext: document share safe functionality in `hg help config -v`
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46007
diff changeset
156
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
157 Syntax
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
158 ======
14456
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 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
161 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
162 ``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
163
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
164 [spam]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
165 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
166 green=
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
167 eggs
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
168
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
169 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
170 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
171 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
172 ``#`` 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
173
14651
e9e4e9ab62bd help/config: fix 'Mercurial' casing
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14460
diff changeset
174 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
175 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
176
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
177 [spam]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
178 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
179 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
180 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
181
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
182 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
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 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
185 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
186 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
187
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
188 [foo]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
189 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
190 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
191 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
192
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
193 [bar]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
194 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
195 green=
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
196 eggs
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
197
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
198 [foo]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
199 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
200 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
201 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
202
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
203 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
204 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
205 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
206 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
207
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
208 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
209 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
210 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
211 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
212 above.
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 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
215 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
216 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
217 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
218 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
219 ``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
220
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
221 %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
222
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
223 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
224
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
225 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
226 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
227
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
228 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
229 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
230 "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
231 (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
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 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
234 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
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 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
237
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
238 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
239 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
240 (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
241
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
242 Sections
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
243 ========
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
244
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
245 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
246 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
247 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
248
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
249 ``alias``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
250 ---------
14456
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 Defines command aliases.
26172
e05e5c6ccd2f help/config: add blank lines
timeless@mozdev.org
parents: 26169
diff changeset
253
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
254 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
255 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
256 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
257 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
258 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
259 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
260
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
261 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
262
14653
6f96c7a908bd help/config: fix small typo
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14652
diff changeset
263 <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
264
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
265 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
266
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
267 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
268
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
269 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
270 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
271
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
272 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
273
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
274 .. note::
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
275
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
276 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
277 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
278 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
279
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
280 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
281 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
282 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
283
16513
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
284 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
285
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
286 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
287 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
288
31001
e7eca6e1372e doc: correct example concerning "hg purge" alias in man page "hgrc.5"
Rainer Woitok <Rainer.Woitok@Gmail.Com>
parents: 30941
diff changeset
289 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
290
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
291 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
292 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
293
16513
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
294 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
295 expand to the command arguments. Unmatched arguments are
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
296 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
297 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
298 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
299 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
300
aa252059a98f alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents: 16399
diff changeset
301 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
302 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
303 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
304 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
305 ``$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
306 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
307
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
308 .. note::
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
309
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
310 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
311 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
312 aliases.
62122c1c830b alias: note interaction of shell aliases with early opts in help
Matt Mackall <mpm@selenic.com>
parents: 14691
diff changeset
313
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
314
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
315 ``annotate``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
316 ------------
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
317
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
318 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
319 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
320 related options for the diff command.
15528
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 ``ignorews``
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
323 Ignore white space when comparing lines.
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
324
34013
da07367d683b mdiff: add a --ignore-space-at-eol option
David Soria Parra <davidsp@fb.com>
parents: 33260
diff changeset
325 ``ignorewseol``
da07367d683b mdiff: add a --ignore-space-at-eol option
David Soria Parra <davidsp@fb.com>
parents: 33260
diff changeset
326 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
327
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
328 ``ignorewsamount``
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
329 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
330
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
331 ``ignoreblanklines``
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
332 Ignore changes whose lines are all blank.
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
333
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
334
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
335 ``auth``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
336 --------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
337
31936
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
338 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
339 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
340 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
341 :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
342 your HTTP server.
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
343
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
344 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
345
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
346 ``cookiefile``
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
347 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
348 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
349
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
350 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
351 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
352 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
353 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
354 format."
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
355
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
356 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
357 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
358 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
359
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
360 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
361
806f9a883b4f url: support auth.cookiesfile for adding cookies to HTTP requests
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31747
diff changeset
362 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
363 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
364
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
365 <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
366
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
367 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
368 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
369
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
370 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
371 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
372 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
373 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
374
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
375 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
376 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
377 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
378 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
379
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
380 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
381
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
382 ``prefix``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
383 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
384 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
385 (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
386 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
387 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
388 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
389
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
390 ``username``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
391 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
392 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
393 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
394 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
395 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
396 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
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 ``password``
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. 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
400 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
401 will be prompted for it.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
402
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
403 ``key``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
404 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
405 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
406
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
407 ``cert``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
408 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
409 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
410
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
411 ``schemes``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
412 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
413 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
414 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
415 static-http and static-https respectively, as well.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
416 (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
417
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
418 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
419 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
420
45057
d6e99a446eea cmdserver: add option to not exit from message loop on SIGINT
Yuya Nishihara <yuya@tcha.org>
parents: 44412
diff changeset
421 ``cmdserver``
d6e99a446eea cmdserver: add option to not exit from message loop on SIGINT
Yuya Nishihara <yuya@tcha.org>
parents: 44412
diff changeset
422 -------------
d6e99a446eea cmdserver: add option to not exit from message loop on SIGINT
Yuya Nishihara <yuya@tcha.org>
parents: 44412
diff changeset
423
d6e99a446eea cmdserver: add option to not exit from message loop on SIGINT
Yuya Nishihara <yuya@tcha.org>
parents: 44412
diff changeset
424 Controls command server settings. (ADVANCED)
d6e99a446eea cmdserver: add option to not exit from message loop on SIGINT
Yuya Nishihara <yuya@tcha.org>
parents: 44412
diff changeset
425
45058
f43bc4ce0d69 cmdserver: document message-encodings and channel output options
Yuya Nishihara <yuya@tcha.org>
parents: 45057
diff changeset
426 ``message-encodings``
f43bc4ce0d69 cmdserver: document message-encodings and channel output options
Yuya Nishihara <yuya@tcha.org>
parents: 45057
diff changeset
427 List of encodings for the ``m`` (message) channel. The first encoding
f43bc4ce0d69 cmdserver: document message-encodings and channel output options
Yuya Nishihara <yuya@tcha.org>
parents: 45057
diff changeset
428 supported by the server will be selected and advertised in the hello
f43bc4ce0d69 cmdserver: document message-encodings and channel output options
Yuya Nishihara <yuya@tcha.org>
parents: 45057
diff changeset
429 message. This is useful only when ``ui.message-output`` is set to
f43bc4ce0d69 cmdserver: document message-encodings and channel output options
Yuya Nishihara <yuya@tcha.org>
parents: 45057
diff changeset
430 ``channel``. Supported encodings are ``cbor``.
f43bc4ce0d69 cmdserver: document message-encodings and channel output options
Yuya Nishihara <yuya@tcha.org>
parents: 45057
diff changeset
431
45057
d6e99a446eea cmdserver: add option to not exit from message loop on SIGINT
Yuya Nishihara <yuya@tcha.org>
parents: 44412
diff changeset
432 ``shutdown-on-interrupt``
d6e99a446eea cmdserver: add option to not exit from message loop on SIGINT
Yuya Nishihara <yuya@tcha.org>
parents: 44412
diff changeset
433 If set to false, the server's main loop will continue running after
d6e99a446eea cmdserver: add option to not exit from message loop on SIGINT
Yuya Nishihara <yuya@tcha.org>
parents: 44412
diff changeset
434 SIGINT received. ``runcommand`` requests can still be interrupted by
d6e99a446eea cmdserver: add option to not exit from message loop on SIGINT
Yuya Nishihara <yuya@tcha.org>
parents: 44412
diff changeset
435 SIGINT. Close the write end of the pipe to shut down the server
d6e99a446eea cmdserver: add option to not exit from message loop on SIGINT
Yuya Nishihara <yuya@tcha.org>
parents: 44412
diff changeset
436 process gracefully.
d6e99a446eea cmdserver: add option to not exit from message loop on SIGINT
Yuya Nishihara <yuya@tcha.org>
parents: 44412
diff changeset
437 (default: True)
d6e99a446eea cmdserver: add option to not exit from message loop on SIGINT
Yuya Nishihara <yuya@tcha.org>
parents: 44412
diff changeset
438
31123
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
439 ``color``
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
440 ---------
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
441
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
442 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
443 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
444
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
445 ``mode``
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
446 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
447 ``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
448 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
449 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
450
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
451 ``pagermode``
32139
de86a6872d06 help: spelling fixes
Matt Harbison <matt_harbison@yahoo.com>
parents: 32104
diff changeset
452 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
453
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
454 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
455 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
456 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
457 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
458 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
459 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
460 codes).
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
461
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
462 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
463 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
464
31557
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
465 ``commands``
31591
2c02bb7fd7fc help: format ``commands`` heading correctly
Martin von Zweigbergk <martinvonz@google.com>
parents: 31589
diff changeset
466 ------------
31557
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
467
42244
0f01394457a0 commit: add ability to print file status after each successful invocation
Anton Shestakov <av6@dwimlabs.net>
parents: 42139
diff changeset
468 ``commit.post-status``
0f01394457a0 commit: add ability to print file status after each successful invocation
Anton Shestakov <av6@dwimlabs.net>
parents: 42139
diff changeset
469 Show status of files in the working directory after successful commit.
0f01394457a0 commit: add ability to print file status after each successful invocation
Anton Shestakov <av6@dwimlabs.net>
parents: 42139
diff changeset
470 (default: False)
0f01394457a0 commit: add ability to print file status after each successful invocation
Anton Shestakov <av6@dwimlabs.net>
parents: 42139
diff changeset
471
43873
8caec25f5d8f merge: add commands.merge.require-rev to require an argument to hg merge
Kyle Lippincott <spectral@google.com>
parents: 43669
diff changeset
472 ``merge.require-rev``
8caec25f5d8f merge: add commands.merge.require-rev to require an argument to hg merge
Kyle Lippincott <spectral@google.com>
parents: 43669
diff changeset
473 Require that the revision to merge the current commit with be specified on
8caec25f5d8f merge: add commands.merge.require-rev to require an argument to hg merge
Kyle Lippincott <spectral@google.com>
parents: 43669
diff changeset
474 the command line. If this is enabled and a revision is not specified, the
8caec25f5d8f merge: add commands.merge.require-rev to require an argument to hg merge
Kyle Lippincott <spectral@google.com>
parents: 43669
diff changeset
475 command aborts.
8caec25f5d8f merge: add commands.merge.require-rev to require an argument to hg merge
Kyle Lippincott <spectral@google.com>
parents: 43669
diff changeset
476 (default: False)
8caec25f5d8f merge: add commands.merge.require-rev to require an argument to hg merge
Kyle Lippincott <spectral@google.com>
parents: 43669
diff changeset
477
43163
5617b748aad8 push: support config option to require revs be specified when running push
Kyle Lippincott <spectral@google.com>
parents: 42932
diff changeset
478 ``push.require-revs``
5617b748aad8 push: support config option to require revs be specified when running push
Kyle Lippincott <spectral@google.com>
parents: 42932
diff changeset
479 Require revisions to push be specified using one or more mechanisms such as
5617b748aad8 push: support config option to require revs be specified when running push
Kyle Lippincott <spectral@google.com>
parents: 42932
diff changeset
480 specifying them positionally on the command line, using ``-r``, ``-b``,
5617b748aad8 push: support config option to require revs be specified when running push
Kyle Lippincott <spectral@google.com>
parents: 42932
diff changeset
481 and/or ``-B`` on the command line, or using ``paths.<path>:pushrev`` in the
5617b748aad8 push: support config option to require revs be specified when running push
Kyle Lippincott <spectral@google.com>
parents: 42932
diff changeset
482 configuration. If this is enabled and revisions are not specified, the
5617b748aad8 push: support config option to require revs be specified when running push
Kyle Lippincott <spectral@google.com>
parents: 42932
diff changeset
483 command aborts.
5617b748aad8 push: support config option to require revs be specified when running push
Kyle Lippincott <spectral@google.com>
parents: 42932
diff changeset
484 (default: False)
5617b748aad8 push: support config option to require revs be specified when running push
Kyle Lippincott <spectral@google.com>
parents: 42932
diff changeset
485
38822
f8732e33bcbc resolve: add confirm config option
Sushil khanchi <sushilkhanchi97@gmail.com>
parents: 38754
diff changeset
486 ``resolve.confirm``
38875
755741c39230 resolve: update commands.resolve.confirm help text
Sushil khanchi <sushilkhanchi97@gmail.com>
parents: 38857
diff changeset
487 Confirm before performing action if no filename is passed.
38822
f8732e33bcbc resolve: add confirm config option
Sushil khanchi <sushilkhanchi97@gmail.com>
parents: 38754
diff changeset
488 (default: False)
f8732e33bcbc resolve: add confirm config option
Sushil khanchi <sushilkhanchi97@gmail.com>
parents: 38754
diff changeset
489
39393
56469d475341 resolve: add config to make hg resolve not re-merge by default
Valentin Gatien-Baron <valentin.gatienbaron@gmail.com>
parents: 39125
diff changeset
490 ``resolve.explicit-re-merge``
56469d475341 resolve: add config to make hg resolve not re-merge by default
Valentin Gatien-Baron <valentin.gatienbaron@gmail.com>
parents: 39125
diff changeset
491 Require uses of ``hg resolve`` to specify which action it should perform,
56469d475341 resolve: add config to make hg resolve not re-merge by default
Valentin Gatien-Baron <valentin.gatienbaron@gmail.com>
parents: 39125
diff changeset
492 instead of re-merging files by default.
56469d475341 resolve: add config to make hg resolve not re-merge by default
Valentin Gatien-Baron <valentin.gatienbaron@gmail.com>
parents: 39125
diff changeset
493 (default: False)
56469d475341 resolve: add config to make hg resolve not re-merge by default
Valentin Gatien-Baron <valentin.gatienbaron@gmail.com>
parents: 39125
diff changeset
494
38857
96d0795bd0bd resolve: graduate resolve.mark-check from experimental, add docs
Kyle Lippincott <spectral@google.com>
parents: 38822
diff changeset
495 ``resolve.mark-check``
96d0795bd0bd resolve: graduate resolve.mark-check from experimental, add docs
Kyle Lippincott <spectral@google.com>
parents: 38822
diff changeset
496 Determines what level of checking :hg:`resolve --mark` will perform before
96d0795bd0bd resolve: graduate resolve.mark-check from experimental, add docs
Kyle Lippincott <spectral@google.com>
parents: 38822
diff changeset
497 marking files as resolved. Valid values are ``none`, ``warn``, and
96d0795bd0bd resolve: graduate resolve.mark-check from experimental, add docs
Kyle Lippincott <spectral@google.com>
parents: 38822
diff changeset
498 ``abort``. ``warn`` will output a warning listing the file(s) that still
96d0795bd0bd resolve: graduate resolve.mark-check from experimental, add docs
Kyle Lippincott <spectral@google.com>
parents: 38822
diff changeset
499 have conflict markers in them, but will still mark everything resolved.
96d0795bd0bd resolve: graduate resolve.mark-check from experimental, add docs
Kyle Lippincott <spectral@google.com>
parents: 38822
diff changeset
500 ``abort`` will output the same warning but will not mark things as resolved.
96d0795bd0bd resolve: graduate resolve.mark-check from experimental, add docs
Kyle Lippincott <spectral@google.com>
parents: 38822
diff changeset
501 If --all is passed and this is set to ``abort``, only a warning will be
96d0795bd0bd resolve: graduate resolve.mark-check from experimental, add docs
Kyle Lippincott <spectral@google.com>
parents: 38822
diff changeset
502 shown (an error will not be raised).
96d0795bd0bd resolve: graduate resolve.mark-check from experimental, add docs
Kyle Lippincott <spectral@google.com>
parents: 38822
diff changeset
503 (default: ``none``)
96d0795bd0bd resolve: graduate resolve.mark-check from experimental, add docs
Kyle Lippincott <spectral@google.com>
parents: 38822
diff changeset
504
31589
7e3b145f8247 status: support commands.status.relative config
Martin von Zweigbergk <martinvonz@google.com>
parents: 31557
diff changeset
505 ``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
506 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
507 (default: False)
7e3b145f8247 status: support commands.status.relative config
Martin von Zweigbergk <martinvonz@google.com>
parents: 31557
diff changeset
508
38100
18424aeece7f status: add a config knob for setting default of --terse
Augie Fackler <augie@google.com>
parents: 37498
diff changeset
509 ``status.terse``
41106
dc56a6273575 help: fix typo
Ludovic Chabant <ludovic@chabant.com>
parents: 40547
diff changeset
510 Default value for the --terse flag, which condenses status output.
38100
18424aeece7f status: add a config knob for setting default of --terse
Augie Fackler <augie@google.com>
parents: 37498
diff changeset
511 (default: empty)
18424aeece7f status: add a config knob for setting default of --terse
Augie Fackler <augie@google.com>
parents: 37498
diff changeset
512
34705
23ed47a895d5 config: graduate experimental.updatecheck to commands.update.check
Augie Fackler <augie@google.com>
parents: 34314
diff changeset
513 ``update.check``
23ed47a895d5 config: graduate experimental.updatecheck to commands.update.check
Augie Fackler <augie@google.com>
parents: 34314
diff changeset
514 Determines what level of checking :hg:`update` will perform before moving
23ed47a895d5 config: graduate experimental.updatecheck to commands.update.check
Augie Fackler <augie@google.com>
parents: 34314
diff changeset
515 to a destination revision. Valid values are ``abort``, ``none``,
23ed47a895d5 config: graduate experimental.updatecheck to commands.update.check
Augie Fackler <augie@google.com>
parents: 34314
diff changeset
516 ``linear``, and ``noconflict``. ``abort`` always fails if the working
23ed47a895d5 config: graduate experimental.updatecheck to commands.update.check
Augie Fackler <augie@google.com>
parents: 34314
diff changeset
517 directory has uncommitted changes. ``none`` performs no checking, and may
23ed47a895d5 config: graduate experimental.updatecheck to commands.update.check
Augie Fackler <augie@google.com>
parents: 34314
diff changeset
518 result in a merge with uncommitted changes. ``linear`` allows any update
23ed47a895d5 config: graduate experimental.updatecheck to commands.update.check
Augie Fackler <augie@google.com>
parents: 34314
diff changeset
519 as long as it follows a straight line in the revision history, and may
23ed47a895d5 config: graduate experimental.updatecheck to commands.update.check
Augie Fackler <augie@google.com>
parents: 34314
diff changeset
520 trigger a merge with uncommitted changes. ``noconflict`` will allow any
23ed47a895d5 config: graduate experimental.updatecheck to commands.update.check
Augie Fackler <augie@google.com>
parents: 34314
diff changeset
521 update which would not trigger a merge with uncommitted changes, if any
23ed47a895d5 config: graduate experimental.updatecheck to commands.update.check
Augie Fackler <augie@google.com>
parents: 34314
diff changeset
522 are present.
23ed47a895d5 config: graduate experimental.updatecheck to commands.update.check
Augie Fackler <augie@google.com>
parents: 34314
diff changeset
523 (default: ``linear``)
23ed47a895d5 config: graduate experimental.updatecheck to commands.update.check
Augie Fackler <augie@google.com>
parents: 34314
diff changeset
524
31557
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
525 ``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
526 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
527 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
528 will be disallowed.
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
529 (default: False)
79d98e1b21a7 update: add flag to require update destination
Ryan McElroy <rmcelroy@fb.com>
parents: 31125
diff changeset
530
21924
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
531 ``committemplate``
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
532 ------------------
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
533
26169
ea888285311f help: config indent committemplate.changeset section
timeless@mozdev.org
parents: 26072
diff changeset
534 ``changeset``
ea888285311f help: config indent committemplate.changeset section
timeless@mozdev.org
parents: 26072
diff changeset
535 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
536 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
537
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
538 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
539 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
540
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
541 ``extramsg``
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
542 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
543 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
544
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
545 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
546 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
547
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
548 [committemplate]
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
549 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
550 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
551 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
552 HG: --
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
553 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
554 "HG: branch merge\n")
25014
7e5d5160073b templatekw: replace currentbookmark with activebookmark keyword
Ryan McElroy <rmcelroy@fb.com>
parents: 24830
diff changeset
555 }HG: branch '{branch}'\n{if(activebookmark,
7e5d5160073b templatekw: replace currentbookmark with activebookmark keyword
Ryan McElroy <rmcelroy@fb.com>
parents: 24830
diff changeset
556 "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
557 "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
558 "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
559 "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
560 "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
561 "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
562
30704
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
563 ``diff()``
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
564 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
565
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
566 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
567 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
568 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
569 it::
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
570
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
571 HG: ------------------------ >8 ------------------------
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
572
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
573 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
574 extra message::
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
575
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
576 [committemplate]
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
577 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
578 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
579 HG: {extramsg}
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
580 HG: ------------------------ >8 ------------------------
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
581 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
582 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
583 {diff()}
0499da0d5a06 config: add docs for ignoring all text below in the editor
Sean Farley <sean@farley.io>
parents: 30347
diff changeset
584
21924
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
585 .. note::
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
586
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
587 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
588 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
589 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
590
26281
5cac3bdb3c67 help/config: reword committemplate multibyte character text
timeless@mozdev.org
parents: 26280
diff changeset
591 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
592 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
593 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
594 (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
595
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
596 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
597 required):
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
598
5375ba75df40 cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21918
diff changeset
599 - :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
600 - :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
601 - :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
602 - :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
603 - :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
604 - :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
605 - :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
606 - :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
607 - :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
608 - :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
609 - :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
610 - :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
611
22012
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
612 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
613 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
614 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
615
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
616 - ``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
617 - ``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
618 - ``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
619 - ``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
620 - ``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
621 - ``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
622 - ``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
623 - ``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
624 - ``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
625 - ``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
626 - ``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
627 - ``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
628 - ``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
629 - ``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
630 - ``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
631 - ``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
632 - ``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
633 - ``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
634 - ``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
635 - ``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
636 - ``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
637 - ``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
638 - ``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
639 - ``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
640 - ``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
641 - ``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
642
9d92b9d1e282 cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 21924
diff changeset
643 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
644 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
645 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
646 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
647
26282
436f5ab16079 help/config: reword committemplate external editor text
timeless@mozdev.org
parents: 26281
diff changeset
648 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
649 dot-separated list of names without the ``changeset.`` prefix
436f5ab16079 help/config: reword committemplate external editor text
timeless@mozdev.org
parents: 26281
diff changeset
650 (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
651 variable.
22205
9fa429723f26 ui: invoke editor for committing with HGEDITFORM environment variable
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22158
diff changeset
652
22013
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
653 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
654 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
655 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
656
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
657 [committemplate]
de5cee8ba088 cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 22012
diff changeset
658 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
659 "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
660 "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
661 "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
662 "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
663
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
664 ``decode/encode``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
665 -----------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
666
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
667 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
668 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
669 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
670
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
671 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
672 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
673 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
674 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
675 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
676 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
677
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
678 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
679 ``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
680
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
681 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
682 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
683
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
684 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
685
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
686 [encode]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
687 # 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
688 # 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
689 *.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
690
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
691 [decode]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
692 # 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
693 # 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
694 *.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
695
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
696 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
697 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
698 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
699 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
700 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
701
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
702 .. container:: windows
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
703
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
704 .. note::
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
705
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
706 The tempfile mechanism is recommended for Windows systems,
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
707 where the standard shell I/O redirection operators often have
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
708 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
709
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
710 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
711 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
712 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
713
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
714
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
715 ``defaults``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
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
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
718 (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
719
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
720 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
721 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
722
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
723 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
724 :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
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 [defaults]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
727 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
728 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
729
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
730 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
731 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
732 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
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
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
735 ``diff``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
736 --------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
737
15528
a84698badf0b annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents: 15321
diff changeset
738 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
739 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
740 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
741
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
742 ``git``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
743 Use git extended diff format.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
744
22602
551d776a0a9a diff: document the nobinary option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 21924
diff changeset
745 ``nobinary``
551d776a0a9a diff: document the nobinary option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 21924
diff changeset
746 Omit git binary patches.
551d776a0a9a diff: document the nobinary option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 21924
diff changeset
747
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
748 ``nodates``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
749 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
750
23297
d7abae94a7a0 patch.diffopts: add support for noprefix
Siddharth Agarwal <sid0@fb.com>
parents: 23142
diff changeset
751 ``noprefix``
d7abae94a7a0 patch.diffopts: add support for noprefix
Siddharth Agarwal <sid0@fb.com>
parents: 23142
diff changeset
752 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
753
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
754 ``showfunc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
755 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
756
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
757 ``ignorews``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
758 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
759
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
760 ``ignorewsamount``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
761 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
762
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
763 ``ignoreblanklines``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
764 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
765
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
766 ``unified``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
767 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
768
38591
be441eb65f09 diff: graduate word-diff option from experimental
Yuya Nishihara <yuya@tcha.org>
parents: 38484
diff changeset
769 ``word-diff``
be441eb65f09 diff: graduate word-diff option from experimental
Yuya Nishihara <yuya@tcha.org>
parents: 38484
diff changeset
770 Highlight changed words.
be441eb65f09 diff: graduate word-diff option from experimental
Yuya Nishihara <yuya@tcha.org>
parents: 38484
diff changeset
771
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
772 ``email``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
773 ---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
774
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
775 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
776
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
777 ``from``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
778 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
779 of outgoing messages.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
780
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
781 ``to``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
782 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
783
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
784 ``cc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
785 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
786 email addresses.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
787
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
788 ``bcc``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
789 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
790 email addresses.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
791
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
792 ``method``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
793 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
794 (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
795 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
796 (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
797 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
798 ``/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
799
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
800 ``charsets``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
801 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
802 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
803 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
804 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
805 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
806 conversion fails, the text in question is sent as is.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
807 (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
808
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
809 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
810
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
811 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
812 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
813 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
814 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
815 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
816
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
817 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
818
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
819 [email]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
820 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
821 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
822 # 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
823 # 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
824 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
825
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
826
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
827 ``extensions``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
828 --------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
829
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
830 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
831 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
832
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
833 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
834 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
835 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
836
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
837 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
838 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
839 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
840
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
841 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
842 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
843 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
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 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
846
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
847 [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
848 # (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
849 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
850 # (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
851 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
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
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
854 ``format``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
855 ----------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
856
38735
8891dc15b327 config: document the purpose of the `format` config section
Boris Feld <boris.feld@octobus.net>
parents: 38725
diff changeset
857 Configuration that controls the repository format. Newer format options are more
44110
6ae32c12b578 help: minor copy editing to the `config.format` section
Matt Harbison <matt_harbison@yahoo.com>
parents: 43953
diff changeset
858 powerful, but incompatible with some older versions of Mercurial. Format options
38735
8891dc15b327 config: document the purpose of the `format` config section
Boris Feld <boris.feld@octobus.net>
parents: 38725
diff changeset
859 are considered at repository initialization only. You need to make a new clone
44110
6ae32c12b578 help: minor copy editing to the `config.format` section
Matt Harbison <matt_harbison@yahoo.com>
parents: 43953
diff changeset
860 for config changes to be taken into account.
38735
8891dc15b327 config: document the purpose of the `format` config section
Boris Feld <boris.feld@octobus.net>
parents: 38725
diff changeset
861
8891dc15b327 config: document the purpose of the `format` config section
Boris Feld <boris.feld@octobus.net>
parents: 38725
diff changeset
862 For more details about repository format and version compatibility, see
8891dc15b327 config: document the purpose of the `format` config section
Boris Feld <boris.feld@octobus.net>
parents: 38725
diff changeset
863 https://www.mercurial-scm.org/wiki/MissingRequirement
8891dc15b327 config: document the purpose of the `format` config section
Boris Feld <boris.feld@octobus.net>
parents: 38725
diff changeset
864
26907
dfab6edb98e3 format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26730
diff changeset
865 ``usegeneraldelta``
dfab6edb98e3 format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26730
diff changeset
866 Enable or disable the "generaldelta" repository format which improves
44110
6ae32c12b578 help: minor copy editing to the `config.format` section
Matt Harbison <matt_harbison@yahoo.com>
parents: 43953
diff changeset
867 repository compression by allowing "revlog" to store deltas against
6ae32c12b578 help: minor copy editing to the `config.format` section
Matt Harbison <matt_harbison@yahoo.com>
parents: 43953
diff changeset
868 arbitrary revisions instead of the previously stored one. This provides
6ae32c12b578 help: minor copy editing to the `config.format` section
Matt Harbison <matt_harbison@yahoo.com>
parents: 43953
diff changeset
869 significant improvement for repositories with branches.
27606
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
870
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
871 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
872
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
873 Enabled by default.
26907
dfab6edb98e3 format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26730
diff changeset
874
27605
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
875 ``dotencode``
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
876 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
877 the "fncache" repository format (which has to be enabled to use
44110
6ae32c12b578 help: minor copy editing to the `config.format` section
Matt Harbison <matt_harbison@yahoo.com>
parents: 43953
diff changeset
878 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
879 Mac OS X and spaces on Windows.
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
880
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
881 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
882
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
883 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
884
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
885 ``usefncache``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
886 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
887 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
888 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
889 reserved names, e.g. "nul".
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
890
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
891 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
892
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
893 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
894
48674
f7086f6173f8 dirstate-v2: rename the configuration to enable the format
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48534
diff changeset
895 ``use-dirstate-v2``
48533
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
896 Enable or disable the experimental "dirstate-v2" feature. The dirstate
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
897 functionality is shared by all commands interacting with the working copy.
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
898 The new version is more robust, faster and stores more information.
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
899
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
900 The performance-improving version of this feature is currently only
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
901 implemented in Rust (see :hg:`help rust`), so people not using a version of
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
902 Mercurial compiled with the Rust parts might actually suffer some slowdown.
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
903 For this reason, such versions will by default refuse to access repositories
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
904 with "dirstate-v2" enabled.
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
905
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
906 This behavior can be adjusted via configuration: check
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
907 :hg:`help config.storage.dirstate-v2.slow-path` for details.
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
908
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
909 Repositories with this on-disk format require Mercurial 6.0 or above.
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
910
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
911 By default this format variant is disabled if the fast implementation is not
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
912 available, and enabled by default if the fast implementation is available.
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
913
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
914 To accomodate installations of Mercurial without the fast implementation,
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
915 you can downgrade your repository. To do so run the following command:
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
916
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
917 $ hg debugupgraderepo \
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
918 --run \
48674
f7086f6173f8 dirstate-v2: rename the configuration to enable the format
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48534
diff changeset
919 --config format.use-dirstate-v2=False \
48533
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
920 --config storage.dirstate-v2.slow-path=allow
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
921
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
922 For a more comprehensive guide, see :hg:`help internals.dirstate-v2`.
5e7a0348acf8 docs: add missing dirstate-v2 documentation
Raphaël Gomès <rgomes@octobus.net>
parents: 48244
diff changeset
923
46305
8b94f05ab069 persistent-nodemap: document the feature in `hg help config.format`
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46139
diff changeset
924 ``use-persistent-nodemap``
8b94f05ab069 persistent-nodemap: document the feature in `hg help config.format`
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46139
diff changeset
925 Enable or disable the "persistent-nodemap" feature which improves
48534
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
926 performance if the Rust extensions are available.
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
927
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
928 The "persistent-nodemap" persist the "node -> rev" on disk removing the
46305
8b94f05ab069 persistent-nodemap: document the feature in `hg help config.format`
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46139
diff changeset
929 need to dynamically build that mapping for each Mercurial invocation. This
48534
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
930 significantly reduces the startup cost of various local and server-side
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
931 operation for larger repositories.
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
932
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
933 The performance-improving version of this feature is currently only
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
934 implemented in Rust (see :hg:`help rust`), so people not using a version of
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
935 Mercurial compiled with the Rust parts might actually suffer some slowdown.
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
936 For this reason, such versions will by default refuse to access repositories
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
937 with "persistent-nodemap".
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
938
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
939 This behavior can be adjusted via configuration: check
47768
c2b8ad34d245 help: use the correct spelling for `slow-path` in persistent nodemap help
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47274
diff changeset
940 :hg:`help config.storage.revlog.persistent-nodemap.slow-path` for details.
46305
8b94f05ab069 persistent-nodemap: document the feature in `hg help config.format`
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46139
diff changeset
941
48534
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
942 Repositories with this on-disk format require Mercurial 5.4 or above.
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
943
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
944 By default this format variant is disabled if the fast implementation is not
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
945 available, and enabled by default if the fast implementation is available.
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
946
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
947 To accomodate installations of Mercurial without the fast implementation,
7e7eaef091c6 docs: fix typos and wording for the persistent-nodemap feature
Raphaël Gomès <rgomes@octobus.net>
parents: 48533
diff changeset
948 you can downgrade your repository. To do so run the following command:
47769
6d79894d3460 help: indicate how to run downgrade a repository using persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47768
diff changeset
949
6d79894d3460 help: indicate how to run downgrade a repository using persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47768
diff changeset
950 $ hg debugupgraderepo \
6d79894d3460 help: indicate how to run downgrade a repository using persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47768
diff changeset
951 --run \
6d79894d3460 help: indicate how to run downgrade a repository using persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47768
diff changeset
952 --config format.use-persistent-nodemap=False \
6d79894d3460 help: indicate how to run downgrade a repository using persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47768
diff changeset
953 --config storage.revlog.persistent-nodemap.slow-path=allow
6d79894d3460 help: indicate how to run downgrade a repository using persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47768
diff changeset
954
46337
6e81446bf1d9 share: move share safe functionality out of experimental
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46336
diff changeset
955 ``use-share-safe``
46346
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
956 Enforce "safe" behaviors for all "shares" that access this repository.
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
957
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
958 With this feature, "shares" using this repository as a source will:
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
959
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
960 * read the source repository's configuration (`<source>/.hg/hgrc`).
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
961 * read and use the source repository's "requirements"
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
962 (except the working copy specific one).
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
963
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
964 Without this feature, "shares" using this repository as a source will:
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
965
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
966 * keep tracking the repository "requirements" in the share only, ignoring
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
967 the source "requirements", possibly diverging from them.
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
968 * ignore source repository config. This can create problems, like silently
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
969 ignoring important hooks.
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
970
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
971 Beware that existing shares will not be upgraded/downgraded, and by
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
972 default, Mercurial will refuse to interact with them until the mismatch
48725
4344fd2687dc help: add missing `.` in config reference
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48674
diff changeset
973 is resolved. See :hg:`help config.share.safe-mismatch.source-safe` and
4344fd2687dc help: add missing `.` in config reference
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48674
diff changeset
974 :hg:`help config.share.safe-mismatch.source-not-safe` for details.
46346
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
975
60e6bf3bf681 doc: improves the share-safe documentation
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46345
diff changeset
976 Introduced in Mercurial 5.7.
46337
6e81446bf1d9 share: move share safe functionality out of experimental
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46336
diff changeset
977
6e81446bf1d9 share: move share safe functionality out of experimental
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46336
diff changeset
978 Disabled by default.
6e81446bf1d9 share: move share safe functionality out of experimental
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46336
diff changeset
979
27605
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
980 ``usestore``
7793b3e220f6 help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents: 27552
diff changeset
981 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
982 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
983 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
984 in some situations at the expense of compatibility.
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
985
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
986 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
987
ebe57ccd4822 help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents: 27605
diff changeset
988 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
989
41446
261d37b94d31 sparserevlog: document the config option
Boris Feld <boris.feld@octobus.net>
parents: 41207
diff changeset
990 ``sparse-revlog``
261d37b94d31 sparserevlog: document the config option
Boris Feld <boris.feld@octobus.net>
parents: 41207
diff changeset
991 Enable or disable the ``sparse-revlog`` delta strategy. This format improves
261d37b94d31 sparserevlog: document the config option
Boris Feld <boris.feld@octobus.net>
parents: 41207
diff changeset
992 delta re-use inside revlog. For very branchy repositories, it results in a
261d37b94d31 sparserevlog: document the config option
Boris Feld <boris.feld@octobus.net>
parents: 41207
diff changeset
993 smaller store. For repositories with many revisions, it also helps
261d37b94d31 sparserevlog: document the config option
Boris Feld <boris.feld@octobus.net>
parents: 41207
diff changeset
994 performance (by using shortened delta chains.)
261d37b94d31 sparserevlog: document the config option
Boris Feld <boris.feld@octobus.net>
parents: 41207
diff changeset
995
261d37b94d31 sparserevlog: document the config option
Boris Feld <boris.feld@octobus.net>
parents: 41207
diff changeset
996 Repositories with this on-disk format require Mercurial version 4.7
261d37b94d31 sparserevlog: document the config option
Boris Feld <boris.feld@octobus.net>
parents: 41207
diff changeset
997
261d37b94d31 sparserevlog: document the config option
Boris Feld <boris.feld@octobus.net>
parents: 41207
diff changeset
998 Enabled by default.
42515
a504aed0a78a help: add a missing blank line to unhide `revlog-compression`
Matt Harbison <matt_harbison@yahoo.com>
parents: 42139
diff changeset
999
42046
4ee906aa7b60 compression: introduce an official `format.revlog-compression` option
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 42044
diff changeset
1000 ``revlog-compression``
44110
6ae32c12b578 help: minor copy editing to the `config.format` section
Matt Harbison <matt_harbison@yahoo.com>
parents: 43953
diff changeset
1001 Compression algorithm used by revlog. Supported values are `zlib` and
6ae32c12b578 help: minor copy editing to the `config.format` section
Matt Harbison <matt_harbison@yahoo.com>
parents: 43953
diff changeset
1002 `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is
6ae32c12b578 help: minor copy editing to the `config.format` section
Matt Harbison <matt_harbison@yahoo.com>
parents: 43953
diff changeset
1003 a newer format that is usually a net win over `zlib`, operating faster at
44382
f0027a3dd7cb revlog-compression: update the config to be a list
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 44110
diff changeset
1004 better compression rates. Use `zstd` to reduce CPU usage. Multiple values
f0027a3dd7cb revlog-compression: update the config to be a list
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 44110
diff changeset
1005 can be specified, the first available one will be used.
44110
6ae32c12b578 help: minor copy editing to the `config.format` section
Matt Harbison <matt_harbison@yahoo.com>
parents: 43953
diff changeset
1006
6ae32c12b578 help: minor copy editing to the `config.format` section
Matt Harbison <matt_harbison@yahoo.com>
parents: 43953
diff changeset
1007 On some systems, the Mercurial installation may lack `zstd` support.
6ae32c12b578 help: minor copy editing to the `config.format` section
Matt Harbison <matt_harbison@yahoo.com>
parents: 43953
diff changeset
1008
46874
84a93fa7ecfd revlog-compression: use zstd by default (if available)
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46675
diff changeset
1009 Default is `zstd` if available, `zlib` otherwise.
41446
261d37b94d31 sparserevlog: document the config option
Boris Feld <boris.feld@octobus.net>
parents: 41207
diff changeset
1010
42325
526750cdd02d bookmarks: keep bookmarks in .hg/store if new config set
Martin von Zweigbergk <martinvonz@google.com>
parents: 42315
diff changeset
1011 ``bookmarks-in-store``
526750cdd02d bookmarks: keep bookmarks in .hg/store if new config set
Martin von Zweigbergk <martinvonz@google.com>
parents: 42315
diff changeset
1012 Store bookmarks in .hg/store/. This means that bookmarks are shared when
526750cdd02d bookmarks: keep bookmarks in .hg/store if new config set
Martin von Zweigbergk <martinvonz@google.com>
parents: 42315
diff changeset
1013 using `hg share` regardless of the `-B` option.
526750cdd02d bookmarks: keep bookmarks in .hg/store if new config set
Martin von Zweigbergk <martinvonz@google.com>
parents: 42315
diff changeset
1014
526750cdd02d bookmarks: keep bookmarks in .hg/store if new config set
Martin von Zweigbergk <martinvonz@google.com>
parents: 42315
diff changeset
1015 Repositories with this on-disk format require Mercurial version 5.1.
526750cdd02d bookmarks: keep bookmarks in .hg/store if new config set
Martin von Zweigbergk <martinvonz@google.com>
parents: 42315
diff changeset
1016
526750cdd02d bookmarks: keep bookmarks in .hg/store if new config set
Martin von Zweigbergk <martinvonz@google.com>
parents: 42315
diff changeset
1017 Disabled by default.
526750cdd02d bookmarks: keep bookmarks in .hg/store if new config set
Martin von Zweigbergk <martinvonz@google.com>
parents: 42315
diff changeset
1018
526750cdd02d bookmarks: keep bookmarks in .hg/store if new config set
Martin von Zweigbergk <martinvonz@google.com>
parents: 42315
diff changeset
1019
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
1020 ``graph``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1021 ---------
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
1022
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1023 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
1024 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
1025 ``default`` branch stand out.
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
1026
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1027 Each line has the following format::
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1028
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1029 <branch>.<argument> = <value>
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
1030
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1031 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
1032 customized. Example::
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1033
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1034 [graph]
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1035 # 2px width
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1036 default.width = 2
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1037 # red color
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1038 default.color = FF0000
16129
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
1039
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
1040 Supported arguments:
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
1041
5e50982c633c graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16005
diff changeset
1042 ``width``
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1043 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
1044
16130
33f702e52906 graph: in hgrc specify line color for main branch
Constantine Linnick <theaspect@gmail.com>
parents: 16129
diff changeset
1045 ``color``
16139
461a59e2765a doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents: 16130
diff changeset
1046 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
1047
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1048 ``hooks``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1049 ---------
14456
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 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
1052 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
1053 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
1054 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
1055 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
1056 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
1057 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
1058
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1059 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
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 [hooks]
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1062 # 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
1063 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
1064 # 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
1065 incoming =
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1066 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
1067 incoming.autobuild = /my/build/hook
15896
30c34fde40cc hooks: prioritize run order of hooks
Matt Zuba <matt.zuba@goodwillaz.org>
parents: 15612
diff changeset
1068 # 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
1069 priority.incoming.autobuild = 1
46492
7289eac777ec hooks: introduce a `:run-with-plain` option for hooks
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46347
diff changeset
1070 ### control HGPLAIN setting when running autobuild hook
7289eac777ec hooks: introduce a `:run-with-plain` option for hooks
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46347
diff changeset
1071 # HGPLAIN always set (default from Mercurial 5.7)
7289eac777ec hooks: introduce a `:run-with-plain` option for hooks
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46347
diff changeset
1072 incoming.autobuild:run-with-plain = yes
7289eac777ec hooks: introduce a `:run-with-plain` option for hooks
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46347
diff changeset
1073 # HGPLAIN never set
7289eac777ec hooks: introduce a `:run-with-plain` option for hooks
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46347
diff changeset
1074 incoming.autobuild:run-with-plain = no
46522
6c8faeea6652 helptext: fix a recent typo
Matt Harbison <matt_harbison@yahoo.com>
parents: 46493
diff changeset
1075 # HGPLAIN inherited from environment (default before Mercurial 5.7)
46493
b910be772eb9 hooks: add a `auto` value for `hooks.*run-with-plain`
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46492
diff changeset
1076 incoming.autobuild:run-with-plain = auto
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1077
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1078 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
1079 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
1080 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
1081 ``$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
1082 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
1083 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
1084 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
1085
38484
e9e61fbac787 hooks: allow Unix style environment variables on external Windows hooks
Matt Harbison <matt_harbison@yahoo.com>
parents: 38260
diff changeset
1086 .. container:: windows
e9e61fbac787 hooks: allow Unix style environment variables on external Windows hooks
Matt Harbison <matt_harbison@yahoo.com>
parents: 38260
diff changeset
1087
38722
2009d84f245a hook: disable the shell to native command translation by default
Matt Harbison <matt_harbison@yahoo.com>
parents: 38629
diff changeset
1088 Some basic Unix syntax can be enabled for portability, including ``$VAR``
38725
c382c19ce9bd windows: expand '~/' and '~\' to %USERPROFILE% when translating to cmd.exe
Matt Harbison <matt_harbison@yahoo.com>
parents: 38724
diff changeset
1089 and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will
c382c19ce9bd windows: expand '~/' and '~\' to %USERPROFILE% when translating to cmd.exe
Matt Harbison <matt_harbison@yahoo.com>
parents: 38724
diff changeset
1090 be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
c382c19ce9bd windows: expand '~/' and '~\' to %USERPROFILE% when translating to cmd.exe
Matt Harbison <matt_harbison@yahoo.com>
parents: 38724
diff changeset
1091 on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back
c382c19ce9bd windows: expand '~/' and '~\' to %USERPROFILE% when translating to cmd.exe
Matt Harbison <matt_harbison@yahoo.com>
parents: 38724
diff changeset
1092 slash or inside of a strong quote. Strong quotes will be replaced by
c382c19ce9bd windows: expand '~/' and '~\' to %USERPROFILE% when translating to cmd.exe
Matt Harbison <matt_harbison@yahoo.com>
parents: 38724
diff changeset
1093 double quotes after processing.
38722
2009d84f245a hook: disable the shell to native command translation by default
Matt Harbison <matt_harbison@yahoo.com>
parents: 38629
diff changeset
1094
2009d84f245a hook: disable the shell to native command translation by default
Matt Harbison <matt_harbison@yahoo.com>
parents: 38629
diff changeset
1095 This feature is enabled by adding a prefix of ``tonative.`` to the hook
2009d84f245a hook: disable the shell to native command translation by default
Matt Harbison <matt_harbison@yahoo.com>
parents: 38629
diff changeset
1096 name on a new line, and setting it to ``True``. For example::
38629
38dfd308fe9d hook: add support for disabling the shell to native command translation
Matt Harbison <matt_harbison@yahoo.com>
parents: 38600
diff changeset
1097
38dfd308fe9d hook: add support for disabling the shell to native command translation
Matt Harbison <matt_harbison@yahoo.com>
parents: 38600
diff changeset
1098 [hooks]
38dfd308fe9d hook: add support for disabling the shell to native command translation
Matt Harbison <matt_harbison@yahoo.com>
parents: 38600
diff changeset
1099 incoming.autobuild = /my/build/hook
38722
2009d84f245a hook: disable the shell to native command translation by default
Matt Harbison <matt_harbison@yahoo.com>
parents: 38629
diff changeset
1100 # enable translation to cmd.exe syntax for autobuild hook
2009d84f245a hook: disable the shell to native command translation by default
Matt Harbison <matt_harbison@yahoo.com>
parents: 38629
diff changeset
1101 tonative.incoming.autobuild = True
38484
e9e61fbac787 hooks: allow Unix style environment variables on external Windows hooks
Matt Harbison <matt_harbison@yahoo.com>
parents: 38260
diff changeset
1102
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1103 ``changegroup``
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
1104 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
1105 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
1106 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
1107
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1108 ``commit``
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
1109 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
1110 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
1111 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
1112
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1113 ``incoming``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1114 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
1115 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
1116 ``$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
1117
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1118 ``outgoing``
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
1119 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
1120 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
1121 ``$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
1122
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1123 ``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
1124 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
1125 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
1126 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
1127 ``$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
1128 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
1129 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
1130 ``$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
1131
29129
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
1132 ``fail-<command>``
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
1133 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
1134 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
1135 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
1136 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
1137 <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
1138 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
1139 Hook failure is ignored.
e6dfb0e4eeef dispatch: add fail-* family of hooks
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 29070
diff changeset
1140
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1141 ``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
1142 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
1143 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
1144 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
1145 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
1146 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
1147 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
1148 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
1149 code.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1150
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1151 ``prechangegroup``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1152 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
1153 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
1154 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
1155 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
1156
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1157 ``precommit``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1158 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
1159 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
1160 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
1161
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1162 ``prelistkeys``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1163 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
1164 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
1165 in ``$HG_NAMESPACE``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1166
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1167 ``preoutgoing``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1168 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
1169 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
1170 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
1171 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
1172 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
1173 ``$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
1174 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
1175 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
1176
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1177 ``prepushkey``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1178 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
1179 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
1180 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
1181 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
1182 ``$HG_NEW``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1183
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1184 ``pretag``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1185 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
1186 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
1187 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
1188 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
1189
24281
e9ede9b4c2f8 hook: have a generic hook for transaction opening
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 23629
diff changeset
1190 ``pretxnopen``
e9ede9b4c2f8 hook: have a generic hook for transaction opening
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 23629
diff changeset
1191 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
1192 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
46967
314386a19cff help: prepend environment variables used in hooks with "$"
Aay Jay Chan <aayjaychan@itopia.com.hk>
parents: 46905
diff changeset
1193 transaction will be in ``$HG_TXNID``. A non-zero status will prevent the
24791
89c5881d692c help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24663
diff changeset
1194 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
1195
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
1196 ``pretxnclose``
27739
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
1197 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
1198 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
1199 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
1200 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
1201 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
46967
314386a19cff help: prepend environment variables used in hooks with "$"
Aay Jay Chan <aayjaychan@itopia.com.hk>
parents: 46905
diff changeset
1202 the transaction will be in ``$HG_TXNID``. The rest of the available data will
46972
6904a9f33b30 help: clarify when `$HG_URL` and `$HG_SOURCE` are added in hooks
Aay Jay Chan <aayjaychan@itopia.com.hk>
parents: 46968
diff changeset
1203 vary according the transaction type. Changes unbundled to the repository will
6904a9f33b30 help: clarify when `$HG_URL` and `$HG_SOURCE` are added in hooks
Aay Jay Chan <aayjaychan@itopia.com.hk>
parents: 46968
diff changeset
1204 add ``$HG_URL`` and ``$HG_SOURCE``. New changesets will add ``$HG_NODE`` (the
6904a9f33b30 help: clarify when `$HG_URL` and `$HG_SOURCE` are added in hooks
Aay Jay Chan <aayjaychan@itopia.com.hk>
parents: 46968
diff changeset
1205 ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last added
6904a9f33b30 help: clarify when `$HG_URL` and `$HG_SOURCE` are added in hooks
Aay Jay Chan <aayjaychan@itopia.com.hk>
parents: 46968
diff changeset
1206 changeset). Bookmark and phase changes will set ``$HG_BOOKMARK_MOVED`` and
6904a9f33b30 help: clarify when `$HG_URL` and `$HG_SOURCE` are added in hooks
Aay Jay Chan <aayjaychan@itopia.com.hk>
parents: 46968
diff changeset
1207 ``$HG_PHASES_MOVED`` to ``1`` respectively. The number of new obsmarkers, if
6904a9f33b30 help: clarify when `$HG_URL` and `$HG_SOURCE` are added in hooks
Aay Jay Chan <aayjaychan@itopia.com.hk>
parents: 46968
diff changeset
1208 any, will be in ``$HG_NEW_OBSMARKERS``, 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
1209
34709
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1210 ``pretxnclose-bookmark``
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1211 Run right before a bookmark change is actually finalized. Any repository
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1212 change will be visible to the hook program. This lets you validate the
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1213 transaction content or change it. Exit status 0 allows the commit to
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1214 proceed. A non-zero status will cause the transaction to be rolled back.
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1215 The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1216 bookmark location will be available in ``$HG_NODE`` while the previous
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1217 location will be available in ``$HG_OLDNODE``. In case of a bookmark
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1218 creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1219 will be empty.
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1220 In addition, the reason for the transaction opening will be in
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1221 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
46967
314386a19cff help: prepend environment variables used in hooks with "$"
Aay Jay Chan <aayjaychan@itopia.com.hk>
parents: 46905
diff changeset
1222 ``$HG_TXNID``.
34709
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1223
34711
f6d17075608f phase: add a dedicated pretxnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34710
diff changeset
1224 ``pretxnclose-phase``
f6d17075608f phase: add a dedicated pretxnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34710
diff changeset
1225 Run right before a phase change is actually finalized. Any repository change
f6d17075608f phase: add a dedicated pretxnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34710
diff changeset
1226 will be visible to the hook program. This lets you validate the transaction
f6d17075608f phase: add a dedicated pretxnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34710
diff changeset
1227 content or change it. Exit status 0 allows the commit to proceed. A non-zero
34931
3f8273172636 help: clarify the pre-txnclose-phase documentation
Boris Feld <boris.feld@octobus.net>
parents: 34872
diff changeset
1228 status will cause the transaction to be rolled back. The hook is called
3f8273172636 help: clarify the pre-txnclose-phase documentation
Boris Feld <boris.feld@octobus.net>
parents: 34872
diff changeset
1229 multiple times, once for each revision affected by a phase change.
34711
f6d17075608f phase: add a dedicated pretxnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34710
diff changeset
1230 The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
f6d17075608f phase: add a dedicated pretxnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34710
diff changeset
1231 while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
f6d17075608f phase: add a dedicated pretxnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34710
diff changeset
1232 will be empty. In addition, the reason for the transaction opening will be in
f6d17075608f phase: add a dedicated pretxnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34710
diff changeset
1233 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
46967
314386a19cff help: prepend environment variables used in hooks with "$"
Aay Jay Chan <aayjaychan@itopia.com.hk>
parents: 46905
diff changeset
1234 ``$HG_TXNID``. The hook is also run for newly added revisions. In this case
34931
3f8273172636 help: clarify the pre-txnclose-phase documentation
Boris Feld <boris.feld@octobus.net>
parents: 34872
diff changeset
1235 the ``$HG_OLDPHASE`` entry will be empty.
34711
f6d17075608f phase: add a dedicated pretxnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34710
diff changeset
1236
24282
db8679812f84 hook: add a generic hook after transaction has been closed
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24281
diff changeset
1237 ``txnclose``
24814
60e4258b2052 help: fix typo commited -> committed
Javi Merino <merino.jav@gmail.com>
parents: 24792
diff changeset
1238 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
1239 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
1240 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
1241 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
1242
34708
ee5f0d047b41 bookmark: add a dedicated txnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34705
diff changeset
1243 ``txnclose-bookmark``
ee5f0d047b41 bookmark: add a dedicated txnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34705
diff changeset
1244 Run after any bookmark change has been committed. At this point, the
ee5f0d047b41 bookmark: add a dedicated txnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34705
diff changeset
1245 transaction can no longer be rolled back. The hook will run after the lock
34709
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1246 is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
c212947273a7 bookmark: add a dedicated pretxnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34708
diff changeset
1247 about available variables.
34708
ee5f0d047b41 bookmark: add a dedicated txnclose-bookmark hook
Boris Feld <boris.feld@octobus.net>
parents: 34705
diff changeset
1248
34710
cdf833d7de98 phase: add a dedicated txnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34709
diff changeset
1249 ``txnclose-phase``
cdf833d7de98 phase: add a dedicated txnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34709
diff changeset
1250 Run after any phase change has been committed. At this point, the
cdf833d7de98 phase: add a dedicated txnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34709
diff changeset
1251 transaction can no longer be rolled back. The hook will run after the lock
34711
f6d17075608f phase: add a dedicated pretxnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34710
diff changeset
1252 is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
f6d17075608f phase: add a dedicated pretxnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34710
diff changeset
1253 available variables.
34710
cdf833d7de98 phase: add a dedicated txnclose-phase hook
Boris Feld <boris.feld@octobus.net>
parents: 34709
diff changeset
1254
24792
7d0421de8de3 hooks: add a 'txnabort' hook
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24791
diff changeset
1255 ``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
1256 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
1257 for details about available variables.
24792
7d0421de8de3 hooks: add a 'txnabort' hook
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 24791
diff changeset
1258
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1259 ``pretxnchangegroup``
27739
d6d3cf5fda6f hooks: add HG_NODE_LAST to txnclose and changegroup hook environments
Mateusz Kwapich <mitrandir@fb.com>
parents: 27738
diff changeset
1260 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
1261 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
1262 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
1263 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
1264 ``$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
1265 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
1266 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
1267
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1268 ``pretxncommit``
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
1269 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
1270 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
1271 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
1272 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
1273 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
1274 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
1275
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1276 ``preupdate``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1277 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
1278 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
1279 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
1280 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
1281
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1282 ``listkeys``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1283 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
1284 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
1285 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
1286
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1287 ``pushkey``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1288 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
1289 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
1290 ``$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
1291 value is in ``$HG_NEW``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1292
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1293 ``tag``
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
1294 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
1295 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
1296 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
1297
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1298 ``update``
33170
26c49ed51a69 help: cleanup grammar in the hooks section
Matt Harbison <matt_harbison@yahoo.com>
parents: 32139
diff changeset
1299 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
1300 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
1301 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
1302 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
1303
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
1304 .. note::
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
1305
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
1306 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
1307 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
1308 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
1309 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
1310 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
1311
20532
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
1312 .. note::
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
1313
f1a3ae7c15df help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents: 20490
diff changeset
1314 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
1315 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
1316 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
1317 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
1318
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1319 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
1320
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1321 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
1322 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
1323
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1324 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
1325 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
1326 ``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
1327 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
1328 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
1329 ``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
1330
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1331 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
1332 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
1333
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1334
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1335 ``hostfingerprints``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1336 --------------------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1337
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1338 (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
1339
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1340 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
1341
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1342 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
1343 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
1344 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
1345
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1346 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
1347 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
1348 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
1349 to a new certificate.
28524
ce1160ae2150 help: add empty lines to hostfingerprints section
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28218
diff changeset
1350
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1351 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
1352
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1353 For example::
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1354
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1355 [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
1356 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
1357 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
1358
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1359 ``hostsecurity``
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1360 ----------------
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1361
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
1362 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
1363 other machines.
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
1364
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
1365 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
1366
29577
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
1367 ``ciphers``
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
1368 Defines the cryptographic ciphers to use for connections.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
1369
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
1370 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
1371 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
1372
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
1373 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
1374 can significantly lower connection security or decrease performance.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
1375 You have been warned.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
1376
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
1377 This option requires Python 2.7.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
1378
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
1379 ``minimumprotocol``
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
1380 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
1381
29560
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
1382 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
1383 is used.
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
1384
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
1385 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
1386
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
1387 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
1388 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
1389
303e9300772a sslutil: require TLS 1.1+ when supported
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29559
diff changeset
1390 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
1391 ``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
1392 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
1393 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
1394
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
1395 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
1396 ``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
1397 per-host basis.
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1398
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1399 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
1400
29577
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
1401 ``ciphers``
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
1402 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
1403 to the host on which it is defined.
9654ef41f7cc sslutil: support defining cipher list
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29560
diff changeset
1404
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1405 ``fingerprints``
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1406 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
1407 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
1408 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
32274
2b017d22fe97 help: clarify that colons are allowed in fingerprints values
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32260
diff changeset
1409 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
1410
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1411 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
1412 ``sha512``.
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1413
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1414 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
1415
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1416 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
1417 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
1418 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
1419 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
1420 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
1421 at the expense of convenience.
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1422
29334
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1423 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
1424
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
1425 ``minimumprotocol``
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
1426 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
1427 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
1428
29334
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1429 ``verifycertsfile``
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1430 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
1431 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
1432 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
1433
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1434 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
1435 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
1436 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
1437
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1438 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
1439 ``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
1440 used.
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1441
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1442 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
1443 is set.
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1444
29649
512611246ea4 doc: make previous line of certificate example end with "::"
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 29648
diff changeset
1445 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
1446
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1447 -----BEGIN CERTIFICATE-----
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1448 ... (certificate in base64 PEM encoding) ...
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1449 -----END CERTIFICATE-----
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1450 -----BEGIN CERTIFICATE-----
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1451 ... (certificate in base64 PEM encoding) ...
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1452 -----END CERTIFICATE-----
ecc9b788fd69 sslutil: per-host config option to define certificates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29285
diff changeset
1453
29267
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1454 For example::
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1455
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1456 [hostsecurity]
f0ccb6cde3e5 sslutil: allow fingerprints to be specified in [hostsecurity]
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29129
diff changeset
1457 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
1458 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
1459 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
1460 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
1461
29559
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
1462 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
1463 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
1464
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
1465 [hostsecurity]
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
1466 minimumprotocol = tls1.2
7dec5e441bf7 sslutil: config option to specify TLS protocol version
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29471
diff changeset
1467 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
1468
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1469 ``http_proxy``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1470 --------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1471
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1472 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
1473 proxy.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1474
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1475 ``host``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1476 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
1477 "myproxy:8000".
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1478
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1479 ``no``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1480 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
1481 the proxy.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1482
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 ``passwd``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1484 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
1485
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1486 ``user``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1487 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
1488
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1489 ``always``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1490 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
1491 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
1492
40043
6509fcec830c url: allow to configure timeout on http connection
Cédric Krier <ced@b2ck.com>
parents: 39792
diff changeset
1493 ``http``
6509fcec830c url: allow to configure timeout on http connection
Cédric Krier <ced@b2ck.com>
parents: 39792
diff changeset
1494 ----------
6509fcec830c url: allow to configure timeout on http connection
Cédric Krier <ced@b2ck.com>
parents: 39792
diff changeset
1495
6509fcec830c url: allow to configure timeout on http connection
Cédric Krier <ced@b2ck.com>
parents: 39792
diff changeset
1496 Used to configure access to Mercurial repositories via HTTP.
6509fcec830c url: allow to configure timeout on http connection
Cédric Krier <ced@b2ck.com>
parents: 39792
diff changeset
1497
6509fcec830c url: allow to configure timeout on http connection
Cédric Krier <ced@b2ck.com>
parents: 39792
diff changeset
1498 ``timeout``
6509fcec830c url: allow to configure timeout on http connection
Cédric Krier <ced@b2ck.com>
parents: 39792
diff changeset
1499 If set, blocking operations will timeout after that many seconds.
6509fcec830c url: allow to configure timeout on http connection
Cédric Krier <ced@b2ck.com>
parents: 39792
diff changeset
1500 (default: None)
6509fcec830c url: allow to configure timeout on http connection
Cédric Krier <ced@b2ck.com>
parents: 39792
diff changeset
1501
28023
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
1502 ``merge``
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
1503 ---------
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
1504
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
1505 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
1506
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
1507 ``checkignored``
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
1508 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
1509 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
1510 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
1511 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
1512 ``.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
1513 ``.orig``. (default: ``abort``)
28023
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
1514
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
1515 ``checkunknown``
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
1516 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
1517 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
1518 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
1519 are not ignored. (default: ``abort``)
b7bf2b0731be merge: document checkignored and checkunknown configs again
Siddharth Agarwal <sid0@fb.com>
parents: 27986
diff changeset
1520
34796
ed91846c29cf filemerge: introduce functions to halt merge flow
Ryan McElroy <rmcelroy@fb.com>
parents: 34711
diff changeset
1521 ``on-failure``
ed91846c29cf filemerge: introduce functions to halt merge flow
Ryan McElroy <rmcelroy@fb.com>
parents: 34711
diff changeset
1522 When set to ``continue`` (the default), the merge process attempts to
ed91846c29cf filemerge: introduce functions to halt merge flow
Ryan McElroy <rmcelroy@fb.com>
parents: 34711
diff changeset
1523 merge all unresolved files using the merge chosen tool, regardless of
ed91846c29cf filemerge: introduce functions to halt merge flow
Ryan McElroy <rmcelroy@fb.com>
parents: 34711
diff changeset
1524 whether previous file merge attempts during the process succeeded or not.
ed91846c29cf filemerge: introduce functions to halt merge flow
Ryan McElroy <rmcelroy@fb.com>
parents: 34711
diff changeset
1525 Setting this to ``prompt`` will prompt after any merge failure continue
ed91846c29cf filemerge: introduce functions to halt merge flow
Ryan McElroy <rmcelroy@fb.com>
parents: 34711
diff changeset
1526 or halt the merge process. Setting this to ``halt`` will automatically
ed91846c29cf filemerge: introduce functions to halt merge flow
Ryan McElroy <rmcelroy@fb.com>
parents: 34711
diff changeset
1527 halt the merge process on any merge tool failure. The merge process
ed91846c29cf filemerge: introduce functions to halt merge flow
Ryan McElroy <rmcelroy@fb.com>
parents: 34711
diff changeset
1528 can be restarted by using the ``resolve`` command. When a merge is
ed91846c29cf filemerge: introduce functions to halt merge flow
Ryan McElroy <rmcelroy@fb.com>
parents: 34711
diff changeset
1529 halted, the repository is left in a normal ``unresolved`` merge state.
ed91846c29cf filemerge: introduce functions to halt merge flow
Ryan McElroy <rmcelroy@fb.com>
parents: 34711
diff changeset
1530 (default: ``continue``)
ed91846c29cf filemerge: introduce functions to halt merge flow
Ryan McElroy <rmcelroy@fb.com>
parents: 34711
diff changeset
1531
39125
cded904f7acc filemerge: add config knob to check capabilities of internal merge tools
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 38875
diff changeset
1532 ``strict-capability-check``
cded904f7acc filemerge: add config knob to check capabilities of internal merge tools
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 38875
diff changeset
1533 Whether capabilities of internal merge tools are checked strictly
cded904f7acc filemerge: add config knob to check capabilities of internal merge tools
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 38875
diff changeset
1534 or not, while examining rules to decide merge tool to be used.
cded904f7acc filemerge: add config knob to check capabilities of internal merge tools
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 38875
diff changeset
1535 (default: False)
cded904f7acc filemerge: add config knob to check capabilities of internal merge tools
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 38875
diff changeset
1536
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1537 ``merge-patterns``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1538 ------------------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1539
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1540 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
1541 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
1542 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
1543 root.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1544
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1545 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
1546
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1547 [merge-patterns]
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1548 **.c = kdiff3
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1549 **.jpg = myimgmerge
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1550
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1551 ``merge-tools``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1552 ---------------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1553
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1554 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
1555 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
1556 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
1557 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
1558
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1559 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
1560
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1561 [merge-tools]
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1562 # Override stock tool location
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1563 kdiff3.executable = ~/bin/kdiff3
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1564 # Specify command line
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1565 kdiff3.args = $base $local $other -o $output
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1566 # Give higher priority
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1567 kdiff3.priority = 1
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1568
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
1569 # 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
1570 meld.priority = 0
a1e43e85d294 merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents: 26625
diff changeset
1571
a1e43e85d294 merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents: 26625
diff changeset
1572 # Disable a preconfigured tool
a1e43e85d294 merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents: 26625
diff changeset
1573 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
1574
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1575 # Define new tool
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1576 myHtmlTool.args = -m $local $other $base $output
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1577 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1578 myHtmlTool.priority = 1
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1579
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1580 Supported arguments:
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1581
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1582 ``priority``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1583 The priority in which to evaluate this tool.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1584 (default: 0)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1585
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1586 ``executable``
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1587 Either just the name of the executable or its pathname.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1588
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1589 .. container:: windows
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1590
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1591 On Windows, the path can use environment variables with ${ProgramFiles}
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1592 syntax.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1593
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1594 (default: the tool name)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1595
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1596 ``args``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1597 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
1598 files being merged as well as the output file through these
35907
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1599 variables: ``$base``, ``$local``, ``$other``, ``$output``.
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1600
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1601 The meaning of ``$local`` and ``$other`` can vary depending on which action is
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1602 being performed. During an update or merge, ``$local`` represents the original
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1603 state of the file, while ``$other`` represents the commit you are updating to or
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1604 the commit you are merging with. During a rebase, ``$local`` represents the
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1605 destination of the rebase, and ``$other`` represents the commit being rebased.
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1606
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1607 Some operations define custom labels to assist with identifying the revisions,
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1608 accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1609 labels are not available, these will be ``local``, ``other``, and ``base``,
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1610 respectively.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1611 (default: ``$local $base $other``)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1612
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1613 ``premerge``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1614 Attempt to run internal non-interactive 3-way merge tool before
46139
3ca5ca380a34 filemerge: add support for the new "mergediff" marker style to premerge
Martin von Zweigbergk <martinvonz@google.com>
parents: 46008
diff changeset
1615 launching external tool. Options are ``true``, ``false``, ``keep``,
3ca5ca380a34 filemerge: add support for the new "mergediff" marker style to premerge
Martin von Zweigbergk <martinvonz@google.com>
parents: 46008
diff changeset
1616 ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option
3ca5ca380a34 filemerge: add support for the new "mergediff" marker style to premerge
Martin von Zweigbergk <martinvonz@google.com>
parents: 46008
diff changeset
1617 will leave markers in the file if the premerge fails. The ``keep-merge3``
3ca5ca380a34 filemerge: add support for the new "mergediff" marker style to premerge
Martin von Zweigbergk <martinvonz@google.com>
parents: 46008
diff changeset
1618 will do the same but include information about the base of the merge in the
3ca5ca380a34 filemerge: add support for the new "mergediff" marker style to premerge
Martin von Zweigbergk <martinvonz@google.com>
parents: 46008
diff changeset
1619 marker (see internal :merge3 in :hg:`help merge-tools`). The
3ca5ca380a34 filemerge: add support for the new "mergediff" marker style to premerge
Martin von Zweigbergk <martinvonz@google.com>
parents: 46008
diff changeset
1620 ``keep-mergediff`` option is similar but uses a different marker style
3ca5ca380a34 filemerge: add support for the new "mergediff" marker style to premerge
Martin von Zweigbergk <martinvonz@google.com>
parents: 46008
diff changeset
1621 (see internal :merge3 in :hg:`help merge-tools`). (default: True)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1622
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1623 ``binary``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1624 This tool can merge binary files. (default: False, unless tool
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1625 was selected by file pattern match)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1626
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1627 ``symlink``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1628 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
1629
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1630 ``check``
26225
e257df7a9974 help/config: back out 5f2a1ebd6e78
Augie Fackler <augie@google.com>
parents: 26182
diff changeset
1631 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
1632
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1633 ``changed``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1634 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
1635 ``conflicts``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1636 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
1637 ``prompt``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1638 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
1639
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1640 ``fixeol``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1641 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
1642 (default: False)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1643
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1644 ``gui``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1645 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
1646
35907
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1647 ``mergemarkers``
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1648 Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1649 ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1650 ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1651 markers generated during premerge will be ``detailed`` if either this option or
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1652 the corresponding option in the ``[ui]`` section is ``detailed``.
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1653 (default: ``basic``)
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1654
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1655 ``mergemarkertemplate``
45767
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
1656 This setting can be used to override ``mergemarker`` from the
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
1657 ``[command-templates]`` section on a per-tool basis; this applies to the
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
1658 ``$label``-prefixed variables and to the conflict markers that are generated
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
1659 if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
1660 in ``[ui]`` for more information.
35907
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
1661
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1662 .. container:: windows
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1663
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1664 ``regkey``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1665 Windows registry key which describes install location of this
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1666 tool. Mercurial will search for this key first under
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1667 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1668 (default: None)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1669
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1670 ``regkeyalt``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1671 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
1672 found. The alternate key uses the same ``regname`` and ``regappend``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1673 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
1674 is to search for 32bit applications on 64bit operating systems.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1675 (default: None)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1676
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1677 ``regname``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1678 Name of value to read from specified registry key.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1679 (default: the unnamed (default) value)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
1680
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1681 ``regappend``
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1682 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
1683 the executable name of the tool.
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
1684 (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
1685
32099
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1686 ``pager``
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1687 ---------
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1688
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1689 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
1690 :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
1691
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1692 ``pager``
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1693 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
1694
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1695 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
1696 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
1697 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
1698
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1699 [pager]
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1700 pager = less -FRX
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1701
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1702 ``ignore``
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1703 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
1704
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1705 [pager]
7c76f3923b6a pager: document the 'pager' config section
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32090
diff changeset
1706 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
1707
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1708 ``patch``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1709 ---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1710
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1711 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
1712 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
1713
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1714 ``eol``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1715 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
1716 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
1717 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
1718 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
1719 ``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
1720 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
1721 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
1722 of line, patch line endings are preserved.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1723 (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
1724
25631
2748bf78a5bf patch: add fuzz config flag (issue4697)
Matt Mackall <mpm@selenic.com>
parents: 25523
diff changeset
1725 ``fuzz``
2748bf78a5bf patch: add fuzz config flag (issue4697)
Matt Mackall <mpm@selenic.com>
parents: 25523
diff changeset
1726 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
1727 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
1728 trying to apply a patch.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1729 (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
1730
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1731 ``paths``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1732 ---------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1733
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1734 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
1735
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1736 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
1737 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
1738
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1739 [paths]
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1740 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
1741 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
1742
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1743 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
1744 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
46904
ede52e19c752 help: point to `hg help urls` in `hg help config.paths`
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46884
diff changeset
1745 :hg:`push local_path`. You can check :hg:`help urls` for details about
ede52e19c752 help: point to `hg help urls` in `hg help config.paths`
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46884
diff changeset
1746 valid URLs.
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1747
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1748 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
1749 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
1750
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1751 [paths]
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1752 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
1753 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
1754
46905
95a5ed7db9ca help: document the `path://` url scheme
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46904
diff changeset
1755 Paths using the `path://otherpath` scheme will inherit the sub-options value from
95a5ed7db9ca help: document the `path://` url scheme
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46904
diff changeset
1756 the path they point to.
95a5ed7db9ca help: document the `path://` url scheme
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46904
diff changeset
1757
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1758 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
1759
47274
0470a44b9e74 multi-urls: document the feature
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47071
diff changeset
1760 ``multi-urls``
0470a44b9e74 multi-urls: document the feature
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47071
diff changeset
1761 A boolean option. When enabled the value of the `[paths]` entry will be
0470a44b9e74 multi-urls: document the feature
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47071
diff changeset
1762 parsed as a list and the alias will resolve to multiple destination. If some
0470a44b9e74 multi-urls: document the feature
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47071
diff changeset
1763 of the list entry use the `path://` syntax, the suboption will be inherited
0470a44b9e74 multi-urls: document the feature
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47071
diff changeset
1764 individually.
0470a44b9e74 multi-urls: document the feature
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47071
diff changeset
1765
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1766 ``pushurl``
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1767 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
1768 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
1769
29413
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
1770 ``pushrev``
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
1771 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
1772
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
1773 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
1774 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
1775
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
1776 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
1777 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
1778
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
1779 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
1780 pushed.
31d3ab7985b8 ui: path option to declare which revisions to push by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29334
diff changeset
1781
48242
4d2ab365699e bookmarks: move the `mirror` option to the `paths` section
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48033
diff changeset
1782 ``bookmarks.mode``
4d2ab365699e bookmarks: move the `mirror` option to the `paths` section
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48033
diff changeset
1783 How bookmark will be dealt during the exchange. It support the following value
4d2ab365699e bookmarks: move the `mirror` option to the `paths` section
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48033
diff changeset
1784
4d2ab365699e bookmarks: move the `mirror` option to the `paths` section
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48033
diff changeset
1785 - ``default``: the default behavior, local and remote bookmarks are "merged"
4d2ab365699e bookmarks: move the `mirror` option to the `paths` section
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48033
diff changeset
1786 on push/pull.
4d2ab365699e bookmarks: move the `mirror` option to the `paths` section
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48033
diff changeset
1787
4d2ab365699e bookmarks: move the `mirror` option to the `paths` section
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48033
diff changeset
1788 - ``mirror``: when pulling, replace local bookmarks by remote bookmarks. This
4d2ab365699e bookmarks: move the `mirror` option to the `paths` section
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48033
diff changeset
1789 is useful to replicate a repository, or as an optimization.
4d2ab365699e bookmarks: move the `mirror` option to the `paths` section
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48033
diff changeset
1790
48244
b56858d85a7b bookmarks: add a `ignore` variant of the bookmark mode
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48242
diff changeset
1791 - ``ignore``: ignore bookmarks during exchange.
b56858d85a7b bookmarks: add a `ignore` variant of the bookmark mode
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48242
diff changeset
1792 (This currently only affect pulling)
b56858d85a7b bookmarks: add a `ignore` variant of the bookmark mode
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48242
diff changeset
1793
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1794 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
1795
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1796 ``default``
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1797 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
1798
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1799 :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
1800 repository was cloned from.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1801
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1802 ``default-push``
27266
4dccc37b87bd ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27246
diff changeset
1803 (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
1804 ``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
1805
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
1806 ``phases``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1807 ----------
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
1808
16005
591f258ae630 help/config: fix help command markup
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 15999
diff changeset
1809 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
1810 information about working with phases.
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
1811
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
1812 ``publish``
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
1813 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
1814 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
1815 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
1816 (default: True)
15999
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
1817
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
1818 ``new-commit``
76625324bd55 help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents: 15896
diff changeset
1819 Phase of newly-created commits.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1820 (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
1821
20176
4c96c50ef937 subrepo: check phase of state in each subrepositories before committing
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 20142
diff changeset
1822 ``checksubrepos``
20333
fa6cb300ded4 help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 20176
diff changeset
1823 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
1824 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
1825 "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
1826 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
1827 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
1828 "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
1829 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
1830 used for the parent repository commit (if set to "follow").
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1831 (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
1832
4c96c50ef937 subrepo: check phase of state in each subrepositories before committing
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 20142
diff changeset
1833
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1834 ``profiling``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
1835 -------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1836
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1837 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
1838 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
1839 profiler (named ``stat``).
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1840
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1841 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
1842 collected during profiling, while 'profiling report' stands for a
36696
0c431d3129c4 docs: small fixes for profiling.nested and the overall description
Kyle Lippincott <spectral@google.com>
parents: 35907
diff changeset
1843 statistical text report generated from the profiling data.
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1844
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
1845 ``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
1846 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
1847 (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
1848
e3501546f7e4 profiling: add a context manager that no-ops if profiling isn't enabled
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29780
diff changeset
1849 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
1850
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1851 ``type``
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1852 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
1853 (default: stat)
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1854
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1855 ``ls``
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1856 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
1857 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
1858 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
1859 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
1860 ``stat``
30316
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
1861 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
1862 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
1863 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
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 ``format``
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1866 Profiling format. Specific to the ``ls`` instrumenting profiler.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1867 (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
1868
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1869 ``text``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1870 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
1871 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
1872 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
1873 ``kcachegrind``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1874 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
1875 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
1876 kcachegrind.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
1877
30316
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
1878 ``statformat``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
1879 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
1880 (default: hotpath)
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
1881
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
1882 ``hotpath``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
1883 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
1884 most time was spent).
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
1885 ``bymethod``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
1886 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
1887 ``byline``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
1888 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
1889 ``json``
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
1890 Render profiling data as JSON.
faf1b8923da2 profiling: use vendored statprof and upstream enhancements (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29784
diff changeset
1891
47777
1a174f122814 help: correct config.profiling.freq name (frequency->freq)
Kyle Lippincott <spectral@google.com>
parents: 47769
diff changeset
1892 ``freq``
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1893 Sampling frequency. Specific to the ``stat`` sampling profiler.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1894 (default: 1000)
16392
ee3f423df1b4 dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents: 16391
diff changeset
1895
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1896 ``output``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
1897 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
1898 file exists, it is replaced. (default: None, data is printed on
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1899 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
1900
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1901 ``sort``
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1902 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
1903 One of ``callcount``, ``reccallcount``, ``totaltime`` and
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1904 ``inlinetime``.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
1905 (default: inlinetime)
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1906
38260
15a1e37f80bd profiling: introduce a "profiling.time-track" option
Boris Feld <boris.feld@octobus.net>
parents: 38215
diff changeset
1907 ``time-track``
15a1e37f80bd profiling: introduce a "profiling.time-track" option
Boris Feld <boris.feld@octobus.net>
parents: 38215
diff changeset
1908 Control if the stat profiler track ``cpu`` or ``real`` time.
40419
5e917b224c20 help: update the default value specified for `profiling.time-track`
Matt Harbison <matt_harbison@yahoo.com>
parents: 40299
diff changeset
1909 (default: ``cpu`` on Windows, otherwise ``real``)
38260
15a1e37f80bd profiling: introduce a "profiling.time-track" option
Boris Feld <boris.feld@octobus.net>
parents: 38215
diff changeset
1910
18548
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
1911 ``limit``
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
1912 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
1913 (default: 30)
18548
e71c2ff93167 profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents: 18502
diff changeset
1914
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1915 ``nested``
18642
a40d608e2a7b profiling: replace '+' markup of nested lines with indentation
Mads Kiilerich <mads@kiilerich.com>
parents: 18636
diff changeset
1916 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
1917 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
1918 Specific to the ``ls`` instrumenting profiler.
36696
0c431d3129c4 docs: small fixes for profiling.nested and the overall description
Kyle Lippincott <spectral@google.com>
parents: 35907
diff changeset
1919 (default: 0)
18502
68eecbaf1bd3 profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents: 18385
diff changeset
1920
32850
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1921 ``showmin``
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1922 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
1923 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
1924 ``%`` 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
1925
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1926 Only used by the ``stat`` profiler.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1927
32851
cb6436e051ca profiling: allow configuring minimum display threshold for hotpath
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32850
diff changeset
1928 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
1929 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
1930
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1931 The option is unused on other formats.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1932
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1933 ``showmax``
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1934 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
1935 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
1936
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1937 Only used by the ``stat`` profiler.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1938
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1939 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
1940
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1941 The option is unused on other formats.
e33c9a47b0db config: document profiling.show{min,max}
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32744
diff changeset
1942
42423
0ae593e791fb profiling: show actual time spent in hotpath display
Valentin Gatien-Baron <vgatien-baron@janestreet.com>
parents: 42325
diff changeset
1943 ``showtime``
0ae593e791fb profiling: show actual time spent in hotpath display
Valentin Gatien-Baron <vgatien-baron@janestreet.com>
parents: 42325
diff changeset
1944 Show time taken as absolute durations, in addition to percentages.
0ae593e791fb profiling: show actual time spent in hotpath display
Valentin Gatien-Baron <vgatien-baron@janestreet.com>
parents: 42325
diff changeset
1945 Only used by the ``hotpath`` format.
0ae593e791fb profiling: show actual time spent in hotpath display
Valentin Gatien-Baron <vgatien-baron@janestreet.com>
parents: 42325
diff changeset
1946 (default: true)
0ae593e791fb profiling: show actual time spent in hotpath display
Valentin Gatien-Baron <vgatien-baron@janestreet.com>
parents: 42325
diff changeset
1947
25520
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1948 ``progress``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1949 ------------
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1950
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1951 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
1952 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
1953 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
1954
41137
785a75f0ddcb progress: document progress.debug config option
Martin von Zweigbergk <martinvonz@google.com>
parents: 41120
diff changeset
1955 ``debug``
785a75f0ddcb progress: document progress.debug config option
Martin von Zweigbergk <martinvonz@google.com>
parents: 41120
diff changeset
1956 Whether to print debug info when updating the progress bar. (default: False)
785a75f0ddcb progress: document progress.debug config option
Martin von Zweigbergk <martinvonz@google.com>
parents: 41120
diff changeset
1957
25520
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1958 ``delay``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1959 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
1960
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1961 ``changedelay``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1962 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
1963 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
1964
34314
a667f0ca1d5f progress: make ETA only consider progress made in the last minute
Jun Wu <quark@fb.com>
parents: 34146
diff changeset
1965 ``estimateinterval``
a667f0ca1d5f progress: make ETA only consider progress made in the last minute
Jun Wu <quark@fb.com>
parents: 34146
diff changeset
1966 Maximum sampling interval in seconds for speed and estimated time
a667f0ca1d5f progress: make ETA only consider progress made in the last minute
Jun Wu <quark@fb.com>
parents: 34146
diff changeset
1967 calculation. (default: 60)
a667f0ca1d5f progress: make ETA only consider progress made in the last minute
Jun Wu <quark@fb.com>
parents: 34146
diff changeset
1968
25520
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1969 ``refresh``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1970 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
1971
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1972 ``format``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1973 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
1974
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1975 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
1976 ``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
1977 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
1978 ``-<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
1979 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
1980
27665
72a25271e294 help: use backticks for progress.format keywords, correct letter case
Anton Shestakov <av6@dwimlabs.net>
parents: 27657
diff changeset
1981 (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
1982
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1983 ``width``
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1984 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
1985 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
1986
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1987 ``clear-complete``
26278
be44d23cb9f1 help/config: capitalize items
timeless@mozdev.org
parents: 26263
diff changeset
1988 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
1989
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1990 ``disable``
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
1991 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
1992
c8fada8d9db9 progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 25430
diff changeset
1993 ``assume-tty``
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
1994 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
1995
27746
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
1996 ``rebase``
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
1997 ----------
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
1998
34872
29f52e7966dd config: gather allowdivergence under the evolution namespace
Boris Feld <boris.feld@octobus.net>
parents: 34796
diff changeset
1999 ``evolution.allowdivergence``
27746
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
2000 Default to False, when True allow creating divergence when performing
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
2001 rebase of obsolete changesets.
f0e9f38d250f rebase: prevent creating divergence
Laurent Charignon <lcharignon@fb.com>
parents: 27742
diff changeset
2002
14691
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
2003 ``revsetalias``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
2004 ---------------
14691
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
2005
b1efd75cdafe help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents: 14661
diff changeset
2006 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
2007
41120
79f8f032c706 amend: add config option to update time to current in hg amend (issue5828)
Taapas Agrawal <taapas2897@gmail.com>
parents: 41106
diff changeset
2008 ``rewrite``
79f8f032c706 amend: add config option to update time to current in hg amend (issue5828)
Taapas Agrawal <taapas2897@gmail.com>
parents: 41106
diff changeset
2009 -----------
79f8f032c706 amend: add config option to update time to current in hg amend (issue5828)
Taapas Agrawal <taapas2897@gmail.com>
parents: 41106
diff changeset
2010
41207
25cec00b333c help: document rewrite.backup-bundle option
Yuya Nishihara <yuya@tcha.org>
parents: 41137
diff changeset
2011 ``backup-bundle``
25cec00b333c help: document rewrite.backup-bundle option
Yuya Nishihara <yuya@tcha.org>
parents: 41137
diff changeset
2012 Whether to save stripped changesets to a bundle file. (default: True)
25cec00b333c help: document rewrite.backup-bundle option
Yuya Nishihara <yuya@tcha.org>
parents: 41137
diff changeset
2013
41120
79f8f032c706 amend: add config option to update time to current in hg amend (issue5828)
Taapas Agrawal <taapas2897@gmail.com>
parents: 41106
diff changeset
2014 ``update-timestamp``
79f8f032c706 amend: add config option to update time to current in hg amend (issue5828)
Taapas Agrawal <taapas2897@gmail.com>
parents: 41106
diff changeset
2015 If true, updates the date and time of the changeset to current. It is only
42932
e4803231f538 amend: add option to update to the current user
Matt Harbison <matt_harbison@yahoo.com>
parents: 42516
diff changeset
2016 applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the
e4803231f538 amend: add option to update to the current user
Matt Harbison <matt_harbison@yahoo.com>
parents: 42516
diff changeset
2017 current version.
41120
79f8f032c706 amend: add config option to update time to current in hg amend (issue5828)
Taapas Agrawal <taapas2897@gmail.com>
parents: 41106
diff changeset
2018
45121
b6269741ed42 config: add option to control creation of empty successors during rewrite
Manuel Jacob <me@manueljacob.de>
parents: 45058
diff changeset
2019 ``empty-successor``
b6269741ed42 config: add option to control creation of empty successors during rewrite
Manuel Jacob <me@manueljacob.de>
parents: 45058
diff changeset
2020
b6269741ed42 config: add option to control creation of empty successors during rewrite
Manuel Jacob <me@manueljacob.de>
parents: 45058
diff changeset
2021 Control what happens with empty successors that are the result of rewrite
b6269741ed42 config: add option to control creation of empty successors during rewrite
Manuel Jacob <me@manueljacob.de>
parents: 45058
diff changeset
2022 operations. If set to ``skip``, the successor is not created. If set to
b6269741ed42 config: add option to control creation of empty successors during rewrite
Manuel Jacob <me@manueljacob.de>
parents: 45058
diff changeset
2023 ``keep``, the empty successor is created and kept.
b6269741ed42 config: add option to control creation of empty successors during rewrite
Manuel Jacob <me@manueljacob.de>
parents: 45058
diff changeset
2024
45124
3ee8e2d5c0d8 absorb: consider rewrite.empty-successor configuration
Manuel Jacob <me@manueljacob.de>
parents: 45123
diff changeset
2025 Currently, only the rebase and absorb commands consider this configuration.
45123
1efbfa9b36a7 rebase: consider rewrite.empty-successor configuration
Manuel Jacob <me@manueljacob.de>
parents: 45121
diff changeset
2026 (EXPERIMENTAL)
45121
b6269741ed42 config: add option to control creation of empty successors during rewrite
Manuel Jacob <me@manueljacob.de>
parents: 45058
diff changeset
2027
46335
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2028 ``share``
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2029 ---------
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2030
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2031 ``safe-mismatch.source-safe``
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2032 Controls what happens when the shared repository does not use the
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2033 share-safe mechanism but its source repository does.
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2034
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2035 Possible values are `abort` (default), `allow`, `upgrade-abort` and
48726
b6a0c1015ee2 help: avoid repeated value in the safe-mistmatch help
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48725
diff changeset
2036 `upgrade-allow`.
46335
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2037
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2038 ``abort``
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2039 Disallows running any command and aborts
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2040 ``allow``
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2041 Respects the feature presence in the share source
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2042 ``upgrade-abort``
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2043 tries to upgrade the share to use share-safe; if it fails, aborts
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2044 ``upgrade-allow``
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2045 tries to upgrade the share; if it fails, continue by
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2046 respecting the share source setting
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2047
48725
4344fd2687dc help: add missing `.` in config reference
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48674
diff changeset
2048 Check :hg:`help config.format.use-share-safe` for details about the
46347
5249ac2bc7a4 doc: point to the main share-safe doc in the "mismatch" config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46346
diff changeset
2049 share-safe feature.
5249ac2bc7a4 doc: point to the main share-safe doc in the "mismatch" config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46346
diff changeset
2050
46344
6bb52cc08855 doc: relocate doc for `share.safe-mismatch.source-safe.warn`
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46337
diff changeset
2051 ``safe-mismatch.source-safe.warn``
6bb52cc08855 doc: relocate doc for `share.safe-mismatch.source-safe.warn`
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46337
diff changeset
2052 Shows a warning on operations if the shared repository does not use
6bb52cc08855 doc: relocate doc for `share.safe-mismatch.source-safe.warn`
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46337
diff changeset
2053 share-safe, but the source repository does.
6bb52cc08855 doc: relocate doc for `share.safe-mismatch.source-safe.warn`
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46337
diff changeset
2054 (default: True)
6bb52cc08855 doc: relocate doc for `share.safe-mismatch.source-safe.warn`
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46337
diff changeset
2055
46335
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2056 ``safe-mismatch.source-not-safe``
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2057 Controls what happens when the shared repository uses the share-safe
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2058 mechanism but its source does not.
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2059
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2060 Possible values are `abort` (default), `allow`, `downgrade-abort` and
48726
b6a0c1015ee2 help: avoid repeated value in the safe-mistmatch help
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48725
diff changeset
2061 `downgrade-allow`.
46335
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2062
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2063 ``abort``
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2064 Disallows running any command and aborts
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2065 ``allow``
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2066 Respects the feature presence in the share source
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2067 ``downgrade-abort``
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2068 tries to downgrade the share to not use share-safe; if it fails, aborts
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2069 ``downgrade-allow``
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2070 tries to downgrade the share to not use share-safe;
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2071 if it fails, continue by respecting the shared source setting
25be21ec6c65 share: rework config options to be much clearer and easier
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46311
diff changeset
2072
48725
4344fd2687dc help: add missing `.` in config reference
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48674
diff changeset
2073 Check :hg:`help config.format.use-share-safe` for details about the
46347
5249ac2bc7a4 doc: point to the main share-safe doc in the "mismatch" config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46346
diff changeset
2074 share-safe feature.
5249ac2bc7a4 doc: point to the main share-safe doc in the "mismatch" config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46346
diff changeset
2075
46336
4f17773fc6b5 share: rename share-safe warning config
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46335
diff changeset
2076 ``safe-mismatch.source-not-safe.warn``
4f17773fc6b5 share: rename share-safe warning config
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46335
diff changeset
2077 Shows a warning on operations if the shared repository uses share-safe,
4f17773fc6b5 share: rename share-safe warning config
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46335
diff changeset
2078 but the source repository does not.
4f17773fc6b5 share: rename share-safe warning config
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46335
diff changeset
2079 (default: True)
4f17773fc6b5 share: rename share-safe warning config
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46335
diff changeset
2080
38744
ae17555ef93f config: rename `revlog` section into `storage`
Boris Feld <boris.feld@octobus.net>
parents: 38737
diff changeset
2081 ``storage``
38754
8b5f97ab5774 doc: fix underline length for config title (issue5949)
Boris Feld <boris.feld@octobus.net>
parents: 38744
diff changeset
2082 -----------
38737
913ca175c4ae aggressivemergedelta: document rename and move to `revlog` section
Boris Feld <boris.feld@octobus.net>
parents: 38735
diff changeset
2083
913ca175c4ae aggressivemergedelta: document rename and move to `revlog` section
Boris Feld <boris.feld@octobus.net>
parents: 38735
diff changeset
2084 Control the strategy Mercurial uses internally to store history. Options in this
913ca175c4ae aggressivemergedelta: document rename and move to `revlog` section
Boris Feld <boris.feld@octobus.net>
parents: 38735
diff changeset
2085 category impact performance and repository size.
913ca175c4ae aggressivemergedelta: document rename and move to `revlog` section
Boris Feld <boris.feld@octobus.net>
parents: 38735
diff changeset
2086
47822
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2087 ``revlog.issue6528.fix-incoming``
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2088 Version 5.8 of Mercurial had a bug leading to altering the parent of file
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2089 revision with copy information (or any other metadata) on exchange. This
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2090 leads to the copy metadata to be overlooked by various internal logic. The
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2091 issue was fixed in Mercurial 5.8.1.
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2092 (See https://bz.mercurial-scm.org/show_bug.cgi?id=6528 for details)
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2093
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2094 As a result Mercurial is now checking and fixing incoming file revisions to
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2095 make sure there parents are in the right order. This behavior can be
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2096 disabled by setting this option to `no`. This apply to revisions added
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2097 through push, pull, clone and unbundle.
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2098
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2099 To fix affected revisions that already exist within the repository, one can
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2100 use :hg:`debug-repair-issue-6528`.
2813d406b036 issue6528: add a config option to control the fixing on the fly
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47777
diff changeset
2101
38744
ae17555ef93f config: rename `revlog` section into `storage`
Boris Feld <boris.feld@octobus.net>
parents: 38737
diff changeset
2102 ``revlog.optimize-delta-parent-choice``
38737
913ca175c4ae aggressivemergedelta: document rename and move to `revlog` section
Boris Feld <boris.feld@octobus.net>
parents: 38735
diff changeset
2103 When storing a merge revision, both parents will be equally considered as
913ca175c4ae aggressivemergedelta: document rename and move to `revlog` section
Boris Feld <boris.feld@octobus.net>
parents: 38735
diff changeset
2104 a possible delta base. This results in better delta selection and improved
913ca175c4ae aggressivemergedelta: document rename and move to `revlog` section
Boris Feld <boris.feld@octobus.net>
parents: 38735
diff changeset
2105 revlog compression. This option is enabled by default.
913ca175c4ae aggressivemergedelta: document rename and move to `revlog` section
Boris Feld <boris.feld@octobus.net>
parents: 38735
diff changeset
2106
913ca175c4ae aggressivemergedelta: document rename and move to `revlog` section
Boris Feld <boris.feld@octobus.net>
parents: 38735
diff changeset
2107 Turning this option off can result in large increase of repository size for
913ca175c4ae aggressivemergedelta: document rename and move to `revlog` section
Boris Feld <boris.feld@octobus.net>
parents: 38735
diff changeset
2108 repository with many merges.
913ca175c4ae aggressivemergedelta: document rename and move to `revlog` section
Boris Feld <boris.feld@octobus.net>
parents: 38735
diff changeset
2109
46307
51da7c8ef357 persistent-nodemap: document storage.revlog.persistent-nodemap.mmap=no
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46305
diff changeset
2110 ``revlog.persistent-nodemap.mmap``
51da7c8ef357 persistent-nodemap: document storage.revlog.persistent-nodemap.mmap=no
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46305
diff changeset
2111 Whether to use the Operating System "memory mapping" feature (when
51da7c8ef357 persistent-nodemap: document storage.revlog.persistent-nodemap.mmap=no
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46305
diff changeset
2112 possible) to access the persistent nodemap data. This improve performance
51da7c8ef357 persistent-nodemap: document storage.revlog.persistent-nodemap.mmap=no
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46305
diff changeset
2113 and reduce memory pressure.
51da7c8ef357 persistent-nodemap: document storage.revlog.persistent-nodemap.mmap=no
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46305
diff changeset
2114
51da7c8ef357 persistent-nodemap: document storage.revlog.persistent-nodemap.mmap=no
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46305
diff changeset
2115 Default to True.
51da7c8ef357 persistent-nodemap: document storage.revlog.persistent-nodemap.mmap=no
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46305
diff changeset
2116
51da7c8ef357 persistent-nodemap: document storage.revlog.persistent-nodemap.mmap=no
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46305
diff changeset
2117 For details on the "persistent-nodemap" feature, see:
48725
4344fd2687dc help: add missing `.` in config reference
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48674
diff changeset
2118 :hg:`help config.format.use-persistent-nodemap`.
46307
51da7c8ef357 persistent-nodemap: document storage.revlog.persistent-nodemap.mmap=no
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46305
diff changeset
2119
46308
05a1e44b2224 persistent-nodemap: add a revlog.storage.persistent-nodemap.slow-path option
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46307
diff changeset
2120 ``revlog.persistent-nodemap.slow-path``
05a1e44b2224 persistent-nodemap: add a revlog.storage.persistent-nodemap.slow-path option
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46307
diff changeset
2121 Control the behavior of Merucrial when using a repository with "persistent"
05a1e44b2224 persistent-nodemap: add a revlog.storage.persistent-nodemap.slow-path option
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46307
diff changeset
2122 nodemap with an installation of Mercurial without a fast implementation for
05a1e44b2224 persistent-nodemap: add a revlog.storage.persistent-nodemap.slow-path option
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46307
diff changeset
2123 the feature:
05a1e44b2224 persistent-nodemap: add a revlog.storage.persistent-nodemap.slow-path option
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46307
diff changeset
2124
05a1e44b2224 persistent-nodemap: add a revlog.storage.persistent-nodemap.slow-path option
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46307
diff changeset
2125 ``allow``: Silently use the slower implementation to access the repository.
46310
fc2d5c0aed7f persistent-nodemap: add a "warn" option to the slow-path config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46308
diff changeset
2126 ``warn``: Warn, but use the slower implementation to access the repository.
46311
014ac7a32048 persistent-nodemap: add a "abort" option to the slow-path config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46310
diff changeset
2127 ``abort``: Prevent access to such repositories. (This is the default)
46308
05a1e44b2224 persistent-nodemap: add a revlog.storage.persistent-nodemap.slow-path option
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46307
diff changeset
2128
05a1e44b2224 persistent-nodemap: add a revlog.storage.persistent-nodemap.slow-path option
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46307
diff changeset
2129 For details on the "persistent-nodemap" feature, see:
48725
4344fd2687dc help: add missing `.` in config reference
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 48674
diff changeset
2130 :hg:`help config.format.use-persistent-nodemap`.
46308
05a1e44b2224 persistent-nodemap: add a revlog.storage.persistent-nodemap.slow-path option
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46307
diff changeset
2131
41818
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2132 ``revlog.reuse-external-delta-parent``
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2133 Control the order in which delta parents are considered when adding new
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2134 revisions from an external source.
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2135 (typically: apply bundle from `hg pull` or `hg push`).
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2136
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2137 New revisions are usually provided as a delta against other revisions. By
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2138 default, Mercurial will try to reuse this delta first, therefore using the
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2139 same "delta parent" as the source. Directly using delta's from the source
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2140 reduces CPU usage and usually speeds up operation. However, in some case,
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2141 the source might have sub-optimal delta bases and forcing their reevaluation
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2142 is useful. For example, pushes from an old client could have sub-optimal
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2143 delta's parent that the server want to optimize. (lack of general delta, bad
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2144 parents, choice, lack of sparse-revlog, etc).
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2145
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2146 This option is enabled by default. Turning it off will ensure bad delta
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2147 parent choices from older client do not propagate to this repository, at
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2148 the cost of a small increase in CPU consumption.
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2149
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2150 Note: this option only control the order in which delta parents are
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2151 considered. Even when disabled, the existing delta from the source will be
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2152 reused if the same delta parent is selected.
f6eff9e4de80 storage: introduce a `revlog.reuse-external-delta-parent` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41529
diff changeset
2153
41819
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2154 ``revlog.reuse-external-delta``
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2155 Control the reuse of delta from external source.
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2156 (typically: apply bundle from `hg pull` or `hg push`).
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2157
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2158 New revisions are usually provided as a delta against another revision. By
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2159 default, Mercurial will not recompute the same delta again, trusting
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2160 externally provided deltas. There have been rare cases of small adjustment
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2161 to the diffing algorithm in the past. So in some rare case, recomputing
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2162 delta provided by ancient clients can provides better results. Disabling
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2163 this option means going through a full delta recomputation for all incoming
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2164 revisions. It means a large increase in CPU usage and will slow operations
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2165 down.
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2166
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2167 This option is enabled by default. When disabled, it also disables the
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2168 related ``storage.revlog.reuse-external-delta-parent`` option.
688fc33e105d storage: introduce a `revlog.reuse-external-delta` config
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41818
diff changeset
2169
42043
1fac9b931d46 compression: introduce a `storage.revlog.zlib.level` configuration
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41840
diff changeset
2170 ``revlog.zlib.level``
1fac9b931d46 compression: introduce a `storage.revlog.zlib.level` configuration
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41840
diff changeset
2171 Zlib compression level used when storing data into the repository. Accepted
1fac9b931d46 compression: introduce a `storage.revlog.zlib.level` configuration
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41840
diff changeset
2172 Value range from 1 (lowest compression) to 9 (highest compression). Zlib
1fac9b931d46 compression: introduce a `storage.revlog.zlib.level` configuration
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41840
diff changeset
2173 default value is 6.
1fac9b931d46 compression: introduce a `storage.revlog.zlib.level` configuration
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 41840
diff changeset
2174
42044
bb271ec2fbfb compression: introduce a `storage.revlog.zstd.level` configuration
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 42043
diff changeset
2175
bb271ec2fbfb compression: introduce a `storage.revlog.zstd.level` configuration
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 42043
diff changeset
2176 ``revlog.zstd.level``
bb271ec2fbfb compression: introduce a `storage.revlog.zstd.level` configuration
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 42043
diff changeset
2177 zstd compression level used when storing data into the repository. Accepted
bb271ec2fbfb compression: introduce a `storage.revlog.zstd.level` configuration
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 42043
diff changeset
2178 Value range from 1 (lowest compression) to 22 (highest compression).
bb271ec2fbfb compression: introduce a `storage.revlog.zstd.level` configuration
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 42043
diff changeset
2179 (default 3)
bb271ec2fbfb compression: introduce a `storage.revlog.zstd.level` configuration
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 42043
diff changeset
2180
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2181 ``server``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
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
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2184 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
2185
35261
f392066d127c bookmark: add pushkey hook compatiblity to the bundle2 part
Boris Feld <boris.feld@octobus.net>
parents: 35209
diff changeset
2186 ``bookmarks-pushkey-compat``
f392066d127c bookmark: add pushkey hook compatiblity to the bundle2 part
Boris Feld <boris.feld@octobus.net>
parents: 35209
diff changeset
2187 Trigger pushkey hook when being pushed bookmark updates. This config exist
f392066d127c bookmark: add pushkey hook compatiblity to the bundle2 part
Boris Feld <boris.feld@octobus.net>
parents: 35209
diff changeset
2188 for compatibility purpose (default to True)
f392066d127c bookmark: add pushkey hook compatiblity to the bundle2 part
Boris Feld <boris.feld@octobus.net>
parents: 35209
diff changeset
2189
f392066d127c bookmark: add pushkey hook compatiblity to the bundle2 part
Boris Feld <boris.feld@octobus.net>
parents: 35209
diff changeset
2190 If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
f392066d127c bookmark: add pushkey hook compatiblity to the bundle2 part
Boris Feld <boris.feld@octobus.net>
parents: 35209
diff changeset
2191 movement we recommend you migrate them to ``txnclose-bookmark`` and
f392066d127c bookmark: add pushkey hook compatiblity to the bundle2 part
Boris Feld <boris.feld@octobus.net>
parents: 35209
diff changeset
2192 ``pretxnclose-bookmark``.
f392066d127c bookmark: add pushkey hook compatiblity to the bundle2 part
Boris Feld <boris.feld@octobus.net>
parents: 35209
diff changeset
2193
30762
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
2194 ``compressionengines``
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
2195 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
2196 to clients.
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
2197
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
2198 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
2199 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
2200 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
2201
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
2202 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
2203 :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
2204 default wire protocol priority.
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
2205
35b516f800e0 wireproto: advertise supported media types and compression formats
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30704
diff changeset
2206 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
2207 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
2208
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2209 ``uncompressed``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2210 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
2211 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
2212 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
2213 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
2214 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
2215 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
2216 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
2217 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
2218 the write lock while determining what data to transfer.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2219 (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
2220
32744
33b7283a3828 streamclone: consider secret changesets (BC) (issue5589)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32666
diff changeset
2221 ``uncompressedallowsecret``
33b7283a3828 streamclone: consider secret changesets (BC) (issue5589)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32666
diff changeset
2222 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
2223 changesets. (default: False)
33b7283a3828 streamclone: consider secret changesets (BC) (issue5589)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 32666
diff changeset
2224
16361
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
2225 ``preferuncompressed``
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
2226 When set, clients will try to use the uncompressed streaming
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2227 protocol. (default: False)
16361
6097ede2be4d protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents: 16140
diff changeset
2228
32260
d0d9a4fca59b clone: add a server-side option to disable full getbundles (pull-based clones)
Siddharth Agarwal <sid0@fb.com>
parents: 32139
diff changeset
2229 ``disablefullbundle``
d0d9a4fca59b clone: add a server-side option to disable full getbundles (pull-based clones)
Siddharth Agarwal <sid0@fb.com>
parents: 32139
diff changeset
2230 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
2231 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
2232 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
2233 (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
2234
37414
2d965bfeb8f6 wireproto: allow direct stream processing for unbundle
Joerg Sonnenberger <joerg@bec.de>
parents: 37009
diff changeset
2235 ``streamunbundle``
2d965bfeb8f6 wireproto: allow direct stream processing for unbundle
Joerg Sonnenberger <joerg@bec.de>
parents: 37009
diff changeset
2236 When set, servers will apply data sent from the client directly,
2d965bfeb8f6 wireproto: allow direct stream processing for unbundle
Joerg Sonnenberger <joerg@bec.de>
parents: 37009
diff changeset
2237 otherwise it will be written to a temporary file first. This option
2d965bfeb8f6 wireproto: allow direct stream processing for unbundle
Joerg Sonnenberger <joerg@bec.de>
parents: 37009
diff changeset
2238 effectively prevents concurrent pushes.
2d965bfeb8f6 wireproto: allow direct stream processing for unbundle
Joerg Sonnenberger <joerg@bec.de>
parents: 37009
diff changeset
2239
37498
aacfca6f9767 wireproto: support for pullbundles
Joerg Sonnenberger <joerg@bec.de>
parents: 37414
diff changeset
2240 ``pullbundle``
aacfca6f9767 wireproto: support for pullbundles
Joerg Sonnenberger <joerg@bec.de>
parents: 37414
diff changeset
2241 When set, the server will check pullbundle.manifest for bundles
aacfca6f9767 wireproto: support for pullbundles
Joerg Sonnenberger <joerg@bec.de>
parents: 37414
diff changeset
2242 covering the requested heads and common nodes. The first matching
aacfca6f9767 wireproto: support for pullbundles
Joerg Sonnenberger <joerg@bec.de>
parents: 37414
diff changeset
2243 entry will be streamed to the client.
aacfca6f9767 wireproto: support for pullbundles
Joerg Sonnenberger <joerg@bec.de>
parents: 37414
diff changeset
2244
aacfca6f9767 wireproto: support for pullbundles
Joerg Sonnenberger <joerg@bec.de>
parents: 37414
diff changeset
2245 For HTTP transport, the stream will still use zlib compression
aacfca6f9767 wireproto: support for pullbundles
Joerg Sonnenberger <joerg@bec.de>
parents: 37414
diff changeset
2246 for older clients.
aacfca6f9767 wireproto: support for pullbundles
Joerg Sonnenberger <joerg@bec.de>
parents: 37414
diff changeset
2247
32892
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
2248 ``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
2249 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
2250
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
2251 - 'strict': push is abort if another client touched the repository
44412
edc8504bc26b exchange: turn on option that makes concurrent pushes work better
Valentin Gatien-Baron <valentin.gatienbaron@gmail.com>
parents: 44410
diff changeset
2252 while the push was preparing.
32892
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
2253 - 'check-related': push is only aborted if it affects head that got also
44412
edc8504bc26b exchange: turn on option that makes concurrent pushes work better
Valentin Gatien-Baron <valentin.gatienbaron@gmail.com>
parents: 44410
diff changeset
2254 affected while the push was preparing. (default since 5.4)
32892
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
2255
44410
c85d5fd1a5d9 help: clarify behavior of server.concurrent-push-mode
Valentin Gatien-Baron <valentin.gatienbaron@gmail.com>
parents: 44382
diff changeset
2256 'check-related' only takes effect for compatible clients (version
c85d5fd1a5d9 help: clarify behavior of server.concurrent-push-mode
Valentin Gatien-Baron <valentin.gatienbaron@gmail.com>
parents: 44382
diff changeset
2257 4.3 and later). Older clients will use 'strict'.
32892
a7851519ea02 check-concurrency: expose the feature as 'concurrent-push-mode'
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 32872
diff changeset
2258
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2259 ``validate``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2260 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
2261 checking that all new file revisions specified in manifests are
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2262 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
2263
25691
5cda0ce05c42 wireproto: add config knob for http header length limit
Mike Edgar <adgar@google.com>
parents: 25649
diff changeset
2264 ``maxhttpheaderlen``
5cda0ce05c42 wireproto: add config knob for http header length limit
Mike Edgar <adgar@google.com>
parents: 25649
diff changeset
2265 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
2266 many bytes. (default: 1024)
25691
5cda0ce05c42 wireproto: add config knob for http header length limit
Mike Edgar <adgar@google.com>
parents: 25649
diff changeset
2267
27246
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
2268 ``bundle1``
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
2269 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
2270 exchange format. (default: True)
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
2271
27633
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
2272 ``bundle1gd``
27683
76fc5ac23473 help: fix quoting for bundle1 options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27665
diff changeset
2273 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
2274 *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
2275
27246
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
2276 ``bundle1.push``
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
2277 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
2278 format. (default: True)
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
2279
27633
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
2280 ``bundle1gd.push``
27683
76fc5ac23473 help: fix quoting for bundle1 options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27665
diff changeset
2281 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
2282 *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
2283
27246
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
2284 ``bundle1.pull``
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
2285 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
2286 format. (default: True)
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
2287
27633
37d7cf569cf3 wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27607
diff changeset
2288 ``bundle1gd.pull``
27683
76fc5ac23473 help: fix quoting for bundle1 options
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27665
diff changeset
2289 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
2290 *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
2291
27246
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
2292 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
2293 consider setting this option because converting *generaldelta*
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
2294 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
2295 format can consume a lot of CPU.
b288fb2724bf wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27216
diff changeset
2296
39721
1b5880352314 bundle2: graduate bundle2.stream option from experimental to server section
Anton Shestakov <av6@dwimlabs.net>
parents: 39441
diff changeset
2297 ``bundle2.stream``
1b5880352314 bundle2: graduate bundle2.stream option from experimental to server section
Anton Shestakov <av6@dwimlabs.net>
parents: 39441
diff changeset
2298 Whether to allow clients to pull using the bundle2 streaming protocol.
39722
4bd6e444c76f bundle2: make server.bundle2.stream default to True
Anton Shestakov <av6@dwimlabs.net>
parents: 39721
diff changeset
2299 (default: True)
39721
1b5880352314 bundle2: graduate bundle2.stream option from experimental to server section
Anton Shestakov <av6@dwimlabs.net>
parents: 39441
diff changeset
2300
29748
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
2301 ``zliblevel``
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
2302 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
2303 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
2304 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
2305
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
2306 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
2307 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
2308 maximum compression.
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
2309
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
2310 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
2311 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
2312 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
2313
5e2365698d44 hgweb: config option to control zlib compression level
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29649
diff changeset
2314 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
2315
30764
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
2316 ``zstdlevel``
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
2317 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
2318 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
2319 ``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
2320
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
2321 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
2322 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
2323
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
2324 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
2325
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30762
diff changeset
2326 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
2327
41840
d6569f1e9b37 server: allow customizing the default repo filter
Joerg Sonnenberger <joerg@bec.de>
parents: 41819
diff changeset
2328 ``view``
d6569f1e9b37 server: allow customizing the default repo filter
Joerg Sonnenberger <joerg@bec.de>
parents: 41819
diff changeset
2329 Repository filter used when exchanging revisions with the peer.
d6569f1e9b37 server: allow customizing the default repo filter
Joerg Sonnenberger <joerg@bec.de>
parents: 41819
diff changeset
2330
d6569f1e9b37 server: allow customizing the default repo filter
Joerg Sonnenberger <joerg@bec.de>
parents: 41819
diff changeset
2331 The default view (``served``) excludes secret and hidden changesets.
42139
08481e11462e repoview: flag `server.view` as experimental
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 42046
diff changeset
2332 Another useful value is ``immutable`` (no draft, secret or hidden
08481e11462e repoview: flag `server.view` as experimental
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 42046
diff changeset
2333 changesets). (EXPERIMENTAL)
41840
d6569f1e9b37 server: allow customizing the default repo filter
Joerg Sonnenberger <joerg@bec.de>
parents: 41819
diff changeset
2334
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2335 ``smtp``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
2336 --------
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2337
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2338 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
2339
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2340 ``host``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2341 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
2342
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2343 ``port``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2344 Optional. Port to connect to on mail server. (default: 465 if
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2345 ``tls`` is smtps; 25 otherwise)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2346
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2347 ``tls``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2348 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
2349 smtps or none. (default: none)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2350
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2351 ``username``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2352 Optional. User name for authenticating with the SMTP server.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2353 (default: None)
16140
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2354
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2355 ``password``
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2356 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
2357 specified, interactive sessions will prompt the user for a
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2358 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
2359
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2360 ``local_hostname``
26180
b1caa076fc3b help/config: change local_hostname help style
timeless@mozdev.org
parents: 26179
diff changeset
2361 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
2362 itself to the MTA.
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
diff changeset
2363
dbf64594a3c3 help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents: 16139
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 ``subpaths``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
2366 ------------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2367
16549
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
2368 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
2369 or becomes temporarily unavailable. This section lets you define
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
2370 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
2371
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2372 <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
2373
16549
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
2374 where ``pattern`` is a regular expression matching a subrepository
517b25608ad6 help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents: 16513
diff changeset
2375 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
2376 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
2377 ``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
2378
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2379 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
2380
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2381 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
2382
17251
98166640b356 help: fix some instances of 'the the'
Mads Kiilerich <mads@kiilerich.com>
parents: 17202
diff changeset
2383 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
2384 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
2385 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
2386 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
2387
34985
5e27afeddaee subrepo: add config option to reject any subrepo operations (SEC)
Yuya Nishihara <yuya@tcha.org>
parents: 34931
diff changeset
2388 ``subrepos``
5e27afeddaee subrepo: add config option to reject any subrepo operations (SEC)
Yuya Nishihara <yuya@tcha.org>
parents: 34931
diff changeset
2389 ------------
5e27afeddaee subrepo: add config option to reject any subrepo operations (SEC)
Yuya Nishihara <yuya@tcha.org>
parents: 34931
diff changeset
2390
5e27afeddaee subrepo: add config option to reject any subrepo operations (SEC)
Yuya Nishihara <yuya@tcha.org>
parents: 34931
diff changeset
2391 This section contains options that control the behavior of the
5e27afeddaee subrepo: add config option to reject any subrepo operations (SEC)
Yuya Nishihara <yuya@tcha.org>
parents: 34931
diff changeset
2392 subrepositories feature. See also :hg:`help subrepos`.
5e27afeddaee subrepo: add config option to reject any subrepo operations (SEC)
Yuya Nishihara <yuya@tcha.org>
parents: 34931
diff changeset
2393
34989
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2394 Security note: auditing in Mercurial is known to be insufficient to
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2395 prevent clone-time code execution with carefully constructed Git
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2396 subrepos. It is unknown if a similar detect is present in Subversion
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2397 subrepos. Both Git and Subversion subrepos are disabled by default
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2398 out of security concerns. These subrepo types can be enabled using
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2399 the respective options below.
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2400
34985
5e27afeddaee subrepo: add config option to reject any subrepo operations (SEC)
Yuya Nishihara <yuya@tcha.org>
parents: 34931
diff changeset
2401 ``allowed``
34989
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2402 Whether subrepositories are allowed in the working directory.
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2403
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2404 When false, commands involving subrepositories (like :hg:`update`)
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2405 will fail for all subrepository types.
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2406 (default: true)
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2407
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2408 ``hg:allowed``
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2409 Whether Mercurial subrepositories are allowed in the working
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2410 directory. This option only has an effect if ``subrepos.allowed``
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2411 is true.
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2412 (default: true)
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2413
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2414 ``git:allowed``
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2415 Whether Git subrepositories are allowed in the working directory.
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2416 This option only has an effect if ``subrepos.allowed`` is true.
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2417
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2418 See the security note above before enabling Git subrepos.
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2419 (default: false)
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2420
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2421 ``svn:allowed``
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2422 Whether Subversion subrepositories are allowed in the working
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2423 directory. This option only has an effect if ``subrepos.allowed``
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2424 is true.
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2425
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2426 See the security note above before enabling Subversion subrepos.
1a314176da9c subrepo: use per-type config options to enable subrepos
Gregory Szorc <gregory.szorc@gmail.com>
parents: 34988
diff changeset
2427 (default: false)
34985
5e27afeddaee subrepo: add config option to reject any subrepo operations (SEC)
Yuya Nishihara <yuya@tcha.org>
parents: 34931
diff changeset
2428
28957
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
2429 ``templatealias``
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
2430 -----------------
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
2431
d813132ea361 templater: load and expand aliases by template engine (API) (issue4842)
Yuya Nishihara <yuya@tcha.org>
parents: 28846
diff changeset
2432 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
2433
29717
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
2434 ``templates``
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
2435 -------------
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
2436
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
2437 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
2438 See :hg:`help templates` for details.
a12d13eac513 help: add example of '[templates]' usage
Mathias De Maré <mathias.demare@gmail.com>
parents: 29649
diff changeset
2439
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2440 ``trusted``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
2441 -----------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2442
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2443 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
2444 ``.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
2445 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
2446 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
2447 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
2448 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
2449 section.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2450
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2451 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
2452 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
2453 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
2454 *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
2455 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
2456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2457 ``users``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2458 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
2459
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2460 ``groups``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2461 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
2462
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2463
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2464 ``ui``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
2465 ------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2466
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2467 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
2468
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2469 ``archivemeta``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2470 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
2471 (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
2472 by the :hg:`archive` command or downloaded via hgweb.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2473 (default: True)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2474
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2475 ``askusername``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2476 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
2477 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
2478 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
2479 default ``USER@HOST`` is used instead.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2480 (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2481
27738
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
2482 ``clonebundles``
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
2483 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
2484
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
2485 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
2486 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
2487
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
2488 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
2489
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
2490 (default: True)
a0e783d26e81 exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27737
diff changeset
2491
26623
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
2492 ``clonebundlefallback``
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
2493 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
2494 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
2495
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
2496 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
2497 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
2498 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
2499 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
2500 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
2501 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
2502 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
2503 fails.
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
2504
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
2505 (default: False)
5a95fe44121d clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents: 26421
diff changeset
2506
27737
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2507 ``clonebundleprefers``
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2508 Defines preferences for which "clone bundles" to use.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2509
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2510 Servers advertising "clone bundles" may advertise multiple available
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2511 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
2512 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
2513 bundle over another.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2514
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2515 The following keys are defined by Mercurial:
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2516
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2517 BUNDLESPEC
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2518 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
2519 e.g. ``gzip-v2`` or ``bzip2-v1``.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2520
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2521 COMPRESSION
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2522 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
2523
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2524 Server operators may define custom keys.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2525
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2526 Example values: ``COMPRESSION=bzip2``,
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2527 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2528
482eb357fe98 exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27683
diff changeset
2529 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
2530
31123
df0a0734304a color: update main documentation
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 31001
diff changeset
2531 ``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
2532 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
2533 "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
2534 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
2535
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2536 ``commitsubrepos``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2537 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
2538 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
2539 changes, abort the commit.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2540 (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2541
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2542 ``debug``
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
2543 Print debugging information. (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2544
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2545 ``editor``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2546 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
2547
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2548 ``fallbackencoding``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2549 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
2550 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
2551
27216
8117e2cd959e graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents: 27093
diff changeset
2552 ``graphnodetemplate``
45766
1f7c077e0640 config: rename ui.graphnodetemplate to command-templates.graphnode
Martin von Zweigbergk <martinvonz@google.com>
parents: 45765
diff changeset
2553 (DEPRECATED) Use ``command-templates.graphnode`` instead.
27216
8117e2cd959e graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents: 27093
diff changeset
2554
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2555 ``ignore``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2556 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
2557 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
2558 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
2559 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
2560 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
2561 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
2562
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2563 ``interactive``
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
2564 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
2565
28542
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
2566 ``interface``
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
2567 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
2568 Possible values are 'text' and 'curses'.
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
2569
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
2570 ``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
2571 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
2572 Possible values are 'text' and 'curses'.
71e12fc53b80 ui: add new config flag for interface selection
Simon Farnsworth <simonfar@fb.com>
parents: 28525
diff changeset
2573 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
2574
38600
a936d1368fc5 ui: make the large file warning limit fully configurable
Joerg Sonnenberger <joerg@bec.de>
parents: 38591
diff changeset
2575 ``large-file-limit``
a936d1368fc5 ui: make the large file warning limit fully configurable
Joerg Sonnenberger <joerg@bec.de>
parents: 38591
diff changeset
2576 Largest file size that gives no memory use warning.
a936d1368fc5 ui: make the large file warning limit fully configurable
Joerg Sonnenberger <joerg@bec.de>
parents: 38591
diff changeset
2577 Possible values are integers or 0 to disable the check.
a936d1368fc5 ui: make the large file warning limit fully configurable
Joerg Sonnenberger <joerg@bec.de>
parents: 38591
diff changeset
2578 (default: 10000000)
a936d1368fc5 ui: make the large file warning limit fully configurable
Joerg Sonnenberger <joerg@bec.de>
parents: 38591
diff changeset
2579
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2580 ``logtemplate``
45765
ed84a4d48910 config: add a new [command-templates] section for templates defined by hg
Martin von Zweigbergk <martinvonz@google.com>
parents: 45124
diff changeset
2581 (DEPRECATED) Use ``command-templates.log`` instead.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2582
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2583 ``merge``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2584 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
2585 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
2586 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
2587
21519
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
2588 ``mergemarkers``
45767
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2589 Sets the merge conflict marker label styling. The ``detailed`` style
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2590 uses the ``command-templates.mergemarker`` setting to style the labels.
21519
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
2591 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
2592 One of ``basic`` or ``detailed``.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2593 (default: ``basic``)
21519
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
2594
25d5a9ecbb85 merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents: 21403
diff changeset
2595 ``mergemarkertemplate``
45767
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2596 (DEPRECATED) Use ``command-templates.mergemarker`` instead.
35907
9037c29e9f53 filemerge: support passing labels to external merge tools
Kyle Lippincott <spectral@google.com>
parents: 35445
diff changeset
2597
40547
840cd57cde32 ui: add config knob to redirect status messages to stderr (API)
Yuya Nishihara <yuya@tcha.org>
parents: 40478
diff changeset
2598 ``message-output``
840cd57cde32 ui: add config knob to redirect status messages to stderr (API)
Yuya Nishihara <yuya@tcha.org>
parents: 40478
diff changeset
2599 Where to write status and error messages. (default: ``stdio``)
840cd57cde32 ui: add config knob to redirect status messages to stderr (API)
Yuya Nishihara <yuya@tcha.org>
parents: 40478
diff changeset
2600
45058
f43bc4ce0d69 cmdserver: document message-encodings and channel output options
Yuya Nishihara <yuya@tcha.org>
parents: 45057
diff changeset
2601 ``channel``
f43bc4ce0d69 cmdserver: document message-encodings and channel output options
Yuya Nishihara <yuya@tcha.org>
parents: 45057
diff changeset
2602 Use separate channel for structured output. (Command-server only)
40547
840cd57cde32 ui: add config knob to redirect status messages to stderr (API)
Yuya Nishihara <yuya@tcha.org>
parents: 40478
diff changeset
2603 ``stderr``
840cd57cde32 ui: add config knob to redirect status messages to stderr (API)
Yuya Nishihara <yuya@tcha.org>
parents: 40478
diff changeset
2604 Everything to stderr.
840cd57cde32 ui: add config knob to redirect status messages to stderr (API)
Yuya Nishihara <yuya@tcha.org>
parents: 40478
diff changeset
2605 ``stdio``
840cd57cde32 ui: add config knob to redirect status messages to stderr (API)
Yuya Nishihara <yuya@tcha.org>
parents: 40478
diff changeset
2606 Status to stdout, and error to stderr.
840cd57cde32 ui: add config knob to redirect status messages to stderr (API)
Yuya Nishihara <yuya@tcha.org>
parents: 40478
diff changeset
2607
26937
dda0aa3baedd cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents: 26907
diff changeset
2608 ``origbackuppath``
dda0aa3baedd cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents: 26907
diff changeset
2609 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
2610 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
2611 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
2612 suffix.
26937
dda0aa3baedd cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents: 26907
diff changeset
2613
32104
f06d23af6cdf pager: rename 'pager.enable' to 'ui.paginate'
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32103
diff changeset
2614 ``paginate``
f06d23af6cdf pager: rename 'pager.enable' to 'ui.paginate'
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32103
diff changeset
2615 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
2616 for details.
f06d23af6cdf pager: rename 'pager.enable' to 'ui.paginate'
Pierre-Yves David <pierre-yves.david@ens-lyon.org>
parents: 32103
diff changeset
2617
25649
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
2618 ``patch``
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
2619 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
2620 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
2621 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
2622 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
2623 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
2624 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
2625 from stdin.
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
2626
e90e031b3016 doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 25631
diff changeset
2627 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
2628 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
2629 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
2630
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2631 ``portablefilenames``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2632 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2633 (default: ``warn``)
27758
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2634
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2635 ``warn``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2636 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
2637 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
2638 Windows because it contains reserved parts like ``AUX``, reserved
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2639 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
2640 file).
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2641
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2642 ``ignore``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2643 Don't print a warning.
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2644
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2645 ``abort``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2646 The command is aborted.
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2647
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2648 ``true``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2649 Alias for ``warn``.
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2650
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2651 ``false``
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2652 Alias for ``ignore``.
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2653
27761
bf8b0796af2e help: label windows config help
timeless <timeless@mozdev.org>
parents: 27760
diff changeset
2654 .. container:: windows
27758
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2655
6a63fd8dd486 help: split config ui.portablefilenames
timeless <timeless@mozdev.org>
parents: 27746
diff changeset
2656 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
2657
40478
86dfae98a3a2 merge-tools: when calling external merge tool, describe the resolve inputs
Kyle Lippincott <spectral@google.com>
parents: 40421
diff changeset
2658 ``pre-merge-tool-output-template``
45768
5effb1992c17 config: move ui.pre-merge-tool-output-template into [command-templates]
Martin von Zweigbergk <martinvonz@google.com>
parents: 45767
diff changeset
2659 (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead.
40478
86dfae98a3a2 merge-tools: when calling external merge tool, describe the resolve inputs
Kyle Lippincott <spectral@google.com>
parents: 40421
diff changeset
2660
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2661 ``quiet``
27759
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
2662 Reduce the amount of output printed.
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
2663 (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2664
41492
02186c6871ac status: introduce higher-level ui.relative-paths
Martin von Zweigbergk <martinvonz@google.com>
parents: 41207
diff changeset
2665 ``relative-paths``
02186c6871ac status: introduce higher-level ui.relative-paths
Martin von Zweigbergk <martinvonz@google.com>
parents: 41207
diff changeset
2666 Prefer relative paths in the UI.
02186c6871ac status: introduce higher-level ui.relative-paths
Martin von Zweigbergk <martinvonz@google.com>
parents: 41207
diff changeset
2667
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2668 ``remotecmd``
27759
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
2669 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
2670 (default: ``hg``)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2671
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2672 ``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
2673 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
2674 trusted user or group.
335167aab197 help: move config default marking to its own line
timeless <timeless@mozdev.org>
parents: 27758
diff changeset
2675 (default: True)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2676
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2677 ``slash``
35445
b86f52426396 help: deprecate ui.slash in favor of slashpath template filter (issue5572)
Yuya Nishihara <yuya@tcha.org>
parents: 35431
diff changeset
2678 (Deprecated. Use ``slashpath`` template filter instead.)
b86f52426396 help: deprecate ui.slash in favor of slashpath template filter (issue5572)
Yuya Nishihara <yuya@tcha.org>
parents: 35431
diff changeset
2679
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2680 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
2681 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
2682 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
2683 backslash character (``\``)).
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2684 (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2685
24663
7d01371e6358 commands: add ui.statuscopies config knob
Mathias De Maré <mathias.demare@gmail.com>
parents: 24542
diff changeset
2686 ``statuscopies``
7d01371e6358 commands: add ui.statuscopies config knob
Mathias De Maré <mathias.demare@gmail.com>
parents: 24542
diff changeset
2687 Display copies in the status command.
7d01371e6358 commands: add ui.statuscopies config knob
Mathias De Maré <mathias.demare@gmail.com>
parents: 24542
diff changeset
2688
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2689 ``ssh``
26278
be44d23cb9f1 help/config: capitalize items
timeless@mozdev.org
parents: 26263
diff changeset
2690 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
2691
35108
8b1c887d52e7 sshpeer: add a configurable hint for the ssh error message
Zuzanna Mroczek <zuza@fb.com>
parents: 35038
diff changeset
2692 ``ssherrorhint``
8b1c887d52e7 sshpeer: add a configurable hint for the ssh error message
Zuzanna Mroczek <zuza@fb.com>
parents: 35038
diff changeset
2693 A hint shown to the user in the case of SSH error (e.g.
8b1c887d52e7 sshpeer: add a configurable hint for the ssh error message
Zuzanna Mroczek <zuza@fb.com>
parents: 35038
diff changeset
2694 ``Please see http://company/internalwiki/ssh.html``)
8b1c887d52e7 sshpeer: add a configurable hint for the ssh error message
Zuzanna Mroczek <zuza@fb.com>
parents: 35038
diff changeset
2695
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2696 ``strict``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2697 Require exact command names, instead of allowing unambiguous
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
2698 abbreviations. (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2699
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2700 ``style``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2701 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
2702
26263
bf2bfc6f45fb traceback: allow providing a local support contact point
Pierre-Yves David <pierre-yves.david@fb.com>
parents: 26225
diff changeset
2703 ``supportcontact``
26313
e8afd380c576 help: copy-edit description of ui.supportcontact
Kevin Bullock <kbullock@ringworld.org>
parents: 26282
diff changeset
2704 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
2705 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
2706 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
2707
29070
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
2708 ``textwidth``
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
2709 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
2710 ``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
2711 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
2712 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
2713 used. (default: 78)
29a7d591ff42 ui: add new config option for help text width
Jun Wu <quark@fb.com>
parents: 29060
diff changeset
2714
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2715 ``timeout``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2716 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
2717 means no timeout. (default: 600)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2718
35209
9153871d50e0 lock: allow to configure when the lock messages are displayed
Boris Feld <boris.feld@octobus.net>
parents: 35108
diff changeset
2719 ``timeout.warn``
9153871d50e0 lock: allow to configure when the lock messages are displayed
Boris Feld <boris.feld@octobus.net>
parents: 35108
diff changeset
2720 Time (in seconds) before a warning is printed about held lock. A negative
9153871d50e0 lock: allow to configure when the lock messages are displayed
Boris Feld <boris.feld@octobus.net>
parents: 35108
diff changeset
2721 value means no warning. (default: 0)
9153871d50e0 lock: allow to configure when the lock messages are displayed
Boris Feld <boris.feld@octobus.net>
parents: 35108
diff changeset
2722
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2723 ``traceback``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2724 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
2725 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
2726 on all exceptions, even those recognized by Mercurial (such as
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2727 IOError or MemoryError). (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2728
32872
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
2729 ``tweakdefaults``
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
2730
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
2731 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
2732 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
2733 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
2734 Mercurial's behavior over time. This config setting will have no
40299
3570adf20d91 help: fix a missing quote character in ui.tweakdefaults
Matt Harbison <matt_harbison@yahoo.com>
parents: 40043
diff changeset
2735 effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
32872
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
2736 not include ``tweakdefaults``. (default: False)
9fcb6df413c9 ui: add support for a tweakdefaults knob
Augie Fackler <augie@google.com>
parents: 32851
diff changeset
2737
40421
e928bedf0919 help: describe what ui.tweakdefaults changes, concretely
Valentin Gatien-Baron <vgatien-baron@janestreet.com>
parents: 40419
diff changeset
2738 It currently means::
e928bedf0919 help: describe what ui.tweakdefaults changes, concretely
Valentin Gatien-Baron <vgatien-baron@janestreet.com>
parents: 40419
diff changeset
2739
e928bedf0919 help: describe what ui.tweakdefaults changes, concretely
Valentin Gatien-Baron <vgatien-baron@janestreet.com>
parents: 40419
diff changeset
2740 .. tweakdefaultsmarker
e928bedf0919 help: describe what ui.tweakdefaults changes, concretely
Valentin Gatien-Baron <vgatien-baron@janestreet.com>
parents: 40419
diff changeset
2741
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2742 ``username``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2743 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
2744 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
2745 <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
2746 username are expanded.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2747
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2748 (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
2749 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
2750 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
2751 hgrc file)
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2752
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2753 ``verbose``
26279
6765d21ff17f help/config: omit True or False
timeless@mozdev.org
parents: 26278
diff changeset
2754 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
2755
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2756
45765
ed84a4d48910 config: add a new [command-templates] section for templates defined by hg
Martin von Zweigbergk <martinvonz@google.com>
parents: 45124
diff changeset
2757 ``command-templates``
ed84a4d48910 config: add a new [command-templates] section for templates defined by hg
Martin von Zweigbergk <martinvonz@google.com>
parents: 45124
diff changeset
2758 ---------------------
ed84a4d48910 config: add a new [command-templates] section for templates defined by hg
Martin von Zweigbergk <martinvonz@google.com>
parents: 45124
diff changeset
2759
ed84a4d48910 config: add a new [command-templates] section for templates defined by hg
Martin von Zweigbergk <martinvonz@google.com>
parents: 45124
diff changeset
2760 Templates used for customizing the output of commands.
ed84a4d48910 config: add a new [command-templates] section for templates defined by hg
Martin von Zweigbergk <martinvonz@google.com>
parents: 45124
diff changeset
2761
45766
1f7c077e0640 config: rename ui.graphnodetemplate to command-templates.graphnode
Martin von Zweigbergk <martinvonz@google.com>
parents: 45765
diff changeset
2762 ``graphnode``
1f7c077e0640 config: rename ui.graphnodetemplate to command-templates.graphnode
Martin von Zweigbergk <martinvonz@google.com>
parents: 45765
diff changeset
2763 The template used to print changeset nodes in an ASCII revision graph.
1f7c077e0640 config: rename ui.graphnodetemplate to command-templates.graphnode
Martin von Zweigbergk <martinvonz@google.com>
parents: 45765
diff changeset
2764 (default: ``{graphnode}``)
1f7c077e0640 config: rename ui.graphnodetemplate to command-templates.graphnode
Martin von Zweigbergk <martinvonz@google.com>
parents: 45765
diff changeset
2765
45765
ed84a4d48910 config: add a new [command-templates] section for templates defined by hg
Martin von Zweigbergk <martinvonz@google.com>
parents: 45124
diff changeset
2766 ``log``
ed84a4d48910 config: add a new [command-templates] section for templates defined by hg
Martin von Zweigbergk <martinvonz@google.com>
parents: 45124
diff changeset
2767 Template string for commands that print changesets.
ed84a4d48910 config: add a new [command-templates] section for templates defined by hg
Martin von Zweigbergk <martinvonz@google.com>
parents: 45124
diff changeset
2768
45767
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2769 ``mergemarker``
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2770 The template used to print the commit description next to each conflict
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2771 marker during merge conflicts. See :hg:`help templates` for the template
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2772 format.
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2773
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2774 Defaults to showing the hash, tags, branches, bookmarks, author, and
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2775 the first line of the commit description.
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2776
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2777 If you use non-ASCII characters in names for tags, branches, bookmarks,
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2778 authors, and/or commit descriptions, you must pay attention to encodings of
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2779 managed files. At template expansion, non-ASCII characters use the encoding
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2780 specified by the ``--encoding`` global option, ``HGENCODING`` or other
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2781 environment variables that govern your locale. If the encoding of the merge
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2782 markers is different from the encoding of the merged files,
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2783 serious problems may occur.
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2784
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2785 Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
40411ad2f5d2 config: rename ui.mergemarkertemplate to command-templates.mergemarker
Martin von Zweigbergk <martinvonz@google.com>
parents: 45766
diff changeset
2786
45866
996cd73431a3 help: document the new [command-templates] config section
Martin von Zweigbergk <martinvonz@google.com>
parents: 45768
diff changeset
2787 ``oneline-summary``
996cd73431a3 help: document the new [command-templates] config section
Martin von Zweigbergk <martinvonz@google.com>
parents: 45768
diff changeset
2788 A template used by `hg rebase` and other commands for showing a one-line
996cd73431a3 help: document the new [command-templates] config section
Martin von Zweigbergk <martinvonz@google.com>
parents: 45768
diff changeset
2789 summary of a commit. If the template configured here is longer than one
996cd73431a3 help: document the new [command-templates] config section
Martin von Zweigbergk <martinvonz@google.com>
parents: 45768
diff changeset
2790 line, then only the first line is used.
996cd73431a3 help: document the new [command-templates] config section
Martin von Zweigbergk <martinvonz@google.com>
parents: 45768
diff changeset
2791
996cd73431a3 help: document the new [command-templates] config section
Martin von Zweigbergk <martinvonz@google.com>
parents: 45768
diff changeset
2792 The template can be overridden per command by defining a template in
996cd73431a3 help: document the new [command-templates] config section
Martin von Zweigbergk <martinvonz@google.com>
parents: 45768
diff changeset
2793 `oneline-summary.<command>`, where `<command>` can be e.g. "rebase".
996cd73431a3 help: document the new [command-templates] config section
Martin von Zweigbergk <martinvonz@google.com>
parents: 45768
diff changeset
2794
45768
5effb1992c17 config: move ui.pre-merge-tool-output-template into [command-templates]
Martin von Zweigbergk <martinvonz@google.com>
parents: 45767
diff changeset
2795 ``pre-merge-tool-output``
5effb1992c17 config: move ui.pre-merge-tool-output-template into [command-templates]
Martin von Zweigbergk <martinvonz@google.com>
parents: 45767
diff changeset
2796 A template that is printed before executing an external merge tool. This can
5effb1992c17 config: move ui.pre-merge-tool-output-template into [command-templates]
Martin von Zweigbergk <martinvonz@google.com>
parents: 45767
diff changeset
2797 be used to print out additional context that might be useful to have during
5effb1992c17 config: move ui.pre-merge-tool-output-template into [command-templates]
Martin von Zweigbergk <martinvonz@google.com>
parents: 45767
diff changeset
2798 the conflict resolution, such as the description of the various commits
5effb1992c17 config: move ui.pre-merge-tool-output-template into [command-templates]
Martin von Zweigbergk <martinvonz@google.com>
parents: 45767
diff changeset
2799 involved or bookmarks/tags.
5effb1992c17 config: move ui.pre-merge-tool-output-template into [command-templates]
Martin von Zweigbergk <martinvonz@google.com>
parents: 45767
diff changeset
2800
5effb1992c17 config: move ui.pre-merge-tool-output-template into [command-templates]
Martin von Zweigbergk <martinvonz@google.com>
parents: 45767
diff changeset
2801 Additional information is available in the ``local`, ``base``, and ``other``
5effb1992c17 config: move ui.pre-merge-tool-output-template into [command-templates]
Martin von Zweigbergk <martinvonz@google.com>
parents: 45767
diff changeset
2802 dicts. For example: ``{local.label}``, ``{base.name}``, or
5effb1992c17 config: move ui.pre-merge-tool-output-template into [command-templates]
Martin von Zweigbergk <martinvonz@google.com>
parents: 45767
diff changeset
2803 ``{other.islink}``.
5effb1992c17 config: move ui.pre-merge-tool-output-template into [command-templates]
Martin von Zweigbergk <martinvonz@google.com>
parents: 45767
diff changeset
2804
45765
ed84a4d48910 config: add a new [command-templates] section for templates defined by hg
Martin von Zweigbergk <martinvonz@google.com>
parents: 45124
diff changeset
2805
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2806 ``web``
17267
979b107eaea2 doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17251
diff changeset
2807 -------
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2808
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2809 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
2810 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
2811 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
2812 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
2813
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2814 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
2815 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
2816 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
2817 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
2818 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
2819 checks.
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2820
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2821 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
2822 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
2823 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
2824
35038
6ef744a7df65 config: rename allow_push to allow-push
David Demelier <markand@malikania.fr>
parents: 35037
diff changeset
2825 $ hg --config web.allow-push=* --config web.push_ssl=False serve
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2826
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2827 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
2828 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
2829
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2830 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
2831
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2832 ``accesslog``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2833 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
2834
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2835 ``address``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2836 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
2837
38215
f715faeaceee config: rename allow_archive to allow-archive
David Demelier <markand@malikania.fr>
parents: 38100
diff changeset
2838 ``allow-archive``
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2839 List of archive format (bz2, gz, zip) allowed for downloading.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2840 (default: empty)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2841
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2842 ``allowbz2``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2843 (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
2844 revisions.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2845 (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2846
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2847 ``allowgz``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2848 (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
2849 revisions.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2850 (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2851
35037
da5d5ea7d696 config: rename allowpull to allow-pull
David Demelier <markand@malikania.fr>
parents: 34989
diff changeset
2852 ``allow-pull``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2853 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
2854
35038
6ef744a7df65 config: rename allow_push to allow-push
David Demelier <markand@malikania.fr>
parents: 35037
diff changeset
2855 ``allow-push``
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2856 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
2857 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
2858 user can push, including unauthenticated users. Otherwise, the
c16f071f048e help/config: reword allow_push to fix grammar
timeless@mozdev.org
parents: 26180
diff changeset
2859 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
2860 user name must be present in this list. The contents of the
35038
6ef744a7df65 config: rename allow_push to allow-push
David Demelier <markand@malikania.fr>
parents: 35037
diff changeset
2861 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
2862
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2863 ``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
2864 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
2865 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
2866 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
2867 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
2868 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
2869 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
2870 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
2871 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
2872 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
2873
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2874 ``allowzip``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2875 (DEPRECATED) Whether to allow .zip downloading of repository
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2876 revisions. This feature creates temporary files.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2877 (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2878
17933
8243dd66e0e3 webcommands: allow hgweb's archive to recurse into subrepos
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 17685
diff changeset
2879 ``archivesubrepos``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2880 Whether to recurse into subrepositories when archiving.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2881 (default: False)
17933
8243dd66e0e3 webcommands: allow hgweb's archive to recurse into subrepos
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 17685
diff changeset
2882
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2883 ``baseurl``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2884 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
2885 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
2886 URLs. Example: ``http://hgserver/repos/``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2887
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2888 ``cacerts``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2889 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
2890 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
2891 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
2892 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
2893 with these certificates.
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
2894
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
2895 To disable SSL verification temporarily, specify ``--insecure`` from
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
2896 command line.
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
2897
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
2898 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
2899 one. On most Linux systems this will be
7416ce2c7887 help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents: 16392
diff changeset
2900 ``/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
2901 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
2902
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2903 -----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
2904 ... (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
2905 -----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
2906 -----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
2907 ... (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
2908 -----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
2909
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2910 ``cache``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2911 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
2912
25853
81802d1355ac hgweb: document web.certificates option
Matt Mackall <mpm@selenic.com>
parents: 25691
diff changeset
2913 ``certificate``
81802d1355ac hgweb: document web.certificates option
Matt Mackall <mpm@selenic.com>
parents: 25691
diff changeset
2914 Certificate to use when running :hg:`serve`.
81802d1355ac hgweb: document web.certificates option
Matt Mackall <mpm@selenic.com>
parents: 25691
diff changeset
2915
16570
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
2916 ``collapse``
63f10a163017 help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents: 16549
diff changeset
2917 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
2918 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
2919 ``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
2920 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
2921 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
2922 collapses each collection of repositories found within a subdirectory
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2923 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
2924
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
2925 ``comparisoncontext``
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
2926 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
2927 negative or the value ``full``, whole files are shown. (default: 5)
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2928
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
2929 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
2930 ``comparison`` command, taking the same values.
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
2931
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2932 ``contact``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2933 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
2934 (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
2935
30766
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
2936 ``csp``
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
2937 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
2938
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
2939 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
2940 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
2941 ``%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
2942 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
2943 ``<script>`` elements containing inline JavaScript.
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
2944
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
2945 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
2946 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
2947 "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
2948 threat model.
d7bf7d2bd5ab hgweb: support Content Security Policy
Gregory Szorc <gregory.szorc@gmail.com>
parents: 30764
diff changeset
2949
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2950 ``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
2951 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
2952 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
2953 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
2954 any authenticated user name present in this list is also denied. The
35038
6ef744a7df65 config: rename allow_push to allow-push
David Demelier <markand@malikania.fr>
parents: 35037
diff changeset
2955 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
2956
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2957 ``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
2958 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
2959 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
2960 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
2961 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
2962 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
2963 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
2964 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
2965 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
2966 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
2967 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
2968 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
2969 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
2970 list.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2971
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2972 ``descend``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2973 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
2974 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
2975 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
2976
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2977 ``description``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2978 Textual description of the repository's purpose or contents.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2979 (default: "unknown")
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2980
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2981 ``encoding``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2982 Character encoding name. (default: the current locale charset)
26177
52e9187cd0e8 help/config: add trailing periods
timeless@mozdev.org
parents: 26176
diff changeset
2983 Example: "UTF-8".
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2984
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2985 ``errorlog``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2986 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
2987
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
2988 ``guessmime``
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
2989 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
2990 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
2991 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
2992 allow cross-site scripting attacks when serving untrusted
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2993 repositories. (default: False)
17202
1ae119269ddc hgweb: side-by-side comparison functionality
wujek srujek
parents: 16585
diff changeset
2994
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2995 ``hidden``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2996 Whether to hide the repository in the hgwebdir index.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
2997 (default: False)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
2998
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
2999 ``ipv6``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
3000 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
3001
29471
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
3002 ``labels``
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
3003 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
3004
c4fc33c477da hgweb: expose list of per-repo labels to templates
Gregory Szorc <gregory.szorc@gmail.com>
parents: 29459
diff changeset
3005 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
3006 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
3007 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
3008 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
3009
14938
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
3010 ``logoimg``
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
3011 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
3012 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
3013 the logo image is "staticurl/logoimg".
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
3014 If unset, ``hglogo.png`` will be used.
ec18cd254156 help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 14891
diff changeset
3015
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
3016 ``logourl``
26421
4b0fc75f9403 urls: bulk-change primary website URLs
Matt Mackall <mpm@selenic.com>
parents: 26365
diff changeset
3017 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
3018 will be used.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
3019
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
3020 ``maxchanges``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
3021 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
3022
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
3023 ``maxfiles``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
3024 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
3025
17317
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
3026 ``maxshortchanges``
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
3027 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
3028 pages. (default: 60)
17317
0b8272274b56 help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents: 17316
diff changeset
3029
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
3030 ``name``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
3031 Repository name to use in the web interface.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
3032 (default: current working directory)
17316
8cf995a6dcb0 help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents: 17267
diff changeset
3033
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
3034 ``port``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
3035 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
3036
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
3037 ``prefix``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
3038 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
3039
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
3040 ``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
3041 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
3042 prevent password sniffing. (default: True)
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
3043
26072
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
3044 ``refreshinterval``
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
3045 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
3046 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
3047 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
3048 required, refreshing may negatively impact performance.
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
3049
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
3050 Values less than or equal to 0 always refresh.
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
3051 (default: 20)
26072
06320fb11699 hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents: 25853
diff changeset
3052
37009
5890e5872f36 hgweb: allow defining Server response header for HTTP server
Gregory Szorc <gregory.szorc@gmail.com>
parents: 36696
diff changeset
3053 ``server-header``
5890e5872f36 hgweb: allow defining Server response header for HTTP server
Gregory Szorc <gregory.szorc@gmail.com>
parents: 36696
diff changeset
3054 Value for HTTP ``Server`` response header.
5890e5872f36 hgweb: allow defining Server response header for HTTP server
Gregory Szorc <gregory.szorc@gmail.com>
parents: 36696
diff changeset
3055
39792
ff0060d2a099 help: document web.static config
Yuya Nishihara <yuya@tcha.org>
parents: 39722
diff changeset
3056 ``static``
ff0060d2a099 help: document web.static config
Yuya Nishihara <yuya@tcha.org>
parents: 39722
diff changeset
3057 Directory where static files are served from.
ff0060d2a099 help: document web.static config
Yuya Nishihara <yuya@tcha.org>
parents: 39722
diff changeset
3058
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
3059 ``staticurl``
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
3060 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
3061 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
3062 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
3063 Example: ``http://hgserver/static/``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
3064
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
3065 ``stripes``
17424
e7cfe3587ea4 fix trivial spelling errors
Mads Kiilerich <mads@kiilerich.com>
parents: 17317
diff changeset
3066 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
3067 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
3068
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
3069 ``style``
22549
b1fc7ea5bb01 help: update help for hgweb template and style (issue4373)
Arun Chandrasekaran <visionofarun@gmail.com>
parents: 22252
diff changeset
3070 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
3071 subdirectories in the HTML templates path. (default: ``paper``)
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
3072 Example: ``monoblue``.
14458
c62b3b74f1d2 help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents: 14457
diff changeset
3073
14456
ff4126ce9301 help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents: 13955
diff changeset
3074 ``templates``
22549
b1fc7ea5bb01 help: update help for hgweb template and style (issue4373)
Arun Chandrasekaran <visionofarun@gmail.com>
parents: 22252
diff changeset
3075 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
3076 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
3077
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3078 ``websub``
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3079 ----------
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3080
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3081 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
3082 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
3083 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
3084
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3085 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
3086 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
3087 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
3088 "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
3089
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3090 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
3091 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
3092 HTML (see the examples below).
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3093
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3094 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
3095 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
3096 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
3097 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
3098
18958
c3b920980f22 spelling: fix typos and spelling errors
Mads Kiilerich <madski@unity3d.com>
parents: 18888
diff changeset
3099 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
3100
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3101 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
3102 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
3103
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3104 Examples::
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3105
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3106 [websub]
52305554fd6e hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents: 18548
diff changeset
3107 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
3108 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
3109 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
3110
18636
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
3111 ``worker``
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
3112 ----------
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
3113
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
3114 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
3115 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
3116 helps performance.
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
3117
35431
471918fa7f46 workers: add config to enable/diable workers
Wojciech Lis <wlis@fb.com>
parents: 35261
diff changeset
3118 ``enabled``
471918fa7f46 workers: add config to enable/diable workers
Wojciech Lis <wlis@fb.com>
parents: 35261
diff changeset
3119 Whether to enable workers code to be used.
471918fa7f46 workers: add config to enable/diable workers
Wojciech Lis <wlis@fb.com>
parents: 35261
diff changeset
3120 (default: true)
471918fa7f46 workers: add config to enable/diable workers
Wojciech Lis <wlis@fb.com>
parents: 35261
diff changeset
3121
18636
dcb27c153a40 worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents: 18548
diff changeset
3122 ``numcpus``
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
3123 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
3124 negative value is treated as ``use the default``.
26182
6832ba528d1a help/config: make defaults consistent
timeless@mozdev.org
parents: 26181
diff changeset
3125 (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
3126
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3127 ``backgroundclose``
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3128 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
3129 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
3130 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
3131 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
3132 (default: true on Windows, false elsewhere)
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3133
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3134 ``backgroundcloseminfilecount``
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3135 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
3136 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
3137 threads.
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3138 (default: 2048)
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3139
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3140 ``backgroundclosemaxqueue``
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3141 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
3142 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
3143 enabled.
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3144 (default: 384)
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3145
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3146 ``backgroundclosethreadcount``
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3147 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
3148 ``backgroundclose`` is enabled.
2d6a89e79b48 scmutil: support background file closing
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27889
diff changeset
3149 (default: 4)