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