##// END OF EJS Templates
doc: improves the share-safe documentation...
marmoute -
r47075:60e6bf3b stable
parent child Browse files
Show More
@@ -1,3041 +1,3060 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 --debug` can help you understand what is introducing
8 :hg:`config --debug` 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 ``use-persistent-nodemap``
895 ``use-persistent-nodemap``
896 Enable or disable the "persistent-nodemap" feature which improves
896 Enable or disable the "persistent-nodemap" feature which improves
897 performance if the rust extensions are available.
897 performance if the rust extensions are available.
898
898
899 The "persistence-nodemap" persist the "node -> rev" on disk removing the
899 The "persistence-nodemap" persist the "node -> rev" on disk removing the
900 need to dynamically build that mapping for each Mercurial invocation. This
900 need to dynamically build that mapping for each Mercurial invocation. This
901 significantly reduce the startup cost of various local and server-side
901 significantly reduce the startup cost of various local and server-side
902 operation for larger repository.
902 operation for larger repository.
903
903
904 The performance improving version of this feature is currently only
904 The performance improving version of this feature is currently only
905 implemented in Rust, so people not using a version of Mercurial compiled
905 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,
906 with the Rust part might actually suffer some slowdown. For this reason,
907 Such version will by default refuse to access such repositories. That
907 Such version will by default refuse to access such repositories. That
908 behavior can be controlled by configuration. Check
908 behavior can be controlled by configuration. Check
909 :hg:`help config.storage.revlog.persistent-nodemap.slowpath` for details.
909 :hg:`help config.storage.revlog.persistent-nodemap.slowpath` for details.
910
910
911 Repository with this on-disk format require Mercurial version 5.4 or above.
911 Repository with this on-disk format require Mercurial version 5.4 or above.
912
912
913 Disabled by default.
913 Disabled by default.
914
914
915 ``use-share-safe``
915 ``use-share-safe``
916 Enable or disable the "share-safe" functionality, which enables shares
916 Enforce "safe" behaviors for all "shares" that access this repository.
917 to read requirements and configuration of its source repository.
917
918 With this feature, "shares" using this repository as a source will:
919
920 * read the source repository's configuration (`<source>/.hg/hgrc`).
921 * read and use the source repository's "requirements"
922 (except the working copy specific one).
923
924 Without this feature, "shares" using this repository as a source will:
925
926 * keep tracking the repository "requirements" in the share only, ignoring
927 the source "requirements", possibly diverging from them.
928 * ignore source repository config. This can create problems, like silently
929 ignoring important hooks.
930
931 Beware that existing shares will not be upgraded/downgraded, and by
932 default, Mercurial will refuse to interact with them until the mismatch
933 is resolved. See :hg:`help config share.safe-mismatch.source-safe` and
934 :hg:`help config share.safe-mismatch.source-not-safe` for details.
935
936 Introduced in Mercurial 5.7.
918
937
919 Disabled by default.
938 Disabled by default.
920
939
921 ``usestore``
940 ``usestore``
922 Enable or disable the "store" repository format which improves
941 Enable or disable the "store" repository format which improves
923 compatibility with systems that fold case or otherwise mangle
942 compatibility with systems that fold case or otherwise mangle
924 filenames. Disabling this option will allow you to store longer filenames
943 filenames. Disabling this option will allow you to store longer filenames
925 in some situations at the expense of compatibility.
944 in some situations at the expense of compatibility.
926
945
927 Repositories with this on-disk format require Mercurial version 0.9.4.
946 Repositories with this on-disk format require Mercurial version 0.9.4.
928
947
929 Enabled by default.
948 Enabled by default.
930
949
931 ``sparse-revlog``
950 ``sparse-revlog``
932 Enable or disable the ``sparse-revlog`` delta strategy. This format improves
951 Enable or disable the ``sparse-revlog`` delta strategy. This format improves
933 delta re-use inside revlog. For very branchy repositories, it results in a
952 delta re-use inside revlog. For very branchy repositories, it results in a
934 smaller store. For repositories with many revisions, it also helps
953 smaller store. For repositories with many revisions, it also helps
935 performance (by using shortened delta chains.)
954 performance (by using shortened delta chains.)
936
955
937 Repositories with this on-disk format require Mercurial version 4.7
956 Repositories with this on-disk format require Mercurial version 4.7
938
957
939 Enabled by default.
958 Enabled by default.
940
959
941 ``revlog-compression``
960 ``revlog-compression``
942 Compression algorithm used by revlog. Supported values are `zlib` and
961 Compression algorithm used by revlog. Supported values are `zlib` and
943 `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is
962 `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is
944 a newer format that is usually a net win over `zlib`, operating faster at
963 a newer format that is usually a net win over `zlib`, operating faster at
945 better compression rates. Use `zstd` to reduce CPU usage. Multiple values
964 better compression rates. Use `zstd` to reduce CPU usage. Multiple values
946 can be specified, the first available one will be used.
965 can be specified, the first available one will be used.
947
966
948 On some systems, the Mercurial installation may lack `zstd` support.
967 On some systems, the Mercurial installation may lack `zstd` support.
949
968
950 Default is `zlib`.
969 Default is `zlib`.
951
970
952 ``bookmarks-in-store``
971 ``bookmarks-in-store``
953 Store bookmarks in .hg/store/. This means that bookmarks are shared when
972 Store bookmarks in .hg/store/. This means that bookmarks are shared when
954 using `hg share` regardless of the `-B` option.
973 using `hg share` regardless of the `-B` option.
955
974
956 Repositories with this on-disk format require Mercurial version 5.1.
975 Repositories with this on-disk format require Mercurial version 5.1.
957
976
958 Disabled by default.
977 Disabled by default.
959
978
960
979
961 ``graph``
980 ``graph``
962 ---------
981 ---------
963
982
964 Web graph view configuration. This section let you change graph
983 Web graph view configuration. This section let you change graph
965 elements display properties by branches, for instance to make the
984 elements display properties by branches, for instance to make the
966 ``default`` branch stand out.
985 ``default`` branch stand out.
967
986
968 Each line has the following format::
987 Each line has the following format::
969
988
970 <branch>.<argument> = <value>
989 <branch>.<argument> = <value>
971
990
972 where ``<branch>`` is the name of the branch being
991 where ``<branch>`` is the name of the branch being
973 customized. Example::
992 customized. Example::
974
993
975 [graph]
994 [graph]
976 # 2px width
995 # 2px width
977 default.width = 2
996 default.width = 2
978 # red color
997 # red color
979 default.color = FF0000
998 default.color = FF0000
980
999
981 Supported arguments:
1000 Supported arguments:
982
1001
983 ``width``
1002 ``width``
984 Set branch edges width in pixels.
1003 Set branch edges width in pixels.
985
1004
986 ``color``
1005 ``color``
987 Set branch edges color in hexadecimal RGB notation.
1006 Set branch edges color in hexadecimal RGB notation.
988
1007
989 ``hooks``
1008 ``hooks``
990 ---------
1009 ---------
991
1010
992 Commands or Python functions that get automatically executed by
1011 Commands or Python functions that get automatically executed by
993 various actions such as starting or finishing a commit. Multiple
1012 various actions such as starting or finishing a commit. Multiple
994 hooks can be run for the same action by appending a suffix to the
1013 hooks can be run for the same action by appending a suffix to the
995 action. Overriding a site-wide hook can be done by changing its
1014 action. Overriding a site-wide hook can be done by changing its
996 value or setting it to an empty string. Hooks can be prioritized
1015 value or setting it to an empty string. Hooks can be prioritized
997 by adding a prefix of ``priority.`` to the hook name on a new line
1016 by adding a prefix of ``priority.`` to the hook name on a new line
998 and setting the priority. The default priority is 0.
1017 and setting the priority. The default priority is 0.
999
1018
1000 Example ``.hg/hgrc``::
1019 Example ``.hg/hgrc``::
1001
1020
1002 [hooks]
1021 [hooks]
1003 # update working directory after adding changesets
1022 # update working directory after adding changesets
1004 changegroup.update = hg update
1023 changegroup.update = hg update
1005 # do not use the site-wide hook
1024 # do not use the site-wide hook
1006 incoming =
1025 incoming =
1007 incoming.email = /my/email/hook
1026 incoming.email = /my/email/hook
1008 incoming.autobuild = /my/build/hook
1027 incoming.autobuild = /my/build/hook
1009 # force autobuild hook to run before other incoming hooks
1028 # force autobuild hook to run before other incoming hooks
1010 priority.incoming.autobuild = 1
1029 priority.incoming.autobuild = 1
1011
1030
1012 Most hooks are run with environment variables set that give useful
1031 Most hooks are run with environment variables set that give useful
1013 additional information. For each hook below, the environment variables
1032 additional information. For each hook below, the environment variables
1014 it is passed are listed with names in the form ``$HG_foo``. The
1033 it is passed are listed with names in the form ``$HG_foo``. The
1015 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
1034 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
1016 They contain the type of hook which triggered the run and the full name
1035 They contain the type of hook which triggered the run and the full name
1017 of the hook in the config, respectively. In the example above, this will
1036 of the hook in the config, respectively. In the example above, this will
1018 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
1037 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
1019
1038
1020 .. container:: windows
1039 .. container:: windows
1021
1040
1022 Some basic Unix syntax can be enabled for portability, including ``$VAR``
1041 Some basic Unix syntax can be enabled for portability, including ``$VAR``
1023 and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will
1042 and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will
1024 be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
1043 be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
1025 on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back
1044 on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back
1026 slash or inside of a strong quote. Strong quotes will be replaced by
1045 slash or inside of a strong quote. Strong quotes will be replaced by
1027 double quotes after processing.
1046 double quotes after processing.
1028
1047
1029 This feature is enabled by adding a prefix of ``tonative.`` to the hook
1048 This feature is enabled by adding a prefix of ``tonative.`` to the hook
1030 name on a new line, and setting it to ``True``. For example::
1049 name on a new line, and setting it to ``True``. For example::
1031
1050
1032 [hooks]
1051 [hooks]
1033 incoming.autobuild = /my/build/hook
1052 incoming.autobuild = /my/build/hook
1034 # enable translation to cmd.exe syntax for autobuild hook
1053 # enable translation to cmd.exe syntax for autobuild hook
1035 tonative.incoming.autobuild = True
1054 tonative.incoming.autobuild = True
1036
1055
1037 ``changegroup``
1056 ``changegroup``
1038 Run after a changegroup has been added via push, pull or unbundle. The ID of
1057 Run after a changegroup has been added via push, pull or unbundle. The ID of
1039 the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
1058 the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
1040 The URL from which changes came is in ``$HG_URL``.
1059 The URL from which changes came is in ``$HG_URL``.
1041
1060
1042 ``commit``
1061 ``commit``
1043 Run after a changeset has been created in the local repository. The ID
1062 Run after a changeset has been created in the local repository. The ID
1044 of the newly created changeset is in ``$HG_NODE``. Parent changeset
1063 of the newly created changeset is in ``$HG_NODE``. Parent changeset
1045 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1064 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1046
1065
1047 ``incoming``
1066 ``incoming``
1048 Run after a changeset has been pulled, pushed, or unbundled into
1067 Run after a changeset has been pulled, pushed, or unbundled into
1049 the local repository. The ID of the newly arrived changeset is in
1068 the local repository. The ID of the newly arrived changeset is in
1050 ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
1069 ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
1051
1070
1052 ``outgoing``
1071 ``outgoing``
1053 Run after sending changes from the local repository to another. The ID of
1072 Run after sending changes from the local repository to another. The ID of
1054 first changeset sent is in ``$HG_NODE``. The source of operation is in
1073 first changeset sent is in ``$HG_NODE``. The source of operation is in
1055 ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
1074 ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
1056
1075
1057 ``post-<command>``
1076 ``post-<command>``
1058 Run after successful invocations of the associated command. The
1077 Run after successful invocations of the associated command. The
1059 contents of the command line are passed as ``$HG_ARGS`` and the result
1078 contents of the command line are passed as ``$HG_ARGS`` and the result
1060 code in ``$HG_RESULT``. Parsed command line arguments are passed as
1079 code in ``$HG_RESULT``. Parsed command line arguments are passed as
1061 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
1080 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
1062 the python data internally passed to <command>. ``$HG_OPTS`` is a
1081 the python data internally passed to <command>. ``$HG_OPTS`` is a
1063 dictionary of options (with unspecified options set to their defaults).
1082 dictionary of options (with unspecified options set to their defaults).
1064 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
1083 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
1065
1084
1066 ``fail-<command>``
1085 ``fail-<command>``
1067 Run after a failed invocation of an associated command. The contents
1086 Run after a failed invocation of an associated command. The contents
1068 of the command line are passed as ``$HG_ARGS``. Parsed command line
1087 of the command line are passed as ``$HG_ARGS``. Parsed command line
1069 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
1088 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
1070 string representations of the python data internally passed to
1089 string representations of the python data internally passed to
1071 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
1090 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
1072 options set to their defaults). ``$HG_PATS`` is a list of arguments.
1091 options set to their defaults). ``$HG_PATS`` is a list of arguments.
1073 Hook failure is ignored.
1092 Hook failure is ignored.
1074
1093
1075 ``pre-<command>``
1094 ``pre-<command>``
1076 Run before executing the associated command. The contents of the
1095 Run before executing the associated command. The contents of the
1077 command line are passed as ``$HG_ARGS``. Parsed command line arguments
1096 command line are passed as ``$HG_ARGS``. Parsed command line arguments
1078 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
1097 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
1079 representations of the data internally passed to <command>. ``$HG_OPTS``
1098 representations of the data internally passed to <command>. ``$HG_OPTS``
1080 is a dictionary of options (with unspecified options set to their
1099 is a dictionary of options (with unspecified options set to their
1081 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
1100 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
1082 failure, the command doesn't execute and Mercurial returns the failure
1101 failure, the command doesn't execute and Mercurial returns the failure
1083 code.
1102 code.
1084
1103
1085 ``prechangegroup``
1104 ``prechangegroup``
1086 Run before a changegroup is added via push, pull or unbundle. Exit
1105 Run before a changegroup is added via push, pull or unbundle. Exit
1087 status 0 allows the changegroup to proceed. A non-zero status will
1106 status 0 allows the changegroup to proceed. A non-zero status will
1088 cause the push, pull or unbundle to fail. The URL from which changes
1107 cause the push, pull or unbundle to fail. The URL from which changes
1089 will come is in ``$HG_URL``.
1108 will come is in ``$HG_URL``.
1090
1109
1091 ``precommit``
1110 ``precommit``
1092 Run before starting a local commit. Exit status 0 allows the
1111 Run before starting a local commit. Exit status 0 allows the
1093 commit to proceed. A non-zero status will cause the commit to fail.
1112 commit to proceed. A non-zero status will cause the commit to fail.
1094 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1113 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1095
1114
1096 ``prelistkeys``
1115 ``prelistkeys``
1097 Run before listing pushkeys (like bookmarks) in the
1116 Run before listing pushkeys (like bookmarks) in the
1098 repository. A non-zero status will cause failure. The key namespace is
1117 repository. A non-zero status will cause failure. The key namespace is
1099 in ``$HG_NAMESPACE``.
1118 in ``$HG_NAMESPACE``.
1100
1119
1101 ``preoutgoing``
1120 ``preoutgoing``
1102 Run before collecting changes to send from the local repository to
1121 Run before collecting changes to send from the local repository to
1103 another. A non-zero status will cause failure. This lets you prevent
1122 another. A non-zero status will cause failure. This lets you prevent
1104 pull over HTTP or SSH. It can also prevent propagating commits (via
1123 pull over HTTP or SSH. It can also prevent propagating commits (via
1105 local pull, push (outbound) or bundle commands), but not completely,
1124 local pull, push (outbound) or bundle commands), but not completely,
1106 since you can just copy files instead. The source of operation is in
1125 since you can just copy files instead. The source of operation is in
1107 ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
1126 ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
1108 SSH or HTTP repository. If "push", "pull" or "bundle", the operation
1127 SSH or HTTP repository. If "push", "pull" or "bundle", the operation
1109 is happening on behalf of a repository on same system.
1128 is happening on behalf of a repository on same system.
1110
1129
1111 ``prepushkey``
1130 ``prepushkey``
1112 Run before a pushkey (like a bookmark) is added to the
1131 Run before a pushkey (like a bookmark) is added to the
1113 repository. A non-zero status will cause the key to be rejected. The
1132 repository. A non-zero status will cause the key to be rejected. The
1114 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
1133 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
1115 the old value (if any) is in ``$HG_OLD``, and the new value is in
1134 the old value (if any) is in ``$HG_OLD``, and the new value is in
1116 ``$HG_NEW``.
1135 ``$HG_NEW``.
1117
1136
1118 ``pretag``
1137 ``pretag``
1119 Run before creating a tag. Exit status 0 allows the tag to be
1138 Run before creating a tag. Exit status 0 allows the tag to be
1120 created. A non-zero status will cause the tag to fail. The ID of the
1139 created. A non-zero status will cause the tag to fail. The ID of the
1121 changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
1140 changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
1122 tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
1141 tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
1123
1142
1124 ``pretxnopen``
1143 ``pretxnopen``
1125 Run before any new repository transaction is open. The reason for the
1144 Run before any new repository transaction is open. The reason for the
1126 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
1145 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
1127 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
1146 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
1128 transaction from being opened.
1147 transaction from being opened.
1129
1148
1130 ``pretxnclose``
1149 ``pretxnclose``
1131 Run right before the transaction is actually finalized. Any repository change
1150 Run right before the transaction is actually finalized. Any repository change
1132 will be visible to the hook program. This lets you validate the transaction
1151 will be visible to the hook program. This lets you validate the transaction
1133 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1152 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1134 status will cause the transaction to be rolled back. The reason for the
1153 status will cause the transaction to be rolled back. The reason for the
1135 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
1154 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
1136 the transaction will be in ``HG_TXNID``. The rest of the available data will
1155 the transaction will be in ``HG_TXNID``. The rest of the available data will
1137 vary according the transaction type. New changesets will add ``$HG_NODE``
1156 vary according the transaction type. New changesets will add ``$HG_NODE``
1138 (the ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last
1157 (the ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last
1139 added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables. Bookmark and
1158 added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables. Bookmark and
1140 phase changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``
1159 phase changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``
1141 respectively, etc.
1160 respectively, etc.
1142
1161
1143 ``pretxnclose-bookmark``
1162 ``pretxnclose-bookmark``
1144 Run right before a bookmark change is actually finalized. Any repository
1163 Run right before a bookmark change is actually finalized. Any repository
1145 change will be visible to the hook program. This lets you validate the
1164 change will be visible to the hook program. This lets you validate the
1146 transaction content or change it. Exit status 0 allows the commit to
1165 transaction content or change it. Exit status 0 allows the commit to
1147 proceed. A non-zero status will cause the transaction to be rolled back.
1166 proceed. A non-zero status will cause the transaction to be rolled back.
1148 The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
1167 The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
1149 bookmark location will be available in ``$HG_NODE`` while the previous
1168 bookmark location will be available in ``$HG_NODE`` while the previous
1150 location will be available in ``$HG_OLDNODE``. In case of a bookmark
1169 location will be available in ``$HG_OLDNODE``. In case of a bookmark
1151 creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
1170 creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
1152 will be empty.
1171 will be empty.
1153 In addition, the reason for the transaction opening will be in
1172 In addition, the reason for the transaction opening will be in
1154 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1173 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1155 ``HG_TXNID``.
1174 ``HG_TXNID``.
1156
1175
1157 ``pretxnclose-phase``
1176 ``pretxnclose-phase``
1158 Run right before a phase change is actually finalized. Any repository change
1177 Run right before a phase change is actually finalized. Any repository change
1159 will be visible to the hook program. This lets you validate the transaction
1178 will be visible to the hook program. This lets you validate the transaction
1160 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1179 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1161 status will cause the transaction to be rolled back. The hook is called
1180 status will cause the transaction to be rolled back. The hook is called
1162 multiple times, once for each revision affected by a phase change.
1181 multiple times, once for each revision affected by a phase change.
1163 The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
1182 The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
1164 while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
1183 while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
1165 will be empty. In addition, the reason for the transaction opening will be in
1184 will be empty. In addition, the reason for the transaction opening will be in
1166 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1185 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1167 ``HG_TXNID``. The hook is also run for newly added revisions. In this case
1186 ``HG_TXNID``. The hook is also run for newly added revisions. In this case
1168 the ``$HG_OLDPHASE`` entry will be empty.
1187 the ``$HG_OLDPHASE`` entry will be empty.
1169
1188
1170 ``txnclose``
1189 ``txnclose``
1171 Run after any repository transaction has been committed. At this
1190 Run after any repository transaction has been committed. At this
1172 point, the transaction can no longer be rolled back. The hook will run
1191 point, the transaction can no longer be rolled back. The hook will run
1173 after the lock is released. See :hg:`help config.hooks.pretxnclose` for
1192 after the lock is released. See :hg:`help config.hooks.pretxnclose` for
1174 details about available variables.
1193 details about available variables.
1175
1194
1176 ``txnclose-bookmark``
1195 ``txnclose-bookmark``
1177 Run after any bookmark change has been committed. At this point, the
1196 Run after any bookmark change has been committed. At this point, the
1178 transaction can no longer be rolled back. The hook will run after the lock
1197 transaction can no longer be rolled back. The hook will run after the lock
1179 is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
1198 is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
1180 about available variables.
1199 about available variables.
1181
1200
1182 ``txnclose-phase``
1201 ``txnclose-phase``
1183 Run after any phase change has been committed. At this point, the
1202 Run after any phase change has been committed. At this point, the
1184 transaction can no longer be rolled back. The hook will run after the lock
1203 transaction can no longer be rolled back. The hook will run after the lock
1185 is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
1204 is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
1186 available variables.
1205 available variables.
1187
1206
1188 ``txnabort``
1207 ``txnabort``
1189 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
1208 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
1190 for details about available variables.
1209 for details about available variables.
1191
1210
1192 ``pretxnchangegroup``
1211 ``pretxnchangegroup``
1193 Run after a changegroup has been added via push, pull or unbundle, but before
1212 Run after a changegroup has been added via push, pull or unbundle, but before
1194 the transaction has been committed. The changegroup is visible to the hook
1213 the transaction has been committed. The changegroup is visible to the hook
1195 program. This allows validation of incoming changes before accepting them.
1214 program. This allows validation of incoming changes before accepting them.
1196 The ID of the first new changeset is in ``$HG_NODE`` and last is in
1215 The ID of the first new changeset is in ``$HG_NODE`` and last is in
1197 ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
1216 ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
1198 status will cause the transaction to be rolled back, and the push, pull or
1217 status will cause the transaction to be rolled back, and the push, pull or
1199 unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
1218 unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
1200
1219
1201 ``pretxncommit``
1220 ``pretxncommit``
1202 Run after a changeset has been created, but before the transaction is
1221 Run after a changeset has been created, but before the transaction is
1203 committed. The changeset is visible to the hook program. This allows
1222 committed. The changeset is visible to the hook program. This allows
1204 validation of the commit message and changes. Exit status 0 allows the
1223 validation of the commit message and changes. Exit status 0 allows the
1205 commit to proceed. A non-zero status will cause the transaction to
1224 commit to proceed. A non-zero status will cause the transaction to
1206 be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
1225 be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
1207 changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1226 changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1208
1227
1209 ``preupdate``
1228 ``preupdate``
1210 Run before updating the working directory. Exit status 0 allows
1229 Run before updating the working directory. Exit status 0 allows
1211 the update to proceed. A non-zero status will prevent the update.
1230 the update to proceed. A non-zero status will prevent the update.
1212 The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
1231 The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
1213 merge, the ID of second new parent is in ``$HG_PARENT2``.
1232 merge, the ID of second new parent is in ``$HG_PARENT2``.
1214
1233
1215 ``listkeys``
1234 ``listkeys``
1216 Run after listing pushkeys (like bookmarks) in the repository. The
1235 Run after listing pushkeys (like bookmarks) in the repository. The
1217 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1236 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1218 dictionary containing the keys and values.
1237 dictionary containing the keys and values.
1219
1238
1220 ``pushkey``
1239 ``pushkey``
1221 Run after a pushkey (like a bookmark) is added to the
1240 Run after a pushkey (like a bookmark) is added to the
1222 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1241 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1223 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1242 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1224 value is in ``$HG_NEW``.
1243 value is in ``$HG_NEW``.
1225
1244
1226 ``tag``
1245 ``tag``
1227 Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
1246 Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
1228 The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
1247 The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
1229 the repository if ``$HG_LOCAL=0``.
1248 the repository if ``$HG_LOCAL=0``.
1230
1249
1231 ``update``
1250 ``update``
1232 Run after updating the working directory. The changeset ID of first
1251 Run after updating the working directory. The changeset ID of first
1233 new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
1252 new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
1234 parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1253 parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1235 update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
1254 update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
1236
1255
1237 .. note::
1256 .. note::
1238
1257
1239 It is generally better to use standard hooks rather than the
1258 It is generally better to use standard hooks rather than the
1240 generic pre- and post- command hooks, as they are guaranteed to be
1259 generic pre- and post- command hooks, as they are guaranteed to be
1241 called in the appropriate contexts for influencing transactions.
1260 called in the appropriate contexts for influencing transactions.
1242 Also, hooks like "commit" will be called in all contexts that
1261 Also, hooks like "commit" will be called in all contexts that
1243 generate a commit (e.g. tag) and not just the commit command.
1262 generate a commit (e.g. tag) and not just the commit command.
1244
1263
1245 .. note::
1264 .. note::
1246
1265
1247 Environment variables with empty values may not be passed to
1266 Environment variables with empty values may not be passed to
1248 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1267 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1249 will have an empty value under Unix-like platforms for non-merge
1268 will have an empty value under Unix-like platforms for non-merge
1250 changesets, while it will not be available at all under Windows.
1269 changesets, while it will not be available at all under Windows.
1251
1270
1252 The syntax for Python hooks is as follows::
1271 The syntax for Python hooks is as follows::
1253
1272
1254 hookname = python:modulename.submodule.callable
1273 hookname = python:modulename.submodule.callable
1255 hookname = python:/path/to/python/module.py:callable
1274 hookname = python:/path/to/python/module.py:callable
1256
1275
1257 Python hooks are run within the Mercurial process. Each hook is
1276 Python hooks are run within the Mercurial process. Each hook is
1258 called with at least three keyword arguments: a ui object (keyword
1277 called with at least three keyword arguments: a ui object (keyword
1259 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1278 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1260 keyword that tells what kind of hook is used. Arguments listed as
1279 keyword that tells what kind of hook is used. Arguments listed as
1261 environment variables above are passed as keyword arguments, with no
1280 environment variables above are passed as keyword arguments, with no
1262 ``HG_`` prefix, and names in lower case.
1281 ``HG_`` prefix, and names in lower case.
1263
1282
1264 If a Python hook returns a "true" value or raises an exception, this
1283 If a Python hook returns a "true" value or raises an exception, this
1265 is treated as a failure.
1284 is treated as a failure.
1266
1285
1267
1286
1268 ``hostfingerprints``
1287 ``hostfingerprints``
1269 --------------------
1288 --------------------
1270
1289
1271 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1290 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1272
1291
1273 Fingerprints of the certificates of known HTTPS servers.
1292 Fingerprints of the certificates of known HTTPS servers.
1274
1293
1275 A HTTPS connection to a server with a fingerprint configured here will
1294 A HTTPS connection to a server with a fingerprint configured here will
1276 only succeed if the servers certificate matches the fingerprint.
1295 only succeed if the servers certificate matches the fingerprint.
1277 This is very similar to how ssh known hosts works.
1296 This is very similar to how ssh known hosts works.
1278
1297
1279 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1298 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1280 Multiple values can be specified (separated by spaces or commas). This can
1299 Multiple values can be specified (separated by spaces or commas). This can
1281 be used to define both old and new fingerprints while a host transitions
1300 be used to define both old and new fingerprints while a host transitions
1282 to a new certificate.
1301 to a new certificate.
1283
1302
1284 The CA chain and web.cacerts is not used for servers with a fingerprint.
1303 The CA chain and web.cacerts is not used for servers with a fingerprint.
1285
1304
1286 For example::
1305 For example::
1287
1306
1288 [hostfingerprints]
1307 [hostfingerprints]
1289 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1308 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1290 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1309 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1291
1310
1292 ``hostsecurity``
1311 ``hostsecurity``
1293 ----------------
1312 ----------------
1294
1313
1295 Used to specify global and per-host security settings for connecting to
1314 Used to specify global and per-host security settings for connecting to
1296 other machines.
1315 other machines.
1297
1316
1298 The following options control default behavior for all hosts.
1317 The following options control default behavior for all hosts.
1299
1318
1300 ``ciphers``
1319 ``ciphers``
1301 Defines the cryptographic ciphers to use for connections.
1320 Defines the cryptographic ciphers to use for connections.
1302
1321
1303 Value must be a valid OpenSSL Cipher List Format as documented at
1322 Value must be a valid OpenSSL Cipher List Format as documented at
1304 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1323 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1305
1324
1306 This setting is for advanced users only. Setting to incorrect values
1325 This setting is for advanced users only. Setting to incorrect values
1307 can significantly lower connection security or decrease performance.
1326 can significantly lower connection security or decrease performance.
1308 You have been warned.
1327 You have been warned.
1309
1328
1310 This option requires Python 2.7.
1329 This option requires Python 2.7.
1311
1330
1312 ``minimumprotocol``
1331 ``minimumprotocol``
1313 Defines the minimum channel encryption protocol to use.
1332 Defines the minimum channel encryption protocol to use.
1314
1333
1315 By default, the highest version of TLS supported by both client and server
1334 By default, the highest version of TLS supported by both client and server
1316 is used.
1335 is used.
1317
1336
1318 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1337 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1319
1338
1320 When running on an old Python version, only ``tls1.0`` is allowed since
1339 When running on an old Python version, only ``tls1.0`` is allowed since
1321 old versions of Python only support up to TLS 1.0.
1340 old versions of Python only support up to TLS 1.0.
1322
1341
1323 When running a Python that supports modern TLS versions, the default is
1342 When running a Python that supports modern TLS versions, the default is
1324 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1343 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1325 weakens security and should only be used as a feature of last resort if
1344 weakens security and should only be used as a feature of last resort if
1326 a server does not support TLS 1.1+.
1345 a server does not support TLS 1.1+.
1327
1346
1328 Options in the ``[hostsecurity]`` section can have the form
1347 Options in the ``[hostsecurity]`` section can have the form
1329 ``hostname``:``setting``. This allows multiple settings to be defined on a
1348 ``hostname``:``setting``. This allows multiple settings to be defined on a
1330 per-host basis.
1349 per-host basis.
1331
1350
1332 The following per-host settings can be defined.
1351 The following per-host settings can be defined.
1333
1352
1334 ``ciphers``
1353 ``ciphers``
1335 This behaves like ``ciphers`` as described above except it only applies
1354 This behaves like ``ciphers`` as described above except it only applies
1336 to the host on which it is defined.
1355 to the host on which it is defined.
1337
1356
1338 ``fingerprints``
1357 ``fingerprints``
1339 A list of hashes of the DER encoded peer/remote certificate. Values have
1358 A list of hashes of the DER encoded peer/remote certificate. Values have
1340 the form ``algorithm``:``fingerprint``. e.g.
1359 the form ``algorithm``:``fingerprint``. e.g.
1341 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1360 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1342 In addition, colons (``:``) can appear in the fingerprint part.
1361 In addition, colons (``:``) can appear in the fingerprint part.
1343
1362
1344 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1363 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1345 ``sha512``.
1364 ``sha512``.
1346
1365
1347 Use of ``sha256`` or ``sha512`` is preferred.
1366 Use of ``sha256`` or ``sha512`` is preferred.
1348
1367
1349 If a fingerprint is specified, the CA chain is not validated for this
1368 If a fingerprint is specified, the CA chain is not validated for this
1350 host and Mercurial will require the remote certificate to match one
1369 host and Mercurial will require the remote certificate to match one
1351 of the fingerprints specified. This means if the server updates its
1370 of the fingerprints specified. This means if the server updates its
1352 certificate, Mercurial will abort until a new fingerprint is defined.
1371 certificate, Mercurial will abort until a new fingerprint is defined.
1353 This can provide stronger security than traditional CA-based validation
1372 This can provide stronger security than traditional CA-based validation
1354 at the expense of convenience.
1373 at the expense of convenience.
1355
1374
1356 This option takes precedence over ``verifycertsfile``.
1375 This option takes precedence over ``verifycertsfile``.
1357
1376
1358 ``minimumprotocol``
1377 ``minimumprotocol``
1359 This behaves like ``minimumprotocol`` as described above except it
1378 This behaves like ``minimumprotocol`` as described above except it
1360 only applies to the host on which it is defined.
1379 only applies to the host on which it is defined.
1361
1380
1362 ``verifycertsfile``
1381 ``verifycertsfile``
1363 Path to file a containing a list of PEM encoded certificates used to
1382 Path to file a containing a list of PEM encoded certificates used to
1364 verify the server certificate. Environment variables and ``~user``
1383 verify the server certificate. Environment variables and ``~user``
1365 constructs are expanded in the filename.
1384 constructs are expanded in the filename.
1366
1385
1367 The server certificate or the certificate's certificate authority (CA)
1386 The server certificate or the certificate's certificate authority (CA)
1368 must match a certificate from this file or certificate verification
1387 must match a certificate from this file or certificate verification
1369 will fail and connections to the server will be refused.
1388 will fail and connections to the server will be refused.
1370
1389
1371 If defined, only certificates provided by this file will be used:
1390 If defined, only certificates provided by this file will be used:
1372 ``web.cacerts`` and any system/default certificates will not be
1391 ``web.cacerts`` and any system/default certificates will not be
1373 used.
1392 used.
1374
1393
1375 This option has no effect if the per-host ``fingerprints`` option
1394 This option has no effect if the per-host ``fingerprints`` option
1376 is set.
1395 is set.
1377
1396
1378 The format of the file is as follows::
1397 The format of the file is as follows::
1379
1398
1380 -----BEGIN CERTIFICATE-----
1399 -----BEGIN CERTIFICATE-----
1381 ... (certificate in base64 PEM encoding) ...
1400 ... (certificate in base64 PEM encoding) ...
1382 -----END CERTIFICATE-----
1401 -----END CERTIFICATE-----
1383 -----BEGIN CERTIFICATE-----
1402 -----BEGIN CERTIFICATE-----
1384 ... (certificate in base64 PEM encoding) ...
1403 ... (certificate in base64 PEM encoding) ...
1385 -----END CERTIFICATE-----
1404 -----END CERTIFICATE-----
1386
1405
1387 For example::
1406 For example::
1388
1407
1389 [hostsecurity]
1408 [hostsecurity]
1390 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1409 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1391 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
1410 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
1392 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
1411 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
1393 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1412 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1394
1413
1395 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1414 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1396 when connecting to ``hg.example.com``::
1415 when connecting to ``hg.example.com``::
1397
1416
1398 [hostsecurity]
1417 [hostsecurity]
1399 minimumprotocol = tls1.2
1418 minimumprotocol = tls1.2
1400 hg.example.com:minimumprotocol = tls1.1
1419 hg.example.com:minimumprotocol = tls1.1
1401
1420
1402 ``http_proxy``
1421 ``http_proxy``
1403 --------------
1422 --------------
1404
1423
1405 Used to access web-based Mercurial repositories through a HTTP
1424 Used to access web-based Mercurial repositories through a HTTP
1406 proxy.
1425 proxy.
1407
1426
1408 ``host``
1427 ``host``
1409 Host name and (optional) port of the proxy server, for example
1428 Host name and (optional) port of the proxy server, for example
1410 "myproxy:8000".
1429 "myproxy:8000".
1411
1430
1412 ``no``
1431 ``no``
1413 Optional. Comma-separated list of host names that should bypass
1432 Optional. Comma-separated list of host names that should bypass
1414 the proxy.
1433 the proxy.
1415
1434
1416 ``passwd``
1435 ``passwd``
1417 Optional. Password to authenticate with at the proxy server.
1436 Optional. Password to authenticate with at the proxy server.
1418
1437
1419 ``user``
1438 ``user``
1420 Optional. User name to authenticate with at the proxy server.
1439 Optional. User name to authenticate with at the proxy server.
1421
1440
1422 ``always``
1441 ``always``
1423 Optional. Always use the proxy, even for localhost and any entries
1442 Optional. Always use the proxy, even for localhost and any entries
1424 in ``http_proxy.no``. (default: False)
1443 in ``http_proxy.no``. (default: False)
1425
1444
1426 ``http``
1445 ``http``
1427 ----------
1446 ----------
1428
1447
1429 Used to configure access to Mercurial repositories via HTTP.
1448 Used to configure access to Mercurial repositories via HTTP.
1430
1449
1431 ``timeout``
1450 ``timeout``
1432 If set, blocking operations will timeout after that many seconds.
1451 If set, blocking operations will timeout after that many seconds.
1433 (default: None)
1452 (default: None)
1434
1453
1435 ``merge``
1454 ``merge``
1436 ---------
1455 ---------
1437
1456
1438 This section specifies behavior during merges and updates.
1457 This section specifies behavior during merges and updates.
1439
1458
1440 ``checkignored``
1459 ``checkignored``
1441 Controls behavior when an ignored file on disk has the same name as a tracked
1460 Controls behavior when an ignored file on disk has the same name as a tracked
1442 file in the changeset being merged or updated to, and has different
1461 file in the changeset being merged or updated to, and has different
1443 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1462 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1444 abort on such files. With ``warn``, warn on such files and back them up as
1463 abort on such files. With ``warn``, warn on such files and back them up as
1445 ``.orig``. With ``ignore``, don't print a warning and back them up as
1464 ``.orig``. With ``ignore``, don't print a warning and back them up as
1446 ``.orig``. (default: ``abort``)
1465 ``.orig``. (default: ``abort``)
1447
1466
1448 ``checkunknown``
1467 ``checkunknown``
1449 Controls behavior when an unknown file that isn't ignored has the same name
1468 Controls behavior when an unknown file that isn't ignored has the same name
1450 as a tracked file in the changeset being merged or updated to, and has
1469 as a tracked file in the changeset being merged or updated to, and has
1451 different contents. Similar to ``merge.checkignored``, except for files that
1470 different contents. Similar to ``merge.checkignored``, except for files that
1452 are not ignored. (default: ``abort``)
1471 are not ignored. (default: ``abort``)
1453
1472
1454 ``on-failure``
1473 ``on-failure``
1455 When set to ``continue`` (the default), the merge process attempts to
1474 When set to ``continue`` (the default), the merge process attempts to
1456 merge all unresolved files using the merge chosen tool, regardless of
1475 merge all unresolved files using the merge chosen tool, regardless of
1457 whether previous file merge attempts during the process succeeded or not.
1476 whether previous file merge attempts during the process succeeded or not.
1458 Setting this to ``prompt`` will prompt after any merge failure continue
1477 Setting this to ``prompt`` will prompt after any merge failure continue
1459 or halt the merge process. Setting this to ``halt`` will automatically
1478 or halt the merge process. Setting this to ``halt`` will automatically
1460 halt the merge process on any merge tool failure. The merge process
1479 halt the merge process on any merge tool failure. The merge process
1461 can be restarted by using the ``resolve`` command. When a merge is
1480 can be restarted by using the ``resolve`` command. When a merge is
1462 halted, the repository is left in a normal ``unresolved`` merge state.
1481 halted, the repository is left in a normal ``unresolved`` merge state.
1463 (default: ``continue``)
1482 (default: ``continue``)
1464
1483
1465 ``strict-capability-check``
1484 ``strict-capability-check``
1466 Whether capabilities of internal merge tools are checked strictly
1485 Whether capabilities of internal merge tools are checked strictly
1467 or not, while examining rules to decide merge tool to be used.
1486 or not, while examining rules to decide merge tool to be used.
1468 (default: False)
1487 (default: False)
1469
1488
1470 ``merge-patterns``
1489 ``merge-patterns``
1471 ------------------
1490 ------------------
1472
1491
1473 This section specifies merge tools to associate with particular file
1492 This section specifies merge tools to associate with particular file
1474 patterns. Tools matched here will take precedence over the default
1493 patterns. Tools matched here will take precedence over the default
1475 merge tool. Patterns are globs by default, rooted at the repository
1494 merge tool. Patterns are globs by default, rooted at the repository
1476 root.
1495 root.
1477
1496
1478 Example::
1497 Example::
1479
1498
1480 [merge-patterns]
1499 [merge-patterns]
1481 **.c = kdiff3
1500 **.c = kdiff3
1482 **.jpg = myimgmerge
1501 **.jpg = myimgmerge
1483
1502
1484 ``merge-tools``
1503 ``merge-tools``
1485 ---------------
1504 ---------------
1486
1505
1487 This section configures external merge tools to use for file-level
1506 This section configures external merge tools to use for file-level
1488 merges. This section has likely been preconfigured at install time.
1507 merges. This section has likely been preconfigured at install time.
1489 Use :hg:`config merge-tools` to check the existing configuration.
1508 Use :hg:`config merge-tools` to check the existing configuration.
1490 Also see :hg:`help merge-tools` for more details.
1509 Also see :hg:`help merge-tools` for more details.
1491
1510
1492 Example ``~/.hgrc``::
1511 Example ``~/.hgrc``::
1493
1512
1494 [merge-tools]
1513 [merge-tools]
1495 # Override stock tool location
1514 # Override stock tool location
1496 kdiff3.executable = ~/bin/kdiff3
1515 kdiff3.executable = ~/bin/kdiff3
1497 # Specify command line
1516 # Specify command line
1498 kdiff3.args = $base $local $other -o $output
1517 kdiff3.args = $base $local $other -o $output
1499 # Give higher priority
1518 # Give higher priority
1500 kdiff3.priority = 1
1519 kdiff3.priority = 1
1501
1520
1502 # Changing the priority of preconfigured tool
1521 # Changing the priority of preconfigured tool
1503 meld.priority = 0
1522 meld.priority = 0
1504
1523
1505 # Disable a preconfigured tool
1524 # Disable a preconfigured tool
1506 vimdiff.disabled = yes
1525 vimdiff.disabled = yes
1507
1526
1508 # Define new tool
1527 # Define new tool
1509 myHtmlTool.args = -m $local $other $base $output
1528 myHtmlTool.args = -m $local $other $base $output
1510 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1529 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1511 myHtmlTool.priority = 1
1530 myHtmlTool.priority = 1
1512
1531
1513 Supported arguments:
1532 Supported arguments:
1514
1533
1515 ``priority``
1534 ``priority``
1516 The priority in which to evaluate this tool.
1535 The priority in which to evaluate this tool.
1517 (default: 0)
1536 (default: 0)
1518
1537
1519 ``executable``
1538 ``executable``
1520 Either just the name of the executable or its pathname.
1539 Either just the name of the executable or its pathname.
1521
1540
1522 .. container:: windows
1541 .. container:: windows
1523
1542
1524 On Windows, the path can use environment variables with ${ProgramFiles}
1543 On Windows, the path can use environment variables with ${ProgramFiles}
1525 syntax.
1544 syntax.
1526
1545
1527 (default: the tool name)
1546 (default: the tool name)
1528
1547
1529 ``args``
1548 ``args``
1530 The arguments to pass to the tool executable. You can refer to the
1549 The arguments to pass to the tool executable. You can refer to the
1531 files being merged as well as the output file through these
1550 files being merged as well as the output file through these
1532 variables: ``$base``, ``$local``, ``$other``, ``$output``.
1551 variables: ``$base``, ``$local``, ``$other``, ``$output``.
1533
1552
1534 The meaning of ``$local`` and ``$other`` can vary depending on which action is
1553 The meaning of ``$local`` and ``$other`` can vary depending on which action is
1535 being performed. During an update or merge, ``$local`` represents the original
1554 being performed. During an update or merge, ``$local`` represents the original
1536 state of the file, while ``$other`` represents the commit you are updating to or
1555 state of the file, while ``$other`` represents the commit you are updating to or
1537 the commit you are merging with. During a rebase, ``$local`` represents the
1556 the commit you are merging with. During a rebase, ``$local`` represents the
1538 destination of the rebase, and ``$other`` represents the commit being rebased.
1557 destination of the rebase, and ``$other`` represents the commit being rebased.
1539
1558
1540 Some operations define custom labels to assist with identifying the revisions,
1559 Some operations define custom labels to assist with identifying the revisions,
1541 accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
1560 accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
1542 labels are not available, these will be ``local``, ``other``, and ``base``,
1561 labels are not available, these will be ``local``, ``other``, and ``base``,
1543 respectively.
1562 respectively.
1544 (default: ``$local $base $other``)
1563 (default: ``$local $base $other``)
1545
1564
1546 ``premerge``
1565 ``premerge``
1547 Attempt to run internal non-interactive 3-way merge tool before
1566 Attempt to run internal non-interactive 3-way merge tool before
1548 launching external tool. Options are ``true``, ``false``, ``keep``,
1567 launching external tool. Options are ``true``, ``false``, ``keep``,
1549 ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option
1568 ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option
1550 will leave markers in the file if the premerge fails. The ``keep-merge3``
1569 will leave markers in the file if the premerge fails. The ``keep-merge3``
1551 will do the same but include information about the base of the merge in the
1570 will do the same but include information about the base of the merge in the
1552 marker (see internal :merge3 in :hg:`help merge-tools`). The
1571 marker (see internal :merge3 in :hg:`help merge-tools`). The
1553 ``keep-mergediff`` option is similar but uses a different marker style
1572 ``keep-mergediff`` option is similar but uses a different marker style
1554 (see internal :merge3 in :hg:`help merge-tools`). (default: True)
1573 (see internal :merge3 in :hg:`help merge-tools`). (default: True)
1555
1574
1556 ``binary``
1575 ``binary``
1557 This tool can merge binary files. (default: False, unless tool
1576 This tool can merge binary files. (default: False, unless tool
1558 was selected by file pattern match)
1577 was selected by file pattern match)
1559
1578
1560 ``symlink``
1579 ``symlink``
1561 This tool can merge symlinks. (default: False)
1580 This tool can merge symlinks. (default: False)
1562
1581
1563 ``check``
1582 ``check``
1564 A list of merge success-checking options:
1583 A list of merge success-checking options:
1565
1584
1566 ``changed``
1585 ``changed``
1567 Ask whether merge was successful when the merged file shows no changes.
1586 Ask whether merge was successful when the merged file shows no changes.
1568 ``conflicts``
1587 ``conflicts``
1569 Check whether there are conflicts even though the tool reported success.
1588 Check whether there are conflicts even though the tool reported success.
1570 ``prompt``
1589 ``prompt``
1571 Always prompt for merge success, regardless of success reported by tool.
1590 Always prompt for merge success, regardless of success reported by tool.
1572
1591
1573 ``fixeol``
1592 ``fixeol``
1574 Attempt to fix up EOL changes caused by the merge tool.
1593 Attempt to fix up EOL changes caused by the merge tool.
1575 (default: False)
1594 (default: False)
1576
1595
1577 ``gui``
1596 ``gui``
1578 This tool requires a graphical interface to run. (default: False)
1597 This tool requires a graphical interface to run. (default: False)
1579
1598
1580 ``mergemarkers``
1599 ``mergemarkers``
1581 Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
1600 Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
1582 ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
1601 ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
1583 ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
1602 ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
1584 markers generated during premerge will be ``detailed`` if either this option or
1603 markers generated during premerge will be ``detailed`` if either this option or
1585 the corresponding option in the ``[ui]`` section is ``detailed``.
1604 the corresponding option in the ``[ui]`` section is ``detailed``.
1586 (default: ``basic``)
1605 (default: ``basic``)
1587
1606
1588 ``mergemarkertemplate``
1607 ``mergemarkertemplate``
1589 This setting can be used to override ``mergemarker`` from the
1608 This setting can be used to override ``mergemarker`` from the
1590 ``[command-templates]`` section on a per-tool basis; this applies to the
1609 ``[command-templates]`` section on a per-tool basis; this applies to the
1591 ``$label``-prefixed variables and to the conflict markers that are generated
1610 ``$label``-prefixed variables and to the conflict markers that are generated
1592 if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable
1611 if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable
1593 in ``[ui]`` for more information.
1612 in ``[ui]`` for more information.
1594
1613
1595 .. container:: windows
1614 .. container:: windows
1596
1615
1597 ``regkey``
1616 ``regkey``
1598 Windows registry key which describes install location of this
1617 Windows registry key which describes install location of this
1599 tool. Mercurial will search for this key first under
1618 tool. Mercurial will search for this key first under
1600 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1619 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1601 (default: None)
1620 (default: None)
1602
1621
1603 ``regkeyalt``
1622 ``regkeyalt``
1604 An alternate Windows registry key to try if the first key is not
1623 An alternate Windows registry key to try if the first key is not
1605 found. The alternate key uses the same ``regname`` and ``regappend``
1624 found. The alternate key uses the same ``regname`` and ``regappend``
1606 semantics of the primary key. The most common use for this key
1625 semantics of the primary key. The most common use for this key
1607 is to search for 32bit applications on 64bit operating systems.
1626 is to search for 32bit applications on 64bit operating systems.
1608 (default: None)
1627 (default: None)
1609
1628
1610 ``regname``
1629 ``regname``
1611 Name of value to read from specified registry key.
1630 Name of value to read from specified registry key.
1612 (default: the unnamed (default) value)
1631 (default: the unnamed (default) value)
1613
1632
1614 ``regappend``
1633 ``regappend``
1615 String to append to the value read from the registry, typically
1634 String to append to the value read from the registry, typically
1616 the executable name of the tool.
1635 the executable name of the tool.
1617 (default: None)
1636 (default: None)
1618
1637
1619 ``pager``
1638 ``pager``
1620 ---------
1639 ---------
1621
1640
1622 Setting used to control when to paginate and with what external tool. See
1641 Setting used to control when to paginate and with what external tool. See
1623 :hg:`help pager` for details.
1642 :hg:`help pager` for details.
1624
1643
1625 ``pager``
1644 ``pager``
1626 Define the external tool used as pager.
1645 Define the external tool used as pager.
1627
1646
1628 If no pager is set, Mercurial uses the environment variable $PAGER.
1647 If no pager is set, Mercurial uses the environment variable $PAGER.
1629 If neither pager.pager, nor $PAGER is set, a default pager will be
1648 If neither pager.pager, nor $PAGER is set, a default pager will be
1630 used, typically `less` on Unix and `more` on Windows. Example::
1649 used, typically `less` on Unix and `more` on Windows. Example::
1631
1650
1632 [pager]
1651 [pager]
1633 pager = less -FRX
1652 pager = less -FRX
1634
1653
1635 ``ignore``
1654 ``ignore``
1636 List of commands to disable the pager for. Example::
1655 List of commands to disable the pager for. Example::
1637
1656
1638 [pager]
1657 [pager]
1639 ignore = version, help, update
1658 ignore = version, help, update
1640
1659
1641 ``patch``
1660 ``patch``
1642 ---------
1661 ---------
1643
1662
1644 Settings used when applying patches, for instance through the 'import'
1663 Settings used when applying patches, for instance through the 'import'
1645 command or with Mercurial Queues extension.
1664 command or with Mercurial Queues extension.
1646
1665
1647 ``eol``
1666 ``eol``
1648 When set to 'strict' patch content and patched files end of lines
1667 When set to 'strict' patch content and patched files end of lines
1649 are preserved. When set to ``lf`` or ``crlf``, both files end of
1668 are preserved. When set to ``lf`` or ``crlf``, both files end of
1650 lines are ignored when patching and the result line endings are
1669 lines are ignored when patching and the result line endings are
1651 normalized to either LF (Unix) or CRLF (Windows). When set to
1670 normalized to either LF (Unix) or CRLF (Windows). When set to
1652 ``auto``, end of lines are again ignored while patching but line
1671 ``auto``, end of lines are again ignored while patching but line
1653 endings in patched files are normalized to their original setting
1672 endings in patched files are normalized to their original setting
1654 on a per-file basis. If target file does not exist or has no end
1673 on a per-file basis. If target file does not exist or has no end
1655 of line, patch line endings are preserved.
1674 of line, patch line endings are preserved.
1656 (default: strict)
1675 (default: strict)
1657
1676
1658 ``fuzz``
1677 ``fuzz``
1659 The number of lines of 'fuzz' to allow when applying patches. This
1678 The number of lines of 'fuzz' to allow when applying patches. This
1660 controls how much context the patcher is allowed to ignore when
1679 controls how much context the patcher is allowed to ignore when
1661 trying to apply a patch.
1680 trying to apply a patch.
1662 (default: 2)
1681 (default: 2)
1663
1682
1664 ``paths``
1683 ``paths``
1665 ---------
1684 ---------
1666
1685
1667 Assigns symbolic names and behavior to repositories.
1686 Assigns symbolic names and behavior to repositories.
1668
1687
1669 Options are symbolic names defining the URL or directory that is the
1688 Options are symbolic names defining the URL or directory that is the
1670 location of the repository. Example::
1689 location of the repository. Example::
1671
1690
1672 [paths]
1691 [paths]
1673 my_server = https://example.com/my_repo
1692 my_server = https://example.com/my_repo
1674 local_path = /home/me/repo
1693 local_path = /home/me/repo
1675
1694
1676 These symbolic names can be used from the command line. To pull
1695 These symbolic names can be used from the command line. To pull
1677 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1696 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1678 :hg:`push local_path`.
1697 :hg:`push local_path`.
1679
1698
1680 Options containing colons (``:``) denote sub-options that can influence
1699 Options containing colons (``:``) denote sub-options that can influence
1681 behavior for that specific path. Example::
1700 behavior for that specific path. Example::
1682
1701
1683 [paths]
1702 [paths]
1684 my_server = https://example.com/my_path
1703 my_server = https://example.com/my_path
1685 my_server:pushurl = ssh://example.com/my_path
1704 my_server:pushurl = ssh://example.com/my_path
1686
1705
1687 The following sub-options can be defined:
1706 The following sub-options can be defined:
1688
1707
1689 ``pushurl``
1708 ``pushurl``
1690 The URL to use for push operations. If not defined, the location
1709 The URL to use for push operations. If not defined, the location
1691 defined by the path's main entry is used.
1710 defined by the path's main entry is used.
1692
1711
1693 ``pushrev``
1712 ``pushrev``
1694 A revset defining which revisions to push by default.
1713 A revset defining which revisions to push by default.
1695
1714
1696 When :hg:`push` is executed without a ``-r`` argument, the revset
1715 When :hg:`push` is executed without a ``-r`` argument, the revset
1697 defined by this sub-option is evaluated to determine what to push.
1716 defined by this sub-option is evaluated to determine what to push.
1698
1717
1699 For example, a value of ``.`` will push the working directory's
1718 For example, a value of ``.`` will push the working directory's
1700 revision by default.
1719 revision by default.
1701
1720
1702 Revsets specifying bookmarks will not result in the bookmark being
1721 Revsets specifying bookmarks will not result in the bookmark being
1703 pushed.
1722 pushed.
1704
1723
1705 The following special named paths exist:
1724 The following special named paths exist:
1706
1725
1707 ``default``
1726 ``default``
1708 The URL or directory to use when no source or remote is specified.
1727 The URL or directory to use when no source or remote is specified.
1709
1728
1710 :hg:`clone` will automatically define this path to the location the
1729 :hg:`clone` will automatically define this path to the location the
1711 repository was cloned from.
1730 repository was cloned from.
1712
1731
1713 ``default-push``
1732 ``default-push``
1714 (deprecated) The URL or directory for the default :hg:`push` location.
1733 (deprecated) The URL or directory for the default :hg:`push` location.
1715 ``default:pushurl`` should be used instead.
1734 ``default:pushurl`` should be used instead.
1716
1735
1717 ``phases``
1736 ``phases``
1718 ----------
1737 ----------
1719
1738
1720 Specifies default handling of phases. See :hg:`help phases` for more
1739 Specifies default handling of phases. See :hg:`help phases` for more
1721 information about working with phases.
1740 information about working with phases.
1722
1741
1723 ``publish``
1742 ``publish``
1724 Controls draft phase behavior when working as a server. When true,
1743 Controls draft phase behavior when working as a server. When true,
1725 pushed changesets are set to public in both client and server and
1744 pushed changesets are set to public in both client and server and
1726 pulled or cloned changesets are set to public in the client.
1745 pulled or cloned changesets are set to public in the client.
1727 (default: True)
1746 (default: True)
1728
1747
1729 ``new-commit``
1748 ``new-commit``
1730 Phase of newly-created commits.
1749 Phase of newly-created commits.
1731 (default: draft)
1750 (default: draft)
1732
1751
1733 ``checksubrepos``
1752 ``checksubrepos``
1734 Check the phase of the current revision of each subrepository. Allowed
1753 Check the phase of the current revision of each subrepository. Allowed
1735 values are "ignore", "follow" and "abort". For settings other than
1754 values are "ignore", "follow" and "abort". For settings other than
1736 "ignore", the phase of the current revision of each subrepository is
1755 "ignore", the phase of the current revision of each subrepository is
1737 checked before committing the parent repository. If any of those phases is
1756 checked before committing the parent repository. If any of those phases is
1738 greater than the phase of the parent repository (e.g. if a subrepo is in a
1757 greater than the phase of the parent repository (e.g. if a subrepo is in a
1739 "secret" phase while the parent repo is in "draft" phase), the commit is
1758 "secret" phase while the parent repo is in "draft" phase), the commit is
1740 either aborted (if checksubrepos is set to "abort") or the higher phase is
1759 either aborted (if checksubrepos is set to "abort") or the higher phase is
1741 used for the parent repository commit (if set to "follow").
1760 used for the parent repository commit (if set to "follow").
1742 (default: follow)
1761 (default: follow)
1743
1762
1744
1763
1745 ``profiling``
1764 ``profiling``
1746 -------------
1765 -------------
1747
1766
1748 Specifies profiling type, format, and file output. Two profilers are
1767 Specifies profiling type, format, and file output. Two profilers are
1749 supported: an instrumenting profiler (named ``ls``), and a sampling
1768 supported: an instrumenting profiler (named ``ls``), and a sampling
1750 profiler (named ``stat``).
1769 profiler (named ``stat``).
1751
1770
1752 In this section description, 'profiling data' stands for the raw data
1771 In this section description, 'profiling data' stands for the raw data
1753 collected during profiling, while 'profiling report' stands for a
1772 collected during profiling, while 'profiling report' stands for a
1754 statistical text report generated from the profiling data.
1773 statistical text report generated from the profiling data.
1755
1774
1756 ``enabled``
1775 ``enabled``
1757 Enable the profiler.
1776 Enable the profiler.
1758 (default: false)
1777 (default: false)
1759
1778
1760 This is equivalent to passing ``--profile`` on the command line.
1779 This is equivalent to passing ``--profile`` on the command line.
1761
1780
1762 ``type``
1781 ``type``
1763 The type of profiler to use.
1782 The type of profiler to use.
1764 (default: stat)
1783 (default: stat)
1765
1784
1766 ``ls``
1785 ``ls``
1767 Use Python's built-in instrumenting profiler. This profiler
1786 Use Python's built-in instrumenting profiler. This profiler
1768 works on all platforms, but each line number it reports is the
1787 works on all platforms, but each line number it reports is the
1769 first line of a function. This restriction makes it difficult to
1788 first line of a function. This restriction makes it difficult to
1770 identify the expensive parts of a non-trivial function.
1789 identify the expensive parts of a non-trivial function.
1771 ``stat``
1790 ``stat``
1772 Use a statistical profiler, statprof. This profiler is most
1791 Use a statistical profiler, statprof. This profiler is most
1773 useful for profiling commands that run for longer than about 0.1
1792 useful for profiling commands that run for longer than about 0.1
1774 seconds.
1793 seconds.
1775
1794
1776 ``format``
1795 ``format``
1777 Profiling format. Specific to the ``ls`` instrumenting profiler.
1796 Profiling format. Specific to the ``ls`` instrumenting profiler.
1778 (default: text)
1797 (default: text)
1779
1798
1780 ``text``
1799 ``text``
1781 Generate a profiling report. When saving to a file, it should be
1800 Generate a profiling report. When saving to a file, it should be
1782 noted that only the report is saved, and the profiling data is
1801 noted that only the report is saved, and the profiling data is
1783 not kept.
1802 not kept.
1784 ``kcachegrind``
1803 ``kcachegrind``
1785 Format profiling data for kcachegrind use: when saving to a
1804 Format profiling data for kcachegrind use: when saving to a
1786 file, the generated file can directly be loaded into
1805 file, the generated file can directly be loaded into
1787 kcachegrind.
1806 kcachegrind.
1788
1807
1789 ``statformat``
1808 ``statformat``
1790 Profiling format for the ``stat`` profiler.
1809 Profiling format for the ``stat`` profiler.
1791 (default: hotpath)
1810 (default: hotpath)
1792
1811
1793 ``hotpath``
1812 ``hotpath``
1794 Show a tree-based display containing the hot path of execution (where
1813 Show a tree-based display containing the hot path of execution (where
1795 most time was spent).
1814 most time was spent).
1796 ``bymethod``
1815 ``bymethod``
1797 Show a table of methods ordered by how frequently they are active.
1816 Show a table of methods ordered by how frequently they are active.
1798 ``byline``
1817 ``byline``
1799 Show a table of lines in files ordered by how frequently they are active.
1818 Show a table of lines in files ordered by how frequently they are active.
1800 ``json``
1819 ``json``
1801 Render profiling data as JSON.
1820 Render profiling data as JSON.
1802
1821
1803 ``frequency``
1822 ``frequency``
1804 Sampling frequency. Specific to the ``stat`` sampling profiler.
1823 Sampling frequency. Specific to the ``stat`` sampling profiler.
1805 (default: 1000)
1824 (default: 1000)
1806
1825
1807 ``output``
1826 ``output``
1808 File path where profiling data or report should be saved. If the
1827 File path where profiling data or report should be saved. If the
1809 file exists, it is replaced. (default: None, data is printed on
1828 file exists, it is replaced. (default: None, data is printed on
1810 stderr)
1829 stderr)
1811
1830
1812 ``sort``
1831 ``sort``
1813 Sort field. Specific to the ``ls`` instrumenting profiler.
1832 Sort field. Specific to the ``ls`` instrumenting profiler.
1814 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1833 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1815 ``inlinetime``.
1834 ``inlinetime``.
1816 (default: inlinetime)
1835 (default: inlinetime)
1817
1836
1818 ``time-track``
1837 ``time-track``
1819 Control if the stat profiler track ``cpu`` or ``real`` time.
1838 Control if the stat profiler track ``cpu`` or ``real`` time.
1820 (default: ``cpu`` on Windows, otherwise ``real``)
1839 (default: ``cpu`` on Windows, otherwise ``real``)
1821
1840
1822 ``limit``
1841 ``limit``
1823 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1842 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1824 (default: 30)
1843 (default: 30)
1825
1844
1826 ``nested``
1845 ``nested``
1827 Show at most this number of lines of drill-down info after each main entry.
1846 Show at most this number of lines of drill-down info after each main entry.
1828 This can help explain the difference between Total and Inline.
1847 This can help explain the difference between Total and Inline.
1829 Specific to the ``ls`` instrumenting profiler.
1848 Specific to the ``ls`` instrumenting profiler.
1830 (default: 0)
1849 (default: 0)
1831
1850
1832 ``showmin``
1851 ``showmin``
1833 Minimum fraction of samples an entry must have for it to be displayed.
1852 Minimum fraction of samples an entry must have for it to be displayed.
1834 Can be specified as a float between ``0.0`` and ``1.0`` or can have a
1853 Can be specified as a float between ``0.0`` and ``1.0`` or can have a
1835 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
1854 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
1836
1855
1837 Only used by the ``stat`` profiler.
1856 Only used by the ``stat`` profiler.
1838
1857
1839 For the ``hotpath`` format, default is ``0.05``.
1858 For the ``hotpath`` format, default is ``0.05``.
1840 For the ``chrome`` format, default is ``0.005``.
1859 For the ``chrome`` format, default is ``0.005``.
1841
1860
1842 The option is unused on other formats.
1861 The option is unused on other formats.
1843
1862
1844 ``showmax``
1863 ``showmax``
1845 Maximum fraction of samples an entry can have before it is ignored in
1864 Maximum fraction of samples an entry can have before it is ignored in
1846 display. Values format is the same as ``showmin``.
1865 display. Values format is the same as ``showmin``.
1847
1866
1848 Only used by the ``stat`` profiler.
1867 Only used by the ``stat`` profiler.
1849
1868
1850 For the ``chrome`` format, default is ``0.999``.
1869 For the ``chrome`` format, default is ``0.999``.
1851
1870
1852 The option is unused on other formats.
1871 The option is unused on other formats.
1853
1872
1854 ``showtime``
1873 ``showtime``
1855 Show time taken as absolute durations, in addition to percentages.
1874 Show time taken as absolute durations, in addition to percentages.
1856 Only used by the ``hotpath`` format.
1875 Only used by the ``hotpath`` format.
1857 (default: true)
1876 (default: true)
1858
1877
1859 ``progress``
1878 ``progress``
1860 ------------
1879 ------------
1861
1880
1862 Mercurial commands can draw progress bars that are as informative as
1881 Mercurial commands can draw progress bars that are as informative as
1863 possible. Some progress bars only offer indeterminate information, while others
1882 possible. Some progress bars only offer indeterminate information, while others
1864 have a definite end point.
1883 have a definite end point.
1865
1884
1866 ``debug``
1885 ``debug``
1867 Whether to print debug info when updating the progress bar. (default: False)
1886 Whether to print debug info when updating the progress bar. (default: False)
1868
1887
1869 ``delay``
1888 ``delay``
1870 Number of seconds (float) before showing the progress bar. (default: 3)
1889 Number of seconds (float) before showing the progress bar. (default: 3)
1871
1890
1872 ``changedelay``
1891 ``changedelay``
1873 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1892 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1874 that value will be used instead. (default: 1)
1893 that value will be used instead. (default: 1)
1875
1894
1876 ``estimateinterval``
1895 ``estimateinterval``
1877 Maximum sampling interval in seconds for speed and estimated time
1896 Maximum sampling interval in seconds for speed and estimated time
1878 calculation. (default: 60)
1897 calculation. (default: 60)
1879
1898
1880 ``refresh``
1899 ``refresh``
1881 Time in seconds between refreshes of the progress bar. (default: 0.1)
1900 Time in seconds between refreshes of the progress bar. (default: 0.1)
1882
1901
1883 ``format``
1902 ``format``
1884 Format of the progress bar.
1903 Format of the progress bar.
1885
1904
1886 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1905 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1887 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1906 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1888 last 20 characters of the item, but this can be changed by adding either
1907 last 20 characters of the item, but this can be changed by adding either
1889 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1908 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1890 first num characters.
1909 first num characters.
1891
1910
1892 (default: topic bar number estimate)
1911 (default: topic bar number estimate)
1893
1912
1894 ``width``
1913 ``width``
1895 If set, the maximum width of the progress information (that is, min(width,
1914 If set, the maximum width of the progress information (that is, min(width,
1896 term width) will be used).
1915 term width) will be used).
1897
1916
1898 ``clear-complete``
1917 ``clear-complete``
1899 Clear the progress bar after it's done. (default: True)
1918 Clear the progress bar after it's done. (default: True)
1900
1919
1901 ``disable``
1920 ``disable``
1902 If true, don't show a progress bar.
1921 If true, don't show a progress bar.
1903
1922
1904 ``assume-tty``
1923 ``assume-tty``
1905 If true, ALWAYS show a progress bar, unless disable is given.
1924 If true, ALWAYS show a progress bar, unless disable is given.
1906
1925
1907 ``rebase``
1926 ``rebase``
1908 ----------
1927 ----------
1909
1928
1910 ``evolution.allowdivergence``
1929 ``evolution.allowdivergence``
1911 Default to False, when True allow creating divergence when performing
1930 Default to False, when True allow creating divergence when performing
1912 rebase of obsolete changesets.
1931 rebase of obsolete changesets.
1913
1932
1914 ``revsetalias``
1933 ``revsetalias``
1915 ---------------
1934 ---------------
1916
1935
1917 Alias definitions for revsets. See :hg:`help revsets` for details.
1936 Alias definitions for revsets. See :hg:`help revsets` for details.
1918
1937
1919 ``rewrite``
1938 ``rewrite``
1920 -----------
1939 -----------
1921
1940
1922 ``backup-bundle``
1941 ``backup-bundle``
1923 Whether to save stripped changesets to a bundle file. (default: True)
1942 Whether to save stripped changesets to a bundle file. (default: True)
1924
1943
1925 ``update-timestamp``
1944 ``update-timestamp``
1926 If true, updates the date and time of the changeset to current. It is only
1945 If true, updates the date and time of the changeset to current. It is only
1927 applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the
1946 applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the
1928 current version.
1947 current version.
1929
1948
1930 ``empty-successor``
1949 ``empty-successor``
1931
1950
1932 Control what happens with empty successors that are the result of rewrite
1951 Control what happens with empty successors that are the result of rewrite
1933 operations. If set to ``skip``, the successor is not created. If set to
1952 operations. If set to ``skip``, the successor is not created. If set to
1934 ``keep``, the empty successor is created and kept.
1953 ``keep``, the empty successor is created and kept.
1935
1954
1936 Currently, only the rebase and absorb commands consider this configuration.
1955 Currently, only the rebase and absorb commands consider this configuration.
1937 (EXPERIMENTAL)
1956 (EXPERIMENTAL)
1938
1957
1939 ``share``
1958 ``share``
1940 ---------
1959 ---------
1941
1960
1942 ``safe-mismatch.source-safe``
1961 ``safe-mismatch.source-safe``
1943
1962
1944 Controls what happens when the shared repository does not use the
1963 Controls what happens when the shared repository does not use the
1945 share-safe mechanism but its source repository does.
1964 share-safe mechanism but its source repository does.
1946
1965
1947 Possible values are `abort` (default), `allow`, `upgrade-abort` and
1966 Possible values are `abort` (default), `allow`, `upgrade-abort` and
1948 `upgrade-abort`.
1967 `upgrade-abort`.
1949
1968
1950 ``abort``
1969 ``abort``
1951 Disallows running any command and aborts
1970 Disallows running any command and aborts
1952 ``allow``
1971 ``allow``
1953 Respects the feature presence in the share source
1972 Respects the feature presence in the share source
1954 ``upgrade-abort``
1973 ``upgrade-abort``
1955 tries to upgrade the share to use share-safe; if it fails, aborts
1974 tries to upgrade the share to use share-safe; if it fails, aborts
1956 ``upgrade-allow``
1975 ``upgrade-allow``
1957 tries to upgrade the share; if it fails, continue by
1976 tries to upgrade the share; if it fails, continue by
1958 respecting the share source setting
1977 respecting the share source setting
1959
1978
1960 ``safe-mismatch.source-safe.warn``
1979 ``safe-mismatch.source-safe.warn``
1961 Shows a warning on operations if the shared repository does not use
1980 Shows a warning on operations if the shared repository does not use
1962 share-safe, but the source repository does.
1981 share-safe, but the source repository does.
1963 (default: True)
1982 (default: True)
1964
1983
1965 ``safe-mismatch.source-not-safe``
1984 ``safe-mismatch.source-not-safe``
1966
1985
1967 Controls what happens when the shared repository uses the share-safe
1986 Controls what happens when the shared repository uses the share-safe
1968 mechanism but its source does not.
1987 mechanism but its source does not.
1969
1988
1970 Possible values are `abort` (default), `allow`, `downgrade-abort` and
1989 Possible values are `abort` (default), `allow`, `downgrade-abort` and
1971 `downgrade-abort`.
1990 `downgrade-abort`.
1972
1991
1973 ``abort``
1992 ``abort``
1974 Disallows running any command and aborts
1993 Disallows running any command and aborts
1975 ``allow``
1994 ``allow``
1976 Respects the feature presence in the share source
1995 Respects the feature presence in the share source
1977 ``downgrade-abort``
1996 ``downgrade-abort``
1978 tries to downgrade the share to not use share-safe; if it fails, aborts
1997 tries to downgrade the share to not use share-safe; if it fails, aborts
1979 ``downgrade-allow``
1998 ``downgrade-allow``
1980 tries to downgrade the share to not use share-safe;
1999 tries to downgrade the share to not use share-safe;
1981 if it fails, continue by respecting the shared source setting
2000 if it fails, continue by respecting the shared source setting
1982
2001
1983 ``safe-mismatch.source-not-safe.warn``
2002 ``safe-mismatch.source-not-safe.warn``
1984 Shows a warning on operations if the shared repository uses share-safe,
2003 Shows a warning on operations if the shared repository uses share-safe,
1985 but the source repository does not.
2004 but the source repository does not.
1986 (default: True)
2005 (default: True)
1987
2006
1988 ``storage``
2007 ``storage``
1989 -----------
2008 -----------
1990
2009
1991 Control the strategy Mercurial uses internally to store history. Options in this
2010 Control the strategy Mercurial uses internally to store history. Options in this
1992 category impact performance and repository size.
2011 category impact performance and repository size.
1993
2012
1994 ``revlog.optimize-delta-parent-choice``
2013 ``revlog.optimize-delta-parent-choice``
1995 When storing a merge revision, both parents will be equally considered as
2014 When storing a merge revision, both parents will be equally considered as
1996 a possible delta base. This results in better delta selection and improved
2015 a possible delta base. This results in better delta selection and improved
1997 revlog compression. This option is enabled by default.
2016 revlog compression. This option is enabled by default.
1998
2017
1999 Turning this option off can result in large increase of repository size for
2018 Turning this option off can result in large increase of repository size for
2000 repository with many merges.
2019 repository with many merges.
2001
2020
2002 ``revlog.persistent-nodemap.mmap``
2021 ``revlog.persistent-nodemap.mmap``
2003 Whether to use the Operating System "memory mapping" feature (when
2022 Whether to use the Operating System "memory mapping" feature (when
2004 possible) to access the persistent nodemap data. This improve performance
2023 possible) to access the persistent nodemap data. This improve performance
2005 and reduce memory pressure.
2024 and reduce memory pressure.
2006
2025
2007 Default to True.
2026 Default to True.
2008
2027
2009 For details on the "persistent-nodemap" feature, see:
2028 For details on the "persistent-nodemap" feature, see:
2010 :hg:`help config format.use-persistent-nodemap`.
2029 :hg:`help config format.use-persistent-nodemap`.
2011
2030
2012 ``revlog.persistent-nodemap.slow-path``
2031 ``revlog.persistent-nodemap.slow-path``
2013 Control the behavior of Merucrial when using a repository with "persistent"
2032 Control the behavior of Merucrial when using a repository with "persistent"
2014 nodemap with an installation of Mercurial without a fast implementation for
2033 nodemap with an installation of Mercurial without a fast implementation for
2015 the feature:
2034 the feature:
2016
2035
2017 ``allow``: Silently use the slower implementation to access the repository.
2036 ``allow``: Silently use the slower implementation to access the repository.
2018 ``warn``: Warn, but use the slower implementation to access the repository.
2037 ``warn``: Warn, but use the slower implementation to access the repository.
2019 ``abort``: Prevent access to such repositories. (This is the default)
2038 ``abort``: Prevent access to such repositories. (This is the default)
2020
2039
2021 For details on the "persistent-nodemap" feature, see:
2040 For details on the "persistent-nodemap" feature, see:
2022 :hg:`help config format.use-persistent-nodemap`.
2041 :hg:`help config format.use-persistent-nodemap`.
2023
2042
2024 ``revlog.reuse-external-delta-parent``
2043 ``revlog.reuse-external-delta-parent``
2025 Control the order in which delta parents are considered when adding new
2044 Control the order in which delta parents are considered when adding new
2026 revisions from an external source.
2045 revisions from an external source.
2027 (typically: apply bundle from `hg pull` or `hg push`).
2046 (typically: apply bundle from `hg pull` or `hg push`).
2028
2047
2029 New revisions are usually provided as a delta against other revisions. By
2048 New revisions are usually provided as a delta against other revisions. By
2030 default, Mercurial will try to reuse this delta first, therefore using the
2049 default, Mercurial will try to reuse this delta first, therefore using the
2031 same "delta parent" as the source. Directly using delta's from the source
2050 same "delta parent" as the source. Directly using delta's from the source
2032 reduces CPU usage and usually speeds up operation. However, in some case,
2051 reduces CPU usage and usually speeds up operation. However, in some case,
2033 the source might have sub-optimal delta bases and forcing their reevaluation
2052 the source might have sub-optimal delta bases and forcing their reevaluation
2034 is useful. For example, pushes from an old client could have sub-optimal
2053 is useful. For example, pushes from an old client could have sub-optimal
2035 delta's parent that the server want to optimize. (lack of general delta, bad
2054 delta's parent that the server want to optimize. (lack of general delta, bad
2036 parents, choice, lack of sparse-revlog, etc).
2055 parents, choice, lack of sparse-revlog, etc).
2037
2056
2038 This option is enabled by default. Turning it off will ensure bad delta
2057 This option is enabled by default. Turning it off will ensure bad delta
2039 parent choices from older client do not propagate to this repository, at
2058 parent choices from older client do not propagate to this repository, at
2040 the cost of a small increase in CPU consumption.
2059 the cost of a small increase in CPU consumption.
2041
2060
2042 Note: this option only control the order in which delta parents are
2061 Note: this option only control the order in which delta parents are
2043 considered. Even when disabled, the existing delta from the source will be
2062 considered. Even when disabled, the existing delta from the source will be
2044 reused if the same delta parent is selected.
2063 reused if the same delta parent is selected.
2045
2064
2046 ``revlog.reuse-external-delta``
2065 ``revlog.reuse-external-delta``
2047 Control the reuse of delta from external source.
2066 Control the reuse of delta from external source.
2048 (typically: apply bundle from `hg pull` or `hg push`).
2067 (typically: apply bundle from `hg pull` or `hg push`).
2049
2068
2050 New revisions are usually provided as a delta against another revision. By
2069 New revisions are usually provided as a delta against another revision. By
2051 default, Mercurial will not recompute the same delta again, trusting
2070 default, Mercurial will not recompute the same delta again, trusting
2052 externally provided deltas. There have been rare cases of small adjustment
2071 externally provided deltas. There have been rare cases of small adjustment
2053 to the diffing algorithm in the past. So in some rare case, recomputing
2072 to the diffing algorithm in the past. So in some rare case, recomputing
2054 delta provided by ancient clients can provides better results. Disabling
2073 delta provided by ancient clients can provides better results. Disabling
2055 this option means going through a full delta recomputation for all incoming
2074 this option means going through a full delta recomputation for all incoming
2056 revisions. It means a large increase in CPU usage and will slow operations
2075 revisions. It means a large increase in CPU usage and will slow operations
2057 down.
2076 down.
2058
2077
2059 This option is enabled by default. When disabled, it also disables the
2078 This option is enabled by default. When disabled, it also disables the
2060 related ``storage.revlog.reuse-external-delta-parent`` option.
2079 related ``storage.revlog.reuse-external-delta-parent`` option.
2061
2080
2062 ``revlog.zlib.level``
2081 ``revlog.zlib.level``
2063 Zlib compression level used when storing data into the repository. Accepted
2082 Zlib compression level used when storing data into the repository. Accepted
2064 Value range from 1 (lowest compression) to 9 (highest compression). Zlib
2083 Value range from 1 (lowest compression) to 9 (highest compression). Zlib
2065 default value is 6.
2084 default value is 6.
2066
2085
2067
2086
2068 ``revlog.zstd.level``
2087 ``revlog.zstd.level``
2069 zstd compression level used when storing data into the repository. Accepted
2088 zstd compression level used when storing data into the repository. Accepted
2070 Value range from 1 (lowest compression) to 22 (highest compression).
2089 Value range from 1 (lowest compression) to 22 (highest compression).
2071 (default 3)
2090 (default 3)
2072
2091
2073 ``server``
2092 ``server``
2074 ----------
2093 ----------
2075
2094
2076 Controls generic server settings.
2095 Controls generic server settings.
2077
2096
2078 ``bookmarks-pushkey-compat``
2097 ``bookmarks-pushkey-compat``
2079 Trigger pushkey hook when being pushed bookmark updates. This config exist
2098 Trigger pushkey hook when being pushed bookmark updates. This config exist
2080 for compatibility purpose (default to True)
2099 for compatibility purpose (default to True)
2081
2100
2082 If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
2101 If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
2083 movement we recommend you migrate them to ``txnclose-bookmark`` and
2102 movement we recommend you migrate them to ``txnclose-bookmark`` and
2084 ``pretxnclose-bookmark``.
2103 ``pretxnclose-bookmark``.
2085
2104
2086 ``compressionengines``
2105 ``compressionengines``
2087 List of compression engines and their relative priority to advertise
2106 List of compression engines and their relative priority to advertise
2088 to clients.
2107 to clients.
2089
2108
2090 The order of compression engines determines their priority, the first
2109 The order of compression engines determines their priority, the first
2091 having the highest priority. If a compression engine is not listed
2110 having the highest priority. If a compression engine is not listed
2092 here, it won't be advertised to clients.
2111 here, it won't be advertised to clients.
2093
2112
2094 If not set (the default), built-in defaults are used. Run
2113 If not set (the default), built-in defaults are used. Run
2095 :hg:`debuginstall` to list available compression engines and their
2114 :hg:`debuginstall` to list available compression engines and their
2096 default wire protocol priority.
2115 default wire protocol priority.
2097
2116
2098 Older Mercurial clients only support zlib compression and this setting
2117 Older Mercurial clients only support zlib compression and this setting
2099 has no effect for legacy clients.
2118 has no effect for legacy clients.
2100
2119
2101 ``uncompressed``
2120 ``uncompressed``
2102 Whether to allow clients to clone a repository using the
2121 Whether to allow clients to clone a repository using the
2103 uncompressed streaming protocol. This transfers about 40% more
2122 uncompressed streaming protocol. This transfers about 40% more
2104 data than a regular clone, but uses less memory and CPU on both
2123 data than a regular clone, but uses less memory and CPU on both
2105 server and client. Over a LAN (100 Mbps or better) or a very fast
2124 server and client. Over a LAN (100 Mbps or better) or a very fast
2106 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
2125 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
2107 regular clone. Over most WAN connections (anything slower than
2126 regular clone. Over most WAN connections (anything slower than
2108 about 6 Mbps), uncompressed streaming is slower, because of the
2127 about 6 Mbps), uncompressed streaming is slower, because of the
2109 extra data transfer overhead. This mode will also temporarily hold
2128 extra data transfer overhead. This mode will also temporarily hold
2110 the write lock while determining what data to transfer.
2129 the write lock while determining what data to transfer.
2111 (default: True)
2130 (default: True)
2112
2131
2113 ``uncompressedallowsecret``
2132 ``uncompressedallowsecret``
2114 Whether to allow stream clones when the repository contains secret
2133 Whether to allow stream clones when the repository contains secret
2115 changesets. (default: False)
2134 changesets. (default: False)
2116
2135
2117 ``preferuncompressed``
2136 ``preferuncompressed``
2118 When set, clients will try to use the uncompressed streaming
2137 When set, clients will try to use the uncompressed streaming
2119 protocol. (default: False)
2138 protocol. (default: False)
2120
2139
2121 ``disablefullbundle``
2140 ``disablefullbundle``
2122 When set, servers will refuse attempts to do pull-based clones.
2141 When set, servers will refuse attempts to do pull-based clones.
2123 If this option is set, ``preferuncompressed`` and/or clone bundles
2142 If this option is set, ``preferuncompressed`` and/or clone bundles
2124 are highly recommended. Partial clones will still be allowed.
2143 are highly recommended. Partial clones will still be allowed.
2125 (default: False)
2144 (default: False)
2126
2145
2127 ``streamunbundle``
2146 ``streamunbundle``
2128 When set, servers will apply data sent from the client directly,
2147 When set, servers will apply data sent from the client directly,
2129 otherwise it will be written to a temporary file first. This option
2148 otherwise it will be written to a temporary file first. This option
2130 effectively prevents concurrent pushes.
2149 effectively prevents concurrent pushes.
2131
2150
2132 ``pullbundle``
2151 ``pullbundle``
2133 When set, the server will check pullbundle.manifest for bundles
2152 When set, the server will check pullbundle.manifest for bundles
2134 covering the requested heads and common nodes. The first matching
2153 covering the requested heads and common nodes. The first matching
2135 entry will be streamed to the client.
2154 entry will be streamed to the client.
2136
2155
2137 For HTTP transport, the stream will still use zlib compression
2156 For HTTP transport, the stream will still use zlib compression
2138 for older clients.
2157 for older clients.
2139
2158
2140 ``concurrent-push-mode``
2159 ``concurrent-push-mode``
2141 Level of allowed race condition between two pushing clients.
2160 Level of allowed race condition between two pushing clients.
2142
2161
2143 - 'strict': push is abort if another client touched the repository
2162 - 'strict': push is abort if another client touched the repository
2144 while the push was preparing.
2163 while the push was preparing.
2145 - 'check-related': push is only aborted if it affects head that got also
2164 - 'check-related': push is only aborted if it affects head that got also
2146 affected while the push was preparing. (default since 5.4)
2165 affected while the push was preparing. (default since 5.4)
2147
2166
2148 'check-related' only takes effect for compatible clients (version
2167 'check-related' only takes effect for compatible clients (version
2149 4.3 and later). Older clients will use 'strict'.
2168 4.3 and later). Older clients will use 'strict'.
2150
2169
2151 ``validate``
2170 ``validate``
2152 Whether to validate the completeness of pushed changesets by
2171 Whether to validate the completeness of pushed changesets by
2153 checking that all new file revisions specified in manifests are
2172 checking that all new file revisions specified in manifests are
2154 present. (default: False)
2173 present. (default: False)
2155
2174
2156 ``maxhttpheaderlen``
2175 ``maxhttpheaderlen``
2157 Instruct HTTP clients not to send request headers longer than this
2176 Instruct HTTP clients not to send request headers longer than this
2158 many bytes. (default: 1024)
2177 many bytes. (default: 1024)
2159
2178
2160 ``bundle1``
2179 ``bundle1``
2161 Whether to allow clients to push and pull using the legacy bundle1
2180 Whether to allow clients to push and pull using the legacy bundle1
2162 exchange format. (default: True)
2181 exchange format. (default: True)
2163
2182
2164 ``bundle1gd``
2183 ``bundle1gd``
2165 Like ``bundle1`` but only used if the repository is using the
2184 Like ``bundle1`` but only used if the repository is using the
2166 *generaldelta* storage format. (default: True)
2185 *generaldelta* storage format. (default: True)
2167
2186
2168 ``bundle1.push``
2187 ``bundle1.push``
2169 Whether to allow clients to push using the legacy bundle1 exchange
2188 Whether to allow clients to push using the legacy bundle1 exchange
2170 format. (default: True)
2189 format. (default: True)
2171
2190
2172 ``bundle1gd.push``
2191 ``bundle1gd.push``
2173 Like ``bundle1.push`` but only used if the repository is using the
2192 Like ``bundle1.push`` but only used if the repository is using the
2174 *generaldelta* storage format. (default: True)
2193 *generaldelta* storage format. (default: True)
2175
2194
2176 ``bundle1.pull``
2195 ``bundle1.pull``
2177 Whether to allow clients to pull using the legacy bundle1 exchange
2196 Whether to allow clients to pull using the legacy bundle1 exchange
2178 format. (default: True)
2197 format. (default: True)
2179
2198
2180 ``bundle1gd.pull``
2199 ``bundle1gd.pull``
2181 Like ``bundle1.pull`` but only used if the repository is using the
2200 Like ``bundle1.pull`` but only used if the repository is using the
2182 *generaldelta* storage format. (default: True)
2201 *generaldelta* storage format. (default: True)
2183
2202
2184 Large repositories using the *generaldelta* storage format should
2203 Large repositories using the *generaldelta* storage format should
2185 consider setting this option because converting *generaldelta*
2204 consider setting this option because converting *generaldelta*
2186 repositories to the exchange format required by the bundle1 data
2205 repositories to the exchange format required by the bundle1 data
2187 format can consume a lot of CPU.
2206 format can consume a lot of CPU.
2188
2207
2189 ``bundle2.stream``
2208 ``bundle2.stream``
2190 Whether to allow clients to pull using the bundle2 streaming protocol.
2209 Whether to allow clients to pull using the bundle2 streaming protocol.
2191 (default: True)
2210 (default: True)
2192
2211
2193 ``zliblevel``
2212 ``zliblevel``
2194 Integer between ``-1`` and ``9`` that controls the zlib compression level
2213 Integer between ``-1`` and ``9`` that controls the zlib compression level
2195 for wire protocol commands that send zlib compressed output (notably the
2214 for wire protocol commands that send zlib compressed output (notably the
2196 commands that send repository history data).
2215 commands that send repository history data).
2197
2216
2198 The default (``-1``) uses the default zlib compression level, which is
2217 The default (``-1``) uses the default zlib compression level, which is
2199 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
2218 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
2200 maximum compression.
2219 maximum compression.
2201
2220
2202 Setting this option allows server operators to make trade-offs between
2221 Setting this option allows server operators to make trade-offs between
2203 bandwidth and CPU used. Lowering the compression lowers CPU utilization
2222 bandwidth and CPU used. Lowering the compression lowers CPU utilization
2204 but sends more bytes to clients.
2223 but sends more bytes to clients.
2205
2224
2206 This option only impacts the HTTP server.
2225 This option only impacts the HTTP server.
2207
2226
2208 ``zstdlevel``
2227 ``zstdlevel``
2209 Integer between ``1`` and ``22`` that controls the zstd compression level
2228 Integer between ``1`` and ``22`` that controls the zstd compression level
2210 for wire protocol commands. ``1`` is the minimal amount of compression and
2229 for wire protocol commands. ``1`` is the minimal amount of compression and
2211 ``22`` is the highest amount of compression.
2230 ``22`` is the highest amount of compression.
2212
2231
2213 The default (``3``) should be significantly faster than zlib while likely
2232 The default (``3``) should be significantly faster than zlib while likely
2214 delivering better compression ratios.
2233 delivering better compression ratios.
2215
2234
2216 This option only impacts the HTTP server.
2235 This option only impacts the HTTP server.
2217
2236
2218 See also ``server.zliblevel``.
2237 See also ``server.zliblevel``.
2219
2238
2220 ``view``
2239 ``view``
2221 Repository filter used when exchanging revisions with the peer.
2240 Repository filter used when exchanging revisions with the peer.
2222
2241
2223 The default view (``served``) excludes secret and hidden changesets.
2242 The default view (``served``) excludes secret and hidden changesets.
2224 Another useful value is ``immutable`` (no draft, secret or hidden
2243 Another useful value is ``immutable`` (no draft, secret or hidden
2225 changesets). (EXPERIMENTAL)
2244 changesets). (EXPERIMENTAL)
2226
2245
2227 ``smtp``
2246 ``smtp``
2228 --------
2247 --------
2229
2248
2230 Configuration for extensions that need to send email messages.
2249 Configuration for extensions that need to send email messages.
2231
2250
2232 ``host``
2251 ``host``
2233 Host name of mail server, e.g. "mail.example.com".
2252 Host name of mail server, e.g. "mail.example.com".
2234
2253
2235 ``port``
2254 ``port``
2236 Optional. Port to connect to on mail server. (default: 465 if
2255 Optional. Port to connect to on mail server. (default: 465 if
2237 ``tls`` is smtps; 25 otherwise)
2256 ``tls`` is smtps; 25 otherwise)
2238
2257
2239 ``tls``
2258 ``tls``
2240 Optional. Method to enable TLS when connecting to mail server: starttls,
2259 Optional. Method to enable TLS when connecting to mail server: starttls,
2241 smtps or none. (default: none)
2260 smtps or none. (default: none)
2242
2261
2243 ``username``
2262 ``username``
2244 Optional. User name for authenticating with the SMTP server.
2263 Optional. User name for authenticating with the SMTP server.
2245 (default: None)
2264 (default: None)
2246
2265
2247 ``password``
2266 ``password``
2248 Optional. Password for authenticating with the SMTP server. If not
2267 Optional. Password for authenticating with the SMTP server. If not
2249 specified, interactive sessions will prompt the user for a
2268 specified, interactive sessions will prompt the user for a
2250 password; non-interactive sessions will fail. (default: None)
2269 password; non-interactive sessions will fail. (default: None)
2251
2270
2252 ``local_hostname``
2271 ``local_hostname``
2253 Optional. The hostname that the sender can use to identify
2272 Optional. The hostname that the sender can use to identify
2254 itself to the MTA.
2273 itself to the MTA.
2255
2274
2256
2275
2257 ``subpaths``
2276 ``subpaths``
2258 ------------
2277 ------------
2259
2278
2260 Subrepository source URLs can go stale if a remote server changes name
2279 Subrepository source URLs can go stale if a remote server changes name
2261 or becomes temporarily unavailable. This section lets you define
2280 or becomes temporarily unavailable. This section lets you define
2262 rewrite rules of the form::
2281 rewrite rules of the form::
2263
2282
2264 <pattern> = <replacement>
2283 <pattern> = <replacement>
2265
2284
2266 where ``pattern`` is a regular expression matching a subrepository
2285 where ``pattern`` is a regular expression matching a subrepository
2267 source URL and ``replacement`` is the replacement string used to
2286 source URL and ``replacement`` is the replacement string used to
2268 rewrite it. Groups can be matched in ``pattern`` and referenced in
2287 rewrite it. Groups can be matched in ``pattern`` and referenced in
2269 ``replacements``. For instance::
2288 ``replacements``. For instance::
2270
2289
2271 http://server/(.*)-hg/ = http://hg.server/\1/
2290 http://server/(.*)-hg/ = http://hg.server/\1/
2272
2291
2273 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
2292 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
2274
2293
2275 Relative subrepository paths are first made absolute, and the
2294 Relative subrepository paths are first made absolute, and the
2276 rewrite rules are then applied on the full (absolute) path. If ``pattern``
2295 rewrite rules are then applied on the full (absolute) path. If ``pattern``
2277 doesn't match the full path, an attempt is made to apply it on the
2296 doesn't match the full path, an attempt is made to apply it on the
2278 relative path alone. The rules are applied in definition order.
2297 relative path alone. The rules are applied in definition order.
2279
2298
2280 ``subrepos``
2299 ``subrepos``
2281 ------------
2300 ------------
2282
2301
2283 This section contains options that control the behavior of the
2302 This section contains options that control the behavior of the
2284 subrepositories feature. See also :hg:`help subrepos`.
2303 subrepositories feature. See also :hg:`help subrepos`.
2285
2304
2286 Security note: auditing in Mercurial is known to be insufficient to
2305 Security note: auditing in Mercurial is known to be insufficient to
2287 prevent clone-time code execution with carefully constructed Git
2306 prevent clone-time code execution with carefully constructed Git
2288 subrepos. It is unknown if a similar detect is present in Subversion
2307 subrepos. It is unknown if a similar detect is present in Subversion
2289 subrepos. Both Git and Subversion subrepos are disabled by default
2308 subrepos. Both Git and Subversion subrepos are disabled by default
2290 out of security concerns. These subrepo types can be enabled using
2309 out of security concerns. These subrepo types can be enabled using
2291 the respective options below.
2310 the respective options below.
2292
2311
2293 ``allowed``
2312 ``allowed``
2294 Whether subrepositories are allowed in the working directory.
2313 Whether subrepositories are allowed in the working directory.
2295
2314
2296 When false, commands involving subrepositories (like :hg:`update`)
2315 When false, commands involving subrepositories (like :hg:`update`)
2297 will fail for all subrepository types.
2316 will fail for all subrepository types.
2298 (default: true)
2317 (default: true)
2299
2318
2300 ``hg:allowed``
2319 ``hg:allowed``
2301 Whether Mercurial subrepositories are allowed in the working
2320 Whether Mercurial subrepositories are allowed in the working
2302 directory. This option only has an effect if ``subrepos.allowed``
2321 directory. This option only has an effect if ``subrepos.allowed``
2303 is true.
2322 is true.
2304 (default: true)
2323 (default: true)
2305
2324
2306 ``git:allowed``
2325 ``git:allowed``
2307 Whether Git subrepositories are allowed in the working directory.
2326 Whether Git subrepositories are allowed in the working directory.
2308 This option only has an effect if ``subrepos.allowed`` is true.
2327 This option only has an effect if ``subrepos.allowed`` is true.
2309
2328
2310 See the security note above before enabling Git subrepos.
2329 See the security note above before enabling Git subrepos.
2311 (default: false)
2330 (default: false)
2312
2331
2313 ``svn:allowed``
2332 ``svn:allowed``
2314 Whether Subversion subrepositories are allowed in the working
2333 Whether Subversion subrepositories are allowed in the working
2315 directory. This option only has an effect if ``subrepos.allowed``
2334 directory. This option only has an effect if ``subrepos.allowed``
2316 is true.
2335 is true.
2317
2336
2318 See the security note above before enabling Subversion subrepos.
2337 See the security note above before enabling Subversion subrepos.
2319 (default: false)
2338 (default: false)
2320
2339
2321 ``templatealias``
2340 ``templatealias``
2322 -----------------
2341 -----------------
2323
2342
2324 Alias definitions for templates. See :hg:`help templates` for details.
2343 Alias definitions for templates. See :hg:`help templates` for details.
2325
2344
2326 ``templates``
2345 ``templates``
2327 -------------
2346 -------------
2328
2347
2329 Use the ``[templates]`` section to define template strings.
2348 Use the ``[templates]`` section to define template strings.
2330 See :hg:`help templates` for details.
2349 See :hg:`help templates` for details.
2331
2350
2332 ``trusted``
2351 ``trusted``
2333 -----------
2352 -----------
2334
2353
2335 Mercurial will not use the settings in the
2354 Mercurial will not use the settings in the
2336 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
2355 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
2337 user or to a trusted group, as various hgrc features allow arbitrary
2356 user or to a trusted group, as various hgrc features allow arbitrary
2338 commands to be run. This issue is often encountered when configuring
2357 commands to be run. This issue is often encountered when configuring
2339 hooks or extensions for shared repositories or servers. However,
2358 hooks or extensions for shared repositories or servers. However,
2340 the web interface will use some safe settings from the ``[web]``
2359 the web interface will use some safe settings from the ``[web]``
2341 section.
2360 section.
2342
2361
2343 This section specifies what users and groups are trusted. The
2362 This section specifies what users and groups are trusted. The
2344 current user is always trusted. To trust everybody, list a user or a
2363 current user is always trusted. To trust everybody, list a user or a
2345 group with name ``*``. These settings must be placed in an
2364 group with name ``*``. These settings must be placed in an
2346 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
2365 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
2347 user or service running Mercurial.
2366 user or service running Mercurial.
2348
2367
2349 ``users``
2368 ``users``
2350 Comma-separated list of trusted users.
2369 Comma-separated list of trusted users.
2351
2370
2352 ``groups``
2371 ``groups``
2353 Comma-separated list of trusted groups.
2372 Comma-separated list of trusted groups.
2354
2373
2355
2374
2356 ``ui``
2375 ``ui``
2357 ------
2376 ------
2358
2377
2359 User interface controls.
2378 User interface controls.
2360
2379
2361 ``archivemeta``
2380 ``archivemeta``
2362 Whether to include the .hg_archival.txt file containing meta data
2381 Whether to include the .hg_archival.txt file containing meta data
2363 (hashes for the repository base and for tip) in archives created
2382 (hashes for the repository base and for tip) in archives created
2364 by the :hg:`archive` command or downloaded via hgweb.
2383 by the :hg:`archive` command or downloaded via hgweb.
2365 (default: True)
2384 (default: True)
2366
2385
2367 ``askusername``
2386 ``askusername``
2368 Whether to prompt for a username when committing. If True, and
2387 Whether to prompt for a username when committing. If True, and
2369 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
2388 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
2370 be prompted to enter a username. If no username is entered, the
2389 be prompted to enter a username. If no username is entered, the
2371 default ``USER@HOST`` is used instead.
2390 default ``USER@HOST`` is used instead.
2372 (default: False)
2391 (default: False)
2373
2392
2374 ``clonebundles``
2393 ``clonebundles``
2375 Whether the "clone bundles" feature is enabled.
2394 Whether the "clone bundles" feature is enabled.
2376
2395
2377 When enabled, :hg:`clone` may download and apply a server-advertised
2396 When enabled, :hg:`clone` may download and apply a server-advertised
2378 bundle file from a URL instead of using the normal exchange mechanism.
2397 bundle file from a URL instead of using the normal exchange mechanism.
2379
2398
2380 This can likely result in faster and more reliable clones.
2399 This can likely result in faster and more reliable clones.
2381
2400
2382 (default: True)
2401 (default: True)
2383
2402
2384 ``clonebundlefallback``
2403 ``clonebundlefallback``
2385 Whether failure to apply an advertised "clone bundle" from a server
2404 Whether failure to apply an advertised "clone bundle" from a server
2386 should result in fallback to a regular clone.
2405 should result in fallback to a regular clone.
2387
2406
2388 This is disabled by default because servers advertising "clone
2407 This is disabled by default because servers advertising "clone
2389 bundles" often do so to reduce server load. If advertised bundles
2408 bundles" often do so to reduce server load. If advertised bundles
2390 start mass failing and clients automatically fall back to a regular
2409 start mass failing and clients automatically fall back to a regular
2391 clone, this would add significant and unexpected load to the server
2410 clone, this would add significant and unexpected load to the server
2392 since the server is expecting clone operations to be offloaded to
2411 since the server is expecting clone operations to be offloaded to
2393 pre-generated bundles. Failing fast (the default behavior) ensures
2412 pre-generated bundles. Failing fast (the default behavior) ensures
2394 clients don't overwhelm the server when "clone bundle" application
2413 clients don't overwhelm the server when "clone bundle" application
2395 fails.
2414 fails.
2396
2415
2397 (default: False)
2416 (default: False)
2398
2417
2399 ``clonebundleprefers``
2418 ``clonebundleprefers``
2400 Defines preferences for which "clone bundles" to use.
2419 Defines preferences for which "clone bundles" to use.
2401
2420
2402 Servers advertising "clone bundles" may advertise multiple available
2421 Servers advertising "clone bundles" may advertise multiple available
2403 bundles. Each bundle may have different attributes, such as the bundle
2422 bundles. Each bundle may have different attributes, such as the bundle
2404 type and compression format. This option is used to prefer a particular
2423 type and compression format. This option is used to prefer a particular
2405 bundle over another.
2424 bundle over another.
2406
2425
2407 The following keys are defined by Mercurial:
2426 The following keys are defined by Mercurial:
2408
2427
2409 BUNDLESPEC
2428 BUNDLESPEC
2410 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
2429 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
2411 e.g. ``gzip-v2`` or ``bzip2-v1``.
2430 e.g. ``gzip-v2`` or ``bzip2-v1``.
2412
2431
2413 COMPRESSION
2432 COMPRESSION
2414 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
2433 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
2415
2434
2416 Server operators may define custom keys.
2435 Server operators may define custom keys.
2417
2436
2418 Example values: ``COMPRESSION=bzip2``,
2437 Example values: ``COMPRESSION=bzip2``,
2419 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
2438 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
2420
2439
2421 By default, the first bundle advertised by the server is used.
2440 By default, the first bundle advertised by the server is used.
2422
2441
2423 ``color``
2442 ``color``
2424 When to colorize output. Possible value are Boolean ("yes" or "no"), or
2443 When to colorize output. Possible value are Boolean ("yes" or "no"), or
2425 "debug", or "always". (default: "yes"). "yes" will use color whenever it
2444 "debug", or "always". (default: "yes"). "yes" will use color whenever it
2426 seems possible. See :hg:`help color` for details.
2445 seems possible. See :hg:`help color` for details.
2427
2446
2428 ``commitsubrepos``
2447 ``commitsubrepos``
2429 Whether to commit modified subrepositories when committing the
2448 Whether to commit modified subrepositories when committing the
2430 parent repository. If False and one subrepository has uncommitted
2449 parent repository. If False and one subrepository has uncommitted
2431 changes, abort the commit.
2450 changes, abort the commit.
2432 (default: False)
2451 (default: False)
2433
2452
2434 ``debug``
2453 ``debug``
2435 Print debugging information. (default: False)
2454 Print debugging information. (default: False)
2436
2455
2437 ``editor``
2456 ``editor``
2438 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
2457 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
2439
2458
2440 ``fallbackencoding``
2459 ``fallbackencoding``
2441 Encoding to try if it's not possible to decode the changelog using
2460 Encoding to try if it's not possible to decode the changelog using
2442 UTF-8. (default: ISO-8859-1)
2461 UTF-8. (default: ISO-8859-1)
2443
2462
2444 ``graphnodetemplate``
2463 ``graphnodetemplate``
2445 (DEPRECATED) Use ``command-templates.graphnode`` instead.
2464 (DEPRECATED) Use ``command-templates.graphnode`` instead.
2446
2465
2447 ``ignore``
2466 ``ignore``
2448 A file to read per-user ignore patterns from. This file should be
2467 A file to read per-user ignore patterns from. This file should be
2449 in the same format as a repository-wide .hgignore file. Filenames
2468 in the same format as a repository-wide .hgignore file. Filenames
2450 are relative to the repository root. This option supports hook syntax,
2469 are relative to the repository root. This option supports hook syntax,
2451 so if you want to specify multiple ignore files, you can do so by
2470 so if you want to specify multiple ignore files, you can do so by
2452 setting something like ``ignore.other = ~/.hgignore2``. For details
2471 setting something like ``ignore.other = ~/.hgignore2``. For details
2453 of the ignore file format, see the ``hgignore(5)`` man page.
2472 of the ignore file format, see the ``hgignore(5)`` man page.
2454
2473
2455 ``interactive``
2474 ``interactive``
2456 Allow to prompt the user. (default: True)
2475 Allow to prompt the user. (default: True)
2457
2476
2458 ``interface``
2477 ``interface``
2459 Select the default interface for interactive features (default: text).
2478 Select the default interface for interactive features (default: text).
2460 Possible values are 'text' and 'curses'.
2479 Possible values are 'text' and 'curses'.
2461
2480
2462 ``interface.chunkselector``
2481 ``interface.chunkselector``
2463 Select the interface for change recording (e.g. :hg:`commit -i`).
2482 Select the interface for change recording (e.g. :hg:`commit -i`).
2464 Possible values are 'text' and 'curses'.
2483 Possible values are 'text' and 'curses'.
2465 This config overrides the interface specified by ui.interface.
2484 This config overrides the interface specified by ui.interface.
2466
2485
2467 ``large-file-limit``
2486 ``large-file-limit``
2468 Largest file size that gives no memory use warning.
2487 Largest file size that gives no memory use warning.
2469 Possible values are integers or 0 to disable the check.
2488 Possible values are integers or 0 to disable the check.
2470 (default: 10000000)
2489 (default: 10000000)
2471
2490
2472 ``logtemplate``
2491 ``logtemplate``
2473 (DEPRECATED) Use ``command-templates.log`` instead.
2492 (DEPRECATED) Use ``command-templates.log`` instead.
2474
2493
2475 ``merge``
2494 ``merge``
2476 The conflict resolution program to use during a manual merge.
2495 The conflict resolution program to use during a manual merge.
2477 For more information on merge tools see :hg:`help merge-tools`.
2496 For more information on merge tools see :hg:`help merge-tools`.
2478 For configuring merge tools see the ``[merge-tools]`` section.
2497 For configuring merge tools see the ``[merge-tools]`` section.
2479
2498
2480 ``mergemarkers``
2499 ``mergemarkers``
2481 Sets the merge conflict marker label styling. The ``detailed`` style
2500 Sets the merge conflict marker label styling. The ``detailed`` style
2482 uses the ``command-templates.mergemarker`` setting to style the labels.
2501 uses the ``command-templates.mergemarker`` setting to style the labels.
2483 The ``basic`` style just uses 'local' and 'other' as the marker label.
2502 The ``basic`` style just uses 'local' and 'other' as the marker label.
2484 One of ``basic`` or ``detailed``.
2503 One of ``basic`` or ``detailed``.
2485 (default: ``basic``)
2504 (default: ``basic``)
2486
2505
2487 ``mergemarkertemplate``
2506 ``mergemarkertemplate``
2488 (DEPRECATED) Use ``command-templates.mergemarker`` instead.
2507 (DEPRECATED) Use ``command-templates.mergemarker`` instead.
2489
2508
2490 ``message-output``
2509 ``message-output``
2491 Where to write status and error messages. (default: ``stdio``)
2510 Where to write status and error messages. (default: ``stdio``)
2492
2511
2493 ``channel``
2512 ``channel``
2494 Use separate channel for structured output. (Command-server only)
2513 Use separate channel for structured output. (Command-server only)
2495 ``stderr``
2514 ``stderr``
2496 Everything to stderr.
2515 Everything to stderr.
2497 ``stdio``
2516 ``stdio``
2498 Status to stdout, and error to stderr.
2517 Status to stdout, and error to stderr.
2499
2518
2500 ``origbackuppath``
2519 ``origbackuppath``
2501 The path to a directory used to store generated .orig files. If the path is
2520 The path to a directory used to store generated .orig files. If the path is
2502 not a directory, one will be created. If set, files stored in this
2521 not a directory, one will be created. If set, files stored in this
2503 directory have the same name as the original file and do not have a .orig
2522 directory have the same name as the original file and do not have a .orig
2504 suffix.
2523 suffix.
2505
2524
2506 ``paginate``
2525 ``paginate``
2507 Control the pagination of command output (default: True). See :hg:`help pager`
2526 Control the pagination of command output (default: True). See :hg:`help pager`
2508 for details.
2527 for details.
2509
2528
2510 ``patch``
2529 ``patch``
2511 An optional external tool that ``hg import`` and some extensions
2530 An optional external tool that ``hg import`` and some extensions
2512 will use for applying patches. By default Mercurial uses an
2531 will use for applying patches. By default Mercurial uses an
2513 internal patch utility. The external tool must work as the common
2532 internal patch utility. The external tool must work as the common
2514 Unix ``patch`` program. In particular, it must accept a ``-p``
2533 Unix ``patch`` program. In particular, it must accept a ``-p``
2515 argument to strip patch headers, a ``-d`` argument to specify the
2534 argument to strip patch headers, a ``-d`` argument to specify the
2516 current directory, a file name to patch, and a patch file to take
2535 current directory, a file name to patch, and a patch file to take
2517 from stdin.
2536 from stdin.
2518
2537
2519 It is possible to specify a patch tool together with extra
2538 It is possible to specify a patch tool together with extra
2520 arguments. For example, setting this option to ``patch --merge``
2539 arguments. For example, setting this option to ``patch --merge``
2521 will use the ``patch`` program with its 2-way merge option.
2540 will use the ``patch`` program with its 2-way merge option.
2522
2541
2523 ``portablefilenames``
2542 ``portablefilenames``
2524 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
2543 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
2525 (default: ``warn``)
2544 (default: ``warn``)
2526
2545
2527 ``warn``
2546 ``warn``
2528 Print a warning message on POSIX platforms, if a file with a non-portable
2547 Print a warning message on POSIX platforms, if a file with a non-portable
2529 filename is added (e.g. a file with a name that can't be created on
2548 filename is added (e.g. a file with a name that can't be created on
2530 Windows because it contains reserved parts like ``AUX``, reserved
2549 Windows because it contains reserved parts like ``AUX``, reserved
2531 characters like ``:``, or would cause a case collision with an existing
2550 characters like ``:``, or would cause a case collision with an existing
2532 file).
2551 file).
2533
2552
2534 ``ignore``
2553 ``ignore``
2535 Don't print a warning.
2554 Don't print a warning.
2536
2555
2537 ``abort``
2556 ``abort``
2538 The command is aborted.
2557 The command is aborted.
2539
2558
2540 ``true``
2559 ``true``
2541 Alias for ``warn``.
2560 Alias for ``warn``.
2542
2561
2543 ``false``
2562 ``false``
2544 Alias for ``ignore``.
2563 Alias for ``ignore``.
2545
2564
2546 .. container:: windows
2565 .. container:: windows
2547
2566
2548 On Windows, this configuration option is ignored and the command aborted.
2567 On Windows, this configuration option is ignored and the command aborted.
2549
2568
2550 ``pre-merge-tool-output-template``
2569 ``pre-merge-tool-output-template``
2551 (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead.
2570 (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead.
2552
2571
2553 ``quiet``
2572 ``quiet``
2554 Reduce the amount of output printed.
2573 Reduce the amount of output printed.
2555 (default: False)
2574 (default: False)
2556
2575
2557 ``relative-paths``
2576 ``relative-paths``
2558 Prefer relative paths in the UI.
2577 Prefer relative paths in the UI.
2559
2578
2560 ``remotecmd``
2579 ``remotecmd``
2561 Remote command to use for clone/push/pull operations.
2580 Remote command to use for clone/push/pull operations.
2562 (default: ``hg``)
2581 (default: ``hg``)
2563
2582
2564 ``report_untrusted``
2583 ``report_untrusted``
2565 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2584 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2566 trusted user or group.
2585 trusted user or group.
2567 (default: True)
2586 (default: True)
2568
2587
2569 ``slash``
2588 ``slash``
2570 (Deprecated. Use ``slashpath`` template filter instead.)
2589 (Deprecated. Use ``slashpath`` template filter instead.)
2571
2590
2572 Display paths using a slash (``/``) as the path separator. This
2591 Display paths using a slash (``/``) as the path separator. This
2573 only makes a difference on systems where the default path
2592 only makes a difference on systems where the default path
2574 separator is not the slash character (e.g. Windows uses the
2593 separator is not the slash character (e.g. Windows uses the
2575 backslash character (``\``)).
2594 backslash character (``\``)).
2576 (default: False)
2595 (default: False)
2577
2596
2578 ``statuscopies``
2597 ``statuscopies``
2579 Display copies in the status command.
2598 Display copies in the status command.
2580
2599
2581 ``ssh``
2600 ``ssh``
2582 Command to use for SSH connections. (default: ``ssh``)
2601 Command to use for SSH connections. (default: ``ssh``)
2583
2602
2584 ``ssherrorhint``
2603 ``ssherrorhint``
2585 A hint shown to the user in the case of SSH error (e.g.
2604 A hint shown to the user in the case of SSH error (e.g.
2586 ``Please see http://company/internalwiki/ssh.html``)
2605 ``Please see http://company/internalwiki/ssh.html``)
2587
2606
2588 ``strict``
2607 ``strict``
2589 Require exact command names, instead of allowing unambiguous
2608 Require exact command names, instead of allowing unambiguous
2590 abbreviations. (default: False)
2609 abbreviations. (default: False)
2591
2610
2592 ``style``
2611 ``style``
2593 Name of style to use for command output.
2612 Name of style to use for command output.
2594
2613
2595 ``supportcontact``
2614 ``supportcontact``
2596 A URL where users should report a Mercurial traceback. Use this if you are a
2615 A URL where users should report a Mercurial traceback. Use this if you are a
2597 large organisation with its own Mercurial deployment process and crash
2616 large organisation with its own Mercurial deployment process and crash
2598 reports should be addressed to your internal support.
2617 reports should be addressed to your internal support.
2599
2618
2600 ``textwidth``
2619 ``textwidth``
2601 Maximum width of help text. A longer line generated by ``hg help`` or
2620 Maximum width of help text. A longer line generated by ``hg help`` or
2602 ``hg subcommand --help`` will be broken after white space to get this
2621 ``hg subcommand --help`` will be broken after white space to get this
2603 width or the terminal width, whichever comes first.
2622 width or the terminal width, whichever comes first.
2604 A non-positive value will disable this and the terminal width will be
2623 A non-positive value will disable this and the terminal width will be
2605 used. (default: 78)
2624 used. (default: 78)
2606
2625
2607 ``timeout``
2626 ``timeout``
2608 The timeout used when a lock is held (in seconds), a negative value
2627 The timeout used when a lock is held (in seconds), a negative value
2609 means no timeout. (default: 600)
2628 means no timeout. (default: 600)
2610
2629
2611 ``timeout.warn``
2630 ``timeout.warn``
2612 Time (in seconds) before a warning is printed about held lock. A negative
2631 Time (in seconds) before a warning is printed about held lock. A negative
2613 value means no warning. (default: 0)
2632 value means no warning. (default: 0)
2614
2633
2615 ``traceback``
2634 ``traceback``
2616 Mercurial always prints a traceback when an unknown exception
2635 Mercurial always prints a traceback when an unknown exception
2617 occurs. Setting this to True will make Mercurial print a traceback
2636 occurs. Setting this to True will make Mercurial print a traceback
2618 on all exceptions, even those recognized by Mercurial (such as
2637 on all exceptions, even those recognized by Mercurial (such as
2619 IOError or MemoryError). (default: False)
2638 IOError or MemoryError). (default: False)
2620
2639
2621 ``tweakdefaults``
2640 ``tweakdefaults``
2622
2641
2623 By default Mercurial's behavior changes very little from release
2642 By default Mercurial's behavior changes very little from release
2624 to release, but over time the recommended config settings
2643 to release, but over time the recommended config settings
2625 shift. Enable this config to opt in to get automatic tweaks to
2644 shift. Enable this config to opt in to get automatic tweaks to
2626 Mercurial's behavior over time. This config setting will have no
2645 Mercurial's behavior over time. This config setting will have no
2627 effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
2646 effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
2628 not include ``tweakdefaults``. (default: False)
2647 not include ``tweakdefaults``. (default: False)
2629
2648
2630 It currently means::
2649 It currently means::
2631
2650
2632 .. tweakdefaultsmarker
2651 .. tweakdefaultsmarker
2633
2652
2634 ``username``
2653 ``username``
2635 The committer of a changeset created when running "commit".
2654 The committer of a changeset created when running "commit".
2636 Typically a person's name and email address, e.g. ``Fred Widget
2655 Typically a person's name and email address, e.g. ``Fred Widget
2637 <fred@example.com>``. Environment variables in the
2656 <fred@example.com>``. Environment variables in the
2638 username are expanded.
2657 username are expanded.
2639
2658
2640 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2659 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2641 hgrc is empty, e.g. if the system admin set ``username =`` in the
2660 hgrc is empty, e.g. if the system admin set ``username =`` in the
2642 system hgrc, it has to be specified manually or in a different
2661 system hgrc, it has to be specified manually or in a different
2643 hgrc file)
2662 hgrc file)
2644
2663
2645 ``verbose``
2664 ``verbose``
2646 Increase the amount of output printed. (default: False)
2665 Increase the amount of output printed. (default: False)
2647
2666
2648
2667
2649 ``command-templates``
2668 ``command-templates``
2650 ---------------------
2669 ---------------------
2651
2670
2652 Templates used for customizing the output of commands.
2671 Templates used for customizing the output of commands.
2653
2672
2654 ``graphnode``
2673 ``graphnode``
2655 The template used to print changeset nodes in an ASCII revision graph.
2674 The template used to print changeset nodes in an ASCII revision graph.
2656 (default: ``{graphnode}``)
2675 (default: ``{graphnode}``)
2657
2676
2658 ``log``
2677 ``log``
2659 Template string for commands that print changesets.
2678 Template string for commands that print changesets.
2660
2679
2661 ``mergemarker``
2680 ``mergemarker``
2662 The template used to print the commit description next to each conflict
2681 The template used to print the commit description next to each conflict
2663 marker during merge conflicts. See :hg:`help templates` for the template
2682 marker during merge conflicts. See :hg:`help templates` for the template
2664 format.
2683 format.
2665
2684
2666 Defaults to showing the hash, tags, branches, bookmarks, author, and
2685 Defaults to showing the hash, tags, branches, bookmarks, author, and
2667 the first line of the commit description.
2686 the first line of the commit description.
2668
2687
2669 If you use non-ASCII characters in names for tags, branches, bookmarks,
2688 If you use non-ASCII characters in names for tags, branches, bookmarks,
2670 authors, and/or commit descriptions, you must pay attention to encodings of
2689 authors, and/or commit descriptions, you must pay attention to encodings of
2671 managed files. At template expansion, non-ASCII characters use the encoding
2690 managed files. At template expansion, non-ASCII characters use the encoding
2672 specified by the ``--encoding`` global option, ``HGENCODING`` or other
2691 specified by the ``--encoding`` global option, ``HGENCODING`` or other
2673 environment variables that govern your locale. If the encoding of the merge
2692 environment variables that govern your locale. If the encoding of the merge
2674 markers is different from the encoding of the merged files,
2693 markers is different from the encoding of the merged files,
2675 serious problems may occur.
2694 serious problems may occur.
2676
2695
2677 Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
2696 Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
2678
2697
2679 ``oneline-summary``
2698 ``oneline-summary``
2680 A template used by `hg rebase` and other commands for showing a one-line
2699 A template used by `hg rebase` and other commands for showing a one-line
2681 summary of a commit. If the template configured here is longer than one
2700 summary of a commit. If the template configured here is longer than one
2682 line, then only the first line is used.
2701 line, then only the first line is used.
2683
2702
2684 The template can be overridden per command by defining a template in
2703 The template can be overridden per command by defining a template in
2685 `oneline-summary.<command>`, where `<command>` can be e.g. "rebase".
2704 `oneline-summary.<command>`, where `<command>` can be e.g. "rebase".
2686
2705
2687 ``pre-merge-tool-output``
2706 ``pre-merge-tool-output``
2688 A template that is printed before executing an external merge tool. This can
2707 A template that is printed before executing an external merge tool. This can
2689 be used to print out additional context that might be useful to have during
2708 be used to print out additional context that might be useful to have during
2690 the conflict resolution, such as the description of the various commits
2709 the conflict resolution, such as the description of the various commits
2691 involved or bookmarks/tags.
2710 involved or bookmarks/tags.
2692
2711
2693 Additional information is available in the ``local`, ``base``, and ``other``
2712 Additional information is available in the ``local`, ``base``, and ``other``
2694 dicts. For example: ``{local.label}``, ``{base.name}``, or
2713 dicts. For example: ``{local.label}``, ``{base.name}``, or
2695 ``{other.islink}``.
2714 ``{other.islink}``.
2696
2715
2697
2716
2698 ``web``
2717 ``web``
2699 -------
2718 -------
2700
2719
2701 Web interface configuration. The settings in this section apply to
2720 Web interface configuration. The settings in this section apply to
2702 both the builtin webserver (started by :hg:`serve`) and the script you
2721 both the builtin webserver (started by :hg:`serve`) and the script you
2703 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2722 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2704 and WSGI).
2723 and WSGI).
2705
2724
2706 The Mercurial webserver does no authentication (it does not prompt for
2725 The Mercurial webserver does no authentication (it does not prompt for
2707 usernames and passwords to validate *who* users are), but it does do
2726 usernames and passwords to validate *who* users are), but it does do
2708 authorization (it grants or denies access for *authenticated users*
2727 authorization (it grants or denies access for *authenticated users*
2709 based on settings in this section). You must either configure your
2728 based on settings in this section). You must either configure your
2710 webserver to do authentication for you, or disable the authorization
2729 webserver to do authentication for you, or disable the authorization
2711 checks.
2730 checks.
2712
2731
2713 For a quick setup in a trusted environment, e.g., a private LAN, where
2732 For a quick setup in a trusted environment, e.g., a private LAN, where
2714 you want it to accept pushes from anybody, you can use the following
2733 you want it to accept pushes from anybody, you can use the following
2715 command line::
2734 command line::
2716
2735
2717 $ hg --config web.allow-push=* --config web.push_ssl=False serve
2736 $ hg --config web.allow-push=* --config web.push_ssl=False serve
2718
2737
2719 Note that this will allow anybody to push anything to the server and
2738 Note that this will allow anybody to push anything to the server and
2720 that this should not be used for public servers.
2739 that this should not be used for public servers.
2721
2740
2722 The full set of options is:
2741 The full set of options is:
2723
2742
2724 ``accesslog``
2743 ``accesslog``
2725 Where to output the access log. (default: stdout)
2744 Where to output the access log. (default: stdout)
2726
2745
2727 ``address``
2746 ``address``
2728 Interface address to bind to. (default: all)
2747 Interface address to bind to. (default: all)
2729
2748
2730 ``allow-archive``
2749 ``allow-archive``
2731 List of archive format (bz2, gz, zip) allowed for downloading.
2750 List of archive format (bz2, gz, zip) allowed for downloading.
2732 (default: empty)
2751 (default: empty)
2733
2752
2734 ``allowbz2``
2753 ``allowbz2``
2735 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2754 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2736 revisions.
2755 revisions.
2737 (default: False)
2756 (default: False)
2738
2757
2739 ``allowgz``
2758 ``allowgz``
2740 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2759 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2741 revisions.
2760 revisions.
2742 (default: False)
2761 (default: False)
2743
2762
2744 ``allow-pull``
2763 ``allow-pull``
2745 Whether to allow pulling from the repository. (default: True)
2764 Whether to allow pulling from the repository. (default: True)
2746
2765
2747 ``allow-push``
2766 ``allow-push``
2748 Whether to allow pushing to the repository. If empty or not set,
2767 Whether to allow pushing to the repository. If empty or not set,
2749 pushing is not allowed. If the special value ``*``, any remote
2768 pushing is not allowed. If the special value ``*``, any remote
2750 user can push, including unauthenticated users. Otherwise, the
2769 user can push, including unauthenticated users. Otherwise, the
2751 remote user must have been authenticated, and the authenticated
2770 remote user must have been authenticated, and the authenticated
2752 user name must be present in this list. The contents of the
2771 user name must be present in this list. The contents of the
2753 allow-push list are examined after the deny_push list.
2772 allow-push list are examined after the deny_push list.
2754
2773
2755 ``allow_read``
2774 ``allow_read``
2756 If the user has not already been denied repository access due to
2775 If the user has not already been denied repository access due to
2757 the contents of deny_read, this list determines whether to grant
2776 the contents of deny_read, this list determines whether to grant
2758 repository access to the user. If this list is not empty, and the
2777 repository access to the user. If this list is not empty, and the
2759 user is unauthenticated or not present in the list, then access is
2778 user is unauthenticated or not present in the list, then access is
2760 denied for the user. If the list is empty or not set, then access
2779 denied for the user. If the list is empty or not set, then access
2761 is permitted to all users by default. Setting allow_read to the
2780 is permitted to all users by default. Setting allow_read to the
2762 special value ``*`` is equivalent to it not being set (i.e. access
2781 special value ``*`` is equivalent to it not being set (i.e. access
2763 is permitted to all users). The contents of the allow_read list are
2782 is permitted to all users). The contents of the allow_read list are
2764 examined after the deny_read list.
2783 examined after the deny_read list.
2765
2784
2766 ``allowzip``
2785 ``allowzip``
2767 (DEPRECATED) Whether to allow .zip downloading of repository
2786 (DEPRECATED) Whether to allow .zip downloading of repository
2768 revisions. This feature creates temporary files.
2787 revisions. This feature creates temporary files.
2769 (default: False)
2788 (default: False)
2770
2789
2771 ``archivesubrepos``
2790 ``archivesubrepos``
2772 Whether to recurse into subrepositories when archiving.
2791 Whether to recurse into subrepositories when archiving.
2773 (default: False)
2792 (default: False)
2774
2793
2775 ``baseurl``
2794 ``baseurl``
2776 Base URL to use when publishing URLs in other locations, so
2795 Base URL to use when publishing URLs in other locations, so
2777 third-party tools like email notification hooks can construct
2796 third-party tools like email notification hooks can construct
2778 URLs. Example: ``http://hgserver/repos/``.
2797 URLs. Example: ``http://hgserver/repos/``.
2779
2798
2780 ``cacerts``
2799 ``cacerts``
2781 Path to file containing a list of PEM encoded certificate
2800 Path to file containing a list of PEM encoded certificate
2782 authority certificates. Environment variables and ``~user``
2801 authority certificates. Environment variables and ``~user``
2783 constructs are expanded in the filename. If specified on the
2802 constructs are expanded in the filename. If specified on the
2784 client, then it will verify the identity of remote HTTPS servers
2803 client, then it will verify the identity of remote HTTPS servers
2785 with these certificates.
2804 with these certificates.
2786
2805
2787 To disable SSL verification temporarily, specify ``--insecure`` from
2806 To disable SSL verification temporarily, specify ``--insecure`` from
2788 command line.
2807 command line.
2789
2808
2790 You can use OpenSSL's CA certificate file if your platform has
2809 You can use OpenSSL's CA certificate file if your platform has
2791 one. On most Linux systems this will be
2810 one. On most Linux systems this will be
2792 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2811 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2793 generate this file manually. The form must be as follows::
2812 generate this file manually. The form must be as follows::
2794
2813
2795 -----BEGIN CERTIFICATE-----
2814 -----BEGIN CERTIFICATE-----
2796 ... (certificate in base64 PEM encoding) ...
2815 ... (certificate in base64 PEM encoding) ...
2797 -----END CERTIFICATE-----
2816 -----END CERTIFICATE-----
2798 -----BEGIN CERTIFICATE-----
2817 -----BEGIN CERTIFICATE-----
2799 ... (certificate in base64 PEM encoding) ...
2818 ... (certificate in base64 PEM encoding) ...
2800 -----END CERTIFICATE-----
2819 -----END CERTIFICATE-----
2801
2820
2802 ``cache``
2821 ``cache``
2803 Whether to support caching in hgweb. (default: True)
2822 Whether to support caching in hgweb. (default: True)
2804
2823
2805 ``certificate``
2824 ``certificate``
2806 Certificate to use when running :hg:`serve`.
2825 Certificate to use when running :hg:`serve`.
2807
2826
2808 ``collapse``
2827 ``collapse``
2809 With ``descend`` enabled, repositories in subdirectories are shown at
2828 With ``descend`` enabled, repositories in subdirectories are shown at
2810 a single level alongside repositories in the current path. With
2829 a single level alongside repositories in the current path. With
2811 ``collapse`` also enabled, repositories residing at a deeper level than
2830 ``collapse`` also enabled, repositories residing at a deeper level than
2812 the current path are grouped behind navigable directory entries that
2831 the current path are grouped behind navigable directory entries that
2813 lead to the locations of these repositories. In effect, this setting
2832 lead to the locations of these repositories. In effect, this setting
2814 collapses each collection of repositories found within a subdirectory
2833 collapses each collection of repositories found within a subdirectory
2815 into a single entry for that subdirectory. (default: False)
2834 into a single entry for that subdirectory. (default: False)
2816
2835
2817 ``comparisoncontext``
2836 ``comparisoncontext``
2818 Number of lines of context to show in side-by-side file comparison. If
2837 Number of lines of context to show in side-by-side file comparison. If
2819 negative or the value ``full``, whole files are shown. (default: 5)
2838 negative or the value ``full``, whole files are shown. (default: 5)
2820
2839
2821 This setting can be overridden by a ``context`` request parameter to the
2840 This setting can be overridden by a ``context`` request parameter to the
2822 ``comparison`` command, taking the same values.
2841 ``comparison`` command, taking the same values.
2823
2842
2824 ``contact``
2843 ``contact``
2825 Name or email address of the person in charge of the repository.
2844 Name or email address of the person in charge of the repository.
2826 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2845 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2827
2846
2828 ``csp``
2847 ``csp``
2829 Send a ``Content-Security-Policy`` HTTP header with this value.
2848 Send a ``Content-Security-Policy`` HTTP header with this value.
2830
2849
2831 The value may contain a special string ``%nonce%``, which will be replaced
2850 The value may contain a special string ``%nonce%``, which will be replaced
2832 by a randomly-generated one-time use value. If the value contains
2851 by a randomly-generated one-time use value. If the value contains
2833 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2852 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2834 one-time property of the nonce. This nonce will also be inserted into
2853 one-time property of the nonce. This nonce will also be inserted into
2835 ``<script>`` elements containing inline JavaScript.
2854 ``<script>`` elements containing inline JavaScript.
2836
2855
2837 Note: lots of HTML content sent by the server is derived from repository
2856 Note: lots of HTML content sent by the server is derived from repository
2838 data. Please consider the potential for malicious repository data to
2857 data. Please consider the potential for malicious repository data to
2839 "inject" itself into generated HTML content as part of your security
2858 "inject" itself into generated HTML content as part of your security
2840 threat model.
2859 threat model.
2841
2860
2842 ``deny_push``
2861 ``deny_push``
2843 Whether to deny pushing to the repository. If empty or not set,
2862 Whether to deny pushing to the repository. If empty or not set,
2844 push is not denied. If the special value ``*``, all remote users are
2863 push is not denied. If the special value ``*``, all remote users are
2845 denied push. Otherwise, unauthenticated users are all denied, and
2864 denied push. Otherwise, unauthenticated users are all denied, and
2846 any authenticated user name present in this list is also denied. The
2865 any authenticated user name present in this list is also denied. The
2847 contents of the deny_push list are examined before the allow-push list.
2866 contents of the deny_push list are examined before the allow-push list.
2848
2867
2849 ``deny_read``
2868 ``deny_read``
2850 Whether to deny reading/viewing of the repository. If this list is
2869 Whether to deny reading/viewing of the repository. If this list is
2851 not empty, unauthenticated users are all denied, and any
2870 not empty, unauthenticated users are all denied, and any
2852 authenticated user name present in this list is also denied access to
2871 authenticated user name present in this list is also denied access to
2853 the repository. If set to the special value ``*``, all remote users
2872 the repository. If set to the special value ``*``, all remote users
2854 are denied access (rarely needed ;). If deny_read is empty or not set,
2873 are denied access (rarely needed ;). If deny_read is empty or not set,
2855 the determination of repository access depends on the presence and
2874 the determination of repository access depends on the presence and
2856 content of the allow_read list (see description). If both
2875 content of the allow_read list (see description). If both
2857 deny_read and allow_read are empty or not set, then access is
2876 deny_read and allow_read are empty or not set, then access is
2858 permitted to all users by default. If the repository is being
2877 permitted to all users by default. If the repository is being
2859 served via hgwebdir, denied users will not be able to see it in
2878 served via hgwebdir, denied users will not be able to see it in
2860 the list of repositories. The contents of the deny_read list have
2879 the list of repositories. The contents of the deny_read list have
2861 priority over (are examined before) the contents of the allow_read
2880 priority over (are examined before) the contents of the allow_read
2862 list.
2881 list.
2863
2882
2864 ``descend``
2883 ``descend``
2865 hgwebdir indexes will not descend into subdirectories. Only repositories
2884 hgwebdir indexes will not descend into subdirectories. Only repositories
2866 directly in the current path will be shown (other repositories are still
2885 directly in the current path will be shown (other repositories are still
2867 available from the index corresponding to their containing path).
2886 available from the index corresponding to their containing path).
2868
2887
2869 ``description``
2888 ``description``
2870 Textual description of the repository's purpose or contents.
2889 Textual description of the repository's purpose or contents.
2871 (default: "unknown")
2890 (default: "unknown")
2872
2891
2873 ``encoding``
2892 ``encoding``
2874 Character encoding name. (default: the current locale charset)
2893 Character encoding name. (default: the current locale charset)
2875 Example: "UTF-8".
2894 Example: "UTF-8".
2876
2895
2877 ``errorlog``
2896 ``errorlog``
2878 Where to output the error log. (default: stderr)
2897 Where to output the error log. (default: stderr)
2879
2898
2880 ``guessmime``
2899 ``guessmime``
2881 Control MIME types for raw download of file content.
2900 Control MIME types for raw download of file content.
2882 Set to True to let hgweb guess the content type from the file
2901 Set to True to let hgweb guess the content type from the file
2883 extension. This will serve HTML files as ``text/html`` and might
2902 extension. This will serve HTML files as ``text/html`` and might
2884 allow cross-site scripting attacks when serving untrusted
2903 allow cross-site scripting attacks when serving untrusted
2885 repositories. (default: False)
2904 repositories. (default: False)
2886
2905
2887 ``hidden``
2906 ``hidden``
2888 Whether to hide the repository in the hgwebdir index.
2907 Whether to hide the repository in the hgwebdir index.
2889 (default: False)
2908 (default: False)
2890
2909
2891 ``ipv6``
2910 ``ipv6``
2892 Whether to use IPv6. (default: False)
2911 Whether to use IPv6. (default: False)
2893
2912
2894 ``labels``
2913 ``labels``
2895 List of string *labels* associated with the repository.
2914 List of string *labels* associated with the repository.
2896
2915
2897 Labels are exposed as a template keyword and can be used to customize
2916 Labels are exposed as a template keyword and can be used to customize
2898 output. e.g. the ``index`` template can group or filter repositories
2917 output. e.g. the ``index`` template can group or filter repositories
2899 by labels and the ``summary`` template can display additional content
2918 by labels and the ``summary`` template can display additional content
2900 if a specific label is present.
2919 if a specific label is present.
2901
2920
2902 ``logoimg``
2921 ``logoimg``
2903 File name of the logo image that some templates display on each page.
2922 File name of the logo image that some templates display on each page.
2904 The file name is relative to ``staticurl``. That is, the full path to
2923 The file name is relative to ``staticurl``. That is, the full path to
2905 the logo image is "staticurl/logoimg".
2924 the logo image is "staticurl/logoimg".
2906 If unset, ``hglogo.png`` will be used.
2925 If unset, ``hglogo.png`` will be used.
2907
2926
2908 ``logourl``
2927 ``logourl``
2909 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2928 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2910 will be used.
2929 will be used.
2911
2930
2912 ``maxchanges``
2931 ``maxchanges``
2913 Maximum number of changes to list on the changelog. (default: 10)
2932 Maximum number of changes to list on the changelog. (default: 10)
2914
2933
2915 ``maxfiles``
2934 ``maxfiles``
2916 Maximum number of files to list per changeset. (default: 10)
2935 Maximum number of files to list per changeset. (default: 10)
2917
2936
2918 ``maxshortchanges``
2937 ``maxshortchanges``
2919 Maximum number of changes to list on the shortlog, graph or filelog
2938 Maximum number of changes to list on the shortlog, graph or filelog
2920 pages. (default: 60)
2939 pages. (default: 60)
2921
2940
2922 ``name``
2941 ``name``
2923 Repository name to use in the web interface.
2942 Repository name to use in the web interface.
2924 (default: current working directory)
2943 (default: current working directory)
2925
2944
2926 ``port``
2945 ``port``
2927 Port to listen on. (default: 8000)
2946 Port to listen on. (default: 8000)
2928
2947
2929 ``prefix``
2948 ``prefix``
2930 Prefix path to serve from. (default: '' (server root))
2949 Prefix path to serve from. (default: '' (server root))
2931
2950
2932 ``push_ssl``
2951 ``push_ssl``
2933 Whether to require that inbound pushes be transported over SSL to
2952 Whether to require that inbound pushes be transported over SSL to
2934 prevent password sniffing. (default: True)
2953 prevent password sniffing. (default: True)
2935
2954
2936 ``refreshinterval``
2955 ``refreshinterval``
2937 How frequently directory listings re-scan the filesystem for new
2956 How frequently directory listings re-scan the filesystem for new
2938 repositories, in seconds. This is relevant when wildcards are used
2957 repositories, in seconds. This is relevant when wildcards are used
2939 to define paths. Depending on how much filesystem traversal is
2958 to define paths. Depending on how much filesystem traversal is
2940 required, refreshing may negatively impact performance.
2959 required, refreshing may negatively impact performance.
2941
2960
2942 Values less than or equal to 0 always refresh.
2961 Values less than or equal to 0 always refresh.
2943 (default: 20)
2962 (default: 20)
2944
2963
2945 ``server-header``
2964 ``server-header``
2946 Value for HTTP ``Server`` response header.
2965 Value for HTTP ``Server`` response header.
2947
2966
2948 ``static``
2967 ``static``
2949 Directory where static files are served from.
2968 Directory where static files are served from.
2950
2969
2951 ``staticurl``
2970 ``staticurl``
2952 Base URL to use for static files. If unset, static files (e.g. the
2971 Base URL to use for static files. If unset, static files (e.g. the
2953 hgicon.png favicon) will be served by the CGI script itself. Use
2972 hgicon.png favicon) will be served by the CGI script itself. Use
2954 this setting to serve them directly with the HTTP server.
2973 this setting to serve them directly with the HTTP server.
2955 Example: ``http://hgserver/static/``.
2974 Example: ``http://hgserver/static/``.
2956
2975
2957 ``stripes``
2976 ``stripes``
2958 How many lines a "zebra stripe" should span in multi-line output.
2977 How many lines a "zebra stripe" should span in multi-line output.
2959 Set to 0 to disable. (default: 1)
2978 Set to 0 to disable. (default: 1)
2960
2979
2961 ``style``
2980 ``style``
2962 Which template map style to use. The available options are the names of
2981 Which template map style to use. The available options are the names of
2963 subdirectories in the HTML templates path. (default: ``paper``)
2982 subdirectories in the HTML templates path. (default: ``paper``)
2964 Example: ``monoblue``.
2983 Example: ``monoblue``.
2965
2984
2966 ``templates``
2985 ``templates``
2967 Where to find the HTML templates. The default path to the HTML templates
2986 Where to find the HTML templates. The default path to the HTML templates
2968 can be obtained from ``hg debuginstall``.
2987 can be obtained from ``hg debuginstall``.
2969
2988
2970 ``websub``
2989 ``websub``
2971 ----------
2990 ----------
2972
2991
2973 Web substitution filter definition. You can use this section to
2992 Web substitution filter definition. You can use this section to
2974 define a set of regular expression substitution patterns which
2993 define a set of regular expression substitution patterns which
2975 let you automatically modify the hgweb server output.
2994 let you automatically modify the hgweb server output.
2976
2995
2977 The default hgweb templates only apply these substitution patterns
2996 The default hgweb templates only apply these substitution patterns
2978 on the revision description fields. You can apply them anywhere
2997 on the revision description fields. You can apply them anywhere
2979 you want when you create your own templates by adding calls to the
2998 you want when you create your own templates by adding calls to the
2980 "websub" filter (usually after calling the "escape" filter).
2999 "websub" filter (usually after calling the "escape" filter).
2981
3000
2982 This can be used, for example, to convert issue references to links
3001 This can be used, for example, to convert issue references to links
2983 to your issue tracker, or to convert "markdown-like" syntax into
3002 to your issue tracker, or to convert "markdown-like" syntax into
2984 HTML (see the examples below).
3003 HTML (see the examples below).
2985
3004
2986 Each entry in this section names a substitution filter.
3005 Each entry in this section names a substitution filter.
2987 The value of each entry defines the substitution expression itself.
3006 The value of each entry defines the substitution expression itself.
2988 The websub expressions follow the old interhg extension syntax,
3007 The websub expressions follow the old interhg extension syntax,
2989 which in turn imitates the Unix sed replacement syntax::
3008 which in turn imitates the Unix sed replacement syntax::
2990
3009
2991 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
3010 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2992
3011
2993 You can use any separator other than "/". The final "i" is optional
3012 You can use any separator other than "/". The final "i" is optional
2994 and indicates that the search must be case insensitive.
3013 and indicates that the search must be case insensitive.
2995
3014
2996 Examples::
3015 Examples::
2997
3016
2998 [websub]
3017 [websub]
2999 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
3018 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
3000 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
3019 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
3001 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
3020 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
3002
3021
3003 ``worker``
3022 ``worker``
3004 ----------
3023 ----------
3005
3024
3006 Parallel master/worker configuration. We currently perform working
3025 Parallel master/worker configuration. We currently perform working
3007 directory updates in parallel on Unix-like systems, which greatly
3026 directory updates in parallel on Unix-like systems, which greatly
3008 helps performance.
3027 helps performance.
3009
3028
3010 ``enabled``
3029 ``enabled``
3011 Whether to enable workers code to be used.
3030 Whether to enable workers code to be used.
3012 (default: true)
3031 (default: true)
3013
3032
3014 ``numcpus``
3033 ``numcpus``
3015 Number of CPUs to use for parallel operations. A zero or
3034 Number of CPUs to use for parallel operations. A zero or
3016 negative value is treated as ``use the default``.
3035 negative value is treated as ``use the default``.
3017 (default: 4 or the number of CPUs on the system, whichever is larger)
3036 (default: 4 or the number of CPUs on the system, whichever is larger)
3018
3037
3019 ``backgroundclose``
3038 ``backgroundclose``
3020 Whether to enable closing file handles on background threads during certain
3039 Whether to enable closing file handles on background threads during certain
3021 operations. Some platforms aren't very efficient at closing file
3040 operations. Some platforms aren't very efficient at closing file
3022 handles that have been written or appended to. By performing file closing
3041 handles that have been written or appended to. By performing file closing
3023 on background threads, file write rate can increase substantially.
3042 on background threads, file write rate can increase substantially.
3024 (default: true on Windows, false elsewhere)
3043 (default: true on Windows, false elsewhere)
3025
3044
3026 ``backgroundcloseminfilecount``
3045 ``backgroundcloseminfilecount``
3027 Minimum number of files required to trigger background file closing.
3046 Minimum number of files required to trigger background file closing.
3028 Operations not writing this many files won't start background close
3047 Operations not writing this many files won't start background close
3029 threads.
3048 threads.
3030 (default: 2048)
3049 (default: 2048)
3031
3050
3032 ``backgroundclosemaxqueue``
3051 ``backgroundclosemaxqueue``
3033 The maximum number of opened file handles waiting to be closed in the
3052 The maximum number of opened file handles waiting to be closed in the
3034 background. This option only has an effect if ``backgroundclose`` is
3053 background. This option only has an effect if ``backgroundclose`` is
3035 enabled.
3054 enabled.
3036 (default: 384)
3055 (default: 384)
3037
3056
3038 ``backgroundclosethreadcount``
3057 ``backgroundclosethreadcount``
3039 Number of threads to process background file closes. Only relevant if
3058 Number of threads to process background file closes. Only relevant if
3040 ``backgroundclose`` is enabled.
3059 ``backgroundclose`` is enabled.
3041 (default: 4)
3060 (default: 4)
General Comments 0
You need to be logged in to leave comments. Login now