##// END OF EJS Templates
docs: add missing dirstate-v2 documentation...
Raphaël Gomès -
r49365:5e7a0348 stable
parent child Browse files
Show More
@@ -1,3120 +1,3149 b''
1 The Mercurial system uses a set of configuration files to control
1 The Mercurial system uses a set of configuration files to control
2 aspects of its behavior.
2 aspects of its behavior.
3
3
4 Troubleshooting
4 Troubleshooting
5 ===============
5 ===============
6
6
7 If you're having problems with your configuration,
7 If you're having problems with your configuration,
8 :hg:`config --source` can help you understand what is introducing
8 :hg:`config --source` can help you understand what is introducing
9 a setting into your environment.
9 a setting into your environment.
10
10
11 See :hg:`help config.syntax` and :hg:`help config.files`
11 See :hg:`help config.syntax` and :hg:`help config.files`
12 for information about how and where to override things.
12 for information about how and where to override things.
13
13
14 Structure
14 Structure
15 =========
15 =========
16
16
17 The configuration files use a simple ini-file format. A configuration
17 The configuration files use a simple ini-file format. A configuration
18 file consists of sections, led by a ``[section]`` header and followed
18 file consists of sections, led by a ``[section]`` header and followed
19 by ``name = value`` entries::
19 by ``name = value`` entries::
20
20
21 [ui]
21 [ui]
22 username = Firstname Lastname <firstname.lastname@example.net>
22 username = Firstname Lastname <firstname.lastname@example.net>
23 verbose = True
23 verbose = True
24
24
25 The above entries will be referred to as ``ui.username`` and
25 The above entries will be referred to as ``ui.username`` and
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
27
27
28 Files
28 Files
29 =====
29 =====
30
30
31 Mercurial reads configuration data from several files, if they exist.
31 Mercurial reads configuration data from several files, if they exist.
32 These files do not exist by default and you will have to create the
32 These files do not exist by default and you will have to create the
33 appropriate configuration files yourself:
33 appropriate configuration files yourself:
34
34
35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
36
36
37 Global configuration like the username setting is typically put into:
37 Global configuration like the username setting is typically put into:
38
38
39 .. container:: windows
39 .. container:: windows
40
40
41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
42
42
43 .. container:: unix.plan9
43 .. container:: unix.plan9
44
44
45 - ``$HOME/.hgrc`` (on Unix, Plan9)
45 - ``$HOME/.hgrc`` (on Unix, Plan9)
46
46
47 The names of these files depend on the system on which Mercurial is
47 The names of these files depend on the system on which Mercurial is
48 installed. ``*.rc`` files from a single directory are read in
48 installed. ``*.rc`` files from a single directory are read in
49 alphabetical order, later ones overriding earlier ones. Where multiple
49 alphabetical order, later ones overriding earlier ones. Where multiple
50 paths are given below, settings from earlier paths override later
50 paths are given below, settings from earlier paths override later
51 ones.
51 ones.
52
52
53 .. container:: verbose.unix
53 .. container:: verbose.unix
54
54
55 On Unix, the following files are consulted:
55 On Unix, the following files are consulted:
56
56
57 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
57 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
58 - ``<repo>/.hg/hgrc`` (per-repository)
58 - ``<repo>/.hg/hgrc`` (per-repository)
59 - ``$HOME/.hgrc`` (per-user)
59 - ``$HOME/.hgrc`` (per-user)
60 - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user)
60 - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user)
61 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
61 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
62 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
62 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
63 - ``/etc/mercurial/hgrc`` (per-system)
63 - ``/etc/mercurial/hgrc`` (per-system)
64 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
64 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
65 - ``<internal>/*.rc`` (defaults)
65 - ``<internal>/*.rc`` (defaults)
66
66
67 .. container:: verbose.windows
67 .. container:: verbose.windows
68
68
69 On Windows, the following files are consulted:
69 On Windows, the following files are consulted:
70
70
71 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
71 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
72 - ``<repo>/.hg/hgrc`` (per-repository)
72 - ``<repo>/.hg/hgrc`` (per-repository)
73 - ``%USERPROFILE%\.hgrc`` (per-user)
73 - ``%USERPROFILE%\.hgrc`` (per-user)
74 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
74 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
75 - ``%HOME%\.hgrc`` (per-user)
75 - ``%HOME%\.hgrc`` (per-user)
76 - ``%HOME%\Mercurial.ini`` (per-user)
76 - ``%HOME%\Mercurial.ini`` (per-user)
77 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-system)
77 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-system)
78 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
78 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
79 - ``<install-dir>\Mercurial.ini`` (per-installation)
79 - ``<install-dir>\Mercurial.ini`` (per-installation)
80 - ``%PROGRAMDATA%\Mercurial\hgrc`` (per-system)
80 - ``%PROGRAMDATA%\Mercurial\hgrc`` (per-system)
81 - ``%PROGRAMDATA%\Mercurial\Mercurial.ini`` (per-system)
81 - ``%PROGRAMDATA%\Mercurial\Mercurial.ini`` (per-system)
82 - ``%PROGRAMDATA%\Mercurial\hgrc.d\*.rc`` (per-system)
82 - ``%PROGRAMDATA%\Mercurial\hgrc.d\*.rc`` (per-system)
83 - ``<internal>/*.rc`` (defaults)
83 - ``<internal>/*.rc`` (defaults)
84
84
85 .. note::
85 .. note::
86
86
87 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
87 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
88 is used when running 32-bit Python on 64-bit Windows.
88 is used when running 32-bit Python on 64-bit Windows.
89
89
90 .. container:: verbose.plan9
90 .. container:: verbose.plan9
91
91
92 On Plan9, the following files are consulted:
92 On Plan9, the following files are consulted:
93
93
94 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
94 - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
95 - ``<repo>/.hg/hgrc`` (per-repository)
95 - ``<repo>/.hg/hgrc`` (per-repository)
96 - ``$home/lib/hgrc`` (per-user)
96 - ``$home/lib/hgrc`` (per-user)
97 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
97 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
98 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
98 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
99 - ``/lib/mercurial/hgrc`` (per-system)
99 - ``/lib/mercurial/hgrc`` (per-system)
100 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
100 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
101 - ``<internal>/*.rc`` (defaults)
101 - ``<internal>/*.rc`` (defaults)
102
102
103 Per-repository configuration options only apply in a
103 Per-repository configuration options only apply in a
104 particular repository. This file is not version-controlled, and
104 particular repository. This file is not version-controlled, and
105 will not get transferred during a "clone" operation. Options in
105 will not get transferred during a "clone" operation. Options in
106 this file override options in all other configuration files.
106 this file override options in all other configuration files.
107
107
108 .. container:: unix.plan9
108 .. container:: unix.plan9
109
109
110 On Plan 9 and Unix, most of this file will be ignored if it doesn't
110 On Plan 9 and Unix, most of this file will be ignored if it doesn't
111 belong to a trusted user or to a trusted group. See
111 belong to a trusted user or to a trusted group. See
112 :hg:`help config.trusted` for more details.
112 :hg:`help config.trusted` for more details.
113
113
114 Per-user configuration file(s) are for the user running Mercurial. Options
114 Per-user configuration file(s) are for the user running Mercurial. Options
115 in these files apply to all Mercurial commands executed by this user in any
115 in these files apply to all Mercurial commands executed by this user in any
116 directory. Options in these files override per-system and per-installation
116 directory. Options in these files override per-system and per-installation
117 options.
117 options.
118
118
119 Per-installation configuration files are searched for in the
119 Per-installation configuration files are searched for in the
120 directory where Mercurial is installed. ``<install-root>`` is the
120 directory where Mercurial is installed. ``<install-root>`` is the
121 parent directory of the **hg** executable (or symlink) being run.
121 parent directory of the **hg** executable (or symlink) being run.
122
122
123 .. container:: unix.plan9
123 .. container:: unix.plan9
124
124
125 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
125 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
126 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
126 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
127 files apply to all Mercurial commands executed by any user in any
127 files apply to all Mercurial commands executed by any user in any
128 directory.
128 directory.
129
129
130 Per-installation configuration files are for the system on
130 Per-installation configuration files are for the system on
131 which Mercurial is running. Options in these files apply to all
131 which Mercurial is running. Options in these files apply to all
132 Mercurial commands executed by any user in any directory. Registry
132 Mercurial commands executed by any user in any directory. Registry
133 keys contain PATH-like strings, every part of which must reference
133 keys contain PATH-like strings, every part of which must reference
134 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
134 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
135 be read. Mercurial checks each of these locations in the specified
135 be read. Mercurial checks each of these locations in the specified
136 order until one or more configuration files are detected.
136 order until one or more configuration files are detected.
137
137
138 Per-system configuration files are for the system on which Mercurial
138 Per-system configuration files are for the system on which Mercurial
139 is running. Options in these files apply to all Mercurial commands
139 is running. Options in these files apply to all Mercurial commands
140 executed by any user in any directory. Options in these files
140 executed by any user in any directory. Options in these files
141 override per-installation options.
141 override per-installation options.
142
142
143 Mercurial comes with some default configuration. The default configuration
143 Mercurial comes with some default configuration. The default configuration
144 files are installed with Mercurial and will be overwritten on upgrades. Default
144 files are installed with Mercurial and will be overwritten on upgrades. Default
145 configuration files should never be edited by users or administrators but can
145 configuration files should never be edited by users or administrators but can
146 be overridden in other configuration files. So far the directory only contains
146 be overridden in other configuration files. So far the directory only contains
147 merge tool configuration but packagers can also put other default configuration
147 merge tool configuration but packagers can also put other default configuration
148 there.
148 there.
149
149
150 On versions 5.7 and later, if share-safe functionality is enabled,
150 On versions 5.7 and later, if share-safe functionality is enabled,
151 shares will read config file of share source too.
151 shares will read config file of share source too.
152 `<share-source/.hg/hgrc>` is read before reading `<repo/.hg/hgrc>`.
152 `<share-source/.hg/hgrc>` is read before reading `<repo/.hg/hgrc>`.
153
153
154 For configs which should not be shared, `<repo/.hg/hgrc-not-shared>`
154 For configs which should not be shared, `<repo/.hg/hgrc-not-shared>`
155 should be used.
155 should be used.
156
156
157 Syntax
157 Syntax
158 ======
158 ======
159
159
160 A configuration file consists of sections, led by a ``[section]`` header
160 A configuration file consists of sections, led by a ``[section]`` header
161 and followed by ``name = value`` entries (sometimes called
161 and followed by ``name = value`` entries (sometimes called
162 ``configuration keys``)::
162 ``configuration keys``)::
163
163
164 [spam]
164 [spam]
165 eggs=ham
165 eggs=ham
166 green=
166 green=
167 eggs
167 eggs
168
168
169 Each line contains one entry. If the lines that follow are indented,
169 Each line contains one entry. If the lines that follow are indented,
170 they are treated as continuations of that entry. Leading whitespace is
170 they are treated as continuations of that entry. Leading whitespace is
171 removed from values. Empty lines are skipped. Lines beginning with
171 removed from values. Empty lines are skipped. Lines beginning with
172 ``#`` or ``;`` are ignored and may be used to provide comments.
172 ``#`` or ``;`` are ignored and may be used to provide comments.
173
173
174 Configuration keys can be set multiple times, in which case Mercurial
174 Configuration keys can be set multiple times, in which case Mercurial
175 will use the value that was configured last. As an example::
175 will use the value that was configured last. As an example::
176
176
177 [spam]
177 [spam]
178 eggs=large
178 eggs=large
179 ham=serrano
179 ham=serrano
180 eggs=small
180 eggs=small
181
181
182 This would set the configuration key named ``eggs`` to ``small``.
182 This would set the configuration key named ``eggs`` to ``small``.
183
183
184 It is also possible to define a section multiple times. A section can
184 It is also possible to define a section multiple times. A section can
185 be redefined on the same and/or on different configuration files. For
185 be redefined on the same and/or on different configuration files. For
186 example::
186 example::
187
187
188 [foo]
188 [foo]
189 eggs=large
189 eggs=large
190 ham=serrano
190 ham=serrano
191 eggs=small
191 eggs=small
192
192
193 [bar]
193 [bar]
194 eggs=ham
194 eggs=ham
195 green=
195 green=
196 eggs
196 eggs
197
197
198 [foo]
198 [foo]
199 ham=prosciutto
199 ham=prosciutto
200 eggs=medium
200 eggs=medium
201 bread=toasted
201 bread=toasted
202
202
203 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
203 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
204 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
204 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
205 respectively. As you can see there only thing that matters is the last
205 respectively. As you can see there only thing that matters is the last
206 value that was set for each of the configuration keys.
206 value that was set for each of the configuration keys.
207
207
208 If a configuration key is set multiple times in different
208 If a configuration key is set multiple times in different
209 configuration files the final value will depend on the order in which
209 configuration files the final value will depend on the order in which
210 the different configuration files are read, with settings from earlier
210 the different configuration files are read, with settings from earlier
211 paths overriding later ones as described on the ``Files`` section
211 paths overriding later ones as described on the ``Files`` section
212 above.
212 above.
213
213
214 A line of the form ``%include file`` will include ``file`` into the
214 A line of the form ``%include file`` will include ``file`` into the
215 current configuration file. The inclusion is recursive, which means
215 current configuration file. The inclusion is recursive, which means
216 that included files can include other files. Filenames are relative to
216 that included files can include other files. Filenames are relative to
217 the configuration file in which the ``%include`` directive is found.
217 the configuration file in which the ``%include`` directive is found.
218 Environment variables and ``~user`` constructs are expanded in
218 Environment variables and ``~user`` constructs are expanded in
219 ``file``. This lets you do something like::
219 ``file``. This lets you do something like::
220
220
221 %include ~/.hgrc.d/$HOST.rc
221 %include ~/.hgrc.d/$HOST.rc
222
222
223 to include a different configuration file on each computer you use.
223 to include a different configuration file on each computer you use.
224
224
225 A line with ``%unset name`` will remove ``name`` from the current
225 A line with ``%unset name`` will remove ``name`` from the current
226 section, if it has been set previously.
226 section, if it has been set previously.
227
227
228 The values are either free-form text strings, lists of text strings,
228 The values are either free-form text strings, lists of text strings,
229 or Boolean values. Boolean values can be set to true using any of "1",
229 or Boolean values. Boolean values can be set to true using any of "1",
230 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
230 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
231 (all case insensitive).
231 (all case insensitive).
232
232
233 List values are separated by whitespace or comma, except when values are
233 List values are separated by whitespace or comma, except when values are
234 placed in double quotation marks::
234 placed in double quotation marks::
235
235
236 allow_read = "John Doe, PhD", brian, betty
236 allow_read = "John Doe, PhD", brian, betty
237
237
238 Quotation marks can be escaped by prefixing them with a backslash. Only
238 Quotation marks can be escaped by prefixing them with a backslash. Only
239 quotation marks at the beginning of a word is counted as a quotation
239 quotation marks at the beginning of a word is counted as a quotation
240 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
240 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
241
241
242 Sections
242 Sections
243 ========
243 ========
244
244
245 This section describes the different sections that may appear in a
245 This section describes the different sections that may appear in a
246 Mercurial configuration file, the purpose of each section, its possible
246 Mercurial configuration file, the purpose of each section, its possible
247 keys, and their possible values.
247 keys, and their possible values.
248
248
249 ``alias``
249 ``alias``
250 ---------
250 ---------
251
251
252 Defines command aliases.
252 Defines command aliases.
253
253
254 Aliases allow you to define your own commands in terms of other
254 Aliases allow you to define your own commands in terms of other
255 commands (or aliases), optionally including arguments. Positional
255 commands (or aliases), optionally including arguments. Positional
256 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
256 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
257 are expanded by Mercurial before execution. Positional arguments not
257 are expanded by Mercurial before execution. Positional arguments not
258 already used by ``$N`` in the definition are put at the end of the
258 already used by ``$N`` in the definition are put at the end of the
259 command to be executed.
259 command to be executed.
260
260
261 Alias definitions consist of lines of the form::
261 Alias definitions consist of lines of the form::
262
262
263 <alias> = <command> [<argument>]...
263 <alias> = <command> [<argument>]...
264
264
265 For example, this definition::
265 For example, this definition::
266
266
267 latest = log --limit 5
267 latest = log --limit 5
268
268
269 creates a new command ``latest`` that shows only the five most recent
269 creates a new command ``latest`` that shows only the five most recent
270 changesets. You can define subsequent aliases using earlier ones::
270 changesets. You can define subsequent aliases using earlier ones::
271
271
272 stable5 = latest -b stable
272 stable5 = latest -b stable
273
273
274 .. note::
274 .. note::
275
275
276 It is possible to create aliases with the same names as
276 It is possible to create aliases with the same names as
277 existing commands, which will then override the original
277 existing commands, which will then override the original
278 definitions. This is almost always a bad idea!
278 definitions. This is almost always a bad idea!
279
279
280 An alias can start with an exclamation point (``!``) to make it a
280 An alias can start with an exclamation point (``!``) to make it a
281 shell alias. A shell alias is executed with the shell and will let you
281 shell alias. A shell alias is executed with the shell and will let you
282 run arbitrary commands. As an example, ::
282 run arbitrary commands. As an example, ::
283
283
284 echo = !echo $@
284 echo = !echo $@
285
285
286 will let you do ``hg echo foo`` to have ``foo`` printed in your
286 will let you do ``hg echo foo`` to have ``foo`` printed in your
287 terminal. A better example might be::
287 terminal. A better example might be::
288
288
289 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
289 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
290
290
291 which will make ``hg purge`` delete all unknown files in the
291 which will make ``hg purge`` delete all unknown files in the
292 repository in the same manner as the purge extension.
292 repository in the same manner as the purge extension.
293
293
294 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
294 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
295 expand to the command arguments. Unmatched arguments are
295 expand to the command arguments. Unmatched arguments are
296 removed. ``$0`` expands to the alias name and ``$@`` expands to all
296 removed. ``$0`` expands to the alias name and ``$@`` expands to all
297 arguments separated by a space. ``"$@"`` (with quotes) expands to all
297 arguments separated by a space. ``"$@"`` (with quotes) expands to all
298 arguments quoted individually and separated by a space. These expansions
298 arguments quoted individually and separated by a space. These expansions
299 happen before the command is passed to the shell.
299 happen before the command is passed to the shell.
300
300
301 Shell aliases are executed in an environment where ``$HG`` expands to
301 Shell aliases are executed in an environment where ``$HG`` expands to
302 the path of the Mercurial that was used to execute the alias. This is
302 the path of the Mercurial that was used to execute the alias. This is
303 useful when you want to call further Mercurial commands in a shell
303 useful when you want to call further Mercurial commands in a shell
304 alias, as was done above for the purge alias. In addition,
304 alias, as was done above for the purge alias. In addition,
305 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
305 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
306 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
306 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
307
307
308 .. note::
308 .. note::
309
309
310 Some global configuration options such as ``-R`` are
310 Some global configuration options such as ``-R`` are
311 processed before shell aliases and will thus not be passed to
311 processed before shell aliases and will thus not be passed to
312 aliases.
312 aliases.
313
313
314
314
315 ``annotate``
315 ``annotate``
316 ------------
316 ------------
317
317
318 Settings used when displaying file annotations. All values are
318 Settings used when displaying file annotations. All values are
319 Booleans and default to False. See :hg:`help config.diff` for
319 Booleans and default to False. See :hg:`help config.diff` for
320 related options for the diff command.
320 related options for the diff command.
321
321
322 ``ignorews``
322 ``ignorews``
323 Ignore white space when comparing lines.
323 Ignore white space when comparing lines.
324
324
325 ``ignorewseol``
325 ``ignorewseol``
326 Ignore white space at the end of a line when comparing lines.
326 Ignore white space at the end of a line when comparing lines.
327
327
328 ``ignorewsamount``
328 ``ignorewsamount``
329 Ignore changes in the amount of white space.
329 Ignore changes in the amount of white space.
330
330
331 ``ignoreblanklines``
331 ``ignoreblanklines``
332 Ignore changes whose lines are all blank.
332 Ignore changes whose lines are all blank.
333
333
334
334
335 ``auth``
335 ``auth``
336 --------
336 --------
337
337
338 Authentication credentials and other authentication-like configuration
338 Authentication credentials and other authentication-like configuration
339 for HTTP connections. This section allows you to store usernames and
339 for HTTP connections. This section allows you to store usernames and
340 passwords for use when logging *into* HTTP servers. See
340 passwords for use when logging *into* HTTP servers. See
341 :hg:`help config.web` if you want to configure *who* can login to
341 :hg:`help config.web` if you want to configure *who* can login to
342 your HTTP server.
342 your HTTP server.
343
343
344 The following options apply to all hosts.
344 The following options apply to all hosts.
345
345
346 ``cookiefile``
346 ``cookiefile``
347 Path to a file containing HTTP cookie lines. Cookies matching a
347 Path to a file containing HTTP cookie lines. Cookies matching a
348 host will be sent automatically.
348 host will be sent automatically.
349
349
350 The file format uses the Mozilla cookies.txt format, which defines cookies
350 The file format uses the Mozilla cookies.txt format, which defines cookies
351 on their own lines. Each line contains 7 fields delimited by the tab
351 on their own lines. Each line contains 7 fields delimited by the tab
352 character (domain, is_domain_cookie, path, is_secure, expires, name,
352 character (domain, is_domain_cookie, path, is_secure, expires, name,
353 value). For more info, do an Internet search for "Netscape cookies.txt
353 value). For more info, do an Internet search for "Netscape cookies.txt
354 format."
354 format."
355
355
356 Note: the cookies parser does not handle port numbers on domains. You
356 Note: the cookies parser does not handle port numbers on domains. You
357 will need to remove ports from the domain for the cookie to be recognized.
357 will need to remove ports from the domain for the cookie to be recognized.
358 This could result in a cookie being disclosed to an unwanted server.
358 This could result in a cookie being disclosed to an unwanted server.
359
359
360 The cookies file is read-only.
360 The cookies file is read-only.
361
361
362 Other options in this section are grouped by name and have the following
362 Other options in this section are grouped by name and have the following
363 format::
363 format::
364
364
365 <name>.<argument> = <value>
365 <name>.<argument> = <value>
366
366
367 where ``<name>`` is used to group arguments into authentication
367 where ``<name>`` is used to group arguments into authentication
368 entries. Example::
368 entries. Example::
369
369
370 foo.prefix = hg.intevation.de/mercurial
370 foo.prefix = hg.intevation.de/mercurial
371 foo.username = foo
371 foo.username = foo
372 foo.password = bar
372 foo.password = bar
373 foo.schemes = http https
373 foo.schemes = http https
374
374
375 bar.prefix = secure.example.org
375 bar.prefix = secure.example.org
376 bar.key = path/to/file.key
376 bar.key = path/to/file.key
377 bar.cert = path/to/file.cert
377 bar.cert = path/to/file.cert
378 bar.schemes = https
378 bar.schemes = https
379
379
380 Supported arguments:
380 Supported arguments:
381
381
382 ``prefix``
382 ``prefix``
383 Either ``*`` or a URI prefix with or without the scheme part.
383 Either ``*`` or a URI prefix with or without the scheme part.
384 The authentication entry with the longest matching prefix is used
384 The authentication entry with the longest matching prefix is used
385 (where ``*`` matches everything and counts as a match of length
385 (where ``*`` matches everything and counts as a match of length
386 1). If the prefix doesn't include a scheme, the match is performed
386 1). If the prefix doesn't include a scheme, the match is performed
387 against the URI with its scheme stripped as well, and the schemes
387 against the URI with its scheme stripped as well, and the schemes
388 argument, q.v., is then subsequently consulted.
388 argument, q.v., is then subsequently consulted.
389
389
390 ``username``
390 ``username``
391 Optional. Username to authenticate with. If not given, and the
391 Optional. Username to authenticate with. If not given, and the
392 remote site requires basic or digest authentication, the user will
392 remote site requires basic or digest authentication, the user will
393 be prompted for it. Environment variables are expanded in the
393 be prompted for it. Environment variables are expanded in the
394 username letting you do ``foo.username = $USER``. If the URI
394 username letting you do ``foo.username = $USER``. If the URI
395 includes a username, only ``[auth]`` entries with a matching
395 includes a username, only ``[auth]`` entries with a matching
396 username or without a username will be considered.
396 username or without a username will be considered.
397
397
398 ``password``
398 ``password``
399 Optional. Password to authenticate with. If not given, and the
399 Optional. Password to authenticate with. If not given, and the
400 remote site requires basic or digest authentication, the user
400 remote site requires basic or digest authentication, the user
401 will be prompted for it.
401 will be prompted for it.
402
402
403 ``key``
403 ``key``
404 Optional. PEM encoded client certificate key file. Environment
404 Optional. PEM encoded client certificate key file. Environment
405 variables are expanded in the filename.
405 variables are expanded in the filename.
406
406
407 ``cert``
407 ``cert``
408 Optional. PEM encoded client certificate chain file. Environment
408 Optional. PEM encoded client certificate chain file. Environment
409 variables are expanded in the filename.
409 variables are expanded in the filename.
410
410
411 ``schemes``
411 ``schemes``
412 Optional. Space separated list of URI schemes to use this
412 Optional. Space separated list of URI schemes to use this
413 authentication entry with. Only used if the prefix doesn't include
413 authentication entry with. Only used if the prefix doesn't include
414 a scheme. Supported schemes are http and https. They will match
414 a scheme. Supported schemes are http and https. They will match
415 static-http and static-https respectively, as well.
415 static-http and static-https respectively, as well.
416 (default: https)
416 (default: https)
417
417
418 If no suitable authentication entry is found, the user is prompted
418 If no suitable authentication entry is found, the user is prompted
419 for credentials as usual if required by the remote.
419 for credentials as usual if required by the remote.
420
420
421 ``cmdserver``
421 ``cmdserver``
422 -------------
422 -------------
423
423
424 Controls command server settings. (ADVANCED)
424 Controls command server settings. (ADVANCED)
425
425
426 ``message-encodings``
426 ``message-encodings``
427 List of encodings for the ``m`` (message) channel. The first encoding
427 List of encodings for the ``m`` (message) channel. The first encoding
428 supported by the server will be selected and advertised in the hello
428 supported by the server will be selected and advertised in the hello
429 message. This is useful only when ``ui.message-output`` is set to
429 message. This is useful only when ``ui.message-output`` is set to
430 ``channel``. Supported encodings are ``cbor``.
430 ``channel``. Supported encodings are ``cbor``.
431
431
432 ``shutdown-on-interrupt``
432 ``shutdown-on-interrupt``
433 If set to false, the server's main loop will continue running after
433 If set to false, the server's main loop will continue running after
434 SIGINT received. ``runcommand`` requests can still be interrupted by
434 SIGINT received. ``runcommand`` requests can still be interrupted by
435 SIGINT. Close the write end of the pipe to shut down the server
435 SIGINT. Close the write end of the pipe to shut down the server
436 process gracefully.
436 process gracefully.
437 (default: True)
437 (default: True)
438
438
439 ``color``
439 ``color``
440 ---------
440 ---------
441
441
442 Configure the Mercurial color mode. For details about how to define your custom
442 Configure the Mercurial color mode. For details about how to define your custom
443 effect and style see :hg:`help color`.
443 effect and style see :hg:`help color`.
444
444
445 ``mode``
445 ``mode``
446 String: control the method used to output color. One of ``auto``, ``ansi``,
446 String: control the method used to output color. One of ``auto``, ``ansi``,
447 ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will
447 ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will
448 use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a
448 use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a
449 terminal. Any invalid value will disable color.
449 terminal. Any invalid value will disable color.
450
450
451 ``pagermode``
451 ``pagermode``
452 String: optional override of ``color.mode`` used with pager.
452 String: optional override of ``color.mode`` used with pager.
453
453
454 On some systems, terminfo mode may cause problems when using
454 On some systems, terminfo mode may cause problems when using
455 color with ``less -R`` as a pager program. less with the -R option
455 color with ``less -R`` as a pager program. less with the -R option
456 will only display ECMA-48 color codes, and terminfo mode may sometimes
456 will only display ECMA-48 color codes, and terminfo mode may sometimes
457 emit codes that less doesn't understand. You can work around this by
457 emit codes that less doesn't understand. You can work around this by
458 either using ansi mode (or auto mode), or by using less -r (which will
458 either using ansi mode (or auto mode), or by using less -r (which will
459 pass through all terminal control codes, not just color control
459 pass through all terminal control codes, not just color control
460 codes).
460 codes).
461
461
462 On some systems (such as MSYS in Windows), the terminal may support
462 On some systems (such as MSYS in Windows), the terminal may support
463 a different color mode than the pager program.
463 a different color mode than the pager program.
464
464
465 ``commands``
465 ``commands``
466 ------------
466 ------------
467
467
468 ``commit.post-status``
468 ``commit.post-status``
469 Show status of files in the working directory after successful commit.
469 Show status of files in the working directory after successful commit.
470 (default: False)
470 (default: False)
471
471
472 ``merge.require-rev``
472 ``merge.require-rev``
473 Require that the revision to merge the current commit with be specified on
473 Require that the revision to merge the current commit with be specified on
474 the command line. If this is enabled and a revision is not specified, the
474 the command line. If this is enabled and a revision is not specified, the
475 command aborts.
475 command aborts.
476 (default: False)
476 (default: False)
477
477
478 ``push.require-revs``
478 ``push.require-revs``
479 Require revisions to push be specified using one or more mechanisms such as
479 Require revisions to push be specified using one or more mechanisms such as
480 specifying them positionally on the command line, using ``-r``, ``-b``,
480 specifying them positionally on the command line, using ``-r``, ``-b``,
481 and/or ``-B`` on the command line, or using ``paths.<path>:pushrev`` in the
481 and/or ``-B`` on the command line, or using ``paths.<path>:pushrev`` in the
482 configuration. If this is enabled and revisions are not specified, the
482 configuration. If this is enabled and revisions are not specified, the
483 command aborts.
483 command aborts.
484 (default: False)
484 (default: False)
485
485
486 ``resolve.confirm``
486 ``resolve.confirm``
487 Confirm before performing action if no filename is passed.
487 Confirm before performing action if no filename is passed.
488 (default: False)
488 (default: False)
489
489
490 ``resolve.explicit-re-merge``
490 ``resolve.explicit-re-merge``
491 Require uses of ``hg resolve`` to specify which action it should perform,
491 Require uses of ``hg resolve`` to specify which action it should perform,
492 instead of re-merging files by default.
492 instead of re-merging files by default.
493 (default: False)
493 (default: False)
494
494
495 ``resolve.mark-check``
495 ``resolve.mark-check``
496 Determines what level of checking :hg:`resolve --mark` will perform before
496 Determines what level of checking :hg:`resolve --mark` will perform before
497 marking files as resolved. Valid values are ``none`, ``warn``, and
497 marking files as resolved. Valid values are ``none`, ``warn``, and
498 ``abort``. ``warn`` will output a warning listing the file(s) that still
498 ``abort``. ``warn`` will output a warning listing the file(s) that still
499 have conflict markers in them, but will still mark everything resolved.
499 have conflict markers in them, but will still mark everything resolved.
500 ``abort`` will output the same warning but will not mark things as resolved.
500 ``abort`` will output the same warning but will not mark things as resolved.
501 If --all is passed and this is set to ``abort``, only a warning will be
501 If --all is passed and this is set to ``abort``, only a warning will be
502 shown (an error will not be raised).
502 shown (an error will not be raised).
503 (default: ``none``)
503 (default: ``none``)
504
504
505 ``status.relative``
505 ``status.relative``
506 Make paths in :hg:`status` output relative to the current directory.
506 Make paths in :hg:`status` output relative to the current directory.
507 (default: False)
507 (default: False)
508
508
509 ``status.terse``
509 ``status.terse``
510 Default value for the --terse flag, which condenses status output.
510 Default value for the --terse flag, which condenses status output.
511 (default: empty)
511 (default: empty)
512
512
513 ``update.check``
513 ``update.check``
514 Determines what level of checking :hg:`update` will perform before moving
514 Determines what level of checking :hg:`update` will perform before moving
515 to a destination revision. Valid values are ``abort``, ``none``,
515 to a destination revision. Valid values are ``abort``, ``none``,
516 ``linear``, and ``noconflict``. ``abort`` always fails if the working
516 ``linear``, and ``noconflict``. ``abort`` always fails if the working
517 directory has uncommitted changes. ``none`` performs no checking, and may
517 directory has uncommitted changes. ``none`` performs no checking, and may
518 result in a merge with uncommitted changes. ``linear`` allows any update
518 result in a merge with uncommitted changes. ``linear`` allows any update
519 as long as it follows a straight line in the revision history, and may
519 as long as it follows a straight line in the revision history, and may
520 trigger a merge with uncommitted changes. ``noconflict`` will allow any
520 trigger a merge with uncommitted changes. ``noconflict`` will allow any
521 update which would not trigger a merge with uncommitted changes, if any
521 update which would not trigger a merge with uncommitted changes, if any
522 are present.
522 are present.
523 (default: ``linear``)
523 (default: ``linear``)
524
524
525 ``update.requiredest``
525 ``update.requiredest``
526 Require that the user pass a destination when running :hg:`update`.
526 Require that the user pass a destination when running :hg:`update`.
527 For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
527 For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
528 will be disallowed.
528 will be disallowed.
529 (default: False)
529 (default: False)
530
530
531 ``committemplate``
531 ``committemplate``
532 ------------------
532 ------------------
533
533
534 ``changeset``
534 ``changeset``
535 String: configuration in this section is used as the template to
535 String: configuration in this section is used as the template to
536 customize the text shown in the editor when committing.
536 customize the text shown in the editor when committing.
537
537
538 In addition to pre-defined template keywords, commit log specific one
538 In addition to pre-defined template keywords, commit log specific one
539 below can be used for customization:
539 below can be used for customization:
540
540
541 ``extramsg``
541 ``extramsg``
542 String: Extra message (typically 'Leave message empty to abort
542 String: Extra message (typically 'Leave message empty to abort
543 commit.'). This may be changed by some commands or extensions.
543 commit.'). This may be changed by some commands or extensions.
544
544
545 For example, the template configuration below shows as same text as
545 For example, the template configuration below shows as same text as
546 one shown by default::
546 one shown by default::
547
547
548 [committemplate]
548 [committemplate]
549 changeset = {desc}\n\n
549 changeset = {desc}\n\n
550 HG: Enter commit message. Lines beginning with 'HG:' are removed.
550 HG: Enter commit message. Lines beginning with 'HG:' are removed.
551 HG: {extramsg}
551 HG: {extramsg}
552 HG: --
552 HG: --
553 HG: user: {author}\n{ifeq(p2rev, "-1", "",
553 HG: user: {author}\n{ifeq(p2rev, "-1", "",
554 "HG: branch merge\n")
554 "HG: branch merge\n")
555 }HG: branch '{branch}'\n{if(activebookmark,
555 }HG: branch '{branch}'\n{if(activebookmark,
556 "HG: bookmark '{activebookmark}'\n") }{subrepos %
556 "HG: bookmark '{activebookmark}'\n") }{subrepos %
557 "HG: subrepo {subrepo}\n" }{file_adds %
557 "HG: subrepo {subrepo}\n" }{file_adds %
558 "HG: added {file}\n" }{file_mods %
558 "HG: added {file}\n" }{file_mods %
559 "HG: changed {file}\n" }{file_dels %
559 "HG: changed {file}\n" }{file_dels %
560 "HG: removed {file}\n" }{if(files, "",
560 "HG: removed {file}\n" }{if(files, "",
561 "HG: no files changed\n")}
561 "HG: no files changed\n")}
562
562
563 ``diff()``
563 ``diff()``
564 String: show the diff (see :hg:`help templates` for detail)
564 String: show the diff (see :hg:`help templates` for detail)
565
565
566 Sometimes it is helpful to show the diff of the changeset in the editor without
566 Sometimes it is helpful to show the diff of the changeset in the editor without
567 having to prefix 'HG: ' to each line so that highlighting works correctly. For
567 having to prefix 'HG: ' to each line so that highlighting works correctly. For
568 this, Mercurial provides a special string which will ignore everything below
568 this, Mercurial provides a special string which will ignore everything below
569 it::
569 it::
570
570
571 HG: ------------------------ >8 ------------------------
571 HG: ------------------------ >8 ------------------------
572
572
573 For example, the template configuration below will show the diff below the
573 For example, the template configuration below will show the diff below the
574 extra message::
574 extra message::
575
575
576 [committemplate]
576 [committemplate]
577 changeset = {desc}\n\n
577 changeset = {desc}\n\n
578 HG: Enter commit message. Lines beginning with 'HG:' are removed.
578 HG: Enter commit message. Lines beginning with 'HG:' are removed.
579 HG: {extramsg}
579 HG: {extramsg}
580 HG: ------------------------ >8 ------------------------
580 HG: ------------------------ >8 ------------------------
581 HG: Do not touch the line above.
581 HG: Do not touch the line above.
582 HG: Everything below will be removed.
582 HG: Everything below will be removed.
583 {diff()}
583 {diff()}
584
584
585 .. note::
585 .. note::
586
586
587 For some problematic encodings (see :hg:`help win32mbcs` for
587 For some problematic encodings (see :hg:`help win32mbcs` for
588 detail), this customization should be configured carefully, to
588 detail), this customization should be configured carefully, to
589 avoid showing broken characters.
589 avoid showing broken characters.
590
590
591 For example, if a multibyte character ending with backslash (0x5c) is
591 For example, if a multibyte character ending with backslash (0x5c) is
592 followed by the ASCII character 'n' in the customized template,
592 followed by the ASCII character 'n' in the customized template,
593 the sequence of backslash and 'n' is treated as line-feed unexpectedly
593 the sequence of backslash and 'n' is treated as line-feed unexpectedly
594 (and the multibyte character is broken, too).
594 (and the multibyte character is broken, too).
595
595
596 Customized template is used for commands below (``--edit`` may be
596 Customized template is used for commands below (``--edit`` may be
597 required):
597 required):
598
598
599 - :hg:`backout`
599 - :hg:`backout`
600 - :hg:`commit`
600 - :hg:`commit`
601 - :hg:`fetch` (for merge commit only)
601 - :hg:`fetch` (for merge commit only)
602 - :hg:`graft`
602 - :hg:`graft`
603 - :hg:`histedit`
603 - :hg:`histedit`
604 - :hg:`import`
604 - :hg:`import`
605 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
605 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
606 - :hg:`rebase`
606 - :hg:`rebase`
607 - :hg:`shelve`
607 - :hg:`shelve`
608 - :hg:`sign`
608 - :hg:`sign`
609 - :hg:`tag`
609 - :hg:`tag`
610 - :hg:`transplant`
610 - :hg:`transplant`
611
611
612 Configuring items below instead of ``changeset`` allows showing
612 Configuring items below instead of ``changeset`` allows showing
613 customized message only for specific actions, or showing different
613 customized message only for specific actions, or showing different
614 messages for each action.
614 messages for each action.
615
615
616 - ``changeset.backout`` for :hg:`backout`
616 - ``changeset.backout`` for :hg:`backout`
617 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
617 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
618 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
618 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
619 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
619 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
620 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
620 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
621 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
621 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
622 - ``changeset.gpg.sign`` for :hg:`sign`
622 - ``changeset.gpg.sign`` for :hg:`sign`
623 - ``changeset.graft`` for :hg:`graft`
623 - ``changeset.graft`` for :hg:`graft`
624 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
624 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
625 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
625 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
626 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
626 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
627 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
627 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
628 - ``changeset.import.bypass`` for :hg:`import --bypass`
628 - ``changeset.import.bypass`` for :hg:`import --bypass`
629 - ``changeset.import.normal.merge`` for :hg:`import` on merges
629 - ``changeset.import.normal.merge`` for :hg:`import` on merges
630 - ``changeset.import.normal.normal`` for :hg:`import` on other
630 - ``changeset.import.normal.normal`` for :hg:`import` on other
631 - ``changeset.mq.qnew`` for :hg:`qnew`
631 - ``changeset.mq.qnew`` for :hg:`qnew`
632 - ``changeset.mq.qfold`` for :hg:`qfold`
632 - ``changeset.mq.qfold`` for :hg:`qfold`
633 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
633 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
634 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
634 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
635 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
635 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
636 - ``changeset.rebase.normal`` for :hg:`rebase` on other
636 - ``changeset.rebase.normal`` for :hg:`rebase` on other
637 - ``changeset.shelve.shelve`` for :hg:`shelve`
637 - ``changeset.shelve.shelve`` for :hg:`shelve`
638 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
638 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
639 - ``changeset.tag.remove`` for :hg:`tag --remove`
639 - ``changeset.tag.remove`` for :hg:`tag --remove`
640 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
640 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
641 - ``changeset.transplant.normal`` for :hg:`transplant` on other
641 - ``changeset.transplant.normal`` for :hg:`transplant` on other
642
642
643 These dot-separated lists of names are treated as hierarchical ones.
643 These dot-separated lists of names are treated as hierarchical ones.
644 For example, ``changeset.tag.remove`` customizes the commit message
644 For example, ``changeset.tag.remove`` customizes the commit message
645 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
645 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
646 commit message for :hg:`tag` regardless of ``--remove`` option.
646 commit message for :hg:`tag` regardless of ``--remove`` option.
647
647
648 When the external editor is invoked for a commit, the corresponding
648 When the external editor is invoked for a commit, the corresponding
649 dot-separated list of names without the ``changeset.`` prefix
649 dot-separated list of names without the ``changeset.`` prefix
650 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
650 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
651 variable.
651 variable.
652
652
653 In this section, items other than ``changeset`` can be referred from
653 In this section, items other than ``changeset`` can be referred from
654 others. For example, the configuration to list committed files up
654 others. For example, the configuration to list committed files up
655 below can be referred as ``{listupfiles}``::
655 below can be referred as ``{listupfiles}``::
656
656
657 [committemplate]
657 [committemplate]
658 listupfiles = {file_adds %
658 listupfiles = {file_adds %
659 "HG: added {file}\n" }{file_mods %
659 "HG: added {file}\n" }{file_mods %
660 "HG: changed {file}\n" }{file_dels %
660 "HG: changed {file}\n" }{file_dels %
661 "HG: removed {file}\n" }{if(files, "",
661 "HG: removed {file}\n" }{if(files, "",
662 "HG: no files changed\n")}
662 "HG: no files changed\n")}
663
663
664 ``decode/encode``
664 ``decode/encode``
665 -----------------
665 -----------------
666
666
667 Filters for transforming files on checkout/checkin. This would
667 Filters for transforming files on checkout/checkin. This would
668 typically be used for newline processing or other
668 typically be used for newline processing or other
669 localization/canonicalization of files.
669 localization/canonicalization of files.
670
670
671 Filters consist of a filter pattern followed by a filter command.
671 Filters consist of a filter pattern followed by a filter command.
672 Filter patterns are globs by default, rooted at the repository root.
672 Filter patterns are globs by default, rooted at the repository root.
673 For example, to match any file ending in ``.txt`` in the root
673 For example, to match any file ending in ``.txt`` in the root
674 directory only, use the pattern ``*.txt``. To match any file ending
674 directory only, use the pattern ``*.txt``. To match any file ending
675 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
675 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
676 For each file only the first matching filter applies.
676 For each file only the first matching filter applies.
677
677
678 The filter command can start with a specifier, either ``pipe:`` or
678 The filter command can start with a specifier, either ``pipe:`` or
679 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
679 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
680
680
681 A ``pipe:`` command must accept data on stdin and return the transformed
681 A ``pipe:`` command must accept data on stdin and return the transformed
682 data on stdout.
682 data on stdout.
683
683
684 Pipe example::
684 Pipe example::
685
685
686 [encode]
686 [encode]
687 # uncompress gzip files on checkin to improve delta compression
687 # uncompress gzip files on checkin to improve delta compression
688 # note: not necessarily a good idea, just an example
688 # note: not necessarily a good idea, just an example
689 *.gz = pipe: gunzip
689 *.gz = pipe: gunzip
690
690
691 [decode]
691 [decode]
692 # recompress gzip files when writing them to the working dir (we
692 # recompress gzip files when writing them to the working dir (we
693 # can safely omit "pipe:", because it's the default)
693 # can safely omit "pipe:", because it's the default)
694 *.gz = gzip
694 *.gz = gzip
695
695
696 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
696 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
697 with the name of a temporary file that contains the data to be
697 with the name of a temporary file that contains the data to be
698 filtered by the command. The string ``OUTFILE`` is replaced with the name
698 filtered by the command. The string ``OUTFILE`` is replaced with the name
699 of an empty temporary file, where the filtered data must be written by
699 of an empty temporary file, where the filtered data must be written by
700 the command.
700 the command.
701
701
702 .. container:: windows
702 .. container:: windows
703
703
704 .. note::
704 .. note::
705
705
706 The tempfile mechanism is recommended for Windows systems,
706 The tempfile mechanism is recommended for Windows systems,
707 where the standard shell I/O redirection operators often have
707 where the standard shell I/O redirection operators often have
708 strange effects and may corrupt the contents of your files.
708 strange effects and may corrupt the contents of your files.
709
709
710 This filter mechanism is used internally by the ``eol`` extension to
710 This filter mechanism is used internally by the ``eol`` extension to
711 translate line ending characters between Windows (CRLF) and Unix (LF)
711 translate line ending characters between Windows (CRLF) and Unix (LF)
712 format. We suggest you use the ``eol`` extension for convenience.
712 format. We suggest you use the ``eol`` extension for convenience.
713
713
714
714
715 ``defaults``
715 ``defaults``
716 ------------
716 ------------
717
717
718 (defaults are deprecated. Don't use them. Use aliases instead.)
718 (defaults are deprecated. Don't use them. Use aliases instead.)
719
719
720 Use the ``[defaults]`` section to define command defaults, i.e. the
720 Use the ``[defaults]`` section to define command defaults, i.e. the
721 default options/arguments to pass to the specified commands.
721 default options/arguments to pass to the specified commands.
722
722
723 The following example makes :hg:`log` run in verbose mode, and
723 The following example makes :hg:`log` run in verbose mode, and
724 :hg:`status` show only the modified files, by default::
724 :hg:`status` show only the modified files, by default::
725
725
726 [defaults]
726 [defaults]
727 log = -v
727 log = -v
728 status = -m
728 status = -m
729
729
730 The actual commands, instead of their aliases, must be used when
730 The actual commands, instead of their aliases, must be used when
731 defining command defaults. The command defaults will also be applied
731 defining command defaults. The command defaults will also be applied
732 to the aliases of the commands defined.
732 to the aliases of the commands defined.
733
733
734
734
735 ``diff``
735 ``diff``
736 --------
736 --------
737
737
738 Settings used when displaying diffs. Everything except for ``unified``
738 Settings used when displaying diffs. Everything except for ``unified``
739 is a Boolean and defaults to False. See :hg:`help config.annotate`
739 is a Boolean and defaults to False. See :hg:`help config.annotate`
740 for related options for the annotate command.
740 for related options for the annotate command.
741
741
742 ``git``
742 ``git``
743 Use git extended diff format.
743 Use git extended diff format.
744
744
745 ``nobinary``
745 ``nobinary``
746 Omit git binary patches.
746 Omit git binary patches.
747
747
748 ``nodates``
748 ``nodates``
749 Don't include dates in diff headers.
749 Don't include dates in diff headers.
750
750
751 ``noprefix``
751 ``noprefix``
752 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
752 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
753
753
754 ``showfunc``
754 ``showfunc``
755 Show which function each change is in.
755 Show which function each change is in.
756
756
757 ``ignorews``
757 ``ignorews``
758 Ignore white space when comparing lines.
758 Ignore white space when comparing lines.
759
759
760 ``ignorewsamount``
760 ``ignorewsamount``
761 Ignore changes in the amount of white space.
761 Ignore changes in the amount of white space.
762
762
763 ``ignoreblanklines``
763 ``ignoreblanklines``
764 Ignore changes whose lines are all blank.
764 Ignore changes whose lines are all blank.
765
765
766 ``unified``
766 ``unified``
767 Number of lines of context to show.
767 Number of lines of context to show.
768
768
769 ``word-diff``
769 ``word-diff``
770 Highlight changed words.
770 Highlight changed words.
771
771
772 ``email``
772 ``email``
773 ---------
773 ---------
774
774
775 Settings for extensions that send email messages.
775 Settings for extensions that send email messages.
776
776
777 ``from``
777 ``from``
778 Optional. Email address to use in "From" header and SMTP envelope
778 Optional. Email address to use in "From" header and SMTP envelope
779 of outgoing messages.
779 of outgoing messages.
780
780
781 ``to``
781 ``to``
782 Optional. Comma-separated list of recipients' email addresses.
782 Optional. Comma-separated list of recipients' email addresses.
783
783
784 ``cc``
784 ``cc``
785 Optional. Comma-separated list of carbon copy recipients'
785 Optional. Comma-separated list of carbon copy recipients'
786 email addresses.
786 email addresses.
787
787
788 ``bcc``
788 ``bcc``
789 Optional. Comma-separated list of blind carbon copy recipients'
789 Optional. Comma-separated list of blind carbon copy recipients'
790 email addresses.
790 email addresses.
791
791
792 ``method``
792 ``method``
793 Optional. Method to use to send email messages. If value is ``smtp``
793 Optional. Method to use to send email messages. If value is ``smtp``
794 (default), use SMTP (see the ``[smtp]`` section for configuration).
794 (default), use SMTP (see the ``[smtp]`` section for configuration).
795 Otherwise, use as name of program to run that acts like sendmail
795 Otherwise, use as name of program to run that acts like sendmail
796 (takes ``-f`` option for sender, list of recipients on command line,
796 (takes ``-f`` option for sender, list of recipients on command line,
797 message on stdin). Normally, setting this to ``sendmail`` or
797 message on stdin). Normally, setting this to ``sendmail`` or
798 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
798 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
799
799
800 ``charsets``
800 ``charsets``
801 Optional. Comma-separated list of character sets considered
801 Optional. Comma-separated list of character sets considered
802 convenient for recipients. Addresses, headers, and parts not
802 convenient for recipients. Addresses, headers, and parts not
803 containing patches of outgoing messages will be encoded in the
803 containing patches of outgoing messages will be encoded in the
804 first character set to which conversion from local encoding
804 first character set to which conversion from local encoding
805 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
805 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
806 conversion fails, the text in question is sent as is.
806 conversion fails, the text in question is sent as is.
807 (default: '')
807 (default: '')
808
808
809 Order of outgoing email character sets:
809 Order of outgoing email character sets:
810
810
811 1. ``us-ascii``: always first, regardless of settings
811 1. ``us-ascii``: always first, regardless of settings
812 2. ``email.charsets``: in order given by user
812 2. ``email.charsets``: in order given by user
813 3. ``ui.fallbackencoding``: if not in email.charsets
813 3. ``ui.fallbackencoding``: if not in email.charsets
814 4. ``$HGENCODING``: if not in email.charsets
814 4. ``$HGENCODING``: if not in email.charsets
815 5. ``utf-8``: always last, regardless of settings
815 5. ``utf-8``: always last, regardless of settings
816
816
817 Email example::
817 Email example::
818
818
819 [email]
819 [email]
820 from = Joseph User <joe.user@example.com>
820 from = Joseph User <joe.user@example.com>
821 method = /usr/sbin/sendmail
821 method = /usr/sbin/sendmail
822 # charsets for western Europeans
822 # charsets for western Europeans
823 # us-ascii, utf-8 omitted, as they are tried first and last
823 # us-ascii, utf-8 omitted, as they are tried first and last
824 charsets = iso-8859-1, iso-8859-15, windows-1252
824 charsets = iso-8859-1, iso-8859-15, windows-1252
825
825
826
826
827 ``extensions``
827 ``extensions``
828 --------------
828 --------------
829
829
830 Mercurial has an extension mechanism for adding new features. To
830 Mercurial has an extension mechanism for adding new features. To
831 enable an extension, create an entry for it in this section.
831 enable an extension, create an entry for it in this section.
832
832
833 If you know that the extension is already in Python's search path,
833 If you know that the extension is already in Python's search path,
834 you can give the name of the module, followed by ``=``, with nothing
834 you can give the name of the module, followed by ``=``, with nothing
835 after the ``=``.
835 after the ``=``.
836
836
837 Otherwise, give a name that you choose, followed by ``=``, followed by
837 Otherwise, give a name that you choose, followed by ``=``, followed by
838 the path to the ``.py`` file (including the file name extension) that
838 the path to the ``.py`` file (including the file name extension) that
839 defines the extension.
839 defines the extension.
840
840
841 To explicitly disable an extension that is enabled in an hgrc of
841 To explicitly disable an extension that is enabled in an hgrc of
842 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
842 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
843 or ``foo = !`` when path is not supplied.
843 or ``foo = !`` when path is not supplied.
844
844
845 Example for ``~/.hgrc``::
845 Example for ``~/.hgrc``::
846
846
847 [extensions]
847 [extensions]
848 # (the churn extension will get loaded from Mercurial's path)
848 # (the churn extension will get loaded from Mercurial's path)
849 churn =
849 churn =
850 # (this extension will get loaded from the file specified)
850 # (this extension will get loaded from the file specified)
851 myfeature = ~/.hgext/myfeature.py
851 myfeature = ~/.hgext/myfeature.py
852
852
853
853
854 ``format``
854 ``format``
855 ----------
855 ----------
856
856
857 Configuration that controls the repository format. Newer format options are more
857 Configuration that controls the repository format. Newer format options are more
858 powerful, but incompatible with some older versions of Mercurial. Format options
858 powerful, but incompatible with some older versions of Mercurial. Format options
859 are considered at repository initialization only. You need to make a new clone
859 are considered at repository initialization only. You need to make a new clone
860 for config changes to be taken into account.
860 for config changes to be taken into account.
861
861
862 For more details about repository format and version compatibility, see
862 For more details about repository format and version compatibility, see
863 https://www.mercurial-scm.org/wiki/MissingRequirement
863 https://www.mercurial-scm.org/wiki/MissingRequirement
864
864
865 ``usegeneraldelta``
865 ``usegeneraldelta``
866 Enable or disable the "generaldelta" repository format which improves
866 Enable or disable the "generaldelta" repository format which improves
867 repository compression by allowing "revlog" to store deltas against
867 repository compression by allowing "revlog" to store deltas against
868 arbitrary revisions instead of the previously stored one. This provides
868 arbitrary revisions instead of the previously stored one. This provides
869 significant improvement for repositories with branches.
869 significant improvement for repositories with branches.
870
870
871 Repositories with this on-disk format require Mercurial version 1.9.
871 Repositories with this on-disk format require Mercurial version 1.9.
872
872
873 Enabled by default.
873 Enabled by default.
874
874
875 ``dotencode``
875 ``dotencode``
876 Enable or disable the "dotencode" repository format which enhances
876 Enable or disable the "dotencode" repository format which enhances
877 the "fncache" repository format (which has to be enabled to use
877 the "fncache" repository format (which has to be enabled to use
878 dotencode) to avoid issues with filenames starting with "._" on
878 dotencode) to avoid issues with filenames starting with "._" on
879 Mac OS X and spaces on Windows.
879 Mac OS X and spaces on Windows.
880
880
881 Repositories with this on-disk format require Mercurial version 1.7.
881 Repositories with this on-disk format require Mercurial version 1.7.
882
882
883 Enabled by default.
883 Enabled by default.
884
884
885 ``usefncache``
885 ``usefncache``
886 Enable or disable the "fncache" repository format which enhances
886 Enable or disable the "fncache" repository format which enhances
887 the "store" repository format (which has to be enabled to use
887 the "store" repository format (which has to be enabled to use
888 fncache) to allow longer filenames and avoids using Windows
888 fncache) to allow longer filenames and avoids using Windows
889 reserved names, e.g. "nul".
889 reserved names, e.g. "nul".
890
890
891 Repositories with this on-disk format require Mercurial version 1.1.
891 Repositories with this on-disk format require Mercurial version 1.1.
892
892
893 Enabled by default.
893 Enabled by default.
894
894
895 ``exp-rc-dirstate-v2``
896 Enable or disable the experimental "dirstate-v2" feature. The dirstate
897 functionality is shared by all commands interacting with the working copy.
898 The new version is more robust, faster and stores more information.
899
900 The performance-improving version of this feature is currently only
901 implemented in Rust (see :hg:`help rust`), so people not using a version of
902 Mercurial compiled with the Rust parts might actually suffer some slowdown.
903 For this reason, such versions will by default refuse to access repositories
904 with "dirstate-v2" enabled.
905
906 This behavior can be adjusted via configuration: check
907 :hg:`help config.storage.dirstate-v2.slow-path` for details.
908
909 Repositories with this on-disk format require Mercurial 6.0 or above.
910
911 By default this format variant is disabled if the fast implementation is not
912 available, and enabled by default if the fast implementation is available.
913
914 To accomodate installations of Mercurial without the fast implementation,
915 you can downgrade your repository. To do so run the following command:
916
917 $ hg debugupgraderepo \
918 --run \
919 --config format.exp-rc-dirstate-v2=False \
920 --config storage.dirstate-v2.slow-path=allow
921
922 For a more comprehensive guide, see :hg:`help internals.dirstate-v2`.
923
895 ``use-persistent-nodemap``
924 ``use-persistent-nodemap``
896 Enable or disable the "persistent-nodemap" feature which improves
925 Enable or disable the "persistent-nodemap" feature which improves
897 performance if the rust extensions are available.
926 performance if the rust extensions are available.
898
927
899 The "persistence-nodemap" persist the "node -> rev" on disk removing the
928 The "persistence-nodemap" persist the "node -> rev" on disk removing the
900 need to dynamically build that mapping for each Mercurial invocation. This
929 need to dynamically build that mapping for each Mercurial invocation. This
901 significantly reduce the startup cost of various local and server-side
930 significantly reduce the startup cost of various local and server-side
902 operation for larger repository.
931 operation for larger repository.
903
932
904 The performance improving version of this feature is currently only
933 The performance improving version of this feature is currently only
905 implemented in Rust, so people not using a version of Mercurial compiled
934 implemented in Rust, so people not using a version of Mercurial compiled
906 with the Rust part might actually suffer some slowdown. For this reason,
935 with the Rust part might actually suffer some slowdown. For this reason,
907 Such version will by default refuse to access such repositories. That
936 Such version will by default refuse to access such repositories. That
908 behavior can be controlled by configuration. Check
937 behavior can be controlled by configuration. Check
909 :hg:`help config.storage.revlog.persistent-nodemap.slow-path` for details.
938 :hg:`help config.storage.revlog.persistent-nodemap.slow-path` for details.
910
939
911 Repository with this on-disk format require Mercurial version 5.4 or above.
940 Repository with this on-disk format require Mercurial version 5.4 or above.
912
941
913 By default this format variant is disabled if fast implementation is not
942 By default this format variant is disabled if fast implementation is not
914 available and enabled by default if the fast implementation is available.
943 available and enabled by default if the fast implementation is available.
915
944
916 To accomodate install of Mercurial without the fast implementation you can
945 To accomodate install of Mercurial without the fast implementation you can
917 downgrade your repository. To do so run the following command:
946 downgrade your repository. To do so run the following command:
918
947
919 $ hg debugupgraderepo \
948 $ hg debugupgraderepo \
920 --run \
949 --run \
921 --config format.use-persistent-nodemap=False \
950 --config format.use-persistent-nodemap=False \
922 --config storage.revlog.persistent-nodemap.slow-path=allow
951 --config storage.revlog.persistent-nodemap.slow-path=allow
923
952
924 ``use-share-safe``
953 ``use-share-safe``
925 Enforce "safe" behaviors for all "shares" that access this repository.
954 Enforce "safe" behaviors for all "shares" that access this repository.
926
955
927 With this feature, "shares" using this repository as a source will:
956 With this feature, "shares" using this repository as a source will:
928
957
929 * read the source repository's configuration (`<source>/.hg/hgrc`).
958 * read the source repository's configuration (`<source>/.hg/hgrc`).
930 * read and use the source repository's "requirements"
959 * read and use the source repository's "requirements"
931 (except the working copy specific one).
960 (except the working copy specific one).
932
961
933 Without this feature, "shares" using this repository as a source will:
962 Without this feature, "shares" using this repository as a source will:
934
963
935 * keep tracking the repository "requirements" in the share only, ignoring
964 * keep tracking the repository "requirements" in the share only, ignoring
936 the source "requirements", possibly diverging from them.
965 the source "requirements", possibly diverging from them.
937 * ignore source repository config. This can create problems, like silently
966 * ignore source repository config. This can create problems, like silently
938 ignoring important hooks.
967 ignoring important hooks.
939
968
940 Beware that existing shares will not be upgraded/downgraded, and by
969 Beware that existing shares will not be upgraded/downgraded, and by
941 default, Mercurial will refuse to interact with them until the mismatch
970 default, Mercurial will refuse to interact with them until the mismatch
942 is resolved. See :hg:`help config share.safe-mismatch.source-safe` and
971 is resolved. See :hg:`help config share.safe-mismatch.source-safe` and
943 :hg:`help config share.safe-mismatch.source-not-safe` for details.
972 :hg:`help config share.safe-mismatch.source-not-safe` for details.
944
973
945 Introduced in Mercurial 5.7.
974 Introduced in Mercurial 5.7.
946
975
947 Disabled by default.
976 Disabled by default.
948
977
949 ``usestore``
978 ``usestore``
950 Enable or disable the "store" repository format which improves
979 Enable or disable the "store" repository format which improves
951 compatibility with systems that fold case or otherwise mangle
980 compatibility with systems that fold case or otherwise mangle
952 filenames. Disabling this option will allow you to store longer filenames
981 filenames. Disabling this option will allow you to store longer filenames
953 in some situations at the expense of compatibility.
982 in some situations at the expense of compatibility.
954
983
955 Repositories with this on-disk format require Mercurial version 0.9.4.
984 Repositories with this on-disk format require Mercurial version 0.9.4.
956
985
957 Enabled by default.
986 Enabled by default.
958
987
959 ``sparse-revlog``
988 ``sparse-revlog``
960 Enable or disable the ``sparse-revlog`` delta strategy. This format improves
989 Enable or disable the ``sparse-revlog`` delta strategy. This format improves
961 delta re-use inside revlog. For very branchy repositories, it results in a
990 delta re-use inside revlog. For very branchy repositories, it results in a
962 smaller store. For repositories with many revisions, it also helps
991 smaller store. For repositories with many revisions, it also helps
963 performance (by using shortened delta chains.)
992 performance (by using shortened delta chains.)
964
993
965 Repositories with this on-disk format require Mercurial version 4.7
994 Repositories with this on-disk format require Mercurial version 4.7
966
995
967 Enabled by default.
996 Enabled by default.
968
997
969 ``revlog-compression``
998 ``revlog-compression``
970 Compression algorithm used by revlog. Supported values are `zlib` and
999 Compression algorithm used by revlog. Supported values are `zlib` and
971 `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is
1000 `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is
972 a newer format that is usually a net win over `zlib`, operating faster at
1001 a newer format that is usually a net win over `zlib`, operating faster at
973 better compression rates. Use `zstd` to reduce CPU usage. Multiple values
1002 better compression rates. Use `zstd` to reduce CPU usage. Multiple values
974 can be specified, the first available one will be used.
1003 can be specified, the first available one will be used.
975
1004
976 On some systems, the Mercurial installation may lack `zstd` support.
1005 On some systems, the Mercurial installation may lack `zstd` support.
977
1006
978 Default is `zstd` if available, `zlib` otherwise.
1007 Default is `zstd` if available, `zlib` otherwise.
979
1008
980 ``bookmarks-in-store``
1009 ``bookmarks-in-store``
981 Store bookmarks in .hg/store/. This means that bookmarks are shared when
1010 Store bookmarks in .hg/store/. This means that bookmarks are shared when
982 using `hg share` regardless of the `-B` option.
1011 using `hg share` regardless of the `-B` option.
983
1012
984 Repositories with this on-disk format require Mercurial version 5.1.
1013 Repositories with this on-disk format require Mercurial version 5.1.
985
1014
986 Disabled by default.
1015 Disabled by default.
987
1016
988
1017
989 ``graph``
1018 ``graph``
990 ---------
1019 ---------
991
1020
992 Web graph view configuration. This section let you change graph
1021 Web graph view configuration. This section let you change graph
993 elements display properties by branches, for instance to make the
1022 elements display properties by branches, for instance to make the
994 ``default`` branch stand out.
1023 ``default`` branch stand out.
995
1024
996 Each line has the following format::
1025 Each line has the following format::
997
1026
998 <branch>.<argument> = <value>
1027 <branch>.<argument> = <value>
999
1028
1000 where ``<branch>`` is the name of the branch being
1029 where ``<branch>`` is the name of the branch being
1001 customized. Example::
1030 customized. Example::
1002
1031
1003 [graph]
1032 [graph]
1004 # 2px width
1033 # 2px width
1005 default.width = 2
1034 default.width = 2
1006 # red color
1035 # red color
1007 default.color = FF0000
1036 default.color = FF0000
1008
1037
1009 Supported arguments:
1038 Supported arguments:
1010
1039
1011 ``width``
1040 ``width``
1012 Set branch edges width in pixels.
1041 Set branch edges width in pixels.
1013
1042
1014 ``color``
1043 ``color``
1015 Set branch edges color in hexadecimal RGB notation.
1044 Set branch edges color in hexadecimal RGB notation.
1016
1045
1017 ``hooks``
1046 ``hooks``
1018 ---------
1047 ---------
1019
1048
1020 Commands or Python functions that get automatically executed by
1049 Commands or Python functions that get automatically executed by
1021 various actions such as starting or finishing a commit. Multiple
1050 various actions such as starting or finishing a commit. Multiple
1022 hooks can be run for the same action by appending a suffix to the
1051 hooks can be run for the same action by appending a suffix to the
1023 action. Overriding a site-wide hook can be done by changing its
1052 action. Overriding a site-wide hook can be done by changing its
1024 value or setting it to an empty string. Hooks can be prioritized
1053 value or setting it to an empty string. Hooks can be prioritized
1025 by adding a prefix of ``priority.`` to the hook name on a new line
1054 by adding a prefix of ``priority.`` to the hook name on a new line
1026 and setting the priority. The default priority is 0.
1055 and setting the priority. The default priority is 0.
1027
1056
1028 Example ``.hg/hgrc``::
1057 Example ``.hg/hgrc``::
1029
1058
1030 [hooks]
1059 [hooks]
1031 # update working directory after adding changesets
1060 # update working directory after adding changesets
1032 changegroup.update = hg update
1061 changegroup.update = hg update
1033 # do not use the site-wide hook
1062 # do not use the site-wide hook
1034 incoming =
1063 incoming =
1035 incoming.email = /my/email/hook
1064 incoming.email = /my/email/hook
1036 incoming.autobuild = /my/build/hook
1065 incoming.autobuild = /my/build/hook
1037 # force autobuild hook to run before other incoming hooks
1066 # force autobuild hook to run before other incoming hooks
1038 priority.incoming.autobuild = 1
1067 priority.incoming.autobuild = 1
1039 ### control HGPLAIN setting when running autobuild hook
1068 ### control HGPLAIN setting when running autobuild hook
1040 # HGPLAIN always set (default from Mercurial 5.7)
1069 # HGPLAIN always set (default from Mercurial 5.7)
1041 incoming.autobuild:run-with-plain = yes
1070 incoming.autobuild:run-with-plain = yes
1042 # HGPLAIN never set
1071 # HGPLAIN never set
1043 incoming.autobuild:run-with-plain = no
1072 incoming.autobuild:run-with-plain = no
1044 # HGPLAIN inherited from environment (default before Mercurial 5.7)
1073 # HGPLAIN inherited from environment (default before Mercurial 5.7)
1045 incoming.autobuild:run-with-plain = auto
1074 incoming.autobuild:run-with-plain = auto
1046
1075
1047 Most hooks are run with environment variables set that give useful
1076 Most hooks are run with environment variables set that give useful
1048 additional information. For each hook below, the environment variables
1077 additional information. For each hook below, the environment variables
1049 it is passed are listed with names in the form ``$HG_foo``. The
1078 it is passed are listed with names in the form ``$HG_foo``. The
1050 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
1079 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
1051 They contain the type of hook which triggered the run and the full name
1080 They contain the type of hook which triggered the run and the full name
1052 of the hook in the config, respectively. In the example above, this will
1081 of the hook in the config, respectively. In the example above, this will
1053 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
1082 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
1054
1083
1055 .. container:: windows
1084 .. container:: windows
1056
1085
1057 Some basic Unix syntax can be enabled for portability, including ``$VAR``
1086 Some basic Unix syntax can be enabled for portability, including ``$VAR``
1058 and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will
1087 and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will
1059 be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
1088 be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
1060 on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back
1089 on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back
1061 slash or inside of a strong quote. Strong quotes will be replaced by
1090 slash or inside of a strong quote. Strong quotes will be replaced by
1062 double quotes after processing.
1091 double quotes after processing.
1063
1092
1064 This feature is enabled by adding a prefix of ``tonative.`` to the hook
1093 This feature is enabled by adding a prefix of ``tonative.`` to the hook
1065 name on a new line, and setting it to ``True``. For example::
1094 name on a new line, and setting it to ``True``. For example::
1066
1095
1067 [hooks]
1096 [hooks]
1068 incoming.autobuild = /my/build/hook
1097 incoming.autobuild = /my/build/hook
1069 # enable translation to cmd.exe syntax for autobuild hook
1098 # enable translation to cmd.exe syntax for autobuild hook
1070 tonative.incoming.autobuild = True
1099 tonative.incoming.autobuild = True
1071
1100
1072 ``changegroup``
1101 ``changegroup``
1073 Run after a changegroup has been added via push, pull or unbundle. The ID of
1102 Run after a changegroup has been added via push, pull or unbundle. The ID of
1074 the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
1103 the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
1075 The URL from which changes came is in ``$HG_URL``.
1104 The URL from which changes came is in ``$HG_URL``.
1076
1105
1077 ``commit``
1106 ``commit``
1078 Run after a changeset has been created in the local repository. The ID
1107 Run after a changeset has been created in the local repository. The ID
1079 of the newly created changeset is in ``$HG_NODE``. Parent changeset
1108 of the newly created changeset is in ``$HG_NODE``. Parent changeset
1080 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1109 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1081
1110
1082 ``incoming``
1111 ``incoming``
1083 Run after a changeset has been pulled, pushed, or unbundled into
1112 Run after a changeset has been pulled, pushed, or unbundled into
1084 the local repository. The ID of the newly arrived changeset is in
1113 the local repository. The ID of the newly arrived changeset is in
1085 ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
1114 ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
1086
1115
1087 ``outgoing``
1116 ``outgoing``
1088 Run after sending changes from the local repository to another. The ID of
1117 Run after sending changes from the local repository to another. The ID of
1089 first changeset sent is in ``$HG_NODE``. The source of operation is in
1118 first changeset sent is in ``$HG_NODE``. The source of operation is in
1090 ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
1119 ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
1091
1120
1092 ``post-<command>``
1121 ``post-<command>``
1093 Run after successful invocations of the associated command. The
1122 Run after successful invocations of the associated command. The
1094 contents of the command line are passed as ``$HG_ARGS`` and the result
1123 contents of the command line are passed as ``$HG_ARGS`` and the result
1095 code in ``$HG_RESULT``. Parsed command line arguments are passed as
1124 code in ``$HG_RESULT``. Parsed command line arguments are passed as
1096 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
1125 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
1097 the python data internally passed to <command>. ``$HG_OPTS`` is a
1126 the python data internally passed to <command>. ``$HG_OPTS`` is a
1098 dictionary of options (with unspecified options set to their defaults).
1127 dictionary of options (with unspecified options set to their defaults).
1099 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
1128 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
1100
1129
1101 ``fail-<command>``
1130 ``fail-<command>``
1102 Run after a failed invocation of an associated command. The contents
1131 Run after a failed invocation of an associated command. The contents
1103 of the command line are passed as ``$HG_ARGS``. Parsed command line
1132 of the command line are passed as ``$HG_ARGS``. Parsed command line
1104 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
1133 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
1105 string representations of the python data internally passed to
1134 string representations of the python data internally passed to
1106 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
1135 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
1107 options set to their defaults). ``$HG_PATS`` is a list of arguments.
1136 options set to their defaults). ``$HG_PATS`` is a list of arguments.
1108 Hook failure is ignored.
1137 Hook failure is ignored.
1109
1138
1110 ``pre-<command>``
1139 ``pre-<command>``
1111 Run before executing the associated command. The contents of the
1140 Run before executing the associated command. The contents of the
1112 command line are passed as ``$HG_ARGS``. Parsed command line arguments
1141 command line are passed as ``$HG_ARGS``. Parsed command line arguments
1113 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
1142 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
1114 representations of the data internally passed to <command>. ``$HG_OPTS``
1143 representations of the data internally passed to <command>. ``$HG_OPTS``
1115 is a dictionary of options (with unspecified options set to their
1144 is a dictionary of options (with unspecified options set to their
1116 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
1145 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
1117 failure, the command doesn't execute and Mercurial returns the failure
1146 failure, the command doesn't execute and Mercurial returns the failure
1118 code.
1147 code.
1119
1148
1120 ``prechangegroup``
1149 ``prechangegroup``
1121 Run before a changegroup is added via push, pull or unbundle. Exit
1150 Run before a changegroup is added via push, pull or unbundle. Exit
1122 status 0 allows the changegroup to proceed. A non-zero status will
1151 status 0 allows the changegroup to proceed. A non-zero status will
1123 cause the push, pull or unbundle to fail. The URL from which changes
1152 cause the push, pull or unbundle to fail. The URL from which changes
1124 will come is in ``$HG_URL``.
1153 will come is in ``$HG_URL``.
1125
1154
1126 ``precommit``
1155 ``precommit``
1127 Run before starting a local commit. Exit status 0 allows the
1156 Run before starting a local commit. Exit status 0 allows the
1128 commit to proceed. A non-zero status will cause the commit to fail.
1157 commit to proceed. A non-zero status will cause the commit to fail.
1129 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1158 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1130
1159
1131 ``prelistkeys``
1160 ``prelistkeys``
1132 Run before listing pushkeys (like bookmarks) in the
1161 Run before listing pushkeys (like bookmarks) in the
1133 repository. A non-zero status will cause failure. The key namespace is
1162 repository. A non-zero status will cause failure. The key namespace is
1134 in ``$HG_NAMESPACE``.
1163 in ``$HG_NAMESPACE``.
1135
1164
1136 ``preoutgoing``
1165 ``preoutgoing``
1137 Run before collecting changes to send from the local repository to
1166 Run before collecting changes to send from the local repository to
1138 another. A non-zero status will cause failure. This lets you prevent
1167 another. A non-zero status will cause failure. This lets you prevent
1139 pull over HTTP or SSH. It can also prevent propagating commits (via
1168 pull over HTTP or SSH. It can also prevent propagating commits (via
1140 local pull, push (outbound) or bundle commands), but not completely,
1169 local pull, push (outbound) or bundle commands), but not completely,
1141 since you can just copy files instead. The source of operation is in
1170 since you can just copy files instead. The source of operation is in
1142 ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
1171 ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
1143 SSH or HTTP repository. If "push", "pull" or "bundle", the operation
1172 SSH or HTTP repository. If "push", "pull" or "bundle", the operation
1144 is happening on behalf of a repository on same system.
1173 is happening on behalf of a repository on same system.
1145
1174
1146 ``prepushkey``
1175 ``prepushkey``
1147 Run before a pushkey (like a bookmark) is added to the
1176 Run before a pushkey (like a bookmark) is added to the
1148 repository. A non-zero status will cause the key to be rejected. The
1177 repository. A non-zero status will cause the key to be rejected. The
1149 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
1178 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
1150 the old value (if any) is in ``$HG_OLD``, and the new value is in
1179 the old value (if any) is in ``$HG_OLD``, and the new value is in
1151 ``$HG_NEW``.
1180 ``$HG_NEW``.
1152
1181
1153 ``pretag``
1182 ``pretag``
1154 Run before creating a tag. Exit status 0 allows the tag to be
1183 Run before creating a tag. Exit status 0 allows the tag to be
1155 created. A non-zero status will cause the tag to fail. The ID of the
1184 created. A non-zero status will cause the tag to fail. The ID of the
1156 changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
1185 changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
1157 tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
1186 tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
1158
1187
1159 ``pretxnopen``
1188 ``pretxnopen``
1160 Run before any new repository transaction is open. The reason for the
1189 Run before any new repository transaction is open. The reason for the
1161 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
1190 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
1162 transaction will be in ``$HG_TXNID``. A non-zero status will prevent the
1191 transaction will be in ``$HG_TXNID``. A non-zero status will prevent the
1163 transaction from being opened.
1192 transaction from being opened.
1164
1193
1165 ``pretxnclose``
1194 ``pretxnclose``
1166 Run right before the transaction is actually finalized. Any repository change
1195 Run right before the transaction is actually finalized. Any repository change
1167 will be visible to the hook program. This lets you validate the transaction
1196 will be visible to the hook program. This lets you validate the transaction
1168 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1197 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1169 status will cause the transaction to be rolled back. The reason for the
1198 status will cause the transaction to be rolled back. The reason for the
1170 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
1199 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
1171 the transaction will be in ``$HG_TXNID``. The rest of the available data will
1200 the transaction will be in ``$HG_TXNID``. The rest of the available data will
1172 vary according the transaction type. Changes unbundled to the repository will
1201 vary according the transaction type. Changes unbundled to the repository will
1173 add ``$HG_URL`` and ``$HG_SOURCE``. New changesets will add ``$HG_NODE`` (the
1202 add ``$HG_URL`` and ``$HG_SOURCE``. New changesets will add ``$HG_NODE`` (the
1174 ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last added
1203 ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last added
1175 changeset). Bookmark and phase changes will set ``$HG_BOOKMARK_MOVED`` and
1204 changeset). Bookmark and phase changes will set ``$HG_BOOKMARK_MOVED`` and
1176 ``$HG_PHASES_MOVED`` to ``1`` respectively. The number of new obsmarkers, if
1205 ``$HG_PHASES_MOVED`` to ``1`` respectively. The number of new obsmarkers, if
1177 any, will be in ``$HG_NEW_OBSMARKERS``, etc.
1206 any, will be in ``$HG_NEW_OBSMARKERS``, etc.
1178
1207
1179 ``pretxnclose-bookmark``
1208 ``pretxnclose-bookmark``
1180 Run right before a bookmark change is actually finalized. Any repository
1209 Run right before a bookmark change is actually finalized. Any repository
1181 change will be visible to the hook program. This lets you validate the
1210 change will be visible to the hook program. This lets you validate the
1182 transaction content or change it. Exit status 0 allows the commit to
1211 transaction content or change it. Exit status 0 allows the commit to
1183 proceed. A non-zero status will cause the transaction to be rolled back.
1212 proceed. A non-zero status will cause the transaction to be rolled back.
1184 The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
1213 The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
1185 bookmark location will be available in ``$HG_NODE`` while the previous
1214 bookmark location will be available in ``$HG_NODE`` while the previous
1186 location will be available in ``$HG_OLDNODE``. In case of a bookmark
1215 location will be available in ``$HG_OLDNODE``. In case of a bookmark
1187 creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
1216 creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
1188 will be empty.
1217 will be empty.
1189 In addition, the reason for the transaction opening will be in
1218 In addition, the reason for the transaction opening will be in
1190 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1219 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1191 ``$HG_TXNID``.
1220 ``$HG_TXNID``.
1192
1221
1193 ``pretxnclose-phase``
1222 ``pretxnclose-phase``
1194 Run right before a phase change is actually finalized. Any repository change
1223 Run right before a phase change is actually finalized. Any repository change
1195 will be visible to the hook program. This lets you validate the transaction
1224 will be visible to the hook program. This lets you validate the transaction
1196 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1225 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1197 status will cause the transaction to be rolled back. The hook is called
1226 status will cause the transaction to be rolled back. The hook is called
1198 multiple times, once for each revision affected by a phase change.
1227 multiple times, once for each revision affected by a phase change.
1199 The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
1228 The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
1200 while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
1229 while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
1201 will be empty. In addition, the reason for the transaction opening will be in
1230 will be empty. In addition, the reason for the transaction opening will be in
1202 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1231 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1203 ``$HG_TXNID``. The hook is also run for newly added revisions. In this case
1232 ``$HG_TXNID``. The hook is also run for newly added revisions. In this case
1204 the ``$HG_OLDPHASE`` entry will be empty.
1233 the ``$HG_OLDPHASE`` entry will be empty.
1205
1234
1206 ``txnclose``
1235 ``txnclose``
1207 Run after any repository transaction has been committed. At this
1236 Run after any repository transaction has been committed. At this
1208 point, the transaction can no longer be rolled back. The hook will run
1237 point, the transaction can no longer be rolled back. The hook will run
1209 after the lock is released. See :hg:`help config.hooks.pretxnclose` for
1238 after the lock is released. See :hg:`help config.hooks.pretxnclose` for
1210 details about available variables.
1239 details about available variables.
1211
1240
1212 ``txnclose-bookmark``
1241 ``txnclose-bookmark``
1213 Run after any bookmark change has been committed. At this point, the
1242 Run after any bookmark change has been committed. At this point, the
1214 transaction can no longer be rolled back. The hook will run after the lock
1243 transaction can no longer be rolled back. The hook will run after the lock
1215 is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
1244 is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
1216 about available variables.
1245 about available variables.
1217
1246
1218 ``txnclose-phase``
1247 ``txnclose-phase``
1219 Run after any phase change has been committed. At this point, the
1248 Run after any phase change has been committed. At this point, the
1220 transaction can no longer be rolled back. The hook will run after the lock
1249 transaction can no longer be rolled back. The hook will run after the lock
1221 is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
1250 is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
1222 available variables.
1251 available variables.
1223
1252
1224 ``txnabort``
1253 ``txnabort``
1225 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
1254 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
1226 for details about available variables.
1255 for details about available variables.
1227
1256
1228 ``pretxnchangegroup``
1257 ``pretxnchangegroup``
1229 Run after a changegroup has been added via push, pull or unbundle, but before
1258 Run after a changegroup has been added via push, pull or unbundle, but before
1230 the transaction has been committed. The changegroup is visible to the hook
1259 the transaction has been committed. The changegroup is visible to the hook
1231 program. This allows validation of incoming changes before accepting them.
1260 program. This allows validation of incoming changes before accepting them.
1232 The ID of the first new changeset is in ``$HG_NODE`` and last is in
1261 The ID of the first new changeset is in ``$HG_NODE`` and last is in
1233 ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
1262 ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
1234 status will cause the transaction to be rolled back, and the push, pull or
1263 status will cause the transaction to be rolled back, and the push, pull or
1235 unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
1264 unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
1236
1265
1237 ``pretxncommit``
1266 ``pretxncommit``
1238 Run after a changeset has been created, but before the transaction is
1267 Run after a changeset has been created, but before the transaction is
1239 committed. The changeset is visible to the hook program. This allows
1268 committed. The changeset is visible to the hook program. This allows
1240 validation of the commit message and changes. Exit status 0 allows the
1269 validation of the commit message and changes. Exit status 0 allows the
1241 commit to proceed. A non-zero status will cause the transaction to
1270 commit to proceed. A non-zero status will cause the transaction to
1242 be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
1271 be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
1243 changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1272 changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1244
1273
1245 ``preupdate``
1274 ``preupdate``
1246 Run before updating the working directory. Exit status 0 allows
1275 Run before updating the working directory. Exit status 0 allows
1247 the update to proceed. A non-zero status will prevent the update.
1276 the update to proceed. A non-zero status will prevent the update.
1248 The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
1277 The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
1249 merge, the ID of second new parent is in ``$HG_PARENT2``.
1278 merge, the ID of second new parent is in ``$HG_PARENT2``.
1250
1279
1251 ``listkeys``
1280 ``listkeys``
1252 Run after listing pushkeys (like bookmarks) in the repository. The
1281 Run after listing pushkeys (like bookmarks) in the repository. The
1253 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1282 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1254 dictionary containing the keys and values.
1283 dictionary containing the keys and values.
1255
1284
1256 ``pushkey``
1285 ``pushkey``
1257 Run after a pushkey (like a bookmark) is added to the
1286 Run after a pushkey (like a bookmark) is added to the
1258 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1287 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1259 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1288 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1260 value is in ``$HG_NEW``.
1289 value is in ``$HG_NEW``.
1261
1290
1262 ``tag``
1291 ``tag``
1263 Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
1292 Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
1264 The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
1293 The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
1265 the repository if ``$HG_LOCAL=0``.
1294 the repository if ``$HG_LOCAL=0``.
1266
1295
1267 ``update``
1296 ``update``
1268 Run after updating the working directory. The changeset ID of first
1297 Run after updating the working directory. The changeset ID of first
1269 new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
1298 new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
1270 parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1299 parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1271 update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
1300 update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
1272
1301
1273 .. note::
1302 .. note::
1274
1303
1275 It is generally better to use standard hooks rather than the
1304 It is generally better to use standard hooks rather than the
1276 generic pre- and post- command hooks, as they are guaranteed to be
1305 generic pre- and post- command hooks, as they are guaranteed to be
1277 called in the appropriate contexts for influencing transactions.
1306 called in the appropriate contexts for influencing transactions.
1278 Also, hooks like "commit" will be called in all contexts that
1307 Also, hooks like "commit" will be called in all contexts that
1279 generate a commit (e.g. tag) and not just the commit command.
1308 generate a commit (e.g. tag) and not just the commit command.
1280
1309
1281 .. note::
1310 .. note::
1282
1311
1283 Environment variables with empty values may not be passed to
1312 Environment variables with empty values may not be passed to
1284 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1313 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1285 will have an empty value under Unix-like platforms for non-merge
1314 will have an empty value under Unix-like platforms for non-merge
1286 changesets, while it will not be available at all under Windows.
1315 changesets, while it will not be available at all under Windows.
1287
1316
1288 The syntax for Python hooks is as follows::
1317 The syntax for Python hooks is as follows::
1289
1318
1290 hookname = python:modulename.submodule.callable
1319 hookname = python:modulename.submodule.callable
1291 hookname = python:/path/to/python/module.py:callable
1320 hookname = python:/path/to/python/module.py:callable
1292
1321
1293 Python hooks are run within the Mercurial process. Each hook is
1322 Python hooks are run within the Mercurial process. Each hook is
1294 called with at least three keyword arguments: a ui object (keyword
1323 called with at least three keyword arguments: a ui object (keyword
1295 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1324 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1296 keyword that tells what kind of hook is used. Arguments listed as
1325 keyword that tells what kind of hook is used. Arguments listed as
1297 environment variables above are passed as keyword arguments, with no
1326 environment variables above are passed as keyword arguments, with no
1298 ``HG_`` prefix, and names in lower case.
1327 ``HG_`` prefix, and names in lower case.
1299
1328
1300 If a Python hook returns a "true" value or raises an exception, this
1329 If a Python hook returns a "true" value or raises an exception, this
1301 is treated as a failure.
1330 is treated as a failure.
1302
1331
1303
1332
1304 ``hostfingerprints``
1333 ``hostfingerprints``
1305 --------------------
1334 --------------------
1306
1335
1307 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1336 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1308
1337
1309 Fingerprints of the certificates of known HTTPS servers.
1338 Fingerprints of the certificates of known HTTPS servers.
1310
1339
1311 A HTTPS connection to a server with a fingerprint configured here will
1340 A HTTPS connection to a server with a fingerprint configured here will
1312 only succeed if the servers certificate matches the fingerprint.
1341 only succeed if the servers certificate matches the fingerprint.
1313 This is very similar to how ssh known hosts works.
1342 This is very similar to how ssh known hosts works.
1314
1343
1315 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1344 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1316 Multiple values can be specified (separated by spaces or commas). This can
1345 Multiple values can be specified (separated by spaces or commas). This can
1317 be used to define both old and new fingerprints while a host transitions
1346 be used to define both old and new fingerprints while a host transitions
1318 to a new certificate.
1347 to a new certificate.
1319
1348
1320 The CA chain and web.cacerts is not used for servers with a fingerprint.
1349 The CA chain and web.cacerts is not used for servers with a fingerprint.
1321
1350
1322 For example::
1351 For example::
1323
1352
1324 [hostfingerprints]
1353 [hostfingerprints]
1325 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1354 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1326 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1355 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1327
1356
1328 ``hostsecurity``
1357 ``hostsecurity``
1329 ----------------
1358 ----------------
1330
1359
1331 Used to specify global and per-host security settings for connecting to
1360 Used to specify global and per-host security settings for connecting to
1332 other machines.
1361 other machines.
1333
1362
1334 The following options control default behavior for all hosts.
1363 The following options control default behavior for all hosts.
1335
1364
1336 ``ciphers``
1365 ``ciphers``
1337 Defines the cryptographic ciphers to use for connections.
1366 Defines the cryptographic ciphers to use for connections.
1338
1367
1339 Value must be a valid OpenSSL Cipher List Format as documented at
1368 Value must be a valid OpenSSL Cipher List Format as documented at
1340 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1369 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1341
1370
1342 This setting is for advanced users only. Setting to incorrect values
1371 This setting is for advanced users only. Setting to incorrect values
1343 can significantly lower connection security or decrease performance.
1372 can significantly lower connection security or decrease performance.
1344 You have been warned.
1373 You have been warned.
1345
1374
1346 This option requires Python 2.7.
1375 This option requires Python 2.7.
1347
1376
1348 ``minimumprotocol``
1377 ``minimumprotocol``
1349 Defines the minimum channel encryption protocol to use.
1378 Defines the minimum channel encryption protocol to use.
1350
1379
1351 By default, the highest version of TLS supported by both client and server
1380 By default, the highest version of TLS supported by both client and server
1352 is used.
1381 is used.
1353
1382
1354 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1383 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1355
1384
1356 When running on an old Python version, only ``tls1.0`` is allowed since
1385 When running on an old Python version, only ``tls1.0`` is allowed since
1357 old versions of Python only support up to TLS 1.0.
1386 old versions of Python only support up to TLS 1.0.
1358
1387
1359 When running a Python that supports modern TLS versions, the default is
1388 When running a Python that supports modern TLS versions, the default is
1360 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1389 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1361 weakens security and should only be used as a feature of last resort if
1390 weakens security and should only be used as a feature of last resort if
1362 a server does not support TLS 1.1+.
1391 a server does not support TLS 1.1+.
1363
1392
1364 Options in the ``[hostsecurity]`` section can have the form
1393 Options in the ``[hostsecurity]`` section can have the form
1365 ``hostname``:``setting``. This allows multiple settings to be defined on a
1394 ``hostname``:``setting``. This allows multiple settings to be defined on a
1366 per-host basis.
1395 per-host basis.
1367
1396
1368 The following per-host settings can be defined.
1397 The following per-host settings can be defined.
1369
1398
1370 ``ciphers``
1399 ``ciphers``
1371 This behaves like ``ciphers`` as described above except it only applies
1400 This behaves like ``ciphers`` as described above except it only applies
1372 to the host on which it is defined.
1401 to the host on which it is defined.
1373
1402
1374 ``fingerprints``
1403 ``fingerprints``
1375 A list of hashes of the DER encoded peer/remote certificate. Values have
1404 A list of hashes of the DER encoded peer/remote certificate. Values have
1376 the form ``algorithm``:``fingerprint``. e.g.
1405 the form ``algorithm``:``fingerprint``. e.g.
1377 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1406 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1378 In addition, colons (``:``) can appear in the fingerprint part.
1407 In addition, colons (``:``) can appear in the fingerprint part.
1379
1408
1380 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1409 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1381 ``sha512``.
1410 ``sha512``.
1382
1411
1383 Use of ``sha256`` or ``sha512`` is preferred.
1412 Use of ``sha256`` or ``sha512`` is preferred.
1384
1413
1385 If a fingerprint is specified, the CA chain is not validated for this
1414 If a fingerprint is specified, the CA chain is not validated for this
1386 host and Mercurial will require the remote certificate to match one
1415 host and Mercurial will require the remote certificate to match one
1387 of the fingerprints specified. This means if the server updates its
1416 of the fingerprints specified. This means if the server updates its
1388 certificate, Mercurial will abort until a new fingerprint is defined.
1417 certificate, Mercurial will abort until a new fingerprint is defined.
1389 This can provide stronger security than traditional CA-based validation
1418 This can provide stronger security than traditional CA-based validation
1390 at the expense of convenience.
1419 at the expense of convenience.
1391
1420
1392 This option takes precedence over ``verifycertsfile``.
1421 This option takes precedence over ``verifycertsfile``.
1393
1422
1394 ``minimumprotocol``
1423 ``minimumprotocol``
1395 This behaves like ``minimumprotocol`` as described above except it
1424 This behaves like ``minimumprotocol`` as described above except it
1396 only applies to the host on which it is defined.
1425 only applies to the host on which it is defined.
1397
1426
1398 ``verifycertsfile``
1427 ``verifycertsfile``
1399 Path to file a containing a list of PEM encoded certificates used to
1428 Path to file a containing a list of PEM encoded certificates used to
1400 verify the server certificate. Environment variables and ``~user``
1429 verify the server certificate. Environment variables and ``~user``
1401 constructs are expanded in the filename.
1430 constructs are expanded in the filename.
1402
1431
1403 The server certificate or the certificate's certificate authority (CA)
1432 The server certificate or the certificate's certificate authority (CA)
1404 must match a certificate from this file or certificate verification
1433 must match a certificate from this file or certificate verification
1405 will fail and connections to the server will be refused.
1434 will fail and connections to the server will be refused.
1406
1435
1407 If defined, only certificates provided by this file will be used:
1436 If defined, only certificates provided by this file will be used:
1408 ``web.cacerts`` and any system/default certificates will not be
1437 ``web.cacerts`` and any system/default certificates will not be
1409 used.
1438 used.
1410
1439
1411 This option has no effect if the per-host ``fingerprints`` option
1440 This option has no effect if the per-host ``fingerprints`` option
1412 is set.
1441 is set.
1413
1442
1414 The format of the file is as follows::
1443 The format of the file is as follows::
1415
1444
1416 -----BEGIN CERTIFICATE-----
1445 -----BEGIN CERTIFICATE-----
1417 ... (certificate in base64 PEM encoding) ...
1446 ... (certificate in base64 PEM encoding) ...
1418 -----END CERTIFICATE-----
1447 -----END CERTIFICATE-----
1419 -----BEGIN CERTIFICATE-----
1448 -----BEGIN CERTIFICATE-----
1420 ... (certificate in base64 PEM encoding) ...
1449 ... (certificate in base64 PEM encoding) ...
1421 -----END CERTIFICATE-----
1450 -----END CERTIFICATE-----
1422
1451
1423 For example::
1452 For example::
1424
1453
1425 [hostsecurity]
1454 [hostsecurity]
1426 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1455 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1427 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
1456 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
1428 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
1457 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
1429 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1458 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1430
1459
1431 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1460 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1432 when connecting to ``hg.example.com``::
1461 when connecting to ``hg.example.com``::
1433
1462
1434 [hostsecurity]
1463 [hostsecurity]
1435 minimumprotocol = tls1.2
1464 minimumprotocol = tls1.2
1436 hg.example.com:minimumprotocol = tls1.1
1465 hg.example.com:minimumprotocol = tls1.1
1437
1466
1438 ``http_proxy``
1467 ``http_proxy``
1439 --------------
1468 --------------
1440
1469
1441 Used to access web-based Mercurial repositories through a HTTP
1470 Used to access web-based Mercurial repositories through a HTTP
1442 proxy.
1471 proxy.
1443
1472
1444 ``host``
1473 ``host``
1445 Host name and (optional) port of the proxy server, for example
1474 Host name and (optional) port of the proxy server, for example
1446 "myproxy:8000".
1475 "myproxy:8000".
1447
1476
1448 ``no``
1477 ``no``
1449 Optional. Comma-separated list of host names that should bypass
1478 Optional. Comma-separated list of host names that should bypass
1450 the proxy.
1479 the proxy.
1451
1480
1452 ``passwd``
1481 ``passwd``
1453 Optional. Password to authenticate with at the proxy server.
1482 Optional. Password to authenticate with at the proxy server.
1454
1483
1455 ``user``
1484 ``user``
1456 Optional. User name to authenticate with at the proxy server.
1485 Optional. User name to authenticate with at the proxy server.
1457
1486
1458 ``always``
1487 ``always``
1459 Optional. Always use the proxy, even for localhost and any entries
1488 Optional. Always use the proxy, even for localhost and any entries
1460 in ``http_proxy.no``. (default: False)
1489 in ``http_proxy.no``. (default: False)
1461
1490
1462 ``http``
1491 ``http``
1463 ----------
1492 ----------
1464
1493
1465 Used to configure access to Mercurial repositories via HTTP.
1494 Used to configure access to Mercurial repositories via HTTP.
1466
1495
1467 ``timeout``
1496 ``timeout``
1468 If set, blocking operations will timeout after that many seconds.
1497 If set, blocking operations will timeout after that many seconds.
1469 (default: None)
1498 (default: None)
1470
1499
1471 ``merge``
1500 ``merge``
1472 ---------
1501 ---------
1473
1502
1474 This section specifies behavior during merges and updates.
1503 This section specifies behavior during merges and updates.
1475
1504
1476 ``checkignored``
1505 ``checkignored``
1477 Controls behavior when an ignored file on disk has the same name as a tracked
1506 Controls behavior when an ignored file on disk has the same name as a tracked
1478 file in the changeset being merged or updated to, and has different
1507 file in the changeset being merged or updated to, and has different
1479 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1508 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1480 abort on such files. With ``warn``, warn on such files and back them up as
1509 abort on such files. With ``warn``, warn on such files and back them up as
1481 ``.orig``. With ``ignore``, don't print a warning and back them up as
1510 ``.orig``. With ``ignore``, don't print a warning and back them up as
1482 ``.orig``. (default: ``abort``)
1511 ``.orig``. (default: ``abort``)
1483
1512
1484 ``checkunknown``
1513 ``checkunknown``
1485 Controls behavior when an unknown file that isn't ignored has the same name
1514 Controls behavior when an unknown file that isn't ignored has the same name
1486 as a tracked file in the changeset being merged or updated to, and has
1515 as a tracked file in the changeset being merged or updated to, and has
1487 different contents. Similar to ``merge.checkignored``, except for files that
1516 different contents. Similar to ``merge.checkignored``, except for files that
1488 are not ignored. (default: ``abort``)
1517 are not ignored. (default: ``abort``)
1489
1518
1490 ``on-failure``
1519 ``on-failure``
1491 When set to ``continue`` (the default), the merge process attempts to
1520 When set to ``continue`` (the default), the merge process attempts to
1492 merge all unresolved files using the merge chosen tool, regardless of
1521 merge all unresolved files using the merge chosen tool, regardless of
1493 whether previous file merge attempts during the process succeeded or not.
1522 whether previous file merge attempts during the process succeeded or not.
1494 Setting this to ``prompt`` will prompt after any merge failure continue
1523 Setting this to ``prompt`` will prompt after any merge failure continue
1495 or halt the merge process. Setting this to ``halt`` will automatically
1524 or halt the merge process. Setting this to ``halt`` will automatically
1496 halt the merge process on any merge tool failure. The merge process
1525 halt the merge process on any merge tool failure. The merge process
1497 can be restarted by using the ``resolve`` command. When a merge is
1526 can be restarted by using the ``resolve`` command. When a merge is
1498 halted, the repository is left in a normal ``unresolved`` merge state.
1527 halted, the repository is left in a normal ``unresolved`` merge state.
1499 (default: ``continue``)
1528 (default: ``continue``)
1500
1529
1501 ``strict-capability-check``
1530 ``strict-capability-check``
1502 Whether capabilities of internal merge tools are checked strictly
1531 Whether capabilities of internal merge tools are checked strictly
1503 or not, while examining rules to decide merge tool to be used.
1532 or not, while examining rules to decide merge tool to be used.
1504 (default: False)
1533 (default: False)
1505
1534
1506 ``merge-patterns``
1535 ``merge-patterns``
1507 ------------------
1536 ------------------
1508
1537
1509 This section specifies merge tools to associate with particular file
1538 This section specifies merge tools to associate with particular file
1510 patterns. Tools matched here will take precedence over the default
1539 patterns. Tools matched here will take precedence over the default
1511 merge tool. Patterns are globs by default, rooted at the repository
1540 merge tool. Patterns are globs by default, rooted at the repository
1512 root.
1541 root.
1513
1542
1514 Example::
1543 Example::
1515
1544
1516 [merge-patterns]
1545 [merge-patterns]
1517 **.c = kdiff3
1546 **.c = kdiff3
1518 **.jpg = myimgmerge
1547 **.jpg = myimgmerge
1519
1548
1520 ``merge-tools``
1549 ``merge-tools``
1521 ---------------
1550 ---------------
1522
1551
1523 This section configures external merge tools to use for file-level
1552 This section configures external merge tools to use for file-level
1524 merges. This section has likely been preconfigured at install time.
1553 merges. This section has likely been preconfigured at install time.
1525 Use :hg:`config merge-tools` to check the existing configuration.
1554 Use :hg:`config merge-tools` to check the existing configuration.
1526 Also see :hg:`help merge-tools` for more details.
1555 Also see :hg:`help merge-tools` for more details.
1527
1556
1528 Example ``~/.hgrc``::
1557 Example ``~/.hgrc``::
1529
1558
1530 [merge-tools]
1559 [merge-tools]
1531 # Override stock tool location
1560 # Override stock tool location
1532 kdiff3.executable = ~/bin/kdiff3
1561 kdiff3.executable = ~/bin/kdiff3
1533 # Specify command line
1562 # Specify command line
1534 kdiff3.args = $base $local $other -o $output
1563 kdiff3.args = $base $local $other -o $output
1535 # Give higher priority
1564 # Give higher priority
1536 kdiff3.priority = 1
1565 kdiff3.priority = 1
1537
1566
1538 # Changing the priority of preconfigured tool
1567 # Changing the priority of preconfigured tool
1539 meld.priority = 0
1568 meld.priority = 0
1540
1569
1541 # Disable a preconfigured tool
1570 # Disable a preconfigured tool
1542 vimdiff.disabled = yes
1571 vimdiff.disabled = yes
1543
1572
1544 # Define new tool
1573 # Define new tool
1545 myHtmlTool.args = -m $local $other $base $output
1574 myHtmlTool.args = -m $local $other $base $output
1546 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1575 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1547 myHtmlTool.priority = 1
1576 myHtmlTool.priority = 1
1548
1577
1549 Supported arguments:
1578 Supported arguments:
1550
1579
1551 ``priority``
1580 ``priority``
1552 The priority in which to evaluate this tool.
1581 The priority in which to evaluate this tool.
1553 (default: 0)
1582 (default: 0)
1554
1583
1555 ``executable``
1584 ``executable``
1556 Either just the name of the executable or its pathname.
1585 Either just the name of the executable or its pathname.
1557
1586
1558 .. container:: windows
1587 .. container:: windows
1559
1588
1560 On Windows, the path can use environment variables with ${ProgramFiles}
1589 On Windows, the path can use environment variables with ${ProgramFiles}
1561 syntax.
1590 syntax.
1562
1591
1563 (default: the tool name)
1592 (default: the tool name)
1564
1593
1565 ``args``
1594 ``args``
1566 The arguments to pass to the tool executable. You can refer to the
1595 The arguments to pass to the tool executable. You can refer to the
1567 files being merged as well as the output file through these
1596 files being merged as well as the output file through these
1568 variables: ``$base``, ``$local``, ``$other``, ``$output``.
1597 variables: ``$base``, ``$local``, ``$other``, ``$output``.
1569
1598
1570 The meaning of ``$local`` and ``$other`` can vary depending on which action is
1599 The meaning of ``$local`` and ``$other`` can vary depending on which action is
1571 being performed. During an update or merge, ``$local`` represents the original
1600 being performed. During an update or merge, ``$local`` represents the original
1572 state of the file, while ``$other`` represents the commit you are updating to or
1601 state of the file, while ``$other`` represents the commit you are updating to or
1573 the commit you are merging with. During a rebase, ``$local`` represents the
1602 the commit you are merging with. During a rebase, ``$local`` represents the
1574 destination of the rebase, and ``$other`` represents the commit being rebased.
1603 destination of the rebase, and ``$other`` represents the commit being rebased.
1575
1604
1576 Some operations define custom labels to assist with identifying the revisions,
1605 Some operations define custom labels to assist with identifying the revisions,
1577 accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
1606 accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
1578 labels are not available, these will be ``local``, ``other``, and ``base``,
1607 labels are not available, these will be ``local``, ``other``, and ``base``,
1579 respectively.
1608 respectively.
1580 (default: ``$local $base $other``)
1609 (default: ``$local $base $other``)
1581
1610
1582 ``premerge``
1611 ``premerge``
1583 Attempt to run internal non-interactive 3-way merge tool before
1612 Attempt to run internal non-interactive 3-way merge tool before
1584 launching external tool. Options are ``true``, ``false``, ``keep``,
1613 launching external tool. Options are ``true``, ``false``, ``keep``,
1585 ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option
1614 ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option
1586 will leave markers in the file if the premerge fails. The ``keep-merge3``
1615 will leave markers in the file if the premerge fails. The ``keep-merge3``
1587 will do the same but include information about the base of the merge in the
1616 will do the same but include information about the base of the merge in the
1588 marker (see internal :merge3 in :hg:`help merge-tools`). The
1617 marker (see internal :merge3 in :hg:`help merge-tools`). The
1589 ``keep-mergediff`` option is similar but uses a different marker style
1618 ``keep-mergediff`` option is similar but uses a different marker style
1590 (see internal :merge3 in :hg:`help merge-tools`). (default: True)
1619 (see internal :merge3 in :hg:`help merge-tools`). (default: True)
1591
1620
1592 ``binary``
1621 ``binary``
1593 This tool can merge binary files. (default: False, unless tool
1622 This tool can merge binary files. (default: False, unless tool
1594 was selected by file pattern match)
1623 was selected by file pattern match)
1595
1624
1596 ``symlink``
1625 ``symlink``
1597 This tool can merge symlinks. (default: False)
1626 This tool can merge symlinks. (default: False)
1598
1627
1599 ``check``
1628 ``check``
1600 A list of merge success-checking options:
1629 A list of merge success-checking options:
1601
1630
1602 ``changed``
1631 ``changed``
1603 Ask whether merge was successful when the merged file shows no changes.
1632 Ask whether merge was successful when the merged file shows no changes.
1604 ``conflicts``
1633 ``conflicts``
1605 Check whether there are conflicts even though the tool reported success.
1634 Check whether there are conflicts even though the tool reported success.
1606 ``prompt``
1635 ``prompt``
1607 Always prompt for merge success, regardless of success reported by tool.
1636 Always prompt for merge success, regardless of success reported by tool.
1608
1637
1609 ``fixeol``
1638 ``fixeol``
1610 Attempt to fix up EOL changes caused by the merge tool.
1639 Attempt to fix up EOL changes caused by the merge tool.
1611 (default: False)
1640 (default: False)
1612
1641
1613 ``gui``
1642 ``gui``
1614 This tool requires a graphical interface to run. (default: False)
1643 This tool requires a graphical interface to run. (default: False)
1615
1644
1616 ``mergemarkers``
1645 ``mergemarkers``
1617 Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
1646 Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
1618 ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
1647 ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
1619 ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
1648 ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
1620 markers generated during premerge will be ``detailed`` if either this option or
1649 markers generated during premerge will be ``detailed`` if either this option or
1621 the corresponding option in the ``[ui]`` section is ``detailed``.
1650 the corresponding option in the ``[ui]`` section is ``detailed``.
1622 (default: ``basic``)
1651 (default: ``basic``)
1623
1652
1624 ``mergemarkertemplate``
1653 ``mergemarkertemplate``
1625 This setting can be used to override ``mergemarker`` from the
1654 This setting can be used to override ``mergemarker`` from the
1626 ``[command-templates]`` section on a per-tool basis; this applies to the
1655 ``[command-templates]`` section on a per-tool basis; this applies to the
1627 ``$label``-prefixed variables and to the conflict markers that are generated
1656 ``$label``-prefixed variables and to the conflict markers that are generated
1628 if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable
1657 if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable
1629 in ``[ui]`` for more information.
1658 in ``[ui]`` for more information.
1630
1659
1631 .. container:: windows
1660 .. container:: windows
1632
1661
1633 ``regkey``
1662 ``regkey``
1634 Windows registry key which describes install location of this
1663 Windows registry key which describes install location of this
1635 tool. Mercurial will search for this key first under
1664 tool. Mercurial will search for this key first under
1636 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1665 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1637 (default: None)
1666 (default: None)
1638
1667
1639 ``regkeyalt``
1668 ``regkeyalt``
1640 An alternate Windows registry key to try if the first key is not
1669 An alternate Windows registry key to try if the first key is not
1641 found. The alternate key uses the same ``regname`` and ``regappend``
1670 found. The alternate key uses the same ``regname`` and ``regappend``
1642 semantics of the primary key. The most common use for this key
1671 semantics of the primary key. The most common use for this key
1643 is to search for 32bit applications on 64bit operating systems.
1672 is to search for 32bit applications on 64bit operating systems.
1644 (default: None)
1673 (default: None)
1645
1674
1646 ``regname``
1675 ``regname``
1647 Name of value to read from specified registry key.
1676 Name of value to read from specified registry key.
1648 (default: the unnamed (default) value)
1677 (default: the unnamed (default) value)
1649
1678
1650 ``regappend``
1679 ``regappend``
1651 String to append to the value read from the registry, typically
1680 String to append to the value read from the registry, typically
1652 the executable name of the tool.
1681 the executable name of the tool.
1653 (default: None)
1682 (default: None)
1654
1683
1655 ``pager``
1684 ``pager``
1656 ---------
1685 ---------
1657
1686
1658 Setting used to control when to paginate and with what external tool. See
1687 Setting used to control when to paginate and with what external tool. See
1659 :hg:`help pager` for details.
1688 :hg:`help pager` for details.
1660
1689
1661 ``pager``
1690 ``pager``
1662 Define the external tool used as pager.
1691 Define the external tool used as pager.
1663
1692
1664 If no pager is set, Mercurial uses the environment variable $PAGER.
1693 If no pager is set, Mercurial uses the environment variable $PAGER.
1665 If neither pager.pager, nor $PAGER is set, a default pager will be
1694 If neither pager.pager, nor $PAGER is set, a default pager will be
1666 used, typically `less` on Unix and `more` on Windows. Example::
1695 used, typically `less` on Unix and `more` on Windows. Example::
1667
1696
1668 [pager]
1697 [pager]
1669 pager = less -FRX
1698 pager = less -FRX
1670
1699
1671 ``ignore``
1700 ``ignore``
1672 List of commands to disable the pager for. Example::
1701 List of commands to disable the pager for. Example::
1673
1702
1674 [pager]
1703 [pager]
1675 ignore = version, help, update
1704 ignore = version, help, update
1676
1705
1677 ``patch``
1706 ``patch``
1678 ---------
1707 ---------
1679
1708
1680 Settings used when applying patches, for instance through the 'import'
1709 Settings used when applying patches, for instance through the 'import'
1681 command or with Mercurial Queues extension.
1710 command or with Mercurial Queues extension.
1682
1711
1683 ``eol``
1712 ``eol``
1684 When set to 'strict' patch content and patched files end of lines
1713 When set to 'strict' patch content and patched files end of lines
1685 are preserved. When set to ``lf`` or ``crlf``, both files end of
1714 are preserved. When set to ``lf`` or ``crlf``, both files end of
1686 lines are ignored when patching and the result line endings are
1715 lines are ignored when patching and the result line endings are
1687 normalized to either LF (Unix) or CRLF (Windows). When set to
1716 normalized to either LF (Unix) or CRLF (Windows). When set to
1688 ``auto``, end of lines are again ignored while patching but line
1717 ``auto``, end of lines are again ignored while patching but line
1689 endings in patched files are normalized to their original setting
1718 endings in patched files are normalized to their original setting
1690 on a per-file basis. If target file does not exist or has no end
1719 on a per-file basis. If target file does not exist or has no end
1691 of line, patch line endings are preserved.
1720 of line, patch line endings are preserved.
1692 (default: strict)
1721 (default: strict)
1693
1722
1694 ``fuzz``
1723 ``fuzz``
1695 The number of lines of 'fuzz' to allow when applying patches. This
1724 The number of lines of 'fuzz' to allow when applying patches. This
1696 controls how much context the patcher is allowed to ignore when
1725 controls how much context the patcher is allowed to ignore when
1697 trying to apply a patch.
1726 trying to apply a patch.
1698 (default: 2)
1727 (default: 2)
1699
1728
1700 ``paths``
1729 ``paths``
1701 ---------
1730 ---------
1702
1731
1703 Assigns symbolic names and behavior to repositories.
1732 Assigns symbolic names and behavior to repositories.
1704
1733
1705 Options are symbolic names defining the URL or directory that is the
1734 Options are symbolic names defining the URL or directory that is the
1706 location of the repository. Example::
1735 location of the repository. Example::
1707
1736
1708 [paths]
1737 [paths]
1709 my_server = https://example.com/my_repo
1738 my_server = https://example.com/my_repo
1710 local_path = /home/me/repo
1739 local_path = /home/me/repo
1711
1740
1712 These symbolic names can be used from the command line. To pull
1741 These symbolic names can be used from the command line. To pull
1713 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1742 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1714 :hg:`push local_path`. You can check :hg:`help urls` for details about
1743 :hg:`push local_path`. You can check :hg:`help urls` for details about
1715 valid URLs.
1744 valid URLs.
1716
1745
1717 Options containing colons (``:``) denote sub-options that can influence
1746 Options containing colons (``:``) denote sub-options that can influence
1718 behavior for that specific path. Example::
1747 behavior for that specific path. Example::
1719
1748
1720 [paths]
1749 [paths]
1721 my_server = https://example.com/my_path
1750 my_server = https://example.com/my_path
1722 my_server:pushurl = ssh://example.com/my_path
1751 my_server:pushurl = ssh://example.com/my_path
1723
1752
1724 Paths using the `path://otherpath` scheme will inherit the sub-options value from
1753 Paths using the `path://otherpath` scheme will inherit the sub-options value from
1725 the path they point to.
1754 the path they point to.
1726
1755
1727 The following sub-options can be defined:
1756 The following sub-options can be defined:
1728
1757
1729 ``multi-urls``
1758 ``multi-urls``
1730 A boolean option. When enabled the value of the `[paths]` entry will be
1759 A boolean option. When enabled the value of the `[paths]` entry will be
1731 parsed as a list and the alias will resolve to multiple destination. If some
1760 parsed as a list and the alias will resolve to multiple destination. If some
1732 of the list entry use the `path://` syntax, the suboption will be inherited
1761 of the list entry use the `path://` syntax, the suboption will be inherited
1733 individually.
1762 individually.
1734
1763
1735 ``pushurl``
1764 ``pushurl``
1736 The URL to use for push operations. If not defined, the location
1765 The URL to use for push operations. If not defined, the location
1737 defined by the path's main entry is used.
1766 defined by the path's main entry is used.
1738
1767
1739 ``pushrev``
1768 ``pushrev``
1740 A revset defining which revisions to push by default.
1769 A revset defining which revisions to push by default.
1741
1770
1742 When :hg:`push` is executed without a ``-r`` argument, the revset
1771 When :hg:`push` is executed without a ``-r`` argument, the revset
1743 defined by this sub-option is evaluated to determine what to push.
1772 defined by this sub-option is evaluated to determine what to push.
1744
1773
1745 For example, a value of ``.`` will push the working directory's
1774 For example, a value of ``.`` will push the working directory's
1746 revision by default.
1775 revision by default.
1747
1776
1748 Revsets specifying bookmarks will not result in the bookmark being
1777 Revsets specifying bookmarks will not result in the bookmark being
1749 pushed.
1778 pushed.
1750
1779
1751 ``bookmarks.mode``
1780 ``bookmarks.mode``
1752 How bookmark will be dealt during the exchange. It support the following value
1781 How bookmark will be dealt during the exchange. It support the following value
1753
1782
1754 - ``default``: the default behavior, local and remote bookmarks are "merged"
1783 - ``default``: the default behavior, local and remote bookmarks are "merged"
1755 on push/pull.
1784 on push/pull.
1756
1785
1757 - ``mirror``: when pulling, replace local bookmarks by remote bookmarks. This
1786 - ``mirror``: when pulling, replace local bookmarks by remote bookmarks. This
1758 is useful to replicate a repository, or as an optimization.
1787 is useful to replicate a repository, or as an optimization.
1759
1788
1760 - ``ignore``: ignore bookmarks during exchange.
1789 - ``ignore``: ignore bookmarks during exchange.
1761 (This currently only affect pulling)
1790 (This currently only affect pulling)
1762
1791
1763 The following special named paths exist:
1792 The following special named paths exist:
1764
1793
1765 ``default``
1794 ``default``
1766 The URL or directory to use when no source or remote is specified.
1795 The URL or directory to use when no source or remote is specified.
1767
1796
1768 :hg:`clone` will automatically define this path to the location the
1797 :hg:`clone` will automatically define this path to the location the
1769 repository was cloned from.
1798 repository was cloned from.
1770
1799
1771 ``default-push``
1800 ``default-push``
1772 (deprecated) The URL or directory for the default :hg:`push` location.
1801 (deprecated) The URL or directory for the default :hg:`push` location.
1773 ``default:pushurl`` should be used instead.
1802 ``default:pushurl`` should be used instead.
1774
1803
1775 ``phases``
1804 ``phases``
1776 ----------
1805 ----------
1777
1806
1778 Specifies default handling of phases. See :hg:`help phases` for more
1807 Specifies default handling of phases. See :hg:`help phases` for more
1779 information about working with phases.
1808 information about working with phases.
1780
1809
1781 ``publish``
1810 ``publish``
1782 Controls draft phase behavior when working as a server. When true,
1811 Controls draft phase behavior when working as a server. When true,
1783 pushed changesets are set to public in both client and server and
1812 pushed changesets are set to public in both client and server and
1784 pulled or cloned changesets are set to public in the client.
1813 pulled or cloned changesets are set to public in the client.
1785 (default: True)
1814 (default: True)
1786
1815
1787 ``new-commit``
1816 ``new-commit``
1788 Phase of newly-created commits.
1817 Phase of newly-created commits.
1789 (default: draft)
1818 (default: draft)
1790
1819
1791 ``checksubrepos``
1820 ``checksubrepos``
1792 Check the phase of the current revision of each subrepository. Allowed
1821 Check the phase of the current revision of each subrepository. Allowed
1793 values are "ignore", "follow" and "abort". For settings other than
1822 values are "ignore", "follow" and "abort". For settings other than
1794 "ignore", the phase of the current revision of each subrepository is
1823 "ignore", the phase of the current revision of each subrepository is
1795 checked before committing the parent repository. If any of those phases is
1824 checked before committing the parent repository. If any of those phases is
1796 greater than the phase of the parent repository (e.g. if a subrepo is in a
1825 greater than the phase of the parent repository (e.g. if a subrepo is in a
1797 "secret" phase while the parent repo is in "draft" phase), the commit is
1826 "secret" phase while the parent repo is in "draft" phase), the commit is
1798 either aborted (if checksubrepos is set to "abort") or the higher phase is
1827 either aborted (if checksubrepos is set to "abort") or the higher phase is
1799 used for the parent repository commit (if set to "follow").
1828 used for the parent repository commit (if set to "follow").
1800 (default: follow)
1829 (default: follow)
1801
1830
1802
1831
1803 ``profiling``
1832 ``profiling``
1804 -------------
1833 -------------
1805
1834
1806 Specifies profiling type, format, and file output. Two profilers are
1835 Specifies profiling type, format, and file output. Two profilers are
1807 supported: an instrumenting profiler (named ``ls``), and a sampling
1836 supported: an instrumenting profiler (named ``ls``), and a sampling
1808 profiler (named ``stat``).
1837 profiler (named ``stat``).
1809
1838
1810 In this section description, 'profiling data' stands for the raw data
1839 In this section description, 'profiling data' stands for the raw data
1811 collected during profiling, while 'profiling report' stands for a
1840 collected during profiling, while 'profiling report' stands for a
1812 statistical text report generated from the profiling data.
1841 statistical text report generated from the profiling data.
1813
1842
1814 ``enabled``
1843 ``enabled``
1815 Enable the profiler.
1844 Enable the profiler.
1816 (default: false)
1845 (default: false)
1817
1846
1818 This is equivalent to passing ``--profile`` on the command line.
1847 This is equivalent to passing ``--profile`` on the command line.
1819
1848
1820 ``type``
1849 ``type``
1821 The type of profiler to use.
1850 The type of profiler to use.
1822 (default: stat)
1851 (default: stat)
1823
1852
1824 ``ls``
1853 ``ls``
1825 Use Python's built-in instrumenting profiler. This profiler
1854 Use Python's built-in instrumenting profiler. This profiler
1826 works on all platforms, but each line number it reports is the
1855 works on all platforms, but each line number it reports is the
1827 first line of a function. This restriction makes it difficult to
1856 first line of a function. This restriction makes it difficult to
1828 identify the expensive parts of a non-trivial function.
1857 identify the expensive parts of a non-trivial function.
1829 ``stat``
1858 ``stat``
1830 Use a statistical profiler, statprof. This profiler is most
1859 Use a statistical profiler, statprof. This profiler is most
1831 useful for profiling commands that run for longer than about 0.1
1860 useful for profiling commands that run for longer than about 0.1
1832 seconds.
1861 seconds.
1833
1862
1834 ``format``
1863 ``format``
1835 Profiling format. Specific to the ``ls`` instrumenting profiler.
1864 Profiling format. Specific to the ``ls`` instrumenting profiler.
1836 (default: text)
1865 (default: text)
1837
1866
1838 ``text``
1867 ``text``
1839 Generate a profiling report. When saving to a file, it should be
1868 Generate a profiling report. When saving to a file, it should be
1840 noted that only the report is saved, and the profiling data is
1869 noted that only the report is saved, and the profiling data is
1841 not kept.
1870 not kept.
1842 ``kcachegrind``
1871 ``kcachegrind``
1843 Format profiling data for kcachegrind use: when saving to a
1872 Format profiling data for kcachegrind use: when saving to a
1844 file, the generated file can directly be loaded into
1873 file, the generated file can directly be loaded into
1845 kcachegrind.
1874 kcachegrind.
1846
1875
1847 ``statformat``
1876 ``statformat``
1848 Profiling format for the ``stat`` profiler.
1877 Profiling format for the ``stat`` profiler.
1849 (default: hotpath)
1878 (default: hotpath)
1850
1879
1851 ``hotpath``
1880 ``hotpath``
1852 Show a tree-based display containing the hot path of execution (where
1881 Show a tree-based display containing the hot path of execution (where
1853 most time was spent).
1882 most time was spent).
1854 ``bymethod``
1883 ``bymethod``
1855 Show a table of methods ordered by how frequently they are active.
1884 Show a table of methods ordered by how frequently they are active.
1856 ``byline``
1885 ``byline``
1857 Show a table of lines in files ordered by how frequently they are active.
1886 Show a table of lines in files ordered by how frequently they are active.
1858 ``json``
1887 ``json``
1859 Render profiling data as JSON.
1888 Render profiling data as JSON.
1860
1889
1861 ``freq``
1890 ``freq``
1862 Sampling frequency. Specific to the ``stat`` sampling profiler.
1891 Sampling frequency. Specific to the ``stat`` sampling profiler.
1863 (default: 1000)
1892 (default: 1000)
1864
1893
1865 ``output``
1894 ``output``
1866 File path where profiling data or report should be saved. If the
1895 File path where profiling data or report should be saved. If the
1867 file exists, it is replaced. (default: None, data is printed on
1896 file exists, it is replaced. (default: None, data is printed on
1868 stderr)
1897 stderr)
1869
1898
1870 ``sort``
1899 ``sort``
1871 Sort field. Specific to the ``ls`` instrumenting profiler.
1900 Sort field. Specific to the ``ls`` instrumenting profiler.
1872 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1901 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1873 ``inlinetime``.
1902 ``inlinetime``.
1874 (default: inlinetime)
1903 (default: inlinetime)
1875
1904
1876 ``time-track``
1905 ``time-track``
1877 Control if the stat profiler track ``cpu`` or ``real`` time.
1906 Control if the stat profiler track ``cpu`` or ``real`` time.
1878 (default: ``cpu`` on Windows, otherwise ``real``)
1907 (default: ``cpu`` on Windows, otherwise ``real``)
1879
1908
1880 ``limit``
1909 ``limit``
1881 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1910 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1882 (default: 30)
1911 (default: 30)
1883
1912
1884 ``nested``
1913 ``nested``
1885 Show at most this number of lines of drill-down info after each main entry.
1914 Show at most this number of lines of drill-down info after each main entry.
1886 This can help explain the difference between Total and Inline.
1915 This can help explain the difference between Total and Inline.
1887 Specific to the ``ls`` instrumenting profiler.
1916 Specific to the ``ls`` instrumenting profiler.
1888 (default: 0)
1917 (default: 0)
1889
1918
1890 ``showmin``
1919 ``showmin``
1891 Minimum fraction of samples an entry must have for it to be displayed.
1920 Minimum fraction of samples an entry must have for it to be displayed.
1892 Can be specified as a float between ``0.0`` and ``1.0`` or can have a
1921 Can be specified as a float between ``0.0`` and ``1.0`` or can have a
1893 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
1922 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
1894
1923
1895 Only used by the ``stat`` profiler.
1924 Only used by the ``stat`` profiler.
1896
1925
1897 For the ``hotpath`` format, default is ``0.05``.
1926 For the ``hotpath`` format, default is ``0.05``.
1898 For the ``chrome`` format, default is ``0.005``.
1927 For the ``chrome`` format, default is ``0.005``.
1899
1928
1900 The option is unused on other formats.
1929 The option is unused on other formats.
1901
1930
1902 ``showmax``
1931 ``showmax``
1903 Maximum fraction of samples an entry can have before it is ignored in
1932 Maximum fraction of samples an entry can have before it is ignored in
1904 display. Values format is the same as ``showmin``.
1933 display. Values format is the same as ``showmin``.
1905
1934
1906 Only used by the ``stat`` profiler.
1935 Only used by the ``stat`` profiler.
1907
1936
1908 For the ``chrome`` format, default is ``0.999``.
1937 For the ``chrome`` format, default is ``0.999``.
1909
1938
1910 The option is unused on other formats.
1939 The option is unused on other formats.
1911
1940
1912 ``showtime``
1941 ``showtime``
1913 Show time taken as absolute durations, in addition to percentages.
1942 Show time taken as absolute durations, in addition to percentages.
1914 Only used by the ``hotpath`` format.
1943 Only used by the ``hotpath`` format.
1915 (default: true)
1944 (default: true)
1916
1945
1917 ``progress``
1946 ``progress``
1918 ------------
1947 ------------
1919
1948
1920 Mercurial commands can draw progress bars that are as informative as
1949 Mercurial commands can draw progress bars that are as informative as
1921 possible. Some progress bars only offer indeterminate information, while others
1950 possible. Some progress bars only offer indeterminate information, while others
1922 have a definite end point.
1951 have a definite end point.
1923
1952
1924 ``debug``
1953 ``debug``
1925 Whether to print debug info when updating the progress bar. (default: False)
1954 Whether to print debug info when updating the progress bar. (default: False)
1926
1955
1927 ``delay``
1956 ``delay``
1928 Number of seconds (float) before showing the progress bar. (default: 3)
1957 Number of seconds (float) before showing the progress bar. (default: 3)
1929
1958
1930 ``changedelay``
1959 ``changedelay``
1931 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1960 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1932 that value will be used instead. (default: 1)
1961 that value will be used instead. (default: 1)
1933
1962
1934 ``estimateinterval``
1963 ``estimateinterval``
1935 Maximum sampling interval in seconds for speed and estimated time
1964 Maximum sampling interval in seconds for speed and estimated time
1936 calculation. (default: 60)
1965 calculation. (default: 60)
1937
1966
1938 ``refresh``
1967 ``refresh``
1939 Time in seconds between refreshes of the progress bar. (default: 0.1)
1968 Time in seconds between refreshes of the progress bar. (default: 0.1)
1940
1969
1941 ``format``
1970 ``format``
1942 Format of the progress bar.
1971 Format of the progress bar.
1943
1972
1944 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1973 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1945 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1974 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1946 last 20 characters of the item, but this can be changed by adding either
1975 last 20 characters of the item, but this can be changed by adding either
1947 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1976 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1948 first num characters.
1977 first num characters.
1949
1978
1950 (default: topic bar number estimate)
1979 (default: topic bar number estimate)
1951
1980
1952 ``width``
1981 ``width``
1953 If set, the maximum width of the progress information (that is, min(width,
1982 If set, the maximum width of the progress information (that is, min(width,
1954 term width) will be used).
1983 term width) will be used).
1955
1984
1956 ``clear-complete``
1985 ``clear-complete``
1957 Clear the progress bar after it's done. (default: True)
1986 Clear the progress bar after it's done. (default: True)
1958
1987
1959 ``disable``
1988 ``disable``
1960 If true, don't show a progress bar.
1989 If true, don't show a progress bar.
1961
1990
1962 ``assume-tty``
1991 ``assume-tty``
1963 If true, ALWAYS show a progress bar, unless disable is given.
1992 If true, ALWAYS show a progress bar, unless disable is given.
1964
1993
1965 ``rebase``
1994 ``rebase``
1966 ----------
1995 ----------
1967
1996
1968 ``evolution.allowdivergence``
1997 ``evolution.allowdivergence``
1969 Default to False, when True allow creating divergence when performing
1998 Default to False, when True allow creating divergence when performing
1970 rebase of obsolete changesets.
1999 rebase of obsolete changesets.
1971
2000
1972 ``revsetalias``
2001 ``revsetalias``
1973 ---------------
2002 ---------------
1974
2003
1975 Alias definitions for revsets. See :hg:`help revsets` for details.
2004 Alias definitions for revsets. See :hg:`help revsets` for details.
1976
2005
1977 ``rewrite``
2006 ``rewrite``
1978 -----------
2007 -----------
1979
2008
1980 ``backup-bundle``
2009 ``backup-bundle``
1981 Whether to save stripped changesets to a bundle file. (default: True)
2010 Whether to save stripped changesets to a bundle file. (default: True)
1982
2011
1983 ``update-timestamp``
2012 ``update-timestamp``
1984 If true, updates the date and time of the changeset to current. It is only
2013 If true, updates the date and time of the changeset to current. It is only
1985 applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the
2014 applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the
1986 current version.
2015 current version.
1987
2016
1988 ``empty-successor``
2017 ``empty-successor``
1989
2018
1990 Control what happens with empty successors that are the result of rewrite
2019 Control what happens with empty successors that are the result of rewrite
1991 operations. If set to ``skip``, the successor is not created. If set to
2020 operations. If set to ``skip``, the successor is not created. If set to
1992 ``keep``, the empty successor is created and kept.
2021 ``keep``, the empty successor is created and kept.
1993
2022
1994 Currently, only the rebase and absorb commands consider this configuration.
2023 Currently, only the rebase and absorb commands consider this configuration.
1995 (EXPERIMENTAL)
2024 (EXPERIMENTAL)
1996
2025
1997 ``share``
2026 ``share``
1998 ---------
2027 ---------
1999
2028
2000 ``safe-mismatch.source-safe``
2029 ``safe-mismatch.source-safe``
2001
2030
2002 Controls what happens when the shared repository does not use the
2031 Controls what happens when the shared repository does not use the
2003 share-safe mechanism but its source repository does.
2032 share-safe mechanism but its source repository does.
2004
2033
2005 Possible values are `abort` (default), `allow`, `upgrade-abort` and
2034 Possible values are `abort` (default), `allow`, `upgrade-abort` and
2006 `upgrade-abort`.
2035 `upgrade-abort`.
2007
2036
2008 ``abort``
2037 ``abort``
2009 Disallows running any command and aborts
2038 Disallows running any command and aborts
2010 ``allow``
2039 ``allow``
2011 Respects the feature presence in the share source
2040 Respects the feature presence in the share source
2012 ``upgrade-abort``
2041 ``upgrade-abort``
2013 tries to upgrade the share to use share-safe; if it fails, aborts
2042 tries to upgrade the share to use share-safe; if it fails, aborts
2014 ``upgrade-allow``
2043 ``upgrade-allow``
2015 tries to upgrade the share; if it fails, continue by
2044 tries to upgrade the share; if it fails, continue by
2016 respecting the share source setting
2045 respecting the share source setting
2017
2046
2018 Check :hg:`help config format.use-share-safe` for details about the
2047 Check :hg:`help config format.use-share-safe` for details about the
2019 share-safe feature.
2048 share-safe feature.
2020
2049
2021 ``safe-mismatch.source-safe.warn``
2050 ``safe-mismatch.source-safe.warn``
2022 Shows a warning on operations if the shared repository does not use
2051 Shows a warning on operations if the shared repository does not use
2023 share-safe, but the source repository does.
2052 share-safe, but the source repository does.
2024 (default: True)
2053 (default: True)
2025
2054
2026 ``safe-mismatch.source-not-safe``
2055 ``safe-mismatch.source-not-safe``
2027
2056
2028 Controls what happens when the shared repository uses the share-safe
2057 Controls what happens when the shared repository uses the share-safe
2029 mechanism but its source does not.
2058 mechanism but its source does not.
2030
2059
2031 Possible values are `abort` (default), `allow`, `downgrade-abort` and
2060 Possible values are `abort` (default), `allow`, `downgrade-abort` and
2032 `downgrade-abort`.
2061 `downgrade-abort`.
2033
2062
2034 ``abort``
2063 ``abort``
2035 Disallows running any command and aborts
2064 Disallows running any command and aborts
2036 ``allow``
2065 ``allow``
2037 Respects the feature presence in the share source
2066 Respects the feature presence in the share source
2038 ``downgrade-abort``
2067 ``downgrade-abort``
2039 tries to downgrade the share to not use share-safe; if it fails, aborts
2068 tries to downgrade the share to not use share-safe; if it fails, aborts
2040 ``downgrade-allow``
2069 ``downgrade-allow``
2041 tries to downgrade the share to not use share-safe;
2070 tries to downgrade the share to not use share-safe;
2042 if it fails, continue by respecting the shared source setting
2071 if it fails, continue by respecting the shared source setting
2043
2072
2044 Check :hg:`help config format.use-share-safe` for details about the
2073 Check :hg:`help config format.use-share-safe` for details about the
2045 share-safe feature.
2074 share-safe feature.
2046
2075
2047 ``safe-mismatch.source-not-safe.warn``
2076 ``safe-mismatch.source-not-safe.warn``
2048 Shows a warning on operations if the shared repository uses share-safe,
2077 Shows a warning on operations if the shared repository uses share-safe,
2049 but the source repository does not.
2078 but the source repository does not.
2050 (default: True)
2079 (default: True)
2051
2080
2052 ``storage``
2081 ``storage``
2053 -----------
2082 -----------
2054
2083
2055 Control the strategy Mercurial uses internally to store history. Options in this
2084 Control the strategy Mercurial uses internally to store history. Options in this
2056 category impact performance and repository size.
2085 category impact performance and repository size.
2057
2086
2058 ``revlog.issue6528.fix-incoming``
2087 ``revlog.issue6528.fix-incoming``
2059 Version 5.8 of Mercurial had a bug leading to altering the parent of file
2088 Version 5.8 of Mercurial had a bug leading to altering the parent of file
2060 revision with copy information (or any other metadata) on exchange. This
2089 revision with copy information (or any other metadata) on exchange. This
2061 leads to the copy metadata to be overlooked by various internal logic. The
2090 leads to the copy metadata to be overlooked by various internal logic. The
2062 issue was fixed in Mercurial 5.8.1.
2091 issue was fixed in Mercurial 5.8.1.
2063 (See https://bz.mercurial-scm.org/show_bug.cgi?id=6528 for details)
2092 (See https://bz.mercurial-scm.org/show_bug.cgi?id=6528 for details)
2064
2093
2065 As a result Mercurial is now checking and fixing incoming file revisions to
2094 As a result Mercurial is now checking and fixing incoming file revisions to
2066 make sure there parents are in the right order. This behavior can be
2095 make sure there parents are in the right order. This behavior can be
2067 disabled by setting this option to `no`. This apply to revisions added
2096 disabled by setting this option to `no`. This apply to revisions added
2068 through push, pull, clone and unbundle.
2097 through push, pull, clone and unbundle.
2069
2098
2070 To fix affected revisions that already exist within the repository, one can
2099 To fix affected revisions that already exist within the repository, one can
2071 use :hg:`debug-repair-issue-6528`.
2100 use :hg:`debug-repair-issue-6528`.
2072
2101
2073 ``revlog.optimize-delta-parent-choice``
2102 ``revlog.optimize-delta-parent-choice``
2074 When storing a merge revision, both parents will be equally considered as
2103 When storing a merge revision, both parents will be equally considered as
2075 a possible delta base. This results in better delta selection and improved
2104 a possible delta base. This results in better delta selection and improved
2076 revlog compression. This option is enabled by default.
2105 revlog compression. This option is enabled by default.
2077
2106
2078 Turning this option off can result in large increase of repository size for
2107 Turning this option off can result in large increase of repository size for
2079 repository with many merges.
2108 repository with many merges.
2080
2109
2081 ``revlog.persistent-nodemap.mmap``
2110 ``revlog.persistent-nodemap.mmap``
2082 Whether to use the Operating System "memory mapping" feature (when
2111 Whether to use the Operating System "memory mapping" feature (when
2083 possible) to access the persistent nodemap data. This improve performance
2112 possible) to access the persistent nodemap data. This improve performance
2084 and reduce memory pressure.
2113 and reduce memory pressure.
2085
2114
2086 Default to True.
2115 Default to True.
2087
2116
2088 For details on the "persistent-nodemap" feature, see:
2117 For details on the "persistent-nodemap" feature, see:
2089 :hg:`help config format.use-persistent-nodemap`.
2118 :hg:`help config format.use-persistent-nodemap`.
2090
2119
2091 ``revlog.persistent-nodemap.slow-path``
2120 ``revlog.persistent-nodemap.slow-path``
2092 Control the behavior of Merucrial when using a repository with "persistent"
2121 Control the behavior of Merucrial when using a repository with "persistent"
2093 nodemap with an installation of Mercurial without a fast implementation for
2122 nodemap with an installation of Mercurial without a fast implementation for
2094 the feature:
2123 the feature:
2095
2124
2096 ``allow``: Silently use the slower implementation to access the repository.
2125 ``allow``: Silently use the slower implementation to access the repository.
2097 ``warn``: Warn, but use the slower implementation to access the repository.
2126 ``warn``: Warn, but use the slower implementation to access the repository.
2098 ``abort``: Prevent access to such repositories. (This is the default)
2127 ``abort``: Prevent access to such repositories. (This is the default)
2099
2128
2100 For details on the "persistent-nodemap" feature, see:
2129 For details on the "persistent-nodemap" feature, see:
2101 :hg:`help config format.use-persistent-nodemap`.
2130 :hg:`help config format.use-persistent-nodemap`.
2102
2131
2103 ``revlog.reuse-external-delta-parent``
2132 ``revlog.reuse-external-delta-parent``
2104 Control the order in which delta parents are considered when adding new
2133 Control the order in which delta parents are considered when adding new
2105 revisions from an external source.
2134 revisions from an external source.
2106 (typically: apply bundle from `hg pull` or `hg push`).
2135 (typically: apply bundle from `hg pull` or `hg push`).
2107
2136
2108 New revisions are usually provided as a delta against other revisions. By
2137 New revisions are usually provided as a delta against other revisions. By
2109 default, Mercurial will try to reuse this delta first, therefore using the
2138 default, Mercurial will try to reuse this delta first, therefore using the
2110 same "delta parent" as the source. Directly using delta's from the source
2139 same "delta parent" as the source. Directly using delta's from the source
2111 reduces CPU usage and usually speeds up operation. However, in some case,
2140 reduces CPU usage and usually speeds up operation. However, in some case,
2112 the source might have sub-optimal delta bases and forcing their reevaluation
2141 the source might have sub-optimal delta bases and forcing their reevaluation
2113 is useful. For example, pushes from an old client could have sub-optimal
2142 is useful. For example, pushes from an old client could have sub-optimal
2114 delta's parent that the server want to optimize. (lack of general delta, bad
2143 delta's parent that the server want to optimize. (lack of general delta, bad
2115 parents, choice, lack of sparse-revlog, etc).
2144 parents, choice, lack of sparse-revlog, etc).
2116
2145
2117 This option is enabled by default. Turning it off will ensure bad delta
2146 This option is enabled by default. Turning it off will ensure bad delta
2118 parent choices from older client do not propagate to this repository, at
2147 parent choices from older client do not propagate to this repository, at
2119 the cost of a small increase in CPU consumption.
2148 the cost of a small increase in CPU consumption.
2120
2149
2121 Note: this option only control the order in which delta parents are
2150 Note: this option only control the order in which delta parents are
2122 considered. Even when disabled, the existing delta from the source will be
2151 considered. Even when disabled, the existing delta from the source will be
2123 reused if the same delta parent is selected.
2152 reused if the same delta parent is selected.
2124
2153
2125 ``revlog.reuse-external-delta``
2154 ``revlog.reuse-external-delta``
2126 Control the reuse of delta from external source.
2155 Control the reuse of delta from external source.
2127 (typically: apply bundle from `hg pull` or `hg push`).
2156 (typically: apply bundle from `hg pull` or `hg push`).
2128
2157
2129 New revisions are usually provided as a delta against another revision. By
2158 New revisions are usually provided as a delta against another revision. By
2130 default, Mercurial will not recompute the same delta again, trusting
2159 default, Mercurial will not recompute the same delta again, trusting
2131 externally provided deltas. There have been rare cases of small adjustment
2160 externally provided deltas. There have been rare cases of small adjustment
2132 to the diffing algorithm in the past. So in some rare case, recomputing
2161 to the diffing algorithm in the past. So in some rare case, recomputing
2133 delta provided by ancient clients can provides better results. Disabling
2162 delta provided by ancient clients can provides better results. Disabling
2134 this option means going through a full delta recomputation for all incoming
2163 this option means going through a full delta recomputation for all incoming
2135 revisions. It means a large increase in CPU usage and will slow operations
2164 revisions. It means a large increase in CPU usage and will slow operations
2136 down.
2165 down.
2137
2166
2138 This option is enabled by default. When disabled, it also disables the
2167 This option is enabled by default. When disabled, it also disables the
2139 related ``storage.revlog.reuse-external-delta-parent`` option.
2168 related ``storage.revlog.reuse-external-delta-parent`` option.
2140
2169
2141 ``revlog.zlib.level``
2170 ``revlog.zlib.level``
2142 Zlib compression level used when storing data into the repository. Accepted
2171 Zlib compression level used when storing data into the repository. Accepted
2143 Value range from 1 (lowest compression) to 9 (highest compression). Zlib
2172 Value range from 1 (lowest compression) to 9 (highest compression). Zlib
2144 default value is 6.
2173 default value is 6.
2145
2174
2146
2175
2147 ``revlog.zstd.level``
2176 ``revlog.zstd.level``
2148 zstd compression level used when storing data into the repository. Accepted
2177 zstd compression level used when storing data into the repository. Accepted
2149 Value range from 1 (lowest compression) to 22 (highest compression).
2178 Value range from 1 (lowest compression) to 22 (highest compression).
2150 (default 3)
2179 (default 3)
2151
2180
2152 ``server``
2181 ``server``
2153 ----------
2182 ----------
2154
2183
2155 Controls generic server settings.
2184 Controls generic server settings.
2156
2185
2157 ``bookmarks-pushkey-compat``
2186 ``bookmarks-pushkey-compat``
2158 Trigger pushkey hook when being pushed bookmark updates. This config exist
2187 Trigger pushkey hook when being pushed bookmark updates. This config exist
2159 for compatibility purpose (default to True)
2188 for compatibility purpose (default to True)
2160
2189
2161 If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
2190 If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
2162 movement we recommend you migrate them to ``txnclose-bookmark`` and
2191 movement we recommend you migrate them to ``txnclose-bookmark`` and
2163 ``pretxnclose-bookmark``.
2192 ``pretxnclose-bookmark``.
2164
2193
2165 ``compressionengines``
2194 ``compressionengines``
2166 List of compression engines and their relative priority to advertise
2195 List of compression engines and their relative priority to advertise
2167 to clients.
2196 to clients.
2168
2197
2169 The order of compression engines determines their priority, the first
2198 The order of compression engines determines their priority, the first
2170 having the highest priority. If a compression engine is not listed
2199 having the highest priority. If a compression engine is not listed
2171 here, it won't be advertised to clients.
2200 here, it won't be advertised to clients.
2172
2201
2173 If not set (the default), built-in defaults are used. Run
2202 If not set (the default), built-in defaults are used. Run
2174 :hg:`debuginstall` to list available compression engines and their
2203 :hg:`debuginstall` to list available compression engines and their
2175 default wire protocol priority.
2204 default wire protocol priority.
2176
2205
2177 Older Mercurial clients only support zlib compression and this setting
2206 Older Mercurial clients only support zlib compression and this setting
2178 has no effect for legacy clients.
2207 has no effect for legacy clients.
2179
2208
2180 ``uncompressed``
2209 ``uncompressed``
2181 Whether to allow clients to clone a repository using the
2210 Whether to allow clients to clone a repository using the
2182 uncompressed streaming protocol. This transfers about 40% more
2211 uncompressed streaming protocol. This transfers about 40% more
2183 data than a regular clone, but uses less memory and CPU on both
2212 data than a regular clone, but uses less memory and CPU on both
2184 server and client. Over a LAN (100 Mbps or better) or a very fast
2213 server and client. Over a LAN (100 Mbps or better) or a very fast
2185 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
2214 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
2186 regular clone. Over most WAN connections (anything slower than
2215 regular clone. Over most WAN connections (anything slower than
2187 about 6 Mbps), uncompressed streaming is slower, because of the
2216 about 6 Mbps), uncompressed streaming is slower, because of the
2188 extra data transfer overhead. This mode will also temporarily hold
2217 extra data transfer overhead. This mode will also temporarily hold
2189 the write lock while determining what data to transfer.
2218 the write lock while determining what data to transfer.
2190 (default: True)
2219 (default: True)
2191
2220
2192 ``uncompressedallowsecret``
2221 ``uncompressedallowsecret``
2193 Whether to allow stream clones when the repository contains secret
2222 Whether to allow stream clones when the repository contains secret
2194 changesets. (default: False)
2223 changesets. (default: False)
2195
2224
2196 ``preferuncompressed``
2225 ``preferuncompressed``
2197 When set, clients will try to use the uncompressed streaming
2226 When set, clients will try to use the uncompressed streaming
2198 protocol. (default: False)
2227 protocol. (default: False)
2199
2228
2200 ``disablefullbundle``
2229 ``disablefullbundle``
2201 When set, servers will refuse attempts to do pull-based clones.
2230 When set, servers will refuse attempts to do pull-based clones.
2202 If this option is set, ``preferuncompressed`` and/or clone bundles
2231 If this option is set, ``preferuncompressed`` and/or clone bundles
2203 are highly recommended. Partial clones will still be allowed.
2232 are highly recommended. Partial clones will still be allowed.
2204 (default: False)
2233 (default: False)
2205
2234
2206 ``streamunbundle``
2235 ``streamunbundle``
2207 When set, servers will apply data sent from the client directly,
2236 When set, servers will apply data sent from the client directly,
2208 otherwise it will be written to a temporary file first. This option
2237 otherwise it will be written to a temporary file first. This option
2209 effectively prevents concurrent pushes.
2238 effectively prevents concurrent pushes.
2210
2239
2211 ``pullbundle``
2240 ``pullbundle``
2212 When set, the server will check pullbundle.manifest for bundles
2241 When set, the server will check pullbundle.manifest for bundles
2213 covering the requested heads and common nodes. The first matching
2242 covering the requested heads and common nodes. The first matching
2214 entry will be streamed to the client.
2243 entry will be streamed to the client.
2215
2244
2216 For HTTP transport, the stream will still use zlib compression
2245 For HTTP transport, the stream will still use zlib compression
2217 for older clients.
2246 for older clients.
2218
2247
2219 ``concurrent-push-mode``
2248 ``concurrent-push-mode``
2220 Level of allowed race condition between two pushing clients.
2249 Level of allowed race condition between two pushing clients.
2221
2250
2222 - 'strict': push is abort if another client touched the repository
2251 - 'strict': push is abort if another client touched the repository
2223 while the push was preparing.
2252 while the push was preparing.
2224 - 'check-related': push is only aborted if it affects head that got also
2253 - 'check-related': push is only aborted if it affects head that got also
2225 affected while the push was preparing. (default since 5.4)
2254 affected while the push was preparing. (default since 5.4)
2226
2255
2227 'check-related' only takes effect for compatible clients (version
2256 'check-related' only takes effect for compatible clients (version
2228 4.3 and later). Older clients will use 'strict'.
2257 4.3 and later). Older clients will use 'strict'.
2229
2258
2230 ``validate``
2259 ``validate``
2231 Whether to validate the completeness of pushed changesets by
2260 Whether to validate the completeness of pushed changesets by
2232 checking that all new file revisions specified in manifests are
2261 checking that all new file revisions specified in manifests are
2233 present. (default: False)
2262 present. (default: False)
2234
2263
2235 ``maxhttpheaderlen``
2264 ``maxhttpheaderlen``
2236 Instruct HTTP clients not to send request headers longer than this
2265 Instruct HTTP clients not to send request headers longer than this
2237 many bytes. (default: 1024)
2266 many bytes. (default: 1024)
2238
2267
2239 ``bundle1``
2268 ``bundle1``
2240 Whether to allow clients to push and pull using the legacy bundle1
2269 Whether to allow clients to push and pull using the legacy bundle1
2241 exchange format. (default: True)
2270 exchange format. (default: True)
2242
2271
2243 ``bundle1gd``
2272 ``bundle1gd``
2244 Like ``bundle1`` but only used if the repository is using the
2273 Like ``bundle1`` but only used if the repository is using the
2245 *generaldelta* storage format. (default: True)
2274 *generaldelta* storage format. (default: True)
2246
2275
2247 ``bundle1.push``
2276 ``bundle1.push``
2248 Whether to allow clients to push using the legacy bundle1 exchange
2277 Whether to allow clients to push using the legacy bundle1 exchange
2249 format. (default: True)
2278 format. (default: True)
2250
2279
2251 ``bundle1gd.push``
2280 ``bundle1gd.push``
2252 Like ``bundle1.push`` but only used if the repository is using the
2281 Like ``bundle1.push`` but only used if the repository is using the
2253 *generaldelta* storage format. (default: True)
2282 *generaldelta* storage format. (default: True)
2254
2283
2255 ``bundle1.pull``
2284 ``bundle1.pull``
2256 Whether to allow clients to pull using the legacy bundle1 exchange
2285 Whether to allow clients to pull using the legacy bundle1 exchange
2257 format. (default: True)
2286 format. (default: True)
2258
2287
2259 ``bundle1gd.pull``
2288 ``bundle1gd.pull``
2260 Like ``bundle1.pull`` but only used if the repository is using the
2289 Like ``bundle1.pull`` but only used if the repository is using the
2261 *generaldelta* storage format. (default: True)
2290 *generaldelta* storage format. (default: True)
2262
2291
2263 Large repositories using the *generaldelta* storage format should
2292 Large repositories using the *generaldelta* storage format should
2264 consider setting this option because converting *generaldelta*
2293 consider setting this option because converting *generaldelta*
2265 repositories to the exchange format required by the bundle1 data
2294 repositories to the exchange format required by the bundle1 data
2266 format can consume a lot of CPU.
2295 format can consume a lot of CPU.
2267
2296
2268 ``bundle2.stream``
2297 ``bundle2.stream``
2269 Whether to allow clients to pull using the bundle2 streaming protocol.
2298 Whether to allow clients to pull using the bundle2 streaming protocol.
2270 (default: True)
2299 (default: True)
2271
2300
2272 ``zliblevel``
2301 ``zliblevel``
2273 Integer between ``-1`` and ``9`` that controls the zlib compression level
2302 Integer between ``-1`` and ``9`` that controls the zlib compression level
2274 for wire protocol commands that send zlib compressed output (notably the
2303 for wire protocol commands that send zlib compressed output (notably the
2275 commands that send repository history data).
2304 commands that send repository history data).
2276
2305
2277 The default (``-1``) uses the default zlib compression level, which is
2306 The default (``-1``) uses the default zlib compression level, which is
2278 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
2307 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
2279 maximum compression.
2308 maximum compression.
2280
2309
2281 Setting this option allows server operators to make trade-offs between
2310 Setting this option allows server operators to make trade-offs between
2282 bandwidth and CPU used. Lowering the compression lowers CPU utilization
2311 bandwidth and CPU used. Lowering the compression lowers CPU utilization
2283 but sends more bytes to clients.
2312 but sends more bytes to clients.
2284
2313
2285 This option only impacts the HTTP server.
2314 This option only impacts the HTTP server.
2286
2315
2287 ``zstdlevel``
2316 ``zstdlevel``
2288 Integer between ``1`` and ``22`` that controls the zstd compression level
2317 Integer between ``1`` and ``22`` that controls the zstd compression level
2289 for wire protocol commands. ``1`` is the minimal amount of compression and
2318 for wire protocol commands. ``1`` is the minimal amount of compression and
2290 ``22`` is the highest amount of compression.
2319 ``22`` is the highest amount of compression.
2291
2320
2292 The default (``3``) should be significantly faster than zlib while likely
2321 The default (``3``) should be significantly faster than zlib while likely
2293 delivering better compression ratios.
2322 delivering better compression ratios.
2294
2323
2295 This option only impacts the HTTP server.
2324 This option only impacts the HTTP server.
2296
2325
2297 See also ``server.zliblevel``.
2326 See also ``server.zliblevel``.
2298
2327
2299 ``view``
2328 ``view``
2300 Repository filter used when exchanging revisions with the peer.
2329 Repository filter used when exchanging revisions with the peer.
2301
2330
2302 The default view (``served``) excludes secret and hidden changesets.
2331 The default view (``served``) excludes secret and hidden changesets.
2303 Another useful value is ``immutable`` (no draft, secret or hidden
2332 Another useful value is ``immutable`` (no draft, secret or hidden
2304 changesets). (EXPERIMENTAL)
2333 changesets). (EXPERIMENTAL)
2305
2334
2306 ``smtp``
2335 ``smtp``
2307 --------
2336 --------
2308
2337
2309 Configuration for extensions that need to send email messages.
2338 Configuration for extensions that need to send email messages.
2310
2339
2311 ``host``
2340 ``host``
2312 Host name of mail server, e.g. "mail.example.com".
2341 Host name of mail server, e.g. "mail.example.com".
2313
2342
2314 ``port``
2343 ``port``
2315 Optional. Port to connect to on mail server. (default: 465 if
2344 Optional. Port to connect to on mail server. (default: 465 if
2316 ``tls`` is smtps; 25 otherwise)
2345 ``tls`` is smtps; 25 otherwise)
2317
2346
2318 ``tls``
2347 ``tls``
2319 Optional. Method to enable TLS when connecting to mail server: starttls,
2348 Optional. Method to enable TLS when connecting to mail server: starttls,
2320 smtps or none. (default: none)
2349 smtps or none. (default: none)
2321
2350
2322 ``username``
2351 ``username``
2323 Optional. User name for authenticating with the SMTP server.
2352 Optional. User name for authenticating with the SMTP server.
2324 (default: None)
2353 (default: None)
2325
2354
2326 ``password``
2355 ``password``
2327 Optional. Password for authenticating with the SMTP server. If not
2356 Optional. Password for authenticating with the SMTP server. If not
2328 specified, interactive sessions will prompt the user for a
2357 specified, interactive sessions will prompt the user for a
2329 password; non-interactive sessions will fail. (default: None)
2358 password; non-interactive sessions will fail. (default: None)
2330
2359
2331 ``local_hostname``
2360 ``local_hostname``
2332 Optional. The hostname that the sender can use to identify
2361 Optional. The hostname that the sender can use to identify
2333 itself to the MTA.
2362 itself to the MTA.
2334
2363
2335
2364
2336 ``subpaths``
2365 ``subpaths``
2337 ------------
2366 ------------
2338
2367
2339 Subrepository source URLs can go stale if a remote server changes name
2368 Subrepository source URLs can go stale if a remote server changes name
2340 or becomes temporarily unavailable. This section lets you define
2369 or becomes temporarily unavailable. This section lets you define
2341 rewrite rules of the form::
2370 rewrite rules of the form::
2342
2371
2343 <pattern> = <replacement>
2372 <pattern> = <replacement>
2344
2373
2345 where ``pattern`` is a regular expression matching a subrepository
2374 where ``pattern`` is a regular expression matching a subrepository
2346 source URL and ``replacement`` is the replacement string used to
2375 source URL and ``replacement`` is the replacement string used to
2347 rewrite it. Groups can be matched in ``pattern`` and referenced in
2376 rewrite it. Groups can be matched in ``pattern`` and referenced in
2348 ``replacements``. For instance::
2377 ``replacements``. For instance::
2349
2378
2350 http://server/(.*)-hg/ = http://hg.server/\1/
2379 http://server/(.*)-hg/ = http://hg.server/\1/
2351
2380
2352 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
2381 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
2353
2382
2354 Relative subrepository paths are first made absolute, and the
2383 Relative subrepository paths are first made absolute, and the
2355 rewrite rules are then applied on the full (absolute) path. If ``pattern``
2384 rewrite rules are then applied on the full (absolute) path. If ``pattern``
2356 doesn't match the full path, an attempt is made to apply it on the
2385 doesn't match the full path, an attempt is made to apply it on the
2357 relative path alone. The rules are applied in definition order.
2386 relative path alone. The rules are applied in definition order.
2358
2387
2359 ``subrepos``
2388 ``subrepos``
2360 ------------
2389 ------------
2361
2390
2362 This section contains options that control the behavior of the
2391 This section contains options that control the behavior of the
2363 subrepositories feature. See also :hg:`help subrepos`.
2392 subrepositories feature. See also :hg:`help subrepos`.
2364
2393
2365 Security note: auditing in Mercurial is known to be insufficient to
2394 Security note: auditing in Mercurial is known to be insufficient to
2366 prevent clone-time code execution with carefully constructed Git
2395 prevent clone-time code execution with carefully constructed Git
2367 subrepos. It is unknown if a similar detect is present in Subversion
2396 subrepos. It is unknown if a similar detect is present in Subversion
2368 subrepos. Both Git and Subversion subrepos are disabled by default
2397 subrepos. Both Git and Subversion subrepos are disabled by default
2369 out of security concerns. These subrepo types can be enabled using
2398 out of security concerns. These subrepo types can be enabled using
2370 the respective options below.
2399 the respective options below.
2371
2400
2372 ``allowed``
2401 ``allowed``
2373 Whether subrepositories are allowed in the working directory.
2402 Whether subrepositories are allowed in the working directory.
2374
2403
2375 When false, commands involving subrepositories (like :hg:`update`)
2404 When false, commands involving subrepositories (like :hg:`update`)
2376 will fail for all subrepository types.
2405 will fail for all subrepository types.
2377 (default: true)
2406 (default: true)
2378
2407
2379 ``hg:allowed``
2408 ``hg:allowed``
2380 Whether Mercurial subrepositories are allowed in the working
2409 Whether Mercurial subrepositories are allowed in the working
2381 directory. This option only has an effect if ``subrepos.allowed``
2410 directory. This option only has an effect if ``subrepos.allowed``
2382 is true.
2411 is true.
2383 (default: true)
2412 (default: true)
2384
2413
2385 ``git:allowed``
2414 ``git:allowed``
2386 Whether Git subrepositories are allowed in the working directory.
2415 Whether Git subrepositories are allowed in the working directory.
2387 This option only has an effect if ``subrepos.allowed`` is true.
2416 This option only has an effect if ``subrepos.allowed`` is true.
2388
2417
2389 See the security note above before enabling Git subrepos.
2418 See the security note above before enabling Git subrepos.
2390 (default: false)
2419 (default: false)
2391
2420
2392 ``svn:allowed``
2421 ``svn:allowed``
2393 Whether Subversion subrepositories are allowed in the working
2422 Whether Subversion subrepositories are allowed in the working
2394 directory. This option only has an effect if ``subrepos.allowed``
2423 directory. This option only has an effect if ``subrepos.allowed``
2395 is true.
2424 is true.
2396
2425
2397 See the security note above before enabling Subversion subrepos.
2426 See the security note above before enabling Subversion subrepos.
2398 (default: false)
2427 (default: false)
2399
2428
2400 ``templatealias``
2429 ``templatealias``
2401 -----------------
2430 -----------------
2402
2431
2403 Alias definitions for templates. See :hg:`help templates` for details.
2432 Alias definitions for templates. See :hg:`help templates` for details.
2404
2433
2405 ``templates``
2434 ``templates``
2406 -------------
2435 -------------
2407
2436
2408 Use the ``[templates]`` section to define template strings.
2437 Use the ``[templates]`` section to define template strings.
2409 See :hg:`help templates` for details.
2438 See :hg:`help templates` for details.
2410
2439
2411 ``trusted``
2440 ``trusted``
2412 -----------
2441 -----------
2413
2442
2414 Mercurial will not use the settings in the
2443 Mercurial will not use the settings in the
2415 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
2444 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
2416 user or to a trusted group, as various hgrc features allow arbitrary
2445 user or to a trusted group, as various hgrc features allow arbitrary
2417 commands to be run. This issue is often encountered when configuring
2446 commands to be run. This issue is often encountered when configuring
2418 hooks or extensions for shared repositories or servers. However,
2447 hooks or extensions for shared repositories or servers. However,
2419 the web interface will use some safe settings from the ``[web]``
2448 the web interface will use some safe settings from the ``[web]``
2420 section.
2449 section.
2421
2450
2422 This section specifies what users and groups are trusted. The
2451 This section specifies what users and groups are trusted. The
2423 current user is always trusted. To trust everybody, list a user or a
2452 current user is always trusted. To trust everybody, list a user or a
2424 group with name ``*``. These settings must be placed in an
2453 group with name ``*``. These settings must be placed in an
2425 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
2454 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
2426 user or service running Mercurial.
2455 user or service running Mercurial.
2427
2456
2428 ``users``
2457 ``users``
2429 Comma-separated list of trusted users.
2458 Comma-separated list of trusted users.
2430
2459
2431 ``groups``
2460 ``groups``
2432 Comma-separated list of trusted groups.
2461 Comma-separated list of trusted groups.
2433
2462
2434
2463
2435 ``ui``
2464 ``ui``
2436 ------
2465 ------
2437
2466
2438 User interface controls.
2467 User interface controls.
2439
2468
2440 ``archivemeta``
2469 ``archivemeta``
2441 Whether to include the .hg_archival.txt file containing meta data
2470 Whether to include the .hg_archival.txt file containing meta data
2442 (hashes for the repository base and for tip) in archives created
2471 (hashes for the repository base and for tip) in archives created
2443 by the :hg:`archive` command or downloaded via hgweb.
2472 by the :hg:`archive` command or downloaded via hgweb.
2444 (default: True)
2473 (default: True)
2445
2474
2446 ``askusername``
2475 ``askusername``
2447 Whether to prompt for a username when committing. If True, and
2476 Whether to prompt for a username when committing. If True, and
2448 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
2477 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
2449 be prompted to enter a username. If no username is entered, the
2478 be prompted to enter a username. If no username is entered, the
2450 default ``USER@HOST`` is used instead.
2479 default ``USER@HOST`` is used instead.
2451 (default: False)
2480 (default: False)
2452
2481
2453 ``clonebundles``
2482 ``clonebundles``
2454 Whether the "clone bundles" feature is enabled.
2483 Whether the "clone bundles" feature is enabled.
2455
2484
2456 When enabled, :hg:`clone` may download and apply a server-advertised
2485 When enabled, :hg:`clone` may download and apply a server-advertised
2457 bundle file from a URL instead of using the normal exchange mechanism.
2486 bundle file from a URL instead of using the normal exchange mechanism.
2458
2487
2459 This can likely result in faster and more reliable clones.
2488 This can likely result in faster and more reliable clones.
2460
2489
2461 (default: True)
2490 (default: True)
2462
2491
2463 ``clonebundlefallback``
2492 ``clonebundlefallback``
2464 Whether failure to apply an advertised "clone bundle" from a server
2493 Whether failure to apply an advertised "clone bundle" from a server
2465 should result in fallback to a regular clone.
2494 should result in fallback to a regular clone.
2466
2495
2467 This is disabled by default because servers advertising "clone
2496 This is disabled by default because servers advertising "clone
2468 bundles" often do so to reduce server load. If advertised bundles
2497 bundles" often do so to reduce server load. If advertised bundles
2469 start mass failing and clients automatically fall back to a regular
2498 start mass failing and clients automatically fall back to a regular
2470 clone, this would add significant and unexpected load to the server
2499 clone, this would add significant and unexpected load to the server
2471 since the server is expecting clone operations to be offloaded to
2500 since the server is expecting clone operations to be offloaded to
2472 pre-generated bundles. Failing fast (the default behavior) ensures
2501 pre-generated bundles. Failing fast (the default behavior) ensures
2473 clients don't overwhelm the server when "clone bundle" application
2502 clients don't overwhelm the server when "clone bundle" application
2474 fails.
2503 fails.
2475
2504
2476 (default: False)
2505 (default: False)
2477
2506
2478 ``clonebundleprefers``
2507 ``clonebundleprefers``
2479 Defines preferences for which "clone bundles" to use.
2508 Defines preferences for which "clone bundles" to use.
2480
2509
2481 Servers advertising "clone bundles" may advertise multiple available
2510 Servers advertising "clone bundles" may advertise multiple available
2482 bundles. Each bundle may have different attributes, such as the bundle
2511 bundles. Each bundle may have different attributes, such as the bundle
2483 type and compression format. This option is used to prefer a particular
2512 type and compression format. This option is used to prefer a particular
2484 bundle over another.
2513 bundle over another.
2485
2514
2486 The following keys are defined by Mercurial:
2515 The following keys are defined by Mercurial:
2487
2516
2488 BUNDLESPEC
2517 BUNDLESPEC
2489 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
2518 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
2490 e.g. ``gzip-v2`` or ``bzip2-v1``.
2519 e.g. ``gzip-v2`` or ``bzip2-v1``.
2491
2520
2492 COMPRESSION
2521 COMPRESSION
2493 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
2522 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
2494
2523
2495 Server operators may define custom keys.
2524 Server operators may define custom keys.
2496
2525
2497 Example values: ``COMPRESSION=bzip2``,
2526 Example values: ``COMPRESSION=bzip2``,
2498 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
2527 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
2499
2528
2500 By default, the first bundle advertised by the server is used.
2529 By default, the first bundle advertised by the server is used.
2501
2530
2502 ``color``
2531 ``color``
2503 When to colorize output. Possible value are Boolean ("yes" or "no"), or
2532 When to colorize output. Possible value are Boolean ("yes" or "no"), or
2504 "debug", or "always". (default: "yes"). "yes" will use color whenever it
2533 "debug", or "always". (default: "yes"). "yes" will use color whenever it
2505 seems possible. See :hg:`help color` for details.
2534 seems possible. See :hg:`help color` for details.
2506
2535
2507 ``commitsubrepos``
2536 ``commitsubrepos``
2508 Whether to commit modified subrepositories when committing the
2537 Whether to commit modified subrepositories when committing the
2509 parent repository. If False and one subrepository has uncommitted
2538 parent repository. If False and one subrepository has uncommitted
2510 changes, abort the commit.
2539 changes, abort the commit.
2511 (default: False)
2540 (default: False)
2512
2541
2513 ``debug``
2542 ``debug``
2514 Print debugging information. (default: False)
2543 Print debugging information. (default: False)
2515
2544
2516 ``editor``
2545 ``editor``
2517 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
2546 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
2518
2547
2519 ``fallbackencoding``
2548 ``fallbackencoding``
2520 Encoding to try if it's not possible to decode the changelog using
2549 Encoding to try if it's not possible to decode the changelog using
2521 UTF-8. (default: ISO-8859-1)
2550 UTF-8. (default: ISO-8859-1)
2522
2551
2523 ``graphnodetemplate``
2552 ``graphnodetemplate``
2524 (DEPRECATED) Use ``command-templates.graphnode`` instead.
2553 (DEPRECATED) Use ``command-templates.graphnode`` instead.
2525
2554
2526 ``ignore``
2555 ``ignore``
2527 A file to read per-user ignore patterns from. This file should be
2556 A file to read per-user ignore patterns from. This file should be
2528 in the same format as a repository-wide .hgignore file. Filenames
2557 in the same format as a repository-wide .hgignore file. Filenames
2529 are relative to the repository root. This option supports hook syntax,
2558 are relative to the repository root. This option supports hook syntax,
2530 so if you want to specify multiple ignore files, you can do so by
2559 so if you want to specify multiple ignore files, you can do so by
2531 setting something like ``ignore.other = ~/.hgignore2``. For details
2560 setting something like ``ignore.other = ~/.hgignore2``. For details
2532 of the ignore file format, see the ``hgignore(5)`` man page.
2561 of the ignore file format, see the ``hgignore(5)`` man page.
2533
2562
2534 ``interactive``
2563 ``interactive``
2535 Allow to prompt the user. (default: True)
2564 Allow to prompt the user. (default: True)
2536
2565
2537 ``interface``
2566 ``interface``
2538 Select the default interface for interactive features (default: text).
2567 Select the default interface for interactive features (default: text).
2539 Possible values are 'text' and 'curses'.
2568 Possible values are 'text' and 'curses'.
2540
2569
2541 ``interface.chunkselector``
2570 ``interface.chunkselector``
2542 Select the interface for change recording (e.g. :hg:`commit -i`).
2571 Select the interface for change recording (e.g. :hg:`commit -i`).
2543 Possible values are 'text' and 'curses'.
2572 Possible values are 'text' and 'curses'.
2544 This config overrides the interface specified by ui.interface.
2573 This config overrides the interface specified by ui.interface.
2545
2574
2546 ``large-file-limit``
2575 ``large-file-limit``
2547 Largest file size that gives no memory use warning.
2576 Largest file size that gives no memory use warning.
2548 Possible values are integers or 0 to disable the check.
2577 Possible values are integers or 0 to disable the check.
2549 (default: 10000000)
2578 (default: 10000000)
2550
2579
2551 ``logtemplate``
2580 ``logtemplate``
2552 (DEPRECATED) Use ``command-templates.log`` instead.
2581 (DEPRECATED) Use ``command-templates.log`` instead.
2553
2582
2554 ``merge``
2583 ``merge``
2555 The conflict resolution program to use during a manual merge.
2584 The conflict resolution program to use during a manual merge.
2556 For more information on merge tools see :hg:`help merge-tools`.
2585 For more information on merge tools see :hg:`help merge-tools`.
2557 For configuring merge tools see the ``[merge-tools]`` section.
2586 For configuring merge tools see the ``[merge-tools]`` section.
2558
2587
2559 ``mergemarkers``
2588 ``mergemarkers``
2560 Sets the merge conflict marker label styling. The ``detailed`` style
2589 Sets the merge conflict marker label styling. The ``detailed`` style
2561 uses the ``command-templates.mergemarker`` setting to style the labels.
2590 uses the ``command-templates.mergemarker`` setting to style the labels.
2562 The ``basic`` style just uses 'local' and 'other' as the marker label.
2591 The ``basic`` style just uses 'local' and 'other' as the marker label.
2563 One of ``basic`` or ``detailed``.
2592 One of ``basic`` or ``detailed``.
2564 (default: ``basic``)
2593 (default: ``basic``)
2565
2594
2566 ``mergemarkertemplate``
2595 ``mergemarkertemplate``
2567 (DEPRECATED) Use ``command-templates.mergemarker`` instead.
2596 (DEPRECATED) Use ``command-templates.mergemarker`` instead.
2568
2597
2569 ``message-output``
2598 ``message-output``
2570 Where to write status and error messages. (default: ``stdio``)
2599 Where to write status and error messages. (default: ``stdio``)
2571
2600
2572 ``channel``
2601 ``channel``
2573 Use separate channel for structured output. (Command-server only)
2602 Use separate channel for structured output. (Command-server only)
2574 ``stderr``
2603 ``stderr``
2575 Everything to stderr.
2604 Everything to stderr.
2576 ``stdio``
2605 ``stdio``
2577 Status to stdout, and error to stderr.
2606 Status to stdout, and error to stderr.
2578
2607
2579 ``origbackuppath``
2608 ``origbackuppath``
2580 The path to a directory used to store generated .orig files. If the path is
2609 The path to a directory used to store generated .orig files. If the path is
2581 not a directory, one will be created. If set, files stored in this
2610 not a directory, one will be created. If set, files stored in this
2582 directory have the same name as the original file and do not have a .orig
2611 directory have the same name as the original file and do not have a .orig
2583 suffix.
2612 suffix.
2584
2613
2585 ``paginate``
2614 ``paginate``
2586 Control the pagination of command output (default: True). See :hg:`help pager`
2615 Control the pagination of command output (default: True). See :hg:`help pager`
2587 for details.
2616 for details.
2588
2617
2589 ``patch``
2618 ``patch``
2590 An optional external tool that ``hg import`` and some extensions
2619 An optional external tool that ``hg import`` and some extensions
2591 will use for applying patches. By default Mercurial uses an
2620 will use for applying patches. By default Mercurial uses an
2592 internal patch utility. The external tool must work as the common
2621 internal patch utility. The external tool must work as the common
2593 Unix ``patch`` program. In particular, it must accept a ``-p``
2622 Unix ``patch`` program. In particular, it must accept a ``-p``
2594 argument to strip patch headers, a ``-d`` argument to specify the
2623 argument to strip patch headers, a ``-d`` argument to specify the
2595 current directory, a file name to patch, and a patch file to take
2624 current directory, a file name to patch, and a patch file to take
2596 from stdin.
2625 from stdin.
2597
2626
2598 It is possible to specify a patch tool together with extra
2627 It is possible to specify a patch tool together with extra
2599 arguments. For example, setting this option to ``patch --merge``
2628 arguments. For example, setting this option to ``patch --merge``
2600 will use the ``patch`` program with its 2-way merge option.
2629 will use the ``patch`` program with its 2-way merge option.
2601
2630
2602 ``portablefilenames``
2631 ``portablefilenames``
2603 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
2632 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
2604 (default: ``warn``)
2633 (default: ``warn``)
2605
2634
2606 ``warn``
2635 ``warn``
2607 Print a warning message on POSIX platforms, if a file with a non-portable
2636 Print a warning message on POSIX platforms, if a file with a non-portable
2608 filename is added (e.g. a file with a name that can't be created on
2637 filename is added (e.g. a file with a name that can't be created on
2609 Windows because it contains reserved parts like ``AUX``, reserved
2638 Windows because it contains reserved parts like ``AUX``, reserved
2610 characters like ``:``, or would cause a case collision with an existing
2639 characters like ``:``, or would cause a case collision with an existing
2611 file).
2640 file).
2612
2641
2613 ``ignore``
2642 ``ignore``
2614 Don't print a warning.
2643 Don't print a warning.
2615
2644
2616 ``abort``
2645 ``abort``
2617 The command is aborted.
2646 The command is aborted.
2618
2647
2619 ``true``
2648 ``true``
2620 Alias for ``warn``.
2649 Alias for ``warn``.
2621
2650
2622 ``false``
2651 ``false``
2623 Alias for ``ignore``.
2652 Alias for ``ignore``.
2624
2653
2625 .. container:: windows
2654 .. container:: windows
2626
2655
2627 On Windows, this configuration option is ignored and the command aborted.
2656 On Windows, this configuration option is ignored and the command aborted.
2628
2657
2629 ``pre-merge-tool-output-template``
2658 ``pre-merge-tool-output-template``
2630 (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead.
2659 (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead.
2631
2660
2632 ``quiet``
2661 ``quiet``
2633 Reduce the amount of output printed.
2662 Reduce the amount of output printed.
2634 (default: False)
2663 (default: False)
2635
2664
2636 ``relative-paths``
2665 ``relative-paths``
2637 Prefer relative paths in the UI.
2666 Prefer relative paths in the UI.
2638
2667
2639 ``remotecmd``
2668 ``remotecmd``
2640 Remote command to use for clone/push/pull operations.
2669 Remote command to use for clone/push/pull operations.
2641 (default: ``hg``)
2670 (default: ``hg``)
2642
2671
2643 ``report_untrusted``
2672 ``report_untrusted``
2644 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2673 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2645 trusted user or group.
2674 trusted user or group.
2646 (default: True)
2675 (default: True)
2647
2676
2648 ``slash``
2677 ``slash``
2649 (Deprecated. Use ``slashpath`` template filter instead.)
2678 (Deprecated. Use ``slashpath`` template filter instead.)
2650
2679
2651 Display paths using a slash (``/``) as the path separator. This
2680 Display paths using a slash (``/``) as the path separator. This
2652 only makes a difference on systems where the default path
2681 only makes a difference on systems where the default path
2653 separator is not the slash character (e.g. Windows uses the
2682 separator is not the slash character (e.g. Windows uses the
2654 backslash character (``\``)).
2683 backslash character (``\``)).
2655 (default: False)
2684 (default: False)
2656
2685
2657 ``statuscopies``
2686 ``statuscopies``
2658 Display copies in the status command.
2687 Display copies in the status command.
2659
2688
2660 ``ssh``
2689 ``ssh``
2661 Command to use for SSH connections. (default: ``ssh``)
2690 Command to use for SSH connections. (default: ``ssh``)
2662
2691
2663 ``ssherrorhint``
2692 ``ssherrorhint``
2664 A hint shown to the user in the case of SSH error (e.g.
2693 A hint shown to the user in the case of SSH error (e.g.
2665 ``Please see http://company/internalwiki/ssh.html``)
2694 ``Please see http://company/internalwiki/ssh.html``)
2666
2695
2667 ``strict``
2696 ``strict``
2668 Require exact command names, instead of allowing unambiguous
2697 Require exact command names, instead of allowing unambiguous
2669 abbreviations. (default: False)
2698 abbreviations. (default: False)
2670
2699
2671 ``style``
2700 ``style``
2672 Name of style to use for command output.
2701 Name of style to use for command output.
2673
2702
2674 ``supportcontact``
2703 ``supportcontact``
2675 A URL where users should report a Mercurial traceback. Use this if you are a
2704 A URL where users should report a Mercurial traceback. Use this if you are a
2676 large organisation with its own Mercurial deployment process and crash
2705 large organisation with its own Mercurial deployment process and crash
2677 reports should be addressed to your internal support.
2706 reports should be addressed to your internal support.
2678
2707
2679 ``textwidth``
2708 ``textwidth``
2680 Maximum width of help text. A longer line generated by ``hg help`` or
2709 Maximum width of help text. A longer line generated by ``hg help`` or
2681 ``hg subcommand --help`` will be broken after white space to get this
2710 ``hg subcommand --help`` will be broken after white space to get this
2682 width or the terminal width, whichever comes first.
2711 width or the terminal width, whichever comes first.
2683 A non-positive value will disable this and the terminal width will be
2712 A non-positive value will disable this and the terminal width will be
2684 used. (default: 78)
2713 used. (default: 78)
2685
2714
2686 ``timeout``
2715 ``timeout``
2687 The timeout used when a lock is held (in seconds), a negative value
2716 The timeout used when a lock is held (in seconds), a negative value
2688 means no timeout. (default: 600)
2717 means no timeout. (default: 600)
2689
2718
2690 ``timeout.warn``
2719 ``timeout.warn``
2691 Time (in seconds) before a warning is printed about held lock. A negative
2720 Time (in seconds) before a warning is printed about held lock. A negative
2692 value means no warning. (default: 0)
2721 value means no warning. (default: 0)
2693
2722
2694 ``traceback``
2723 ``traceback``
2695 Mercurial always prints a traceback when an unknown exception
2724 Mercurial always prints a traceback when an unknown exception
2696 occurs. Setting this to True will make Mercurial print a traceback
2725 occurs. Setting this to True will make Mercurial print a traceback
2697 on all exceptions, even those recognized by Mercurial (such as
2726 on all exceptions, even those recognized by Mercurial (such as
2698 IOError or MemoryError). (default: False)
2727 IOError or MemoryError). (default: False)
2699
2728
2700 ``tweakdefaults``
2729 ``tweakdefaults``
2701
2730
2702 By default Mercurial's behavior changes very little from release
2731 By default Mercurial's behavior changes very little from release
2703 to release, but over time the recommended config settings
2732 to release, but over time the recommended config settings
2704 shift. Enable this config to opt in to get automatic tweaks to
2733 shift. Enable this config to opt in to get automatic tweaks to
2705 Mercurial's behavior over time. This config setting will have no
2734 Mercurial's behavior over time. This config setting will have no
2706 effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
2735 effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
2707 not include ``tweakdefaults``. (default: False)
2736 not include ``tweakdefaults``. (default: False)
2708
2737
2709 It currently means::
2738 It currently means::
2710
2739
2711 .. tweakdefaultsmarker
2740 .. tweakdefaultsmarker
2712
2741
2713 ``username``
2742 ``username``
2714 The committer of a changeset created when running "commit".
2743 The committer of a changeset created when running "commit".
2715 Typically a person's name and email address, e.g. ``Fred Widget
2744 Typically a person's name and email address, e.g. ``Fred Widget
2716 <fred@example.com>``. Environment variables in the
2745 <fred@example.com>``. Environment variables in the
2717 username are expanded.
2746 username are expanded.
2718
2747
2719 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2748 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2720 hgrc is empty, e.g. if the system admin set ``username =`` in the
2749 hgrc is empty, e.g. if the system admin set ``username =`` in the
2721 system hgrc, it has to be specified manually or in a different
2750 system hgrc, it has to be specified manually or in a different
2722 hgrc file)
2751 hgrc file)
2723
2752
2724 ``verbose``
2753 ``verbose``
2725 Increase the amount of output printed. (default: False)
2754 Increase the amount of output printed. (default: False)
2726
2755
2727
2756
2728 ``command-templates``
2757 ``command-templates``
2729 ---------------------
2758 ---------------------
2730
2759
2731 Templates used for customizing the output of commands.
2760 Templates used for customizing the output of commands.
2732
2761
2733 ``graphnode``
2762 ``graphnode``
2734 The template used to print changeset nodes in an ASCII revision graph.
2763 The template used to print changeset nodes in an ASCII revision graph.
2735 (default: ``{graphnode}``)
2764 (default: ``{graphnode}``)
2736
2765
2737 ``log``
2766 ``log``
2738 Template string for commands that print changesets.
2767 Template string for commands that print changesets.
2739
2768
2740 ``mergemarker``
2769 ``mergemarker``
2741 The template used to print the commit description next to each conflict
2770 The template used to print the commit description next to each conflict
2742 marker during merge conflicts. See :hg:`help templates` for the template
2771 marker during merge conflicts. See :hg:`help templates` for the template
2743 format.
2772 format.
2744
2773
2745 Defaults to showing the hash, tags, branches, bookmarks, author, and
2774 Defaults to showing the hash, tags, branches, bookmarks, author, and
2746 the first line of the commit description.
2775 the first line of the commit description.
2747
2776
2748 If you use non-ASCII characters in names for tags, branches, bookmarks,
2777 If you use non-ASCII characters in names for tags, branches, bookmarks,
2749 authors, and/or commit descriptions, you must pay attention to encodings of
2778 authors, and/or commit descriptions, you must pay attention to encodings of
2750 managed files. At template expansion, non-ASCII characters use the encoding
2779 managed files. At template expansion, non-ASCII characters use the encoding
2751 specified by the ``--encoding`` global option, ``HGENCODING`` or other
2780 specified by the ``--encoding`` global option, ``HGENCODING`` or other
2752 environment variables that govern your locale. If the encoding of the merge
2781 environment variables that govern your locale. If the encoding of the merge
2753 markers is different from the encoding of the merged files,
2782 markers is different from the encoding of the merged files,
2754 serious problems may occur.
2783 serious problems may occur.
2755
2784
2756 Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
2785 Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
2757
2786
2758 ``oneline-summary``
2787 ``oneline-summary``
2759 A template used by `hg rebase` and other commands for showing a one-line
2788 A template used by `hg rebase` and other commands for showing a one-line
2760 summary of a commit. If the template configured here is longer than one
2789 summary of a commit. If the template configured here is longer than one
2761 line, then only the first line is used.
2790 line, then only the first line is used.
2762
2791
2763 The template can be overridden per command by defining a template in
2792 The template can be overridden per command by defining a template in
2764 `oneline-summary.<command>`, where `<command>` can be e.g. "rebase".
2793 `oneline-summary.<command>`, where `<command>` can be e.g. "rebase".
2765
2794
2766 ``pre-merge-tool-output``
2795 ``pre-merge-tool-output``
2767 A template that is printed before executing an external merge tool. This can
2796 A template that is printed before executing an external merge tool. This can
2768 be used to print out additional context that might be useful to have during
2797 be used to print out additional context that might be useful to have during
2769 the conflict resolution, such as the description of the various commits
2798 the conflict resolution, such as the description of the various commits
2770 involved or bookmarks/tags.
2799 involved or bookmarks/tags.
2771
2800
2772 Additional information is available in the ``local`, ``base``, and ``other``
2801 Additional information is available in the ``local`, ``base``, and ``other``
2773 dicts. For example: ``{local.label}``, ``{base.name}``, or
2802 dicts. For example: ``{local.label}``, ``{base.name}``, or
2774 ``{other.islink}``.
2803 ``{other.islink}``.
2775
2804
2776
2805
2777 ``web``
2806 ``web``
2778 -------
2807 -------
2779
2808
2780 Web interface configuration. The settings in this section apply to
2809 Web interface configuration. The settings in this section apply to
2781 both the builtin webserver (started by :hg:`serve`) and the script you
2810 both the builtin webserver (started by :hg:`serve`) and the script you
2782 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2811 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2783 and WSGI).
2812 and WSGI).
2784
2813
2785 The Mercurial webserver does no authentication (it does not prompt for
2814 The Mercurial webserver does no authentication (it does not prompt for
2786 usernames and passwords to validate *who* users are), but it does do
2815 usernames and passwords to validate *who* users are), but it does do
2787 authorization (it grants or denies access for *authenticated users*
2816 authorization (it grants or denies access for *authenticated users*
2788 based on settings in this section). You must either configure your
2817 based on settings in this section). You must either configure your
2789 webserver to do authentication for you, or disable the authorization
2818 webserver to do authentication for you, or disable the authorization
2790 checks.
2819 checks.
2791
2820
2792 For a quick setup in a trusted environment, e.g., a private LAN, where
2821 For a quick setup in a trusted environment, e.g., a private LAN, where
2793 you want it to accept pushes from anybody, you can use the following
2822 you want it to accept pushes from anybody, you can use the following
2794 command line::
2823 command line::
2795
2824
2796 $ hg --config web.allow-push=* --config web.push_ssl=False serve
2825 $ hg --config web.allow-push=* --config web.push_ssl=False serve
2797
2826
2798 Note that this will allow anybody to push anything to the server and
2827 Note that this will allow anybody to push anything to the server and
2799 that this should not be used for public servers.
2828 that this should not be used for public servers.
2800
2829
2801 The full set of options is:
2830 The full set of options is:
2802
2831
2803 ``accesslog``
2832 ``accesslog``
2804 Where to output the access log. (default: stdout)
2833 Where to output the access log. (default: stdout)
2805
2834
2806 ``address``
2835 ``address``
2807 Interface address to bind to. (default: all)
2836 Interface address to bind to. (default: all)
2808
2837
2809 ``allow-archive``
2838 ``allow-archive``
2810 List of archive format (bz2, gz, zip) allowed for downloading.
2839 List of archive format (bz2, gz, zip) allowed for downloading.
2811 (default: empty)
2840 (default: empty)
2812
2841
2813 ``allowbz2``
2842 ``allowbz2``
2814 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2843 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2815 revisions.
2844 revisions.
2816 (default: False)
2845 (default: False)
2817
2846
2818 ``allowgz``
2847 ``allowgz``
2819 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2848 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2820 revisions.
2849 revisions.
2821 (default: False)
2850 (default: False)
2822
2851
2823 ``allow-pull``
2852 ``allow-pull``
2824 Whether to allow pulling from the repository. (default: True)
2853 Whether to allow pulling from the repository. (default: True)
2825
2854
2826 ``allow-push``
2855 ``allow-push``
2827 Whether to allow pushing to the repository. If empty or not set,
2856 Whether to allow pushing to the repository. If empty or not set,
2828 pushing is not allowed. If the special value ``*``, any remote
2857 pushing is not allowed. If the special value ``*``, any remote
2829 user can push, including unauthenticated users. Otherwise, the
2858 user can push, including unauthenticated users. Otherwise, the
2830 remote user must have been authenticated, and the authenticated
2859 remote user must have been authenticated, and the authenticated
2831 user name must be present in this list. The contents of the
2860 user name must be present in this list. The contents of the
2832 allow-push list are examined after the deny_push list.
2861 allow-push list are examined after the deny_push list.
2833
2862
2834 ``allow_read``
2863 ``allow_read``
2835 If the user has not already been denied repository access due to
2864 If the user has not already been denied repository access due to
2836 the contents of deny_read, this list determines whether to grant
2865 the contents of deny_read, this list determines whether to grant
2837 repository access to the user. If this list is not empty, and the
2866 repository access to the user. If this list is not empty, and the
2838 user is unauthenticated or not present in the list, then access is
2867 user is unauthenticated or not present in the list, then access is
2839 denied for the user. If the list is empty or not set, then access
2868 denied for the user. If the list is empty or not set, then access
2840 is permitted to all users by default. Setting allow_read to the
2869 is permitted to all users by default. Setting allow_read to the
2841 special value ``*`` is equivalent to it not being set (i.e. access
2870 special value ``*`` is equivalent to it not being set (i.e. access
2842 is permitted to all users). The contents of the allow_read list are
2871 is permitted to all users). The contents of the allow_read list are
2843 examined after the deny_read list.
2872 examined after the deny_read list.
2844
2873
2845 ``allowzip``
2874 ``allowzip``
2846 (DEPRECATED) Whether to allow .zip downloading of repository
2875 (DEPRECATED) Whether to allow .zip downloading of repository
2847 revisions. This feature creates temporary files.
2876 revisions. This feature creates temporary files.
2848 (default: False)
2877 (default: False)
2849
2878
2850 ``archivesubrepos``
2879 ``archivesubrepos``
2851 Whether to recurse into subrepositories when archiving.
2880 Whether to recurse into subrepositories when archiving.
2852 (default: False)
2881 (default: False)
2853
2882
2854 ``baseurl``
2883 ``baseurl``
2855 Base URL to use when publishing URLs in other locations, so
2884 Base URL to use when publishing URLs in other locations, so
2856 third-party tools like email notification hooks can construct
2885 third-party tools like email notification hooks can construct
2857 URLs. Example: ``http://hgserver/repos/``.
2886 URLs. Example: ``http://hgserver/repos/``.
2858
2887
2859 ``cacerts``
2888 ``cacerts``
2860 Path to file containing a list of PEM encoded certificate
2889 Path to file containing a list of PEM encoded certificate
2861 authority certificates. Environment variables and ``~user``
2890 authority certificates. Environment variables and ``~user``
2862 constructs are expanded in the filename. If specified on the
2891 constructs are expanded in the filename. If specified on the
2863 client, then it will verify the identity of remote HTTPS servers
2892 client, then it will verify the identity of remote HTTPS servers
2864 with these certificates.
2893 with these certificates.
2865
2894
2866 To disable SSL verification temporarily, specify ``--insecure`` from
2895 To disable SSL verification temporarily, specify ``--insecure`` from
2867 command line.
2896 command line.
2868
2897
2869 You can use OpenSSL's CA certificate file if your platform has
2898 You can use OpenSSL's CA certificate file if your platform has
2870 one. On most Linux systems this will be
2899 one. On most Linux systems this will be
2871 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2900 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2872 generate this file manually. The form must be as follows::
2901 generate this file manually. The form must be as follows::
2873
2902
2874 -----BEGIN CERTIFICATE-----
2903 -----BEGIN CERTIFICATE-----
2875 ... (certificate in base64 PEM encoding) ...
2904 ... (certificate in base64 PEM encoding) ...
2876 -----END CERTIFICATE-----
2905 -----END CERTIFICATE-----
2877 -----BEGIN CERTIFICATE-----
2906 -----BEGIN CERTIFICATE-----
2878 ... (certificate in base64 PEM encoding) ...
2907 ... (certificate in base64 PEM encoding) ...
2879 -----END CERTIFICATE-----
2908 -----END CERTIFICATE-----
2880
2909
2881 ``cache``
2910 ``cache``
2882 Whether to support caching in hgweb. (default: True)
2911 Whether to support caching in hgweb. (default: True)
2883
2912
2884 ``certificate``
2913 ``certificate``
2885 Certificate to use when running :hg:`serve`.
2914 Certificate to use when running :hg:`serve`.
2886
2915
2887 ``collapse``
2916 ``collapse``
2888 With ``descend`` enabled, repositories in subdirectories are shown at
2917 With ``descend`` enabled, repositories in subdirectories are shown at
2889 a single level alongside repositories in the current path. With
2918 a single level alongside repositories in the current path. With
2890 ``collapse`` also enabled, repositories residing at a deeper level than
2919 ``collapse`` also enabled, repositories residing at a deeper level than
2891 the current path are grouped behind navigable directory entries that
2920 the current path are grouped behind navigable directory entries that
2892 lead to the locations of these repositories. In effect, this setting
2921 lead to the locations of these repositories. In effect, this setting
2893 collapses each collection of repositories found within a subdirectory
2922 collapses each collection of repositories found within a subdirectory
2894 into a single entry for that subdirectory. (default: False)
2923 into a single entry for that subdirectory. (default: False)
2895
2924
2896 ``comparisoncontext``
2925 ``comparisoncontext``
2897 Number of lines of context to show in side-by-side file comparison. If
2926 Number of lines of context to show in side-by-side file comparison. If
2898 negative or the value ``full``, whole files are shown. (default: 5)
2927 negative or the value ``full``, whole files are shown. (default: 5)
2899
2928
2900 This setting can be overridden by a ``context`` request parameter to the
2929 This setting can be overridden by a ``context`` request parameter to the
2901 ``comparison`` command, taking the same values.
2930 ``comparison`` command, taking the same values.
2902
2931
2903 ``contact``
2932 ``contact``
2904 Name or email address of the person in charge of the repository.
2933 Name or email address of the person in charge of the repository.
2905 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2934 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2906
2935
2907 ``csp``
2936 ``csp``
2908 Send a ``Content-Security-Policy`` HTTP header with this value.
2937 Send a ``Content-Security-Policy`` HTTP header with this value.
2909
2938
2910 The value may contain a special string ``%nonce%``, which will be replaced
2939 The value may contain a special string ``%nonce%``, which will be replaced
2911 by a randomly-generated one-time use value. If the value contains
2940 by a randomly-generated one-time use value. If the value contains
2912 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2941 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2913 one-time property of the nonce. This nonce will also be inserted into
2942 one-time property of the nonce. This nonce will also be inserted into
2914 ``<script>`` elements containing inline JavaScript.
2943 ``<script>`` elements containing inline JavaScript.
2915
2944
2916 Note: lots of HTML content sent by the server is derived from repository
2945 Note: lots of HTML content sent by the server is derived from repository
2917 data. Please consider the potential for malicious repository data to
2946 data. Please consider the potential for malicious repository data to
2918 "inject" itself into generated HTML content as part of your security
2947 "inject" itself into generated HTML content as part of your security
2919 threat model.
2948 threat model.
2920
2949
2921 ``deny_push``
2950 ``deny_push``
2922 Whether to deny pushing to the repository. If empty or not set,
2951 Whether to deny pushing to the repository. If empty or not set,
2923 push is not denied. If the special value ``*``, all remote users are
2952 push is not denied. If the special value ``*``, all remote users are
2924 denied push. Otherwise, unauthenticated users are all denied, and
2953 denied push. Otherwise, unauthenticated users are all denied, and
2925 any authenticated user name present in this list is also denied. The
2954 any authenticated user name present in this list is also denied. The
2926 contents of the deny_push list are examined before the allow-push list.
2955 contents of the deny_push list are examined before the allow-push list.
2927
2956
2928 ``deny_read``
2957 ``deny_read``
2929 Whether to deny reading/viewing of the repository. If this list is
2958 Whether to deny reading/viewing of the repository. If this list is
2930 not empty, unauthenticated users are all denied, and any
2959 not empty, unauthenticated users are all denied, and any
2931 authenticated user name present in this list is also denied access to
2960 authenticated user name present in this list is also denied access to
2932 the repository. If set to the special value ``*``, all remote users
2961 the repository. If set to the special value ``*``, all remote users
2933 are denied access (rarely needed ;). If deny_read is empty or not set,
2962 are denied access (rarely needed ;). If deny_read is empty or not set,
2934 the determination of repository access depends on the presence and
2963 the determination of repository access depends on the presence and
2935 content of the allow_read list (see description). If both
2964 content of the allow_read list (see description). If both
2936 deny_read and allow_read are empty or not set, then access is
2965 deny_read and allow_read are empty or not set, then access is
2937 permitted to all users by default. If the repository is being
2966 permitted to all users by default. If the repository is being
2938 served via hgwebdir, denied users will not be able to see it in
2967 served via hgwebdir, denied users will not be able to see it in
2939 the list of repositories. The contents of the deny_read list have
2968 the list of repositories. The contents of the deny_read list have
2940 priority over (are examined before) the contents of the allow_read
2969 priority over (are examined before) the contents of the allow_read
2941 list.
2970 list.
2942
2971
2943 ``descend``
2972 ``descend``
2944 hgwebdir indexes will not descend into subdirectories. Only repositories
2973 hgwebdir indexes will not descend into subdirectories. Only repositories
2945 directly in the current path will be shown (other repositories are still
2974 directly in the current path will be shown (other repositories are still
2946 available from the index corresponding to their containing path).
2975 available from the index corresponding to their containing path).
2947
2976
2948 ``description``
2977 ``description``
2949 Textual description of the repository's purpose or contents.
2978 Textual description of the repository's purpose or contents.
2950 (default: "unknown")
2979 (default: "unknown")
2951
2980
2952 ``encoding``
2981 ``encoding``
2953 Character encoding name. (default: the current locale charset)
2982 Character encoding name. (default: the current locale charset)
2954 Example: "UTF-8".
2983 Example: "UTF-8".
2955
2984
2956 ``errorlog``
2985 ``errorlog``
2957 Where to output the error log. (default: stderr)
2986 Where to output the error log. (default: stderr)
2958
2987
2959 ``guessmime``
2988 ``guessmime``
2960 Control MIME types for raw download of file content.
2989 Control MIME types for raw download of file content.
2961 Set to True to let hgweb guess the content type from the file
2990 Set to True to let hgweb guess the content type from the file
2962 extension. This will serve HTML files as ``text/html`` and might
2991 extension. This will serve HTML files as ``text/html`` and might
2963 allow cross-site scripting attacks when serving untrusted
2992 allow cross-site scripting attacks when serving untrusted
2964 repositories. (default: False)
2993 repositories. (default: False)
2965
2994
2966 ``hidden``
2995 ``hidden``
2967 Whether to hide the repository in the hgwebdir index.
2996 Whether to hide the repository in the hgwebdir index.
2968 (default: False)
2997 (default: False)
2969
2998
2970 ``ipv6``
2999 ``ipv6``
2971 Whether to use IPv6. (default: False)
3000 Whether to use IPv6. (default: False)
2972
3001
2973 ``labels``
3002 ``labels``
2974 List of string *labels* associated with the repository.
3003 List of string *labels* associated with the repository.
2975
3004
2976 Labels are exposed as a template keyword and can be used to customize
3005 Labels are exposed as a template keyword and can be used to customize
2977 output. e.g. the ``index`` template can group or filter repositories
3006 output. e.g. the ``index`` template can group or filter repositories
2978 by labels and the ``summary`` template can display additional content
3007 by labels and the ``summary`` template can display additional content
2979 if a specific label is present.
3008 if a specific label is present.
2980
3009
2981 ``logoimg``
3010 ``logoimg``
2982 File name of the logo image that some templates display on each page.
3011 File name of the logo image that some templates display on each page.
2983 The file name is relative to ``staticurl``. That is, the full path to
3012 The file name is relative to ``staticurl``. That is, the full path to
2984 the logo image is "staticurl/logoimg".
3013 the logo image is "staticurl/logoimg".
2985 If unset, ``hglogo.png`` will be used.
3014 If unset, ``hglogo.png`` will be used.
2986
3015
2987 ``logourl``
3016 ``logourl``
2988 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
3017 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2989 will be used.
3018 will be used.
2990
3019
2991 ``maxchanges``
3020 ``maxchanges``
2992 Maximum number of changes to list on the changelog. (default: 10)
3021 Maximum number of changes to list on the changelog. (default: 10)
2993
3022
2994 ``maxfiles``
3023 ``maxfiles``
2995 Maximum number of files to list per changeset. (default: 10)
3024 Maximum number of files to list per changeset. (default: 10)
2996
3025
2997 ``maxshortchanges``
3026 ``maxshortchanges``
2998 Maximum number of changes to list on the shortlog, graph or filelog
3027 Maximum number of changes to list on the shortlog, graph or filelog
2999 pages. (default: 60)
3028 pages. (default: 60)
3000
3029
3001 ``name``
3030 ``name``
3002 Repository name to use in the web interface.
3031 Repository name to use in the web interface.
3003 (default: current working directory)
3032 (default: current working directory)
3004
3033
3005 ``port``
3034 ``port``
3006 Port to listen on. (default: 8000)
3035 Port to listen on. (default: 8000)
3007
3036
3008 ``prefix``
3037 ``prefix``
3009 Prefix path to serve from. (default: '' (server root))
3038 Prefix path to serve from. (default: '' (server root))
3010
3039
3011 ``push_ssl``
3040 ``push_ssl``
3012 Whether to require that inbound pushes be transported over SSL to
3041 Whether to require that inbound pushes be transported over SSL to
3013 prevent password sniffing. (default: True)
3042 prevent password sniffing. (default: True)
3014
3043
3015 ``refreshinterval``
3044 ``refreshinterval``
3016 How frequently directory listings re-scan the filesystem for new
3045 How frequently directory listings re-scan the filesystem for new
3017 repositories, in seconds. This is relevant when wildcards are used
3046 repositories, in seconds. This is relevant when wildcards are used
3018 to define paths. Depending on how much filesystem traversal is
3047 to define paths. Depending on how much filesystem traversal is
3019 required, refreshing may negatively impact performance.
3048 required, refreshing may negatively impact performance.
3020
3049
3021 Values less than or equal to 0 always refresh.
3050 Values less than or equal to 0 always refresh.
3022 (default: 20)
3051 (default: 20)
3023
3052
3024 ``server-header``
3053 ``server-header``
3025 Value for HTTP ``Server`` response header.
3054 Value for HTTP ``Server`` response header.
3026
3055
3027 ``static``
3056 ``static``
3028 Directory where static files are served from.
3057 Directory where static files are served from.
3029
3058
3030 ``staticurl``
3059 ``staticurl``
3031 Base URL to use for static files. If unset, static files (e.g. the
3060 Base URL to use for static files. If unset, static files (e.g. the
3032 hgicon.png favicon) will be served by the CGI script itself. Use
3061 hgicon.png favicon) will be served by the CGI script itself. Use
3033 this setting to serve them directly with the HTTP server.
3062 this setting to serve them directly with the HTTP server.
3034 Example: ``http://hgserver/static/``.
3063 Example: ``http://hgserver/static/``.
3035
3064
3036 ``stripes``
3065 ``stripes``
3037 How many lines a "zebra stripe" should span in multi-line output.
3066 How many lines a "zebra stripe" should span in multi-line output.
3038 Set to 0 to disable. (default: 1)
3067 Set to 0 to disable. (default: 1)
3039
3068
3040 ``style``
3069 ``style``
3041 Which template map style to use. The available options are the names of
3070 Which template map style to use. The available options are the names of
3042 subdirectories in the HTML templates path. (default: ``paper``)
3071 subdirectories in the HTML templates path. (default: ``paper``)
3043 Example: ``monoblue``.
3072 Example: ``monoblue``.
3044
3073
3045 ``templates``
3074 ``templates``
3046 Where to find the HTML templates. The default path to the HTML templates
3075 Where to find the HTML templates. The default path to the HTML templates
3047 can be obtained from ``hg debuginstall``.
3076 can be obtained from ``hg debuginstall``.
3048
3077
3049 ``websub``
3078 ``websub``
3050 ----------
3079 ----------
3051
3080
3052 Web substitution filter definition. You can use this section to
3081 Web substitution filter definition. You can use this section to
3053 define a set of regular expression substitution patterns which
3082 define a set of regular expression substitution patterns which
3054 let you automatically modify the hgweb server output.
3083 let you automatically modify the hgweb server output.
3055
3084
3056 The default hgweb templates only apply these substitution patterns
3085 The default hgweb templates only apply these substitution patterns
3057 on the revision description fields. You can apply them anywhere
3086 on the revision description fields. You can apply them anywhere
3058 you want when you create your own templates by adding calls to the
3087 you want when you create your own templates by adding calls to the
3059 "websub" filter (usually after calling the "escape" filter).
3088 "websub" filter (usually after calling the "escape" filter).
3060
3089
3061 This can be used, for example, to convert issue references to links
3090 This can be used, for example, to convert issue references to links
3062 to your issue tracker, or to convert "markdown-like" syntax into
3091 to your issue tracker, or to convert "markdown-like" syntax into
3063 HTML (see the examples below).
3092 HTML (see the examples below).
3064
3093
3065 Each entry in this section names a substitution filter.
3094 Each entry in this section names a substitution filter.
3066 The value of each entry defines the substitution expression itself.
3095 The value of each entry defines the substitution expression itself.
3067 The websub expressions follow the old interhg extension syntax,
3096 The websub expressions follow the old interhg extension syntax,
3068 which in turn imitates the Unix sed replacement syntax::
3097 which in turn imitates the Unix sed replacement syntax::
3069
3098
3070 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
3099 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
3071
3100
3072 You can use any separator other than "/". The final "i" is optional
3101 You can use any separator other than "/". The final "i" is optional
3073 and indicates that the search must be case insensitive.
3102 and indicates that the search must be case insensitive.
3074
3103
3075 Examples::
3104 Examples::
3076
3105
3077 [websub]
3106 [websub]
3078 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
3107 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
3079 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
3108 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
3080 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
3109 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
3081
3110
3082 ``worker``
3111 ``worker``
3083 ----------
3112 ----------
3084
3113
3085 Parallel master/worker configuration. We currently perform working
3114 Parallel master/worker configuration. We currently perform working
3086 directory updates in parallel on Unix-like systems, which greatly
3115 directory updates in parallel on Unix-like systems, which greatly
3087 helps performance.
3116 helps performance.
3088
3117
3089 ``enabled``
3118 ``enabled``
3090 Whether to enable workers code to be used.
3119 Whether to enable workers code to be used.
3091 (default: true)
3120 (default: true)
3092
3121
3093 ``numcpus``
3122 ``numcpus``
3094 Number of CPUs to use for parallel operations. A zero or
3123 Number of CPUs to use for parallel operations. A zero or
3095 negative value is treated as ``use the default``.
3124 negative value is treated as ``use the default``.
3096 (default: 4 or the number of CPUs on the system, whichever is larger)
3125 (default: 4 or the number of CPUs on the system, whichever is larger)
3097
3126
3098 ``backgroundclose``
3127 ``backgroundclose``
3099 Whether to enable closing file handles on background threads during certain
3128 Whether to enable closing file handles on background threads during certain
3100 operations. Some platforms aren't very efficient at closing file
3129 operations. Some platforms aren't very efficient at closing file
3101 handles that have been written or appended to. By performing file closing
3130 handles that have been written or appended to. By performing file closing
3102 on background threads, file write rate can increase substantially.
3131 on background threads, file write rate can increase substantially.
3103 (default: true on Windows, false elsewhere)
3132 (default: true on Windows, false elsewhere)
3104
3133
3105 ``backgroundcloseminfilecount``
3134 ``backgroundcloseminfilecount``
3106 Minimum number of files required to trigger background file closing.
3135 Minimum number of files required to trigger background file closing.
3107 Operations not writing this many files won't start background close
3136 Operations not writing this many files won't start background close
3108 threads.
3137 threads.
3109 (default: 2048)
3138 (default: 2048)
3110
3139
3111 ``backgroundclosemaxqueue``
3140 ``backgroundclosemaxqueue``
3112 The maximum number of opened file handles waiting to be closed in the
3141 The maximum number of opened file handles waiting to be closed in the
3113 background. This option only has an effect if ``backgroundclose`` is
3142 background. This option only has an effect if ``backgroundclose`` is
3114 enabled.
3143 enabled.
3115 (default: 384)
3144 (default: 384)
3116
3145
3117 ``backgroundclosethreadcount``
3146 ``backgroundclosethreadcount``
3118 Number of threads to process background file closes. Only relevant if
3147 Number of threads to process background file closes. Only relevant if
3119 ``backgroundclose`` is enabled.
3148 ``backgroundclose`` is enabled.
3120 (default: 4)
3149 (default: 4)
General Comments 0
You need to be logged in to leave comments. Login now