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