##// END OF EJS Templates
profiling: use vendored statprof and upstream enhancements (BC)...
Gregory Szorc -
r30316:faf1b892 default
parent child Browse files
Show More
@@ -1,2240 +1,2254 b''
1 The Mercurial system uses a set of configuration files to control
1 The Mercurial system uses a set of configuration files to control
2 aspects of its behavior.
2 aspects of its behavior.
3
3
4 Troubleshooting
4 Troubleshooting
5 ===============
5 ===============
6
6
7 If you're having problems with your configuration,
7 If you're having problems with your configuration,
8 :hg:`config --debug` can help you understand what is introducing
8 :hg:`config --debug` can help you understand what is introducing
9 a setting into your environment.
9 a setting into your environment.
10
10
11 See :hg:`help config.syntax` and :hg:`help config.files`
11 See :hg:`help config.syntax` and :hg:`help config.files`
12 for information about how and where to override things.
12 for information about how and where to override things.
13
13
14 Structure
14 Structure
15 =========
15 =========
16
16
17 The configuration files use a simple ini-file format. A configuration
17 The configuration files use a simple ini-file format. A configuration
18 file consists of sections, led by a ``[section]`` header and followed
18 file consists of sections, led by a ``[section]`` header and followed
19 by ``name = value`` entries::
19 by ``name = value`` entries::
20
20
21 [ui]
21 [ui]
22 username = Firstname Lastname <firstname.lastname@example.net>
22 username = Firstname Lastname <firstname.lastname@example.net>
23 verbose = True
23 verbose = True
24
24
25 The above entries will be referred to as ``ui.username`` and
25 The above entries will be referred to as ``ui.username`` and
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
27
27
28 Files
28 Files
29 =====
29 =====
30
30
31 Mercurial reads configuration data from several files, if they exist.
31 Mercurial reads configuration data from several files, if they exist.
32 These files do not exist by default and you will have to create the
32 These files do not exist by default and you will have to create the
33 appropriate configuration files yourself:
33 appropriate configuration files yourself:
34
34
35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
36
36
37 Global configuration like the username setting is typically put into:
37 Global configuration like the username setting is typically put into:
38
38
39 .. container:: windows
39 .. container:: windows
40
40
41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
42
42
43 .. container:: unix.plan9
43 .. container:: unix.plan9
44
44
45 - ``$HOME/.hgrc`` (on Unix, Plan9)
45 - ``$HOME/.hgrc`` (on Unix, Plan9)
46
46
47 The names of these files depend on the system on which Mercurial is
47 The names of these files depend on the system on which Mercurial is
48 installed. ``*.rc`` files from a single directory are read in
48 installed. ``*.rc`` files from a single directory are read in
49 alphabetical order, later ones overriding earlier ones. Where multiple
49 alphabetical order, later ones overriding earlier ones. Where multiple
50 paths are given below, settings from earlier paths override later
50 paths are given below, settings from earlier paths override later
51 ones.
51 ones.
52
52
53 .. container:: verbose.unix
53 .. container:: verbose.unix
54
54
55 On Unix, the following files are consulted:
55 On Unix, the following files are consulted:
56
56
57 - ``<repo>/.hg/hgrc`` (per-repository)
57 - ``<repo>/.hg/hgrc`` (per-repository)
58 - ``$HOME/.hgrc`` (per-user)
58 - ``$HOME/.hgrc`` (per-user)
59 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
59 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
60 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
60 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
61 - ``/etc/mercurial/hgrc`` (per-system)
61 - ``/etc/mercurial/hgrc`` (per-system)
62 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
62 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
63 - ``<internal>/default.d/*.rc`` (defaults)
63 - ``<internal>/default.d/*.rc`` (defaults)
64
64
65 .. container:: verbose.windows
65 .. container:: verbose.windows
66
66
67 On Windows, the following files are consulted:
67 On Windows, the following files are consulted:
68
68
69 - ``<repo>/.hg/hgrc`` (per-repository)
69 - ``<repo>/.hg/hgrc`` (per-repository)
70 - ``%USERPROFILE%\.hgrc`` (per-user)
70 - ``%USERPROFILE%\.hgrc`` (per-user)
71 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
71 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
72 - ``%HOME%\.hgrc`` (per-user)
72 - ``%HOME%\.hgrc`` (per-user)
73 - ``%HOME%\Mercurial.ini`` (per-user)
73 - ``%HOME%\Mercurial.ini`` (per-user)
74 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
74 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
75 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
75 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
76 - ``<install-dir>\Mercurial.ini`` (per-installation)
76 - ``<install-dir>\Mercurial.ini`` (per-installation)
77 - ``<internal>/default.d/*.rc`` (defaults)
77 - ``<internal>/default.d/*.rc`` (defaults)
78
78
79 .. note::
79 .. note::
80
80
81 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
81 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
82 is used when running 32-bit Python on 64-bit Windows.
82 is used when running 32-bit Python on 64-bit Windows.
83
83
84 .. container:: windows
84 .. container:: windows
85
85
86 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
86 On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
87
87
88 .. container:: verbose.plan9
88 .. container:: verbose.plan9
89
89
90 On Plan9, the following files are consulted:
90 On Plan9, the following files are consulted:
91
91
92 - ``<repo>/.hg/hgrc`` (per-repository)
92 - ``<repo>/.hg/hgrc`` (per-repository)
93 - ``$home/lib/hgrc`` (per-user)
93 - ``$home/lib/hgrc`` (per-user)
94 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
94 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
95 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
95 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
96 - ``/lib/mercurial/hgrc`` (per-system)
96 - ``/lib/mercurial/hgrc`` (per-system)
97 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
97 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
98 - ``<internal>/default.d/*.rc`` (defaults)
98 - ``<internal>/default.d/*.rc`` (defaults)
99
99
100 Per-repository configuration options only apply in a
100 Per-repository configuration options only apply in a
101 particular repository. This file is not version-controlled, and
101 particular repository. This file is not version-controlled, and
102 will not get transferred during a "clone" operation. Options in
102 will not get transferred during a "clone" operation. Options in
103 this file override options in all other configuration files.
103 this file override options in all other configuration files.
104
104
105 .. container:: unix.plan9
105 .. container:: unix.plan9
106
106
107 On Plan 9 and Unix, most of this file will be ignored if it doesn't
107 On Plan 9 and Unix, most of this file will be ignored if it doesn't
108 belong to a trusted user or to a trusted group. See
108 belong to a trusted user or to a trusted group. See
109 :hg:`help config.trusted` for more details.
109 :hg:`help config.trusted` for more details.
110
110
111 Per-user configuration file(s) are for the user running Mercurial. Options
111 Per-user configuration file(s) are for the user running Mercurial. Options
112 in these files apply to all Mercurial commands executed by this user in any
112 in these files apply to all Mercurial commands executed by this user in any
113 directory. Options in these files override per-system and per-installation
113 directory. Options in these files override per-system and per-installation
114 options.
114 options.
115
115
116 Per-installation configuration files are searched for in the
116 Per-installation configuration files are searched for in the
117 directory where Mercurial is installed. ``<install-root>`` is the
117 directory where Mercurial is installed. ``<install-root>`` is the
118 parent directory of the **hg** executable (or symlink) being run.
118 parent directory of the **hg** executable (or symlink) being run.
119
119
120 .. container:: unix.plan9
120 .. container:: unix.plan9
121
121
122 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
122 For example, if installed in ``/shared/tools/bin/hg``, Mercurial
123 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
123 will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
124 files apply to all Mercurial commands executed by any user in any
124 files apply to all Mercurial commands executed by any user in any
125 directory.
125 directory.
126
126
127 Per-installation configuration files are for the system on
127 Per-installation configuration files are for the system on
128 which Mercurial is running. Options in these files apply to all
128 which Mercurial is running. Options in these files apply to all
129 Mercurial commands executed by any user in any directory. Registry
129 Mercurial commands executed by any user in any directory. Registry
130 keys contain PATH-like strings, every part of which must reference
130 keys contain PATH-like strings, every part of which must reference
131 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
131 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
132 be read. Mercurial checks each of these locations in the specified
132 be read. Mercurial checks each of these locations in the specified
133 order until one or more configuration files are detected.
133 order until one or more configuration files are detected.
134
134
135 Per-system configuration files are for the system on which Mercurial
135 Per-system configuration files are for the system on which Mercurial
136 is running. Options in these files apply to all Mercurial commands
136 is running. Options in these files apply to all Mercurial commands
137 executed by any user in any directory. Options in these files
137 executed by any user in any directory. Options in these files
138 override per-installation options.
138 override per-installation options.
139
139
140 Mercurial comes with some default configuration. The default configuration
140 Mercurial comes with some default configuration. The default configuration
141 files are installed with Mercurial and will be overwritten on upgrades. Default
141 files are installed with Mercurial and will be overwritten on upgrades. Default
142 configuration files should never be edited by users or administrators but can
142 configuration files should never be edited by users or administrators but can
143 be overridden in other configuration files. So far the directory only contains
143 be overridden in other configuration files. So far the directory only contains
144 merge tool configuration but packagers can also put other default configuration
144 merge tool configuration but packagers can also put other default configuration
145 there.
145 there.
146
146
147 Syntax
147 Syntax
148 ======
148 ======
149
149
150 A configuration file consists of sections, led by a ``[section]`` header
150 A configuration file consists of sections, led by a ``[section]`` header
151 and followed by ``name = value`` entries (sometimes called
151 and followed by ``name = value`` entries (sometimes called
152 ``configuration keys``)::
152 ``configuration keys``)::
153
153
154 [spam]
154 [spam]
155 eggs=ham
155 eggs=ham
156 green=
156 green=
157 eggs
157 eggs
158
158
159 Each line contains one entry. If the lines that follow are indented,
159 Each line contains one entry. If the lines that follow are indented,
160 they are treated as continuations of that entry. Leading whitespace is
160 they are treated as continuations of that entry. Leading whitespace is
161 removed from values. Empty lines are skipped. Lines beginning with
161 removed from values. Empty lines are skipped. Lines beginning with
162 ``#`` or ``;`` are ignored and may be used to provide comments.
162 ``#`` or ``;`` are ignored and may be used to provide comments.
163
163
164 Configuration keys can be set multiple times, in which case Mercurial
164 Configuration keys can be set multiple times, in which case Mercurial
165 will use the value that was configured last. As an example::
165 will use the value that was configured last. As an example::
166
166
167 [spam]
167 [spam]
168 eggs=large
168 eggs=large
169 ham=serrano
169 ham=serrano
170 eggs=small
170 eggs=small
171
171
172 This would set the configuration key named ``eggs`` to ``small``.
172 This would set the configuration key named ``eggs`` to ``small``.
173
173
174 It is also possible to define a section multiple times. A section can
174 It is also possible to define a section multiple times. A section can
175 be redefined on the same and/or on different configuration files. For
175 be redefined on the same and/or on different configuration files. For
176 example::
176 example::
177
177
178 [foo]
178 [foo]
179 eggs=large
179 eggs=large
180 ham=serrano
180 ham=serrano
181 eggs=small
181 eggs=small
182
182
183 [bar]
183 [bar]
184 eggs=ham
184 eggs=ham
185 green=
185 green=
186 eggs
186 eggs
187
187
188 [foo]
188 [foo]
189 ham=prosciutto
189 ham=prosciutto
190 eggs=medium
190 eggs=medium
191 bread=toasted
191 bread=toasted
192
192
193 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
193 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
194 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
194 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
195 respectively. As you can see there only thing that matters is the last
195 respectively. As you can see there only thing that matters is the last
196 value that was set for each of the configuration keys.
196 value that was set for each of the configuration keys.
197
197
198 If a configuration key is set multiple times in different
198 If a configuration key is set multiple times in different
199 configuration files the final value will depend on the order in which
199 configuration files the final value will depend on the order in which
200 the different configuration files are read, with settings from earlier
200 the different configuration files are read, with settings from earlier
201 paths overriding later ones as described on the ``Files`` section
201 paths overriding later ones as described on the ``Files`` section
202 above.
202 above.
203
203
204 A line of the form ``%include file`` will include ``file`` into the
204 A line of the form ``%include file`` will include ``file`` into the
205 current configuration file. The inclusion is recursive, which means
205 current configuration file. The inclusion is recursive, which means
206 that included files can include other files. Filenames are relative to
206 that included files can include other files. Filenames are relative to
207 the configuration file in which the ``%include`` directive is found.
207 the configuration file in which the ``%include`` directive is found.
208 Environment variables and ``~user`` constructs are expanded in
208 Environment variables and ``~user`` constructs are expanded in
209 ``file``. This lets you do something like::
209 ``file``. This lets you do something like::
210
210
211 %include ~/.hgrc.d/$HOST.rc
211 %include ~/.hgrc.d/$HOST.rc
212
212
213 to include a different configuration file on each computer you use.
213 to include a different configuration file on each computer you use.
214
214
215 A line with ``%unset name`` will remove ``name`` from the current
215 A line with ``%unset name`` will remove ``name`` from the current
216 section, if it has been set previously.
216 section, if it has been set previously.
217
217
218 The values are either free-form text strings, lists of text strings,
218 The values are either free-form text strings, lists of text strings,
219 or Boolean values. Boolean values can be set to true using any of "1",
219 or Boolean values. Boolean values can be set to true using any of "1",
220 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
220 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
221 (all case insensitive).
221 (all case insensitive).
222
222
223 List values are separated by whitespace or comma, except when values are
223 List values are separated by whitespace or comma, except when values are
224 placed in double quotation marks::
224 placed in double quotation marks::
225
225
226 allow_read = "John Doe, PhD", brian, betty
226 allow_read = "John Doe, PhD", brian, betty
227
227
228 Quotation marks can be escaped by prefixing them with a backslash. Only
228 Quotation marks can be escaped by prefixing them with a backslash. Only
229 quotation marks at the beginning of a word is counted as a quotation
229 quotation marks at the beginning of a word is counted as a quotation
230 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
230 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
231
231
232 Sections
232 Sections
233 ========
233 ========
234
234
235 This section describes the different sections that may appear in a
235 This section describes the different sections that may appear in a
236 Mercurial configuration file, the purpose of each section, its possible
236 Mercurial configuration file, the purpose of each section, its possible
237 keys, and their possible values.
237 keys, and their possible values.
238
238
239 ``alias``
239 ``alias``
240 ---------
240 ---------
241
241
242 Defines command aliases.
242 Defines command aliases.
243
243
244 Aliases allow you to define your own commands in terms of other
244 Aliases allow you to define your own commands in terms of other
245 commands (or aliases), optionally including arguments. Positional
245 commands (or aliases), optionally including arguments. Positional
246 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
246 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
247 are expanded by Mercurial before execution. Positional arguments not
247 are expanded by Mercurial before execution. Positional arguments not
248 already used by ``$N`` in the definition are put at the end of the
248 already used by ``$N`` in the definition are put at the end of the
249 command to be executed.
249 command to be executed.
250
250
251 Alias definitions consist of lines of the form::
251 Alias definitions consist of lines of the form::
252
252
253 <alias> = <command> [<argument>]...
253 <alias> = <command> [<argument>]...
254
254
255 For example, this definition::
255 For example, this definition::
256
256
257 latest = log --limit 5
257 latest = log --limit 5
258
258
259 creates a new command ``latest`` that shows only the five most recent
259 creates a new command ``latest`` that shows only the five most recent
260 changesets. You can define subsequent aliases using earlier ones::
260 changesets. You can define subsequent aliases using earlier ones::
261
261
262 stable5 = latest -b stable
262 stable5 = latest -b stable
263
263
264 .. note::
264 .. note::
265
265
266 It is possible to create aliases with the same names as
266 It is possible to create aliases with the same names as
267 existing commands, which will then override the original
267 existing commands, which will then override the original
268 definitions. This is almost always a bad idea!
268 definitions. This is almost always a bad idea!
269
269
270 An alias can start with an exclamation point (``!``) to make it a
270 An alias can start with an exclamation point (``!``) to make it a
271 shell alias. A shell alias is executed with the shell and will let you
271 shell alias. A shell alias is executed with the shell and will let you
272 run arbitrary commands. As an example, ::
272 run arbitrary commands. As an example, ::
273
273
274 echo = !echo $@
274 echo = !echo $@
275
275
276 will let you do ``hg echo foo`` to have ``foo`` printed in your
276 will let you do ``hg echo foo`` to have ``foo`` printed in your
277 terminal. A better example might be::
277 terminal. A better example might be::
278
278
279 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm
279 purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm
280
280
281 which will make ``hg purge`` delete all unknown files in the
281 which will make ``hg purge`` delete all unknown files in the
282 repository in the same manner as the purge extension.
282 repository in the same manner as the purge extension.
283
283
284 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
284 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
285 expand to the command arguments. Unmatched arguments are
285 expand to the command arguments. Unmatched arguments are
286 removed. ``$0`` expands to the alias name and ``$@`` expands to all
286 removed. ``$0`` expands to the alias name and ``$@`` expands to all
287 arguments separated by a space. ``"$@"`` (with quotes) expands to all
287 arguments separated by a space. ``"$@"`` (with quotes) expands to all
288 arguments quoted individually and separated by a space. These expansions
288 arguments quoted individually and separated by a space. These expansions
289 happen before the command is passed to the shell.
289 happen before the command is passed to the shell.
290
290
291 Shell aliases are executed in an environment where ``$HG`` expands to
291 Shell aliases are executed in an environment where ``$HG`` expands to
292 the path of the Mercurial that was used to execute the alias. This is
292 the path of the Mercurial that was used to execute the alias. This is
293 useful when you want to call further Mercurial commands in a shell
293 useful when you want to call further Mercurial commands in a shell
294 alias, as was done above for the purge alias. In addition,
294 alias, as was done above for the purge alias. In addition,
295 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
295 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
296 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
296 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
297
297
298 .. note::
298 .. note::
299
299
300 Some global configuration options such as ``-R`` are
300 Some global configuration options such as ``-R`` are
301 processed before shell aliases and will thus not be passed to
301 processed before shell aliases and will thus not be passed to
302 aliases.
302 aliases.
303
303
304
304
305 ``annotate``
305 ``annotate``
306 ------------
306 ------------
307
307
308 Settings used when displaying file annotations. All values are
308 Settings used when displaying file annotations. All values are
309 Booleans and default to False. See :hg:`help config.diff` for
309 Booleans and default to False. See :hg:`help config.diff` for
310 related options for the diff command.
310 related options for the diff command.
311
311
312 ``ignorews``
312 ``ignorews``
313 Ignore white space when comparing lines.
313 Ignore white space when comparing lines.
314
314
315 ``ignorewsamount``
315 ``ignorewsamount``
316 Ignore changes in the amount of white space.
316 Ignore changes in the amount of white space.
317
317
318 ``ignoreblanklines``
318 ``ignoreblanklines``
319 Ignore changes whose lines are all blank.
319 Ignore changes whose lines are all blank.
320
320
321
321
322 ``auth``
322 ``auth``
323 --------
323 --------
324
324
325 Authentication credentials for HTTP authentication. This section
325 Authentication credentials for HTTP authentication. This section
326 allows you to store usernames and passwords for use when logging
326 allows you to store usernames and passwords for use when logging
327 *into* HTTP servers. See :hg:`help config.web` if
327 *into* HTTP servers. See :hg:`help config.web` if
328 you want to configure *who* can login to your HTTP server.
328 you want to configure *who* can login to your HTTP server.
329
329
330 Each line has the following format::
330 Each line has the following format::
331
331
332 <name>.<argument> = <value>
332 <name>.<argument> = <value>
333
333
334 where ``<name>`` is used to group arguments into authentication
334 where ``<name>`` is used to group arguments into authentication
335 entries. Example::
335 entries. Example::
336
336
337 foo.prefix = hg.intevation.de/mercurial
337 foo.prefix = hg.intevation.de/mercurial
338 foo.username = foo
338 foo.username = foo
339 foo.password = bar
339 foo.password = bar
340 foo.schemes = http https
340 foo.schemes = http https
341
341
342 bar.prefix = secure.example.org
342 bar.prefix = secure.example.org
343 bar.key = path/to/file.key
343 bar.key = path/to/file.key
344 bar.cert = path/to/file.cert
344 bar.cert = path/to/file.cert
345 bar.schemes = https
345 bar.schemes = https
346
346
347 Supported arguments:
347 Supported arguments:
348
348
349 ``prefix``
349 ``prefix``
350 Either ``*`` or a URI prefix with or without the scheme part.
350 Either ``*`` or a URI prefix with or without the scheme part.
351 The authentication entry with the longest matching prefix is used
351 The authentication entry with the longest matching prefix is used
352 (where ``*`` matches everything and counts as a match of length
352 (where ``*`` matches everything and counts as a match of length
353 1). If the prefix doesn't include a scheme, the match is performed
353 1). If the prefix doesn't include a scheme, the match is performed
354 against the URI with its scheme stripped as well, and the schemes
354 against the URI with its scheme stripped as well, and the schemes
355 argument, q.v., is then subsequently consulted.
355 argument, q.v., is then subsequently consulted.
356
356
357 ``username``
357 ``username``
358 Optional. Username to authenticate with. If not given, and the
358 Optional. Username to authenticate with. If not given, and the
359 remote site requires basic or digest authentication, the user will
359 remote site requires basic or digest authentication, the user will
360 be prompted for it. Environment variables are expanded in the
360 be prompted for it. Environment variables are expanded in the
361 username letting you do ``foo.username = $USER``. If the URI
361 username letting you do ``foo.username = $USER``. If the URI
362 includes a username, only ``[auth]`` entries with a matching
362 includes a username, only ``[auth]`` entries with a matching
363 username or without a username will be considered.
363 username or without a username will be considered.
364
364
365 ``password``
365 ``password``
366 Optional. Password to authenticate with. If not given, and the
366 Optional. Password to authenticate with. If not given, and the
367 remote site requires basic or digest authentication, the user
367 remote site requires basic or digest authentication, the user
368 will be prompted for it.
368 will be prompted for it.
369
369
370 ``key``
370 ``key``
371 Optional. PEM encoded client certificate key file. Environment
371 Optional. PEM encoded client certificate key file. Environment
372 variables are expanded in the filename.
372 variables are expanded in the filename.
373
373
374 ``cert``
374 ``cert``
375 Optional. PEM encoded client certificate chain file. Environment
375 Optional. PEM encoded client certificate chain file. Environment
376 variables are expanded in the filename.
376 variables are expanded in the filename.
377
377
378 ``schemes``
378 ``schemes``
379 Optional. Space separated list of URI schemes to use this
379 Optional. Space separated list of URI schemes to use this
380 authentication entry with. Only used if the prefix doesn't include
380 authentication entry with. Only used if the prefix doesn't include
381 a scheme. Supported schemes are http and https. They will match
381 a scheme. Supported schemes are http and https. They will match
382 static-http and static-https respectively, as well.
382 static-http and static-https respectively, as well.
383 (default: https)
383 (default: https)
384
384
385 If no suitable authentication entry is found, the user is prompted
385 If no suitable authentication entry is found, the user is prompted
386 for credentials as usual if required by the remote.
386 for credentials as usual if required by the remote.
387
387
388
388
389 ``committemplate``
389 ``committemplate``
390 ------------------
390 ------------------
391
391
392 ``changeset``
392 ``changeset``
393 String: configuration in this section is used as the template to
393 String: configuration in this section is used as the template to
394 customize the text shown in the editor when committing.
394 customize the text shown in the editor when committing.
395
395
396 In addition to pre-defined template keywords, commit log specific one
396 In addition to pre-defined template keywords, commit log specific one
397 below can be used for customization:
397 below can be used for customization:
398
398
399 ``extramsg``
399 ``extramsg``
400 String: Extra message (typically 'Leave message empty to abort
400 String: Extra message (typically 'Leave message empty to abort
401 commit.'). This may be changed by some commands or extensions.
401 commit.'). This may be changed by some commands or extensions.
402
402
403 For example, the template configuration below shows as same text as
403 For example, the template configuration below shows as same text as
404 one shown by default::
404 one shown by default::
405
405
406 [committemplate]
406 [committemplate]
407 changeset = {desc}\n\n
407 changeset = {desc}\n\n
408 HG: Enter commit message. Lines beginning with 'HG:' are removed.
408 HG: Enter commit message. Lines beginning with 'HG:' are removed.
409 HG: {extramsg}
409 HG: {extramsg}
410 HG: --
410 HG: --
411 HG: user: {author}\n{ifeq(p2rev, "-1", "",
411 HG: user: {author}\n{ifeq(p2rev, "-1", "",
412 "HG: branch merge\n")
412 "HG: branch merge\n")
413 }HG: branch '{branch}'\n{if(activebookmark,
413 }HG: branch '{branch}'\n{if(activebookmark,
414 "HG: bookmark '{activebookmark}'\n") }{subrepos %
414 "HG: bookmark '{activebookmark}'\n") }{subrepos %
415 "HG: subrepo {subrepo}\n" }{file_adds %
415 "HG: subrepo {subrepo}\n" }{file_adds %
416 "HG: added {file}\n" }{file_mods %
416 "HG: added {file}\n" }{file_mods %
417 "HG: changed {file}\n" }{file_dels %
417 "HG: changed {file}\n" }{file_dels %
418 "HG: removed {file}\n" }{if(files, "",
418 "HG: removed {file}\n" }{if(files, "",
419 "HG: no files changed\n")}
419 "HG: no files changed\n")}
420
420
421 .. note::
421 .. note::
422
422
423 For some problematic encodings (see :hg:`help win32mbcs` for
423 For some problematic encodings (see :hg:`help win32mbcs` for
424 detail), this customization should be configured carefully, to
424 detail), this customization should be configured carefully, to
425 avoid showing broken characters.
425 avoid showing broken characters.
426
426
427 For example, if a multibyte character ending with backslash (0x5c) is
427 For example, if a multibyte character ending with backslash (0x5c) is
428 followed by the ASCII character 'n' in the customized template,
428 followed by the ASCII character 'n' in the customized template,
429 the sequence of backslash and 'n' is treated as line-feed unexpectedly
429 the sequence of backslash and 'n' is treated as line-feed unexpectedly
430 (and the multibyte character is broken, too).
430 (and the multibyte character is broken, too).
431
431
432 Customized template is used for commands below (``--edit`` may be
432 Customized template is used for commands below (``--edit`` may be
433 required):
433 required):
434
434
435 - :hg:`backout`
435 - :hg:`backout`
436 - :hg:`commit`
436 - :hg:`commit`
437 - :hg:`fetch` (for merge commit only)
437 - :hg:`fetch` (for merge commit only)
438 - :hg:`graft`
438 - :hg:`graft`
439 - :hg:`histedit`
439 - :hg:`histedit`
440 - :hg:`import`
440 - :hg:`import`
441 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
441 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
442 - :hg:`rebase`
442 - :hg:`rebase`
443 - :hg:`shelve`
443 - :hg:`shelve`
444 - :hg:`sign`
444 - :hg:`sign`
445 - :hg:`tag`
445 - :hg:`tag`
446 - :hg:`transplant`
446 - :hg:`transplant`
447
447
448 Configuring items below instead of ``changeset`` allows showing
448 Configuring items below instead of ``changeset`` allows showing
449 customized message only for specific actions, or showing different
449 customized message only for specific actions, or showing different
450 messages for each action.
450 messages for each action.
451
451
452 - ``changeset.backout`` for :hg:`backout`
452 - ``changeset.backout`` for :hg:`backout`
453 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
453 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
454 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
454 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
455 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
455 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
456 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
456 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
457 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
457 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
458 - ``changeset.gpg.sign`` for :hg:`sign`
458 - ``changeset.gpg.sign`` for :hg:`sign`
459 - ``changeset.graft`` for :hg:`graft`
459 - ``changeset.graft`` for :hg:`graft`
460 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
460 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
461 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
461 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
462 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
462 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
463 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
463 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
464 - ``changeset.import.bypass`` for :hg:`import --bypass`
464 - ``changeset.import.bypass`` for :hg:`import --bypass`
465 - ``changeset.import.normal.merge`` for :hg:`import` on merges
465 - ``changeset.import.normal.merge`` for :hg:`import` on merges
466 - ``changeset.import.normal.normal`` for :hg:`import` on other
466 - ``changeset.import.normal.normal`` for :hg:`import` on other
467 - ``changeset.mq.qnew`` for :hg:`qnew`
467 - ``changeset.mq.qnew`` for :hg:`qnew`
468 - ``changeset.mq.qfold`` for :hg:`qfold`
468 - ``changeset.mq.qfold`` for :hg:`qfold`
469 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
469 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
470 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
470 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
471 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
471 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
472 - ``changeset.rebase.normal`` for :hg:`rebase` on other
472 - ``changeset.rebase.normal`` for :hg:`rebase` on other
473 - ``changeset.shelve.shelve`` for :hg:`shelve`
473 - ``changeset.shelve.shelve`` for :hg:`shelve`
474 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
474 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
475 - ``changeset.tag.remove`` for :hg:`tag --remove`
475 - ``changeset.tag.remove`` for :hg:`tag --remove`
476 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
476 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
477 - ``changeset.transplant.normal`` for :hg:`transplant` on other
477 - ``changeset.transplant.normal`` for :hg:`transplant` on other
478
478
479 These dot-separated lists of names are treated as hierarchical ones.
479 These dot-separated lists of names are treated as hierarchical ones.
480 For example, ``changeset.tag.remove`` customizes the commit message
480 For example, ``changeset.tag.remove`` customizes the commit message
481 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
481 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
482 commit message for :hg:`tag` regardless of ``--remove`` option.
482 commit message for :hg:`tag` regardless of ``--remove`` option.
483
483
484 When the external editor is invoked for a commit, the corresponding
484 When the external editor is invoked for a commit, the corresponding
485 dot-separated list of names without the ``changeset.`` prefix
485 dot-separated list of names without the ``changeset.`` prefix
486 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
486 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
487 variable.
487 variable.
488
488
489 In this section, items other than ``changeset`` can be referred from
489 In this section, items other than ``changeset`` can be referred from
490 others. For example, the configuration to list committed files up
490 others. For example, the configuration to list committed files up
491 below can be referred as ``{listupfiles}``::
491 below can be referred as ``{listupfiles}``::
492
492
493 [committemplate]
493 [committemplate]
494 listupfiles = {file_adds %
494 listupfiles = {file_adds %
495 "HG: added {file}\n" }{file_mods %
495 "HG: added {file}\n" }{file_mods %
496 "HG: changed {file}\n" }{file_dels %
496 "HG: changed {file}\n" }{file_dels %
497 "HG: removed {file}\n" }{if(files, "",
497 "HG: removed {file}\n" }{if(files, "",
498 "HG: no files changed\n")}
498 "HG: no files changed\n")}
499
499
500 ``decode/encode``
500 ``decode/encode``
501 -----------------
501 -----------------
502
502
503 Filters for transforming files on checkout/checkin. This would
503 Filters for transforming files on checkout/checkin. This would
504 typically be used for newline processing or other
504 typically be used for newline processing or other
505 localization/canonicalization of files.
505 localization/canonicalization of files.
506
506
507 Filters consist of a filter pattern followed by a filter command.
507 Filters consist of a filter pattern followed by a filter command.
508 Filter patterns are globs by default, rooted at the repository root.
508 Filter patterns are globs by default, rooted at the repository root.
509 For example, to match any file ending in ``.txt`` in the root
509 For example, to match any file ending in ``.txt`` in the root
510 directory only, use the pattern ``*.txt``. To match any file ending
510 directory only, use the pattern ``*.txt``. To match any file ending
511 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
511 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
512 For each file only the first matching filter applies.
512 For each file only the first matching filter applies.
513
513
514 The filter command can start with a specifier, either ``pipe:`` or
514 The filter command can start with a specifier, either ``pipe:`` or
515 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
515 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
516
516
517 A ``pipe:`` command must accept data on stdin and return the transformed
517 A ``pipe:`` command must accept data on stdin and return the transformed
518 data on stdout.
518 data on stdout.
519
519
520 Pipe example::
520 Pipe example::
521
521
522 [encode]
522 [encode]
523 # uncompress gzip files on checkin to improve delta compression
523 # uncompress gzip files on checkin to improve delta compression
524 # note: not necessarily a good idea, just an example
524 # note: not necessarily a good idea, just an example
525 *.gz = pipe: gunzip
525 *.gz = pipe: gunzip
526
526
527 [decode]
527 [decode]
528 # recompress gzip files when writing them to the working dir (we
528 # recompress gzip files when writing them to the working dir (we
529 # can safely omit "pipe:", because it's the default)
529 # can safely omit "pipe:", because it's the default)
530 *.gz = gzip
530 *.gz = gzip
531
531
532 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
532 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
533 with the name of a temporary file that contains the data to be
533 with the name of a temporary file that contains the data to be
534 filtered by the command. The string ``OUTFILE`` is replaced with the name
534 filtered by the command. The string ``OUTFILE`` is replaced with the name
535 of an empty temporary file, where the filtered data must be written by
535 of an empty temporary file, where the filtered data must be written by
536 the command.
536 the command.
537
537
538 .. container:: windows
538 .. container:: windows
539
539
540 .. note::
540 .. note::
541
541
542 The tempfile mechanism is recommended for Windows systems,
542 The tempfile mechanism is recommended for Windows systems,
543 where the standard shell I/O redirection operators often have
543 where the standard shell I/O redirection operators often have
544 strange effects and may corrupt the contents of your files.
544 strange effects and may corrupt the contents of your files.
545
545
546 This filter mechanism is used internally by the ``eol`` extension to
546 This filter mechanism is used internally by the ``eol`` extension to
547 translate line ending characters between Windows (CRLF) and Unix (LF)
547 translate line ending characters between Windows (CRLF) and Unix (LF)
548 format. We suggest you use the ``eol`` extension for convenience.
548 format. We suggest you use the ``eol`` extension for convenience.
549
549
550
550
551 ``defaults``
551 ``defaults``
552 ------------
552 ------------
553
553
554 (defaults are deprecated. Don't use them. Use aliases instead.)
554 (defaults are deprecated. Don't use them. Use aliases instead.)
555
555
556 Use the ``[defaults]`` section to define command defaults, i.e. the
556 Use the ``[defaults]`` section to define command defaults, i.e. the
557 default options/arguments to pass to the specified commands.
557 default options/arguments to pass to the specified commands.
558
558
559 The following example makes :hg:`log` run in verbose mode, and
559 The following example makes :hg:`log` run in verbose mode, and
560 :hg:`status` show only the modified files, by default::
560 :hg:`status` show only the modified files, by default::
561
561
562 [defaults]
562 [defaults]
563 log = -v
563 log = -v
564 status = -m
564 status = -m
565
565
566 The actual commands, instead of their aliases, must be used when
566 The actual commands, instead of their aliases, must be used when
567 defining command defaults. The command defaults will also be applied
567 defining command defaults. The command defaults will also be applied
568 to the aliases of the commands defined.
568 to the aliases of the commands defined.
569
569
570
570
571 ``diff``
571 ``diff``
572 --------
572 --------
573
573
574 Settings used when displaying diffs. Everything except for ``unified``
574 Settings used when displaying diffs. Everything except for ``unified``
575 is a Boolean and defaults to False. See :hg:`help config.annotate`
575 is a Boolean and defaults to False. See :hg:`help config.annotate`
576 for related options for the annotate command.
576 for related options for the annotate command.
577
577
578 ``git``
578 ``git``
579 Use git extended diff format.
579 Use git extended diff format.
580
580
581 ``nobinary``
581 ``nobinary``
582 Omit git binary patches.
582 Omit git binary patches.
583
583
584 ``nodates``
584 ``nodates``
585 Don't include dates in diff headers.
585 Don't include dates in diff headers.
586
586
587 ``noprefix``
587 ``noprefix``
588 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
588 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
589
589
590 ``showfunc``
590 ``showfunc``
591 Show which function each change is in.
591 Show which function each change is in.
592
592
593 ``ignorews``
593 ``ignorews``
594 Ignore white space when comparing lines.
594 Ignore white space when comparing lines.
595
595
596 ``ignorewsamount``
596 ``ignorewsamount``
597 Ignore changes in the amount of white space.
597 Ignore changes in the amount of white space.
598
598
599 ``ignoreblanklines``
599 ``ignoreblanklines``
600 Ignore changes whose lines are all blank.
600 Ignore changes whose lines are all blank.
601
601
602 ``unified``
602 ``unified``
603 Number of lines of context to show.
603 Number of lines of context to show.
604
604
605 ``email``
605 ``email``
606 ---------
606 ---------
607
607
608 Settings for extensions that send email messages.
608 Settings for extensions that send email messages.
609
609
610 ``from``
610 ``from``
611 Optional. Email address to use in "From" header and SMTP envelope
611 Optional. Email address to use in "From" header and SMTP envelope
612 of outgoing messages.
612 of outgoing messages.
613
613
614 ``to``
614 ``to``
615 Optional. Comma-separated list of recipients' email addresses.
615 Optional. Comma-separated list of recipients' email addresses.
616
616
617 ``cc``
617 ``cc``
618 Optional. Comma-separated list of carbon copy recipients'
618 Optional. Comma-separated list of carbon copy recipients'
619 email addresses.
619 email addresses.
620
620
621 ``bcc``
621 ``bcc``
622 Optional. Comma-separated list of blind carbon copy recipients'
622 Optional. Comma-separated list of blind carbon copy recipients'
623 email addresses.
623 email addresses.
624
624
625 ``method``
625 ``method``
626 Optional. Method to use to send email messages. If value is ``smtp``
626 Optional. Method to use to send email messages. If value is ``smtp``
627 (default), use SMTP (see the ``[smtp]`` section for configuration).
627 (default), use SMTP (see the ``[smtp]`` section for configuration).
628 Otherwise, use as name of program to run that acts like sendmail
628 Otherwise, use as name of program to run that acts like sendmail
629 (takes ``-f`` option for sender, list of recipients on command line,
629 (takes ``-f`` option for sender, list of recipients on command line,
630 message on stdin). Normally, setting this to ``sendmail`` or
630 message on stdin). Normally, setting this to ``sendmail`` or
631 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
631 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
632
632
633 ``charsets``
633 ``charsets``
634 Optional. Comma-separated list of character sets considered
634 Optional. Comma-separated list of character sets considered
635 convenient for recipients. Addresses, headers, and parts not
635 convenient for recipients. Addresses, headers, and parts not
636 containing patches of outgoing messages will be encoded in the
636 containing patches of outgoing messages will be encoded in the
637 first character set to which conversion from local encoding
637 first character set to which conversion from local encoding
638 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
638 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
639 conversion fails, the text in question is sent as is.
639 conversion fails, the text in question is sent as is.
640 (default: '')
640 (default: '')
641
641
642 Order of outgoing email character sets:
642 Order of outgoing email character sets:
643
643
644 1. ``us-ascii``: always first, regardless of settings
644 1. ``us-ascii``: always first, regardless of settings
645 2. ``email.charsets``: in order given by user
645 2. ``email.charsets``: in order given by user
646 3. ``ui.fallbackencoding``: if not in email.charsets
646 3. ``ui.fallbackencoding``: if not in email.charsets
647 4. ``$HGENCODING``: if not in email.charsets
647 4. ``$HGENCODING``: if not in email.charsets
648 5. ``utf-8``: always last, regardless of settings
648 5. ``utf-8``: always last, regardless of settings
649
649
650 Email example::
650 Email example::
651
651
652 [email]
652 [email]
653 from = Joseph User <joe.user@example.com>
653 from = Joseph User <joe.user@example.com>
654 method = /usr/sbin/sendmail
654 method = /usr/sbin/sendmail
655 # charsets for western Europeans
655 # charsets for western Europeans
656 # us-ascii, utf-8 omitted, as they are tried first and last
656 # us-ascii, utf-8 omitted, as they are tried first and last
657 charsets = iso-8859-1, iso-8859-15, windows-1252
657 charsets = iso-8859-1, iso-8859-15, windows-1252
658
658
659
659
660 ``extensions``
660 ``extensions``
661 --------------
661 --------------
662
662
663 Mercurial has an extension mechanism for adding new features. To
663 Mercurial has an extension mechanism for adding new features. To
664 enable an extension, create an entry for it in this section.
664 enable an extension, create an entry for it in this section.
665
665
666 If you know that the extension is already in Python's search path,
666 If you know that the extension is already in Python's search path,
667 you can give the name of the module, followed by ``=``, with nothing
667 you can give the name of the module, followed by ``=``, with nothing
668 after the ``=``.
668 after the ``=``.
669
669
670 Otherwise, give a name that you choose, followed by ``=``, followed by
670 Otherwise, give a name that you choose, followed by ``=``, followed by
671 the path to the ``.py`` file (including the file name extension) that
671 the path to the ``.py`` file (including the file name extension) that
672 defines the extension.
672 defines the extension.
673
673
674 To explicitly disable an extension that is enabled in an hgrc of
674 To explicitly disable an extension that is enabled in an hgrc of
675 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
675 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
676 or ``foo = !`` when path is not supplied.
676 or ``foo = !`` when path is not supplied.
677
677
678 Example for ``~/.hgrc``::
678 Example for ``~/.hgrc``::
679
679
680 [extensions]
680 [extensions]
681 # (the color extension will get loaded from Mercurial's path)
681 # (the color extension will get loaded from Mercurial's path)
682 color =
682 color =
683 # (this extension will get loaded from the file specified)
683 # (this extension will get loaded from the file specified)
684 myfeature = ~/.hgext/myfeature.py
684 myfeature = ~/.hgext/myfeature.py
685
685
686
686
687 ``format``
687 ``format``
688 ----------
688 ----------
689
689
690 ``usegeneraldelta``
690 ``usegeneraldelta``
691 Enable or disable the "generaldelta" repository format which improves
691 Enable or disable the "generaldelta" repository format which improves
692 repository compression by allowing "revlog" to store delta against arbitrary
692 repository compression by allowing "revlog" to store delta against arbitrary
693 revision instead of the previous stored one. This provides significant
693 revision instead of the previous stored one. This provides significant
694 improvement for repositories with branches.
694 improvement for repositories with branches.
695
695
696 Repositories with this on-disk format require Mercurial version 1.9.
696 Repositories with this on-disk format require Mercurial version 1.9.
697
697
698 Enabled by default.
698 Enabled by default.
699
699
700 ``dotencode``
700 ``dotencode``
701 Enable or disable the "dotencode" repository format which enhances
701 Enable or disable the "dotencode" repository format which enhances
702 the "fncache" repository format (which has to be enabled to use
702 the "fncache" repository format (which has to be enabled to use
703 dotencode) to avoid issues with filenames starting with ._ on
703 dotencode) to avoid issues with filenames starting with ._ on
704 Mac OS X and spaces on Windows.
704 Mac OS X and spaces on Windows.
705
705
706 Repositories with this on-disk format require Mercurial version 1.7.
706 Repositories with this on-disk format require Mercurial version 1.7.
707
707
708 Enabled by default.
708 Enabled by default.
709
709
710 ``usefncache``
710 ``usefncache``
711 Enable or disable the "fncache" repository format which enhances
711 Enable or disable the "fncache" repository format which enhances
712 the "store" repository format (which has to be enabled to use
712 the "store" repository format (which has to be enabled to use
713 fncache) to allow longer filenames and avoids using Windows
713 fncache) to allow longer filenames and avoids using Windows
714 reserved names, e.g. "nul".
714 reserved names, e.g. "nul".
715
715
716 Repositories with this on-disk format require Mercurial version 1.1.
716 Repositories with this on-disk format require Mercurial version 1.1.
717
717
718 Enabled by default.
718 Enabled by default.
719
719
720 ``usestore``
720 ``usestore``
721 Enable or disable the "store" repository format which improves
721 Enable or disable the "store" repository format which improves
722 compatibility with systems that fold case or otherwise mangle
722 compatibility with systems that fold case or otherwise mangle
723 filenames. Disabling this option will allow you to store longer filenames
723 filenames. Disabling this option will allow you to store longer filenames
724 in some situations at the expense of compatibility.
724 in some situations at the expense of compatibility.
725
725
726 Repositories with this on-disk format require Mercurial version 0.9.4.
726 Repositories with this on-disk format require Mercurial version 0.9.4.
727
727
728 Enabled by default.
728 Enabled by default.
729
729
730 ``graph``
730 ``graph``
731 ---------
731 ---------
732
732
733 Web graph view configuration. This section let you change graph
733 Web graph view configuration. This section let you change graph
734 elements display properties by branches, for instance to make the
734 elements display properties by branches, for instance to make the
735 ``default`` branch stand out.
735 ``default`` branch stand out.
736
736
737 Each line has the following format::
737 Each line has the following format::
738
738
739 <branch>.<argument> = <value>
739 <branch>.<argument> = <value>
740
740
741 where ``<branch>`` is the name of the branch being
741 where ``<branch>`` is the name of the branch being
742 customized. Example::
742 customized. Example::
743
743
744 [graph]
744 [graph]
745 # 2px width
745 # 2px width
746 default.width = 2
746 default.width = 2
747 # red color
747 # red color
748 default.color = FF0000
748 default.color = FF0000
749
749
750 Supported arguments:
750 Supported arguments:
751
751
752 ``width``
752 ``width``
753 Set branch edges width in pixels.
753 Set branch edges width in pixels.
754
754
755 ``color``
755 ``color``
756 Set branch edges color in hexadecimal RGB notation.
756 Set branch edges color in hexadecimal RGB notation.
757
757
758 ``hooks``
758 ``hooks``
759 ---------
759 ---------
760
760
761 Commands or Python functions that get automatically executed by
761 Commands or Python functions that get automatically executed by
762 various actions such as starting or finishing a commit. Multiple
762 various actions such as starting or finishing a commit. Multiple
763 hooks can be run for the same action by appending a suffix to the
763 hooks can be run for the same action by appending a suffix to the
764 action. Overriding a site-wide hook can be done by changing its
764 action. Overriding a site-wide hook can be done by changing its
765 value or setting it to an empty string. Hooks can be prioritized
765 value or setting it to an empty string. Hooks can be prioritized
766 by adding a prefix of ``priority.`` to the hook name on a new line
766 by adding a prefix of ``priority.`` to the hook name on a new line
767 and setting the priority. The default priority is 0.
767 and setting the priority. The default priority is 0.
768
768
769 Example ``.hg/hgrc``::
769 Example ``.hg/hgrc``::
770
770
771 [hooks]
771 [hooks]
772 # update working directory after adding changesets
772 # update working directory after adding changesets
773 changegroup.update = hg update
773 changegroup.update = hg update
774 # do not use the site-wide hook
774 # do not use the site-wide hook
775 incoming =
775 incoming =
776 incoming.email = /my/email/hook
776 incoming.email = /my/email/hook
777 incoming.autobuild = /my/build/hook
777 incoming.autobuild = /my/build/hook
778 # force autobuild hook to run before other incoming hooks
778 # force autobuild hook to run before other incoming hooks
779 priority.incoming.autobuild = 1
779 priority.incoming.autobuild = 1
780
780
781 Most hooks are run with environment variables set that give useful
781 Most hooks are run with environment variables set that give useful
782 additional information. For each hook below, the environment
782 additional information. For each hook below, the environment
783 variables it is passed are listed with names of the form ``$HG_foo``.
783 variables it is passed are listed with names of the form ``$HG_foo``.
784
784
785 ``changegroup``
785 ``changegroup``
786 Run after a changegroup has been added via push, pull or unbundle. ID of the
786 Run after a changegroup has been added via push, pull or unbundle. ID of the
787 first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
787 first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
788 from which changes came is in ``$HG_URL``.
788 from which changes came is in ``$HG_URL``.
789
789
790 ``commit``
790 ``commit``
791 Run after a changeset has been created in the local repository. ID
791 Run after a changeset has been created in the local repository. ID
792 of the newly created changeset is in ``$HG_NODE``. Parent changeset
792 of the newly created changeset is in ``$HG_NODE``. Parent changeset
793 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
793 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
794
794
795 ``incoming``
795 ``incoming``
796 Run after a changeset has been pulled, pushed, or unbundled into
796 Run after a changeset has been pulled, pushed, or unbundled into
797 the local repository. The ID of the newly arrived changeset is in
797 the local repository. The ID of the newly arrived changeset is in
798 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
798 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
799
799
800 ``outgoing``
800 ``outgoing``
801 Run after sending changes from local repository to another. ID of
801 Run after sending changes from local repository to another. ID of
802 first changeset sent is in ``$HG_NODE``. Source of operation is in
802 first changeset sent is in ``$HG_NODE``. Source of operation is in
803 ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
803 ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
804
804
805 ``post-<command>``
805 ``post-<command>``
806 Run after successful invocations of the associated command. The
806 Run after successful invocations of the associated command. The
807 contents of the command line are passed as ``$HG_ARGS`` and the result
807 contents of the command line are passed as ``$HG_ARGS`` and the result
808 code in ``$HG_RESULT``. Parsed command line arguments are passed as
808 code in ``$HG_RESULT``. Parsed command line arguments are passed as
809 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
809 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
810 the python data internally passed to <command>. ``$HG_OPTS`` is a
810 the python data internally passed to <command>. ``$HG_OPTS`` is a
811 dictionary of options (with unspecified options set to their defaults).
811 dictionary of options (with unspecified options set to their defaults).
812 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
812 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
813
813
814 ``fail-<command>``
814 ``fail-<command>``
815 Run after a failed invocation of an associated command. The contents
815 Run after a failed invocation of an associated command. The contents
816 of the command line are passed as ``$HG_ARGS``. Parsed command line
816 of the command line are passed as ``$HG_ARGS``. Parsed command line
817 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
817 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
818 string representations of the python data internally passed to
818 string representations of the python data internally passed to
819 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
819 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
820 options set to their defaults). ``$HG_PATS`` is a list of arguments.
820 options set to their defaults). ``$HG_PATS`` is a list of arguments.
821 Hook failure is ignored.
821 Hook failure is ignored.
822
822
823 ``pre-<command>``
823 ``pre-<command>``
824 Run before executing the associated command. The contents of the
824 Run before executing the associated command. The contents of the
825 command line are passed as ``$HG_ARGS``. Parsed command line arguments
825 command line are passed as ``$HG_ARGS``. Parsed command line arguments
826 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
826 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
827 representations of the data internally passed to <command>. ``$HG_OPTS``
827 representations of the data internally passed to <command>. ``$HG_OPTS``
828 is a dictionary of options (with unspecified options set to their
828 is a dictionary of options (with unspecified options set to their
829 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
829 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
830 failure, the command doesn't execute and Mercurial returns the failure
830 failure, the command doesn't execute and Mercurial returns the failure
831 code.
831 code.
832
832
833 ``prechangegroup``
833 ``prechangegroup``
834 Run before a changegroup is added via push, pull or unbundle. Exit
834 Run before a changegroup is added via push, pull or unbundle. Exit
835 status 0 allows the changegroup to proceed. Non-zero status will
835 status 0 allows the changegroup to proceed. Non-zero status will
836 cause the push, pull or unbundle to fail. URL from which changes
836 cause the push, pull or unbundle to fail. URL from which changes
837 will come is in ``$HG_URL``.
837 will come is in ``$HG_URL``.
838
838
839 ``precommit``
839 ``precommit``
840 Run before starting a local commit. Exit status 0 allows the
840 Run before starting a local commit. Exit status 0 allows the
841 commit to proceed. Non-zero status will cause the commit to fail.
841 commit to proceed. Non-zero status will cause the commit to fail.
842 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
842 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
843
843
844 ``prelistkeys``
844 ``prelistkeys``
845 Run before listing pushkeys (like bookmarks) in the
845 Run before listing pushkeys (like bookmarks) in the
846 repository. Non-zero status will cause failure. The key namespace is
846 repository. Non-zero status will cause failure. The key namespace is
847 in ``$HG_NAMESPACE``.
847 in ``$HG_NAMESPACE``.
848
848
849 ``preoutgoing``
849 ``preoutgoing``
850 Run before collecting changes to send from the local repository to
850 Run before collecting changes to send from the local repository to
851 another. Non-zero status will cause failure. This lets you prevent
851 another. Non-zero status will cause failure. This lets you prevent
852 pull over HTTP or SSH. Also prevents against local pull, push
852 pull over HTTP or SSH. Also prevents against local pull, push
853 (outbound) or bundle commands, but not effective, since you can
853 (outbound) or bundle commands, but not effective, since you can
854 just copy files instead then. Source of operation is in
854 just copy files instead then. Source of operation is in
855 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
855 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
856 SSH or HTTP repository. If "push", "pull" or "bundle", operation
856 SSH or HTTP repository. If "push", "pull" or "bundle", operation
857 is happening on behalf of repository on same system.
857 is happening on behalf of repository on same system.
858
858
859 ``prepushkey``
859 ``prepushkey``
860 Run before a pushkey (like a bookmark) is added to the
860 Run before a pushkey (like a bookmark) is added to the
861 repository. Non-zero status will cause the key to be rejected. The
861 repository. Non-zero status will cause the key to be rejected. The
862 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
862 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
863 the old value (if any) is in ``$HG_OLD``, and the new value is in
863 the old value (if any) is in ``$HG_OLD``, and the new value is in
864 ``$HG_NEW``.
864 ``$HG_NEW``.
865
865
866 ``pretag``
866 ``pretag``
867 Run before creating a tag. Exit status 0 allows the tag to be
867 Run before creating a tag. Exit status 0 allows the tag to be
868 created. Non-zero status will cause the tag to fail. ID of
868 created. Non-zero status will cause the tag to fail. ID of
869 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
869 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
870 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
870 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
871
871
872 ``pretxnopen``
872 ``pretxnopen``
873 Run before any new repository transaction is open. The reason for the
873 Run before any new repository transaction is open. The reason for the
874 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
874 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
875 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
875 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
876 transaction from being opened.
876 transaction from being opened.
877
877
878 ``pretxnclose``
878 ``pretxnclose``
879 Run right before the transaction is actually finalized. Any repository change
879 Run right before the transaction is actually finalized. Any repository change
880 will be visible to the hook program. This lets you validate the transaction
880 will be visible to the hook program. This lets you validate the transaction
881 content or change it. Exit status 0 allows the commit to proceed. Non-zero
881 content or change it. Exit status 0 allows the commit to proceed. Non-zero
882 status will cause the transaction to be rolled back. The reason for the
882 status will cause the transaction to be rolled back. The reason for the
883 transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
883 transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
884 the transaction will be in ``HG_TXNID``. The rest of the available data will
884 the transaction will be in ``HG_TXNID``. The rest of the available data will
885 vary according the transaction type. New changesets will add ``$HG_NODE`` (id
885 vary according the transaction type. New changesets will add ``$HG_NODE`` (id
886 of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
886 of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
887 changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
887 changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
888 changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
888 changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
889
889
890 ``txnclose``
890 ``txnclose``
891 Run after any repository transaction has been committed. At this
891 Run after any repository transaction has been committed. At this
892 point, the transaction can no longer be rolled back. The hook will run
892 point, the transaction can no longer be rolled back. The hook will run
893 after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
893 after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
894 details about available variables.
894 details about available variables.
895
895
896 ``txnabort``
896 ``txnabort``
897 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
897 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
898 docs for details about available variables.
898 docs for details about available variables.
899
899
900 ``pretxnchangegroup``
900 ``pretxnchangegroup``
901 Run after a changegroup has been added via push, pull or unbundle, but before
901 Run after a changegroup has been added via push, pull or unbundle, but before
902 the transaction has been committed. Changegroup is visible to hook program.
902 the transaction has been committed. Changegroup is visible to hook program.
903 This lets you validate incoming changes before accepting them. Passed the ID
903 This lets you validate incoming changes before accepting them. Passed the ID
904 of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
904 of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
905 Exit status 0 allows the transaction to commit. Non-zero status will cause
905 Exit status 0 allows the transaction to commit. Non-zero status will cause
906 the transaction to be rolled back and the push, pull or unbundle will fail.
906 the transaction to be rolled back and the push, pull or unbundle will fail.
907 URL that was source of changes is in ``$HG_URL``.
907 URL that was source of changes is in ``$HG_URL``.
908
908
909 ``pretxncommit``
909 ``pretxncommit``
910 Run after a changeset has been created but the transaction not yet
910 Run after a changeset has been created but the transaction not yet
911 committed. Changeset is visible to hook program. This lets you
911 committed. Changeset is visible to hook program. This lets you
912 validate commit message and changes. Exit status 0 allows the
912 validate commit message and changes. Exit status 0 allows the
913 commit to proceed. Non-zero status will cause the transaction to
913 commit to proceed. Non-zero status will cause the transaction to
914 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
914 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
915 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
915 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
916
916
917 ``preupdate``
917 ``preupdate``
918 Run before updating the working directory. Exit status 0 allows
918 Run before updating the working directory. Exit status 0 allows
919 the update to proceed. Non-zero status will prevent the update.
919 the update to proceed. Non-zero status will prevent the update.
920 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
920 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
921 of second new parent is in ``$HG_PARENT2``.
921 of second new parent is in ``$HG_PARENT2``.
922
922
923 ``listkeys``
923 ``listkeys``
924 Run after listing pushkeys (like bookmarks) in the repository. The
924 Run after listing pushkeys (like bookmarks) in the repository. The
925 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
925 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
926 dictionary containing the keys and values.
926 dictionary containing the keys and values.
927
927
928 ``pushkey``
928 ``pushkey``
929 Run after a pushkey (like a bookmark) is added to the
929 Run after a pushkey (like a bookmark) is added to the
930 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
930 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
931 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
931 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
932 value is in ``$HG_NEW``.
932 value is in ``$HG_NEW``.
933
933
934 ``tag``
934 ``tag``
935 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
935 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
936 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
936 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
937 repository if ``$HG_LOCAL=0``.
937 repository if ``$HG_LOCAL=0``.
938
938
939 ``update``
939 ``update``
940 Run after updating the working directory. Changeset ID of first
940 Run after updating the working directory. Changeset ID of first
941 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
941 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
942 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
942 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
943 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
943 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
944
944
945 .. note::
945 .. note::
946
946
947 It is generally better to use standard hooks rather than the
947 It is generally better to use standard hooks rather than the
948 generic pre- and post- command hooks as they are guaranteed to be
948 generic pre- and post- command hooks as they are guaranteed to be
949 called in the appropriate contexts for influencing transactions.
949 called in the appropriate contexts for influencing transactions.
950 Also, hooks like "commit" will be called in all contexts that
950 Also, hooks like "commit" will be called in all contexts that
951 generate a commit (e.g. tag) and not just the commit command.
951 generate a commit (e.g. tag) and not just the commit command.
952
952
953 .. note::
953 .. note::
954
954
955 Environment variables with empty values may not be passed to
955 Environment variables with empty values may not be passed to
956 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
956 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
957 will have an empty value under Unix-like platforms for non-merge
957 will have an empty value under Unix-like platforms for non-merge
958 changesets, while it will not be available at all under Windows.
958 changesets, while it will not be available at all under Windows.
959
959
960 The syntax for Python hooks is as follows::
960 The syntax for Python hooks is as follows::
961
961
962 hookname = python:modulename.submodule.callable
962 hookname = python:modulename.submodule.callable
963 hookname = python:/path/to/python/module.py:callable
963 hookname = python:/path/to/python/module.py:callable
964
964
965 Python hooks are run within the Mercurial process. Each hook is
965 Python hooks are run within the Mercurial process. Each hook is
966 called with at least three keyword arguments: a ui object (keyword
966 called with at least three keyword arguments: a ui object (keyword
967 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
967 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
968 keyword that tells what kind of hook is used. Arguments listed as
968 keyword that tells what kind of hook is used. Arguments listed as
969 environment variables above are passed as keyword arguments, with no
969 environment variables above are passed as keyword arguments, with no
970 ``HG_`` prefix, and names in lower case.
970 ``HG_`` prefix, and names in lower case.
971
971
972 If a Python hook returns a "true" value or raises an exception, this
972 If a Python hook returns a "true" value or raises an exception, this
973 is treated as a failure.
973 is treated as a failure.
974
974
975
975
976 ``hostfingerprints``
976 ``hostfingerprints``
977 --------------------
977 --------------------
978
978
979 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
979 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
980
980
981 Fingerprints of the certificates of known HTTPS servers.
981 Fingerprints of the certificates of known HTTPS servers.
982
982
983 A HTTPS connection to a server with a fingerprint configured here will
983 A HTTPS connection to a server with a fingerprint configured here will
984 only succeed if the servers certificate matches the fingerprint.
984 only succeed if the servers certificate matches the fingerprint.
985 This is very similar to how ssh known hosts works.
985 This is very similar to how ssh known hosts works.
986
986
987 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
987 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
988 Multiple values can be specified (separated by spaces or commas). This can
988 Multiple values can be specified (separated by spaces or commas). This can
989 be used to define both old and new fingerprints while a host transitions
989 be used to define both old and new fingerprints while a host transitions
990 to a new certificate.
990 to a new certificate.
991
991
992 The CA chain and web.cacerts is not used for servers with a fingerprint.
992 The CA chain and web.cacerts is not used for servers with a fingerprint.
993
993
994 For example::
994 For example::
995
995
996 [hostfingerprints]
996 [hostfingerprints]
997 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
997 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
998 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
998 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
999
999
1000 ``hostsecurity``
1000 ``hostsecurity``
1001 ----------------
1001 ----------------
1002
1002
1003 Used to specify global and per-host security settings for connecting to
1003 Used to specify global and per-host security settings for connecting to
1004 other machines.
1004 other machines.
1005
1005
1006 The following options control default behavior for all hosts.
1006 The following options control default behavior for all hosts.
1007
1007
1008 ``ciphers``
1008 ``ciphers``
1009 Defines the cryptographic ciphers to use for connections.
1009 Defines the cryptographic ciphers to use for connections.
1010
1010
1011 Value must be a valid OpenSSL Cipher List Format as documented at
1011 Value must be a valid OpenSSL Cipher List Format as documented at
1012 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1012 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1013
1013
1014 This setting is for advanced users only. Setting to incorrect values
1014 This setting is for advanced users only. Setting to incorrect values
1015 can significantly lower connection security or decrease performance.
1015 can significantly lower connection security or decrease performance.
1016 You have been warned.
1016 You have been warned.
1017
1017
1018 This option requires Python 2.7.
1018 This option requires Python 2.7.
1019
1019
1020 ``minimumprotocol``
1020 ``minimumprotocol``
1021 Defines the minimum channel encryption protocol to use.
1021 Defines the minimum channel encryption protocol to use.
1022
1022
1023 By default, the highest version of TLS supported by both client and server
1023 By default, the highest version of TLS supported by both client and server
1024 is used.
1024 is used.
1025
1025
1026 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1026 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1027
1027
1028 When running on an old Python version, only ``tls1.0`` is allowed since
1028 When running on an old Python version, only ``tls1.0`` is allowed since
1029 old versions of Python only support up to TLS 1.0.
1029 old versions of Python only support up to TLS 1.0.
1030
1030
1031 When running a Python that supports modern TLS versions, the default is
1031 When running a Python that supports modern TLS versions, the default is
1032 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1032 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1033 weakens security and should only be used as a feature of last resort if
1033 weakens security and should only be used as a feature of last resort if
1034 a server does not support TLS 1.1+.
1034 a server does not support TLS 1.1+.
1035
1035
1036 Options in the ``[hostsecurity]`` section can have the form
1036 Options in the ``[hostsecurity]`` section can have the form
1037 ``hostname``:``setting``. This allows multiple settings to be defined on a
1037 ``hostname``:``setting``. This allows multiple settings to be defined on a
1038 per-host basis.
1038 per-host basis.
1039
1039
1040 The following per-host settings can be defined.
1040 The following per-host settings can be defined.
1041
1041
1042 ``ciphers``
1042 ``ciphers``
1043 This behaves like ``ciphers`` as described above except it only applies
1043 This behaves like ``ciphers`` as described above except it only applies
1044 to the host on which it is defined.
1044 to the host on which it is defined.
1045
1045
1046 ``fingerprints``
1046 ``fingerprints``
1047 A list of hashes of the DER encoded peer/remote certificate. Values have
1047 A list of hashes of the DER encoded peer/remote certificate. Values have
1048 the form ``algorithm``:``fingerprint``. e.g.
1048 the form ``algorithm``:``fingerprint``. e.g.
1049 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1049 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1050
1050
1051 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1051 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1052 ``sha512``.
1052 ``sha512``.
1053
1053
1054 Use of ``sha256`` or ``sha512`` is preferred.
1054 Use of ``sha256`` or ``sha512`` is preferred.
1055
1055
1056 If a fingerprint is specified, the CA chain is not validated for this
1056 If a fingerprint is specified, the CA chain is not validated for this
1057 host and Mercurial will require the remote certificate to match one
1057 host and Mercurial will require the remote certificate to match one
1058 of the fingerprints specified. This means if the server updates its
1058 of the fingerprints specified. This means if the server updates its
1059 certificate, Mercurial will abort until a new fingerprint is defined.
1059 certificate, Mercurial will abort until a new fingerprint is defined.
1060 This can provide stronger security than traditional CA-based validation
1060 This can provide stronger security than traditional CA-based validation
1061 at the expense of convenience.
1061 at the expense of convenience.
1062
1062
1063 This option takes precedence over ``verifycertsfile``.
1063 This option takes precedence over ``verifycertsfile``.
1064
1064
1065 ``minimumprotocol``
1065 ``minimumprotocol``
1066 This behaves like ``minimumprotocol`` as described above except it
1066 This behaves like ``minimumprotocol`` as described above except it
1067 only applies to the host on which it is defined.
1067 only applies to the host on which it is defined.
1068
1068
1069 ``verifycertsfile``
1069 ``verifycertsfile``
1070 Path to file a containing a list of PEM encoded certificates used to
1070 Path to file a containing a list of PEM encoded certificates used to
1071 verify the server certificate. Environment variables and ``~user``
1071 verify the server certificate. Environment variables and ``~user``
1072 constructs are expanded in the filename.
1072 constructs are expanded in the filename.
1073
1073
1074 The server certificate or the certificate's certificate authority (CA)
1074 The server certificate or the certificate's certificate authority (CA)
1075 must match a certificate from this file or certificate verification
1075 must match a certificate from this file or certificate verification
1076 will fail and connections to the server will be refused.
1076 will fail and connections to the server will be refused.
1077
1077
1078 If defined, only certificates provided by this file will be used:
1078 If defined, only certificates provided by this file will be used:
1079 ``web.cacerts`` and any system/default certificates will not be
1079 ``web.cacerts`` and any system/default certificates will not be
1080 used.
1080 used.
1081
1081
1082 This option has no effect if the per-host ``fingerprints`` option
1082 This option has no effect if the per-host ``fingerprints`` option
1083 is set.
1083 is set.
1084
1084
1085 The format of the file is as follows::
1085 The format of the file is as follows::
1086
1086
1087 -----BEGIN CERTIFICATE-----
1087 -----BEGIN CERTIFICATE-----
1088 ... (certificate in base64 PEM encoding) ...
1088 ... (certificate in base64 PEM encoding) ...
1089 -----END CERTIFICATE-----
1089 -----END CERTIFICATE-----
1090 -----BEGIN CERTIFICATE-----
1090 -----BEGIN CERTIFICATE-----
1091 ... (certificate in base64 PEM encoding) ...
1091 ... (certificate in base64 PEM encoding) ...
1092 -----END CERTIFICATE-----
1092 -----END CERTIFICATE-----
1093
1093
1094 For example::
1094 For example::
1095
1095
1096 [hostsecurity]
1096 [hostsecurity]
1097 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1097 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1098 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
1098 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
1099 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1099 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1100
1100
1101 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1101 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1102 when connecting to ``hg.example.com``::
1102 when connecting to ``hg.example.com``::
1103
1103
1104 [hostsecurity]
1104 [hostsecurity]
1105 minimumprotocol = tls1.2
1105 minimumprotocol = tls1.2
1106 hg.example.com:minimumprotocol = tls1.1
1106 hg.example.com:minimumprotocol = tls1.1
1107
1107
1108 ``http_proxy``
1108 ``http_proxy``
1109 --------------
1109 --------------
1110
1110
1111 Used to access web-based Mercurial repositories through a HTTP
1111 Used to access web-based Mercurial repositories through a HTTP
1112 proxy.
1112 proxy.
1113
1113
1114 ``host``
1114 ``host``
1115 Host name and (optional) port of the proxy server, for example
1115 Host name and (optional) port of the proxy server, for example
1116 "myproxy:8000".
1116 "myproxy:8000".
1117
1117
1118 ``no``
1118 ``no``
1119 Optional. Comma-separated list of host names that should bypass
1119 Optional. Comma-separated list of host names that should bypass
1120 the proxy.
1120 the proxy.
1121
1121
1122 ``passwd``
1122 ``passwd``
1123 Optional. Password to authenticate with at the proxy server.
1123 Optional. Password to authenticate with at the proxy server.
1124
1124
1125 ``user``
1125 ``user``
1126 Optional. User name to authenticate with at the proxy server.
1126 Optional. User name to authenticate with at the proxy server.
1127
1127
1128 ``always``
1128 ``always``
1129 Optional. Always use the proxy, even for localhost and any entries
1129 Optional. Always use the proxy, even for localhost and any entries
1130 in ``http_proxy.no``. (default: False)
1130 in ``http_proxy.no``. (default: False)
1131
1131
1132 ``merge``
1132 ``merge``
1133 ---------
1133 ---------
1134
1134
1135 This section specifies behavior during merges and updates.
1135 This section specifies behavior during merges and updates.
1136
1136
1137 ``checkignored``
1137 ``checkignored``
1138 Controls behavior when an ignored file on disk has the same name as a tracked
1138 Controls behavior when an ignored file on disk has the same name as a tracked
1139 file in the changeset being merged or updated to, and has different
1139 file in the changeset being merged or updated to, and has different
1140 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1140 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1141 abort on such files. With ``warn``, warn on such files and back them up as
1141 abort on such files. With ``warn``, warn on such files and back them up as
1142 ``.orig``. With ``ignore``, don't print a warning and back them up as
1142 ``.orig``. With ``ignore``, don't print a warning and back them up as
1143 ``.orig``. (default: ``abort``)
1143 ``.orig``. (default: ``abort``)
1144
1144
1145 ``checkunknown``
1145 ``checkunknown``
1146 Controls behavior when an unknown file that isn't ignored has the same name
1146 Controls behavior when an unknown file that isn't ignored has the same name
1147 as a tracked file in the changeset being merged or updated to, and has
1147 as a tracked file in the changeset being merged or updated to, and has
1148 different contents. Similar to ``merge.checkignored``, except for files that
1148 different contents. Similar to ``merge.checkignored``, except for files that
1149 are not ignored. (default: ``abort``)
1149 are not ignored. (default: ``abort``)
1150
1150
1151 ``merge-patterns``
1151 ``merge-patterns``
1152 ------------------
1152 ------------------
1153
1153
1154 This section specifies merge tools to associate with particular file
1154 This section specifies merge tools to associate with particular file
1155 patterns. Tools matched here will take precedence over the default
1155 patterns. Tools matched here will take precedence over the default
1156 merge tool. Patterns are globs by default, rooted at the repository
1156 merge tool. Patterns are globs by default, rooted at the repository
1157 root.
1157 root.
1158
1158
1159 Example::
1159 Example::
1160
1160
1161 [merge-patterns]
1161 [merge-patterns]
1162 **.c = kdiff3
1162 **.c = kdiff3
1163 **.jpg = myimgmerge
1163 **.jpg = myimgmerge
1164
1164
1165 ``merge-tools``
1165 ``merge-tools``
1166 ---------------
1166 ---------------
1167
1167
1168 This section configures external merge tools to use for file-level
1168 This section configures external merge tools to use for file-level
1169 merges. This section has likely been preconfigured at install time.
1169 merges. This section has likely been preconfigured at install time.
1170 Use :hg:`config merge-tools` to check the existing configuration.
1170 Use :hg:`config merge-tools` to check the existing configuration.
1171 Also see :hg:`help merge-tools` for more details.
1171 Also see :hg:`help merge-tools` for more details.
1172
1172
1173 Example ``~/.hgrc``::
1173 Example ``~/.hgrc``::
1174
1174
1175 [merge-tools]
1175 [merge-tools]
1176 # Override stock tool location
1176 # Override stock tool location
1177 kdiff3.executable = ~/bin/kdiff3
1177 kdiff3.executable = ~/bin/kdiff3
1178 # Specify command line
1178 # Specify command line
1179 kdiff3.args = $base $local $other -o $output
1179 kdiff3.args = $base $local $other -o $output
1180 # Give higher priority
1180 # Give higher priority
1181 kdiff3.priority = 1
1181 kdiff3.priority = 1
1182
1182
1183 # Changing the priority of preconfigured tool
1183 # Changing the priority of preconfigured tool
1184 meld.priority = 0
1184 meld.priority = 0
1185
1185
1186 # Disable a preconfigured tool
1186 # Disable a preconfigured tool
1187 vimdiff.disabled = yes
1187 vimdiff.disabled = yes
1188
1188
1189 # Define new tool
1189 # Define new tool
1190 myHtmlTool.args = -m $local $other $base $output
1190 myHtmlTool.args = -m $local $other $base $output
1191 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1191 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1192 myHtmlTool.priority = 1
1192 myHtmlTool.priority = 1
1193
1193
1194 Supported arguments:
1194 Supported arguments:
1195
1195
1196 ``priority``
1196 ``priority``
1197 The priority in which to evaluate this tool.
1197 The priority in which to evaluate this tool.
1198 (default: 0)
1198 (default: 0)
1199
1199
1200 ``executable``
1200 ``executable``
1201 Either just the name of the executable or its pathname.
1201 Either just the name of the executable or its pathname.
1202
1202
1203 .. container:: windows
1203 .. container:: windows
1204
1204
1205 On Windows, the path can use environment variables with ${ProgramFiles}
1205 On Windows, the path can use environment variables with ${ProgramFiles}
1206 syntax.
1206 syntax.
1207
1207
1208 (default: the tool name)
1208 (default: the tool name)
1209
1209
1210 ``args``
1210 ``args``
1211 The arguments to pass to the tool executable. You can refer to the
1211 The arguments to pass to the tool executable. You can refer to the
1212 files being merged as well as the output file through these
1212 files being merged as well as the output file through these
1213 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1213 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1214 of ``$local`` and ``$other`` can vary depending on which action is being
1214 of ``$local`` and ``$other`` can vary depending on which action is being
1215 performed. During and update or merge, ``$local`` represents the original
1215 performed. During and update or merge, ``$local`` represents the original
1216 state of the file, while ``$other`` represents the commit you are updating
1216 state of the file, while ``$other`` represents the commit you are updating
1217 to or the commit you are merging with. During a rebase ``$local``
1217 to or the commit you are merging with. During a rebase ``$local``
1218 represents the destination of the rebase, and ``$other`` represents the
1218 represents the destination of the rebase, and ``$other`` represents the
1219 commit being rebased.
1219 commit being rebased.
1220 (default: ``$local $base $other``)
1220 (default: ``$local $base $other``)
1221
1221
1222 ``premerge``
1222 ``premerge``
1223 Attempt to run internal non-interactive 3-way merge tool before
1223 Attempt to run internal non-interactive 3-way merge tool before
1224 launching external tool. Options are ``true``, ``false``, ``keep`` or
1224 launching external tool. Options are ``true``, ``false``, ``keep`` or
1225 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1225 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1226 premerge fails. The ``keep-merge3`` will do the same but include information
1226 premerge fails. The ``keep-merge3`` will do the same but include information
1227 about the base of the merge in the marker (see internal :merge3 in
1227 about the base of the merge in the marker (see internal :merge3 in
1228 :hg:`help merge-tools`).
1228 :hg:`help merge-tools`).
1229 (default: True)
1229 (default: True)
1230
1230
1231 ``binary``
1231 ``binary``
1232 This tool can merge binary files. (default: False, unless tool
1232 This tool can merge binary files. (default: False, unless tool
1233 was selected by file pattern match)
1233 was selected by file pattern match)
1234
1234
1235 ``symlink``
1235 ``symlink``
1236 This tool can merge symlinks. (default: False)
1236 This tool can merge symlinks. (default: False)
1237
1237
1238 ``check``
1238 ``check``
1239 A list of merge success-checking options:
1239 A list of merge success-checking options:
1240
1240
1241 ``changed``
1241 ``changed``
1242 Ask whether merge was successful when the merged file shows no changes.
1242 Ask whether merge was successful when the merged file shows no changes.
1243 ``conflicts``
1243 ``conflicts``
1244 Check whether there are conflicts even though the tool reported success.
1244 Check whether there are conflicts even though the tool reported success.
1245 ``prompt``
1245 ``prompt``
1246 Always prompt for merge success, regardless of success reported by tool.
1246 Always prompt for merge success, regardless of success reported by tool.
1247
1247
1248 ``fixeol``
1248 ``fixeol``
1249 Attempt to fix up EOL changes caused by the merge tool.
1249 Attempt to fix up EOL changes caused by the merge tool.
1250 (default: False)
1250 (default: False)
1251
1251
1252 ``gui``
1252 ``gui``
1253 This tool requires a graphical interface to run. (default: False)
1253 This tool requires a graphical interface to run. (default: False)
1254
1254
1255 .. container:: windows
1255 .. container:: windows
1256
1256
1257 ``regkey``
1257 ``regkey``
1258 Windows registry key which describes install location of this
1258 Windows registry key which describes install location of this
1259 tool. Mercurial will search for this key first under
1259 tool. Mercurial will search for this key first under
1260 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1260 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1261 (default: None)
1261 (default: None)
1262
1262
1263 ``regkeyalt``
1263 ``regkeyalt``
1264 An alternate Windows registry key to try if the first key is not
1264 An alternate Windows registry key to try if the first key is not
1265 found. The alternate key uses the same ``regname`` and ``regappend``
1265 found. The alternate key uses the same ``regname`` and ``regappend``
1266 semantics of the primary key. The most common use for this key
1266 semantics of the primary key. The most common use for this key
1267 is to search for 32bit applications on 64bit operating systems.
1267 is to search for 32bit applications on 64bit operating systems.
1268 (default: None)
1268 (default: None)
1269
1269
1270 ``regname``
1270 ``regname``
1271 Name of value to read from specified registry key.
1271 Name of value to read from specified registry key.
1272 (default: the unnamed (default) value)
1272 (default: the unnamed (default) value)
1273
1273
1274 ``regappend``
1274 ``regappend``
1275 String to append to the value read from the registry, typically
1275 String to append to the value read from the registry, typically
1276 the executable name of the tool.
1276 the executable name of the tool.
1277 (default: None)
1277 (default: None)
1278
1278
1279
1279
1280 ``patch``
1280 ``patch``
1281 ---------
1281 ---------
1282
1282
1283 Settings used when applying patches, for instance through the 'import'
1283 Settings used when applying patches, for instance through the 'import'
1284 command or with Mercurial Queues extension.
1284 command or with Mercurial Queues extension.
1285
1285
1286 ``eol``
1286 ``eol``
1287 When set to 'strict' patch content and patched files end of lines
1287 When set to 'strict' patch content and patched files end of lines
1288 are preserved. When set to ``lf`` or ``crlf``, both files end of
1288 are preserved. When set to ``lf`` or ``crlf``, both files end of
1289 lines are ignored when patching and the result line endings are
1289 lines are ignored when patching and the result line endings are
1290 normalized to either LF (Unix) or CRLF (Windows). When set to
1290 normalized to either LF (Unix) or CRLF (Windows). When set to
1291 ``auto``, end of lines are again ignored while patching but line
1291 ``auto``, end of lines are again ignored while patching but line
1292 endings in patched files are normalized to their original setting
1292 endings in patched files are normalized to their original setting
1293 on a per-file basis. If target file does not exist or has no end
1293 on a per-file basis. If target file does not exist or has no end
1294 of line, patch line endings are preserved.
1294 of line, patch line endings are preserved.
1295 (default: strict)
1295 (default: strict)
1296
1296
1297 ``fuzz``
1297 ``fuzz``
1298 The number of lines of 'fuzz' to allow when applying patches. This
1298 The number of lines of 'fuzz' to allow when applying patches. This
1299 controls how much context the patcher is allowed to ignore when
1299 controls how much context the patcher is allowed to ignore when
1300 trying to apply a patch.
1300 trying to apply a patch.
1301 (default: 2)
1301 (default: 2)
1302
1302
1303 ``paths``
1303 ``paths``
1304 ---------
1304 ---------
1305
1305
1306 Assigns symbolic names and behavior to repositories.
1306 Assigns symbolic names and behavior to repositories.
1307
1307
1308 Options are symbolic names defining the URL or directory that is the
1308 Options are symbolic names defining the URL or directory that is the
1309 location of the repository. Example::
1309 location of the repository. Example::
1310
1310
1311 [paths]
1311 [paths]
1312 my_server = https://example.com/my_repo
1312 my_server = https://example.com/my_repo
1313 local_path = /home/me/repo
1313 local_path = /home/me/repo
1314
1314
1315 These symbolic names can be used from the command line. To pull
1315 These symbolic names can be used from the command line. To pull
1316 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1316 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1317 :hg:`push local_path`.
1317 :hg:`push local_path`.
1318
1318
1319 Options containing colons (``:``) denote sub-options that can influence
1319 Options containing colons (``:``) denote sub-options that can influence
1320 behavior for that specific path. Example::
1320 behavior for that specific path. Example::
1321
1321
1322 [paths]
1322 [paths]
1323 my_server = https://example.com/my_path
1323 my_server = https://example.com/my_path
1324 my_server:pushurl = ssh://example.com/my_path
1324 my_server:pushurl = ssh://example.com/my_path
1325
1325
1326 The following sub-options can be defined:
1326 The following sub-options can be defined:
1327
1327
1328 ``pushurl``
1328 ``pushurl``
1329 The URL to use for push operations. If not defined, the location
1329 The URL to use for push operations. If not defined, the location
1330 defined by the path's main entry is used.
1330 defined by the path's main entry is used.
1331
1331
1332 ``pushrev``
1332 ``pushrev``
1333 A revset defining which revisions to push by default.
1333 A revset defining which revisions to push by default.
1334
1334
1335 When :hg:`push` is executed without a ``-r`` argument, the revset
1335 When :hg:`push` is executed without a ``-r`` argument, the revset
1336 defined by this sub-option is evaluated to determine what to push.
1336 defined by this sub-option is evaluated to determine what to push.
1337
1337
1338 For example, a value of ``.`` will push the working directory's
1338 For example, a value of ``.`` will push the working directory's
1339 revision by default.
1339 revision by default.
1340
1340
1341 Revsets specifying bookmarks will not result in the bookmark being
1341 Revsets specifying bookmarks will not result in the bookmark being
1342 pushed.
1342 pushed.
1343
1343
1344 The following special named paths exist:
1344 The following special named paths exist:
1345
1345
1346 ``default``
1346 ``default``
1347 The URL or directory to use when no source or remote is specified.
1347 The URL or directory to use when no source or remote is specified.
1348
1348
1349 :hg:`clone` will automatically define this path to the location the
1349 :hg:`clone` will automatically define this path to the location the
1350 repository was cloned from.
1350 repository was cloned from.
1351
1351
1352 ``default-push``
1352 ``default-push``
1353 (deprecated) The URL or directory for the default :hg:`push` location.
1353 (deprecated) The URL or directory for the default :hg:`push` location.
1354 ``default:pushurl`` should be used instead.
1354 ``default:pushurl`` should be used instead.
1355
1355
1356 ``phases``
1356 ``phases``
1357 ----------
1357 ----------
1358
1358
1359 Specifies default handling of phases. See :hg:`help phases` for more
1359 Specifies default handling of phases. See :hg:`help phases` for more
1360 information about working with phases.
1360 information about working with phases.
1361
1361
1362 ``publish``
1362 ``publish``
1363 Controls draft phase behavior when working as a server. When true,
1363 Controls draft phase behavior when working as a server. When true,
1364 pushed changesets are set to public in both client and server and
1364 pushed changesets are set to public in both client and server and
1365 pulled or cloned changesets are set to public in the client.
1365 pulled or cloned changesets are set to public in the client.
1366 (default: True)
1366 (default: True)
1367
1367
1368 ``new-commit``
1368 ``new-commit``
1369 Phase of newly-created commits.
1369 Phase of newly-created commits.
1370 (default: draft)
1370 (default: draft)
1371
1371
1372 ``checksubrepos``
1372 ``checksubrepos``
1373 Check the phase of the current revision of each subrepository. Allowed
1373 Check the phase of the current revision of each subrepository. Allowed
1374 values are "ignore", "follow" and "abort". For settings other than
1374 values are "ignore", "follow" and "abort". For settings other than
1375 "ignore", the phase of the current revision of each subrepository is
1375 "ignore", the phase of the current revision of each subrepository is
1376 checked before committing the parent repository. If any of those phases is
1376 checked before committing the parent repository. If any of those phases is
1377 greater than the phase of the parent repository (e.g. if a subrepo is in a
1377 greater than the phase of the parent repository (e.g. if a subrepo is in a
1378 "secret" phase while the parent repo is in "draft" phase), the commit is
1378 "secret" phase while the parent repo is in "draft" phase), the commit is
1379 either aborted (if checksubrepos is set to "abort") or the higher phase is
1379 either aborted (if checksubrepos is set to "abort") or the higher phase is
1380 used for the parent repository commit (if set to "follow").
1380 used for the parent repository commit (if set to "follow").
1381 (default: follow)
1381 (default: follow)
1382
1382
1383
1383
1384 ``profiling``
1384 ``profiling``
1385 -------------
1385 -------------
1386
1386
1387 Specifies profiling type, format, and file output. Two profilers are
1387 Specifies profiling type, format, and file output. Two profilers are
1388 supported: an instrumenting profiler (named ``ls``), and a sampling
1388 supported: an instrumenting profiler (named ``ls``), and a sampling
1389 profiler (named ``stat``).
1389 profiler (named ``stat``).
1390
1390
1391 In this section description, 'profiling data' stands for the raw data
1391 In this section description, 'profiling data' stands for the raw data
1392 collected during profiling, while 'profiling report' stands for a
1392 collected during profiling, while 'profiling report' stands for a
1393 statistical text report generated from the profiling data. The
1393 statistical text report generated from the profiling data. The
1394 profiling is done using lsprof.
1394 profiling is done using lsprof.
1395
1395
1396 ``enabled``
1396 ``enabled``
1397 Enable the profiler.
1397 Enable the profiler.
1398 (default: false)
1398 (default: false)
1399
1399
1400 This is equivalent to passing ``--profile`` on the command line.
1400 This is equivalent to passing ``--profile`` on the command line.
1401
1401
1402 ``type``
1402 ``type``
1403 The type of profiler to use.
1403 The type of profiler to use.
1404 (default: ls)
1404 (default: ls)
1405
1405
1406 ``ls``
1406 ``ls``
1407 Use Python's built-in instrumenting profiler. This profiler
1407 Use Python's built-in instrumenting profiler. This profiler
1408 works on all platforms, but each line number it reports is the
1408 works on all platforms, but each line number it reports is the
1409 first line of a function. This restriction makes it difficult to
1409 first line of a function. This restriction makes it difficult to
1410 identify the expensive parts of a non-trivial function.
1410 identify the expensive parts of a non-trivial function.
1411 ``stat``
1411 ``stat``
1412 Use a third-party statistical profiler, statprof. This profiler
1412 Use a statistical profiler, statprof. This profiler is most
1413 currently runs only on Unix systems, and is most useful for
1413 most useful for profiling commands that run for longer than
1414 profiling commands that run for longer than about 0.1 seconds.
1414 about 0.1 seconds.
1415
1415
1416 ``format``
1416 ``format``
1417 Profiling format. Specific to the ``ls`` instrumenting profiler.
1417 Profiling format. Specific to the ``ls`` instrumenting profiler.
1418 (default: text)
1418 (default: text)
1419
1419
1420 ``text``
1420 ``text``
1421 Generate a profiling report. When saving to a file, it should be
1421 Generate a profiling report. When saving to a file, it should be
1422 noted that only the report is saved, and the profiling data is
1422 noted that only the report is saved, and the profiling data is
1423 not kept.
1423 not kept.
1424 ``kcachegrind``
1424 ``kcachegrind``
1425 Format profiling data for kcachegrind use: when saving to a
1425 Format profiling data for kcachegrind use: when saving to a
1426 file, the generated file can directly be loaded into
1426 file, the generated file can directly be loaded into
1427 kcachegrind.
1427 kcachegrind.
1428
1428
1429 ``statformat``
1430 Profiling format for the ``stat`` profiler.
1431 (default: hotpath)
1432
1433 ``hotpath``
1434 Show a tree-based display containing the hot path of execution (where
1435 most time was spent).
1436 ``bymethod``
1437 Show a table of methods ordered by how frequently they are active.
1438 ``byline``
1439 Show a table of lines in files ordered by how frequently they are active.
1440 ``json``
1441 Render profiling data as JSON.
1442
1429 ``frequency``
1443 ``frequency``
1430 Sampling frequency. Specific to the ``stat`` sampling profiler.
1444 Sampling frequency. Specific to the ``stat`` sampling profiler.
1431 (default: 1000)
1445 (default: 1000)
1432
1446
1433 ``output``
1447 ``output``
1434 File path where profiling data or report should be saved. If the
1448 File path where profiling data or report should be saved. If the
1435 file exists, it is replaced. (default: None, data is printed on
1449 file exists, it is replaced. (default: None, data is printed on
1436 stderr)
1450 stderr)
1437
1451
1438 ``sort``
1452 ``sort``
1439 Sort field. Specific to the ``ls`` instrumenting profiler.
1453 Sort field. Specific to the ``ls`` instrumenting profiler.
1440 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1454 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1441 ``inlinetime``.
1455 ``inlinetime``.
1442 (default: inlinetime)
1456 (default: inlinetime)
1443
1457
1444 ``limit``
1458 ``limit``
1445 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1459 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1446 (default: 30)
1460 (default: 30)
1447
1461
1448 ``nested``
1462 ``nested``
1449 Show at most this number of lines of drill-down info after each main entry.
1463 Show at most this number of lines of drill-down info after each main entry.
1450 This can help explain the difference between Total and Inline.
1464 This can help explain the difference between Total and Inline.
1451 Specific to the ``ls`` instrumenting profiler.
1465 Specific to the ``ls`` instrumenting profiler.
1452 (default: 5)
1466 (default: 5)
1453
1467
1454 ``progress``
1468 ``progress``
1455 ------------
1469 ------------
1456
1470
1457 Mercurial commands can draw progress bars that are as informative as
1471 Mercurial commands can draw progress bars that are as informative as
1458 possible. Some progress bars only offer indeterminate information, while others
1472 possible. Some progress bars only offer indeterminate information, while others
1459 have a definite end point.
1473 have a definite end point.
1460
1474
1461 ``delay``
1475 ``delay``
1462 Number of seconds (float) before showing the progress bar. (default: 3)
1476 Number of seconds (float) before showing the progress bar. (default: 3)
1463
1477
1464 ``changedelay``
1478 ``changedelay``
1465 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1479 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1466 that value will be used instead. (default: 1)
1480 that value will be used instead. (default: 1)
1467
1481
1468 ``refresh``
1482 ``refresh``
1469 Time in seconds between refreshes of the progress bar. (default: 0.1)
1483 Time in seconds between refreshes of the progress bar. (default: 0.1)
1470
1484
1471 ``format``
1485 ``format``
1472 Format of the progress bar.
1486 Format of the progress bar.
1473
1487
1474 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1488 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1475 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1489 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1476 last 20 characters of the item, but this can be changed by adding either
1490 last 20 characters of the item, but this can be changed by adding either
1477 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1491 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1478 first num characters.
1492 first num characters.
1479
1493
1480 (default: topic bar number estimate)
1494 (default: topic bar number estimate)
1481
1495
1482 ``width``
1496 ``width``
1483 If set, the maximum width of the progress information (that is, min(width,
1497 If set, the maximum width of the progress information (that is, min(width,
1484 term width) will be used).
1498 term width) will be used).
1485
1499
1486 ``clear-complete``
1500 ``clear-complete``
1487 Clear the progress bar after it's done. (default: True)
1501 Clear the progress bar after it's done. (default: True)
1488
1502
1489 ``disable``
1503 ``disable``
1490 If true, don't show a progress bar.
1504 If true, don't show a progress bar.
1491
1505
1492 ``assume-tty``
1506 ``assume-tty``
1493 If true, ALWAYS show a progress bar, unless disable is given.
1507 If true, ALWAYS show a progress bar, unless disable is given.
1494
1508
1495 ``rebase``
1509 ``rebase``
1496 ----------
1510 ----------
1497
1511
1498 ``allowdivergence``
1512 ``allowdivergence``
1499 Default to False, when True allow creating divergence when performing
1513 Default to False, when True allow creating divergence when performing
1500 rebase of obsolete changesets.
1514 rebase of obsolete changesets.
1501
1515
1502 ``revsetalias``
1516 ``revsetalias``
1503 ---------------
1517 ---------------
1504
1518
1505 Alias definitions for revsets. See :hg:`help revsets` for details.
1519 Alias definitions for revsets. See :hg:`help revsets` for details.
1506
1520
1507 ``server``
1521 ``server``
1508 ----------
1522 ----------
1509
1523
1510 Controls generic server settings.
1524 Controls generic server settings.
1511
1525
1512 ``uncompressed``
1526 ``uncompressed``
1513 Whether to allow clients to clone a repository using the
1527 Whether to allow clients to clone a repository using the
1514 uncompressed streaming protocol. This transfers about 40% more
1528 uncompressed streaming protocol. This transfers about 40% more
1515 data than a regular clone, but uses less memory and CPU on both
1529 data than a regular clone, but uses less memory and CPU on both
1516 server and client. Over a LAN (100 Mbps or better) or a very fast
1530 server and client. Over a LAN (100 Mbps or better) or a very fast
1517 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1531 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1518 regular clone. Over most WAN connections (anything slower than
1532 regular clone. Over most WAN connections (anything slower than
1519 about 6 Mbps), uncompressed streaming is slower, because of the
1533 about 6 Mbps), uncompressed streaming is slower, because of the
1520 extra data transfer overhead. This mode will also temporarily hold
1534 extra data transfer overhead. This mode will also temporarily hold
1521 the write lock while determining what data to transfer.
1535 the write lock while determining what data to transfer.
1522 (default: True)
1536 (default: True)
1523
1537
1524 ``preferuncompressed``
1538 ``preferuncompressed``
1525 When set, clients will try to use the uncompressed streaming
1539 When set, clients will try to use the uncompressed streaming
1526 protocol. (default: False)
1540 protocol. (default: False)
1527
1541
1528 ``validate``
1542 ``validate``
1529 Whether to validate the completeness of pushed changesets by
1543 Whether to validate the completeness of pushed changesets by
1530 checking that all new file revisions specified in manifests are
1544 checking that all new file revisions specified in manifests are
1531 present. (default: False)
1545 present. (default: False)
1532
1546
1533 ``maxhttpheaderlen``
1547 ``maxhttpheaderlen``
1534 Instruct HTTP clients not to send request headers longer than this
1548 Instruct HTTP clients not to send request headers longer than this
1535 many bytes. (default: 1024)
1549 many bytes. (default: 1024)
1536
1550
1537 ``bundle1``
1551 ``bundle1``
1538 Whether to allow clients to push and pull using the legacy bundle1
1552 Whether to allow clients to push and pull using the legacy bundle1
1539 exchange format. (default: True)
1553 exchange format. (default: True)
1540
1554
1541 ``bundle1gd``
1555 ``bundle1gd``
1542 Like ``bundle1`` but only used if the repository is using the
1556 Like ``bundle1`` but only used if the repository is using the
1543 *generaldelta* storage format. (default: True)
1557 *generaldelta* storage format. (default: True)
1544
1558
1545 ``bundle1.push``
1559 ``bundle1.push``
1546 Whether to allow clients to push using the legacy bundle1 exchange
1560 Whether to allow clients to push using the legacy bundle1 exchange
1547 format. (default: True)
1561 format. (default: True)
1548
1562
1549 ``bundle1gd.push``
1563 ``bundle1gd.push``
1550 Like ``bundle1.push`` but only used if the repository is using the
1564 Like ``bundle1.push`` but only used if the repository is using the
1551 *generaldelta* storage format. (default: True)
1565 *generaldelta* storage format. (default: True)
1552
1566
1553 ``bundle1.pull``
1567 ``bundle1.pull``
1554 Whether to allow clients to pull using the legacy bundle1 exchange
1568 Whether to allow clients to pull using the legacy bundle1 exchange
1555 format. (default: True)
1569 format. (default: True)
1556
1570
1557 ``bundle1gd.pull``
1571 ``bundle1gd.pull``
1558 Like ``bundle1.pull`` but only used if the repository is using the
1572 Like ``bundle1.pull`` but only used if the repository is using the
1559 *generaldelta* storage format. (default: True)
1573 *generaldelta* storage format. (default: True)
1560
1574
1561 Large repositories using the *generaldelta* storage format should
1575 Large repositories using the *generaldelta* storage format should
1562 consider setting this option because converting *generaldelta*
1576 consider setting this option because converting *generaldelta*
1563 repositories to the exchange format required by the bundle1 data
1577 repositories to the exchange format required by the bundle1 data
1564 format can consume a lot of CPU.
1578 format can consume a lot of CPU.
1565
1579
1566 ``zliblevel``
1580 ``zliblevel``
1567 Integer between ``-1`` and ``9`` that controls the zlib compression level
1581 Integer between ``-1`` and ``9`` that controls the zlib compression level
1568 for wire protocol commands that send zlib compressed output (notably the
1582 for wire protocol commands that send zlib compressed output (notably the
1569 commands that send repository history data).
1583 commands that send repository history data).
1570
1584
1571 The default (``-1``) uses the default zlib compression level, which is
1585 The default (``-1``) uses the default zlib compression level, which is
1572 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
1586 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
1573 maximum compression.
1587 maximum compression.
1574
1588
1575 Setting this option allows server operators to make trade-offs between
1589 Setting this option allows server operators to make trade-offs between
1576 bandwidth and CPU used. Lowering the compression lowers CPU utilization
1590 bandwidth and CPU used. Lowering the compression lowers CPU utilization
1577 but sends more bytes to clients.
1591 but sends more bytes to clients.
1578
1592
1579 This option only impacts the HTTP server.
1593 This option only impacts the HTTP server.
1580
1594
1581 ``smtp``
1595 ``smtp``
1582 --------
1596 --------
1583
1597
1584 Configuration for extensions that need to send email messages.
1598 Configuration for extensions that need to send email messages.
1585
1599
1586 ``host``
1600 ``host``
1587 Host name of mail server, e.g. "mail.example.com".
1601 Host name of mail server, e.g. "mail.example.com".
1588
1602
1589 ``port``
1603 ``port``
1590 Optional. Port to connect to on mail server. (default: 465 if
1604 Optional. Port to connect to on mail server. (default: 465 if
1591 ``tls`` is smtps; 25 otherwise)
1605 ``tls`` is smtps; 25 otherwise)
1592
1606
1593 ``tls``
1607 ``tls``
1594 Optional. Method to enable TLS when connecting to mail server: starttls,
1608 Optional. Method to enable TLS when connecting to mail server: starttls,
1595 smtps or none. (default: none)
1609 smtps or none. (default: none)
1596
1610
1597 ``username``
1611 ``username``
1598 Optional. User name for authenticating with the SMTP server.
1612 Optional. User name for authenticating with the SMTP server.
1599 (default: None)
1613 (default: None)
1600
1614
1601 ``password``
1615 ``password``
1602 Optional. Password for authenticating with the SMTP server. If not
1616 Optional. Password for authenticating with the SMTP server. If not
1603 specified, interactive sessions will prompt the user for a
1617 specified, interactive sessions will prompt the user for a
1604 password; non-interactive sessions will fail. (default: None)
1618 password; non-interactive sessions will fail. (default: None)
1605
1619
1606 ``local_hostname``
1620 ``local_hostname``
1607 Optional. The hostname that the sender can use to identify
1621 Optional. The hostname that the sender can use to identify
1608 itself to the MTA.
1622 itself to the MTA.
1609
1623
1610
1624
1611 ``subpaths``
1625 ``subpaths``
1612 ------------
1626 ------------
1613
1627
1614 Subrepository source URLs can go stale if a remote server changes name
1628 Subrepository source URLs can go stale if a remote server changes name
1615 or becomes temporarily unavailable. This section lets you define
1629 or becomes temporarily unavailable. This section lets you define
1616 rewrite rules of the form::
1630 rewrite rules of the form::
1617
1631
1618 <pattern> = <replacement>
1632 <pattern> = <replacement>
1619
1633
1620 where ``pattern`` is a regular expression matching a subrepository
1634 where ``pattern`` is a regular expression matching a subrepository
1621 source URL and ``replacement`` is the replacement string used to
1635 source URL and ``replacement`` is the replacement string used to
1622 rewrite it. Groups can be matched in ``pattern`` and referenced in
1636 rewrite it. Groups can be matched in ``pattern`` and referenced in
1623 ``replacements``. For instance::
1637 ``replacements``. For instance::
1624
1638
1625 http://server/(.*)-hg/ = http://hg.server/\1/
1639 http://server/(.*)-hg/ = http://hg.server/\1/
1626
1640
1627 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1641 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1628
1642
1629 Relative subrepository paths are first made absolute, and the
1643 Relative subrepository paths are first made absolute, and the
1630 rewrite rules are then applied on the full (absolute) path. If ``pattern``
1644 rewrite rules are then applied on the full (absolute) path. If ``pattern``
1631 doesn't match the full path, an attempt is made to apply it on the
1645 doesn't match the full path, an attempt is made to apply it on the
1632 relative path alone. The rules are applied in definition order.
1646 relative path alone. The rules are applied in definition order.
1633
1647
1634 ``templatealias``
1648 ``templatealias``
1635 -----------------
1649 -----------------
1636
1650
1637 Alias definitions for templates. See :hg:`help templates` for details.
1651 Alias definitions for templates. See :hg:`help templates` for details.
1638
1652
1639 ``templates``
1653 ``templates``
1640 -------------
1654 -------------
1641
1655
1642 Use the ``[templates]`` section to define template strings.
1656 Use the ``[templates]`` section to define template strings.
1643 See :hg:`help templates` for details.
1657 See :hg:`help templates` for details.
1644
1658
1645 ``trusted``
1659 ``trusted``
1646 -----------
1660 -----------
1647
1661
1648 Mercurial will not use the settings in the
1662 Mercurial will not use the settings in the
1649 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1663 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1650 user or to a trusted group, as various hgrc features allow arbitrary
1664 user or to a trusted group, as various hgrc features allow arbitrary
1651 commands to be run. This issue is often encountered when configuring
1665 commands to be run. This issue is often encountered when configuring
1652 hooks or extensions for shared repositories or servers. However,
1666 hooks or extensions for shared repositories or servers. However,
1653 the web interface will use some safe settings from the ``[web]``
1667 the web interface will use some safe settings from the ``[web]``
1654 section.
1668 section.
1655
1669
1656 This section specifies what users and groups are trusted. The
1670 This section specifies what users and groups are trusted. The
1657 current user is always trusted. To trust everybody, list a user or a
1671 current user is always trusted. To trust everybody, list a user or a
1658 group with name ``*``. These settings must be placed in an
1672 group with name ``*``. These settings must be placed in an
1659 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1673 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1660 user or service running Mercurial.
1674 user or service running Mercurial.
1661
1675
1662 ``users``
1676 ``users``
1663 Comma-separated list of trusted users.
1677 Comma-separated list of trusted users.
1664
1678
1665 ``groups``
1679 ``groups``
1666 Comma-separated list of trusted groups.
1680 Comma-separated list of trusted groups.
1667
1681
1668
1682
1669 ``ui``
1683 ``ui``
1670 ------
1684 ------
1671
1685
1672 User interface controls.
1686 User interface controls.
1673
1687
1674 ``archivemeta``
1688 ``archivemeta``
1675 Whether to include the .hg_archival.txt file containing meta data
1689 Whether to include the .hg_archival.txt file containing meta data
1676 (hashes for the repository base and for tip) in archives created
1690 (hashes for the repository base and for tip) in archives created
1677 by the :hg:`archive` command or downloaded via hgweb.
1691 by the :hg:`archive` command or downloaded via hgweb.
1678 (default: True)
1692 (default: True)
1679
1693
1680 ``askusername``
1694 ``askusername``
1681 Whether to prompt for a username when committing. If True, and
1695 Whether to prompt for a username when committing. If True, and
1682 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1696 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1683 be prompted to enter a username. If no username is entered, the
1697 be prompted to enter a username. If no username is entered, the
1684 default ``USER@HOST`` is used instead.
1698 default ``USER@HOST`` is used instead.
1685 (default: False)
1699 (default: False)
1686
1700
1687 ``clonebundles``
1701 ``clonebundles``
1688 Whether the "clone bundles" feature is enabled.
1702 Whether the "clone bundles" feature is enabled.
1689
1703
1690 When enabled, :hg:`clone` may download and apply a server-advertised
1704 When enabled, :hg:`clone` may download and apply a server-advertised
1691 bundle file from a URL instead of using the normal exchange mechanism.
1705 bundle file from a URL instead of using the normal exchange mechanism.
1692
1706
1693 This can likely result in faster and more reliable clones.
1707 This can likely result in faster and more reliable clones.
1694
1708
1695 (default: True)
1709 (default: True)
1696
1710
1697 ``clonebundlefallback``
1711 ``clonebundlefallback``
1698 Whether failure to apply an advertised "clone bundle" from a server
1712 Whether failure to apply an advertised "clone bundle" from a server
1699 should result in fallback to a regular clone.
1713 should result in fallback to a regular clone.
1700
1714
1701 This is disabled by default because servers advertising "clone
1715 This is disabled by default because servers advertising "clone
1702 bundles" often do so to reduce server load. If advertised bundles
1716 bundles" often do so to reduce server load. If advertised bundles
1703 start mass failing and clients automatically fall back to a regular
1717 start mass failing and clients automatically fall back to a regular
1704 clone, this would add significant and unexpected load to the server
1718 clone, this would add significant and unexpected load to the server
1705 since the server is expecting clone operations to be offloaded to
1719 since the server is expecting clone operations to be offloaded to
1706 pre-generated bundles. Failing fast (the default behavior) ensures
1720 pre-generated bundles. Failing fast (the default behavior) ensures
1707 clients don't overwhelm the server when "clone bundle" application
1721 clients don't overwhelm the server when "clone bundle" application
1708 fails.
1722 fails.
1709
1723
1710 (default: False)
1724 (default: False)
1711
1725
1712 ``clonebundleprefers``
1726 ``clonebundleprefers``
1713 Defines preferences for which "clone bundles" to use.
1727 Defines preferences for which "clone bundles" to use.
1714
1728
1715 Servers advertising "clone bundles" may advertise multiple available
1729 Servers advertising "clone bundles" may advertise multiple available
1716 bundles. Each bundle may have different attributes, such as the bundle
1730 bundles. Each bundle may have different attributes, such as the bundle
1717 type and compression format. This option is used to prefer a particular
1731 type and compression format. This option is used to prefer a particular
1718 bundle over another.
1732 bundle over another.
1719
1733
1720 The following keys are defined by Mercurial:
1734 The following keys are defined by Mercurial:
1721
1735
1722 BUNDLESPEC
1736 BUNDLESPEC
1723 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
1737 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
1724 e.g. ``gzip-v2`` or ``bzip2-v1``.
1738 e.g. ``gzip-v2`` or ``bzip2-v1``.
1725
1739
1726 COMPRESSION
1740 COMPRESSION
1727 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
1741 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
1728
1742
1729 Server operators may define custom keys.
1743 Server operators may define custom keys.
1730
1744
1731 Example values: ``COMPRESSION=bzip2``,
1745 Example values: ``COMPRESSION=bzip2``,
1732 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
1746 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
1733
1747
1734 By default, the first bundle advertised by the server is used.
1748 By default, the first bundle advertised by the server is used.
1735
1749
1736 ``commitsubrepos``
1750 ``commitsubrepos``
1737 Whether to commit modified subrepositories when committing the
1751 Whether to commit modified subrepositories when committing the
1738 parent repository. If False and one subrepository has uncommitted
1752 parent repository. If False and one subrepository has uncommitted
1739 changes, abort the commit.
1753 changes, abort the commit.
1740 (default: False)
1754 (default: False)
1741
1755
1742 ``debug``
1756 ``debug``
1743 Print debugging information. (default: False)
1757 Print debugging information. (default: False)
1744
1758
1745 ``editor``
1759 ``editor``
1746 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
1760 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
1747
1761
1748 ``fallbackencoding``
1762 ``fallbackencoding``
1749 Encoding to try if it's not possible to decode the changelog using
1763 Encoding to try if it's not possible to decode the changelog using
1750 UTF-8. (default: ISO-8859-1)
1764 UTF-8. (default: ISO-8859-1)
1751
1765
1752 ``graphnodetemplate``
1766 ``graphnodetemplate``
1753 The template used to print changeset nodes in an ASCII revision graph.
1767 The template used to print changeset nodes in an ASCII revision graph.
1754 (default: ``{graphnode}``)
1768 (default: ``{graphnode}``)
1755
1769
1756 ``ignore``
1770 ``ignore``
1757 A file to read per-user ignore patterns from. This file should be
1771 A file to read per-user ignore patterns from. This file should be
1758 in the same format as a repository-wide .hgignore file. Filenames
1772 in the same format as a repository-wide .hgignore file. Filenames
1759 are relative to the repository root. This option supports hook syntax,
1773 are relative to the repository root. This option supports hook syntax,
1760 so if you want to specify multiple ignore files, you can do so by
1774 so if you want to specify multiple ignore files, you can do so by
1761 setting something like ``ignore.other = ~/.hgignore2``. For details
1775 setting something like ``ignore.other = ~/.hgignore2``. For details
1762 of the ignore file format, see the ``hgignore(5)`` man page.
1776 of the ignore file format, see the ``hgignore(5)`` man page.
1763
1777
1764 ``interactive``
1778 ``interactive``
1765 Allow to prompt the user. (default: True)
1779 Allow to prompt the user. (default: True)
1766
1780
1767 ``interface``
1781 ``interface``
1768 Select the default interface for interactive features (default: text).
1782 Select the default interface for interactive features (default: text).
1769 Possible values are 'text' and 'curses'.
1783 Possible values are 'text' and 'curses'.
1770
1784
1771 ``interface.chunkselector``
1785 ``interface.chunkselector``
1772 Select the interface for change recording (e.g. :hg:`commit -i`).
1786 Select the interface for change recording (e.g. :hg:`commit -i`).
1773 Possible values are 'text' and 'curses'.
1787 Possible values are 'text' and 'curses'.
1774 This config overrides the interface specified by ui.interface.
1788 This config overrides the interface specified by ui.interface.
1775
1789
1776 ``logtemplate``
1790 ``logtemplate``
1777 Template string for commands that print changesets.
1791 Template string for commands that print changesets.
1778
1792
1779 ``merge``
1793 ``merge``
1780 The conflict resolution program to use during a manual merge.
1794 The conflict resolution program to use during a manual merge.
1781 For more information on merge tools see :hg:`help merge-tools`.
1795 For more information on merge tools see :hg:`help merge-tools`.
1782 For configuring merge tools see the ``[merge-tools]`` section.
1796 For configuring merge tools see the ``[merge-tools]`` section.
1783
1797
1784 ``mergemarkers``
1798 ``mergemarkers``
1785 Sets the merge conflict marker label styling. The ``detailed``
1799 Sets the merge conflict marker label styling. The ``detailed``
1786 style uses the ``mergemarkertemplate`` setting to style the labels.
1800 style uses the ``mergemarkertemplate`` setting to style the labels.
1787 The ``basic`` style just uses 'local' and 'other' as the marker label.
1801 The ``basic`` style just uses 'local' and 'other' as the marker label.
1788 One of ``basic`` or ``detailed``.
1802 One of ``basic`` or ``detailed``.
1789 (default: ``basic``)
1803 (default: ``basic``)
1790
1804
1791 ``mergemarkertemplate``
1805 ``mergemarkertemplate``
1792 The template used to print the commit description next to each conflict
1806 The template used to print the commit description next to each conflict
1793 marker during merge conflicts. See :hg:`help templates` for the template
1807 marker during merge conflicts. See :hg:`help templates` for the template
1794 format.
1808 format.
1795
1809
1796 Defaults to showing the hash, tags, branches, bookmarks, author, and
1810 Defaults to showing the hash, tags, branches, bookmarks, author, and
1797 the first line of the commit description.
1811 the first line of the commit description.
1798
1812
1799 If you use non-ASCII characters in names for tags, branches, bookmarks,
1813 If you use non-ASCII characters in names for tags, branches, bookmarks,
1800 authors, and/or commit descriptions, you must pay attention to encodings of
1814 authors, and/or commit descriptions, you must pay attention to encodings of
1801 managed files. At template expansion, non-ASCII characters use the encoding
1815 managed files. At template expansion, non-ASCII characters use the encoding
1802 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1816 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1803 environment variables that govern your locale. If the encoding of the merge
1817 environment variables that govern your locale. If the encoding of the merge
1804 markers is different from the encoding of the merged files,
1818 markers is different from the encoding of the merged files,
1805 serious problems may occur.
1819 serious problems may occur.
1806
1820
1807 ``origbackuppath``
1821 ``origbackuppath``
1808 The path to a directory used to store generated .orig files. If the path is
1822 The path to a directory used to store generated .orig files. If the path is
1809 not a directory, one will be created.
1823 not a directory, one will be created.
1810
1824
1811 ``patch``
1825 ``patch``
1812 An optional external tool that ``hg import`` and some extensions
1826 An optional external tool that ``hg import`` and some extensions
1813 will use for applying patches. By default Mercurial uses an
1827 will use for applying patches. By default Mercurial uses an
1814 internal patch utility. The external tool must work as the common
1828 internal patch utility. The external tool must work as the common
1815 Unix ``patch`` program. In particular, it must accept a ``-p``
1829 Unix ``patch`` program. In particular, it must accept a ``-p``
1816 argument to strip patch headers, a ``-d`` argument to specify the
1830 argument to strip patch headers, a ``-d`` argument to specify the
1817 current directory, a file name to patch, and a patch file to take
1831 current directory, a file name to patch, and a patch file to take
1818 from stdin.
1832 from stdin.
1819
1833
1820 It is possible to specify a patch tool together with extra
1834 It is possible to specify a patch tool together with extra
1821 arguments. For example, setting this option to ``patch --merge``
1835 arguments. For example, setting this option to ``patch --merge``
1822 will use the ``patch`` program with its 2-way merge option.
1836 will use the ``patch`` program with its 2-way merge option.
1823
1837
1824 ``portablefilenames``
1838 ``portablefilenames``
1825 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1839 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1826 (default: ``warn``)
1840 (default: ``warn``)
1827
1841
1828 ``warn``
1842 ``warn``
1829 Print a warning message on POSIX platforms, if a file with a non-portable
1843 Print a warning message on POSIX platforms, if a file with a non-portable
1830 filename is added (e.g. a file with a name that can't be created on
1844 filename is added (e.g. a file with a name that can't be created on
1831 Windows because it contains reserved parts like ``AUX``, reserved
1845 Windows because it contains reserved parts like ``AUX``, reserved
1832 characters like ``:``, or would cause a case collision with an existing
1846 characters like ``:``, or would cause a case collision with an existing
1833 file).
1847 file).
1834
1848
1835 ``ignore``
1849 ``ignore``
1836 Don't print a warning.
1850 Don't print a warning.
1837
1851
1838 ``abort``
1852 ``abort``
1839 The command is aborted.
1853 The command is aborted.
1840
1854
1841 ``true``
1855 ``true``
1842 Alias for ``warn``.
1856 Alias for ``warn``.
1843
1857
1844 ``false``
1858 ``false``
1845 Alias for ``ignore``.
1859 Alias for ``ignore``.
1846
1860
1847 .. container:: windows
1861 .. container:: windows
1848
1862
1849 On Windows, this configuration option is ignored and the command aborted.
1863 On Windows, this configuration option is ignored and the command aborted.
1850
1864
1851 ``quiet``
1865 ``quiet``
1852 Reduce the amount of output printed.
1866 Reduce the amount of output printed.
1853 (default: False)
1867 (default: False)
1854
1868
1855 ``remotecmd``
1869 ``remotecmd``
1856 Remote command to use for clone/push/pull operations.
1870 Remote command to use for clone/push/pull operations.
1857 (default: ``hg``)
1871 (default: ``hg``)
1858
1872
1859 ``report_untrusted``
1873 ``report_untrusted``
1860 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1874 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1861 trusted user or group.
1875 trusted user or group.
1862 (default: True)
1876 (default: True)
1863
1877
1864 ``slash``
1878 ``slash``
1865 Display paths using a slash (``/``) as the path separator. This
1879 Display paths using a slash (``/``) as the path separator. This
1866 only makes a difference on systems where the default path
1880 only makes a difference on systems where the default path
1867 separator is not the slash character (e.g. Windows uses the
1881 separator is not the slash character (e.g. Windows uses the
1868 backslash character (``\``)).
1882 backslash character (``\``)).
1869 (default: False)
1883 (default: False)
1870
1884
1871 ``statuscopies``
1885 ``statuscopies``
1872 Display copies in the status command.
1886 Display copies in the status command.
1873
1887
1874 ``ssh``
1888 ``ssh``
1875 Command to use for SSH connections. (default: ``ssh``)
1889 Command to use for SSH connections. (default: ``ssh``)
1876
1890
1877 ``strict``
1891 ``strict``
1878 Require exact command names, instead of allowing unambiguous
1892 Require exact command names, instead of allowing unambiguous
1879 abbreviations. (default: False)
1893 abbreviations. (default: False)
1880
1894
1881 ``style``
1895 ``style``
1882 Name of style to use for command output.
1896 Name of style to use for command output.
1883
1897
1884 ``supportcontact``
1898 ``supportcontact``
1885 A URL where users should report a Mercurial traceback. Use this if you are a
1899 A URL where users should report a Mercurial traceback. Use this if you are a
1886 large organisation with its own Mercurial deployment process and crash
1900 large organisation with its own Mercurial deployment process and crash
1887 reports should be addressed to your internal support.
1901 reports should be addressed to your internal support.
1888
1902
1889 ``textwidth``
1903 ``textwidth``
1890 Maximum width of help text. A longer line generated by ``hg help`` or
1904 Maximum width of help text. A longer line generated by ``hg help`` or
1891 ``hg subcommand --help`` will be broken after white space to get this
1905 ``hg subcommand --help`` will be broken after white space to get this
1892 width or the terminal width, whichever comes first.
1906 width or the terminal width, whichever comes first.
1893 A non-positive value will disable this and the terminal width will be
1907 A non-positive value will disable this and the terminal width will be
1894 used. (default: 78)
1908 used. (default: 78)
1895
1909
1896 ``timeout``
1910 ``timeout``
1897 The timeout used when a lock is held (in seconds), a negative value
1911 The timeout used when a lock is held (in seconds), a negative value
1898 means no timeout. (default: 600)
1912 means no timeout. (default: 600)
1899
1913
1900 ``traceback``
1914 ``traceback``
1901 Mercurial always prints a traceback when an unknown exception
1915 Mercurial always prints a traceback when an unknown exception
1902 occurs. Setting this to True will make Mercurial print a traceback
1916 occurs. Setting this to True will make Mercurial print a traceback
1903 on all exceptions, even those recognized by Mercurial (such as
1917 on all exceptions, even those recognized by Mercurial (such as
1904 IOError or MemoryError). (default: False)
1918 IOError or MemoryError). (default: False)
1905
1919
1906 ``username``
1920 ``username``
1907 The committer of a changeset created when running "commit".
1921 The committer of a changeset created when running "commit".
1908 Typically a person's name and email address, e.g. ``Fred Widget
1922 Typically a person's name and email address, e.g. ``Fred Widget
1909 <fred@example.com>``. Environment variables in the
1923 <fred@example.com>``. Environment variables in the
1910 username are expanded.
1924 username are expanded.
1911
1925
1912 (default: ``$EMAIL`` or ``username@hostname``. If the username in
1926 (default: ``$EMAIL`` or ``username@hostname``. If the username in
1913 hgrc is empty, e.g. if the system admin set ``username =`` in the
1927 hgrc is empty, e.g. if the system admin set ``username =`` in the
1914 system hgrc, it has to be specified manually or in a different
1928 system hgrc, it has to be specified manually or in a different
1915 hgrc file)
1929 hgrc file)
1916
1930
1917 ``verbose``
1931 ``verbose``
1918 Increase the amount of output printed. (default: False)
1932 Increase the amount of output printed. (default: False)
1919
1933
1920
1934
1921 ``web``
1935 ``web``
1922 -------
1936 -------
1923
1937
1924 Web interface configuration. The settings in this section apply to
1938 Web interface configuration. The settings in this section apply to
1925 both the builtin webserver (started by :hg:`serve`) and the script you
1939 both the builtin webserver (started by :hg:`serve`) and the script you
1926 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1940 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1927 and WSGI).
1941 and WSGI).
1928
1942
1929 The Mercurial webserver does no authentication (it does not prompt for
1943 The Mercurial webserver does no authentication (it does not prompt for
1930 usernames and passwords to validate *who* users are), but it does do
1944 usernames and passwords to validate *who* users are), but it does do
1931 authorization (it grants or denies access for *authenticated users*
1945 authorization (it grants or denies access for *authenticated users*
1932 based on settings in this section). You must either configure your
1946 based on settings in this section). You must either configure your
1933 webserver to do authentication for you, or disable the authorization
1947 webserver to do authentication for you, or disable the authorization
1934 checks.
1948 checks.
1935
1949
1936 For a quick setup in a trusted environment, e.g., a private LAN, where
1950 For a quick setup in a trusted environment, e.g., a private LAN, where
1937 you want it to accept pushes from anybody, you can use the following
1951 you want it to accept pushes from anybody, you can use the following
1938 command line::
1952 command line::
1939
1953
1940 $ hg --config web.allow_push=* --config web.push_ssl=False serve
1954 $ hg --config web.allow_push=* --config web.push_ssl=False serve
1941
1955
1942 Note that this will allow anybody to push anything to the server and
1956 Note that this will allow anybody to push anything to the server and
1943 that this should not be used for public servers.
1957 that this should not be used for public servers.
1944
1958
1945 The full set of options is:
1959 The full set of options is:
1946
1960
1947 ``accesslog``
1961 ``accesslog``
1948 Where to output the access log. (default: stdout)
1962 Where to output the access log. (default: stdout)
1949
1963
1950 ``address``
1964 ``address``
1951 Interface address to bind to. (default: all)
1965 Interface address to bind to. (default: all)
1952
1966
1953 ``allow_archive``
1967 ``allow_archive``
1954 List of archive format (bz2, gz, zip) allowed for downloading.
1968 List of archive format (bz2, gz, zip) allowed for downloading.
1955 (default: empty)
1969 (default: empty)
1956
1970
1957 ``allowbz2``
1971 ``allowbz2``
1958 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
1972 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
1959 revisions.
1973 revisions.
1960 (default: False)
1974 (default: False)
1961
1975
1962 ``allowgz``
1976 ``allowgz``
1963 (DEPRECATED) Whether to allow .tar.gz downloading of repository
1977 (DEPRECATED) Whether to allow .tar.gz downloading of repository
1964 revisions.
1978 revisions.
1965 (default: False)
1979 (default: False)
1966
1980
1967 ``allowpull``
1981 ``allowpull``
1968 Whether to allow pulling from the repository. (default: True)
1982 Whether to allow pulling from the repository. (default: True)
1969
1983
1970 ``allow_push``
1984 ``allow_push``
1971 Whether to allow pushing to the repository. If empty or not set,
1985 Whether to allow pushing to the repository. If empty or not set,
1972 pushing is not allowed. If the special value ``*``, any remote
1986 pushing is not allowed. If the special value ``*``, any remote
1973 user can push, including unauthenticated users. Otherwise, the
1987 user can push, including unauthenticated users. Otherwise, the
1974 remote user must have been authenticated, and the authenticated
1988 remote user must have been authenticated, and the authenticated
1975 user name must be present in this list. The contents of the
1989 user name must be present in this list. The contents of the
1976 allow_push list are examined after the deny_push list.
1990 allow_push list are examined after the deny_push list.
1977
1991
1978 ``allow_read``
1992 ``allow_read``
1979 If the user has not already been denied repository access due to
1993 If the user has not already been denied repository access due to
1980 the contents of deny_read, this list determines whether to grant
1994 the contents of deny_read, this list determines whether to grant
1981 repository access to the user. If this list is not empty, and the
1995 repository access to the user. If this list is not empty, and the
1982 user is unauthenticated or not present in the list, then access is
1996 user is unauthenticated or not present in the list, then access is
1983 denied for the user. If the list is empty or not set, then access
1997 denied for the user. If the list is empty or not set, then access
1984 is permitted to all users by default. Setting allow_read to the
1998 is permitted to all users by default. Setting allow_read to the
1985 special value ``*`` is equivalent to it not being set (i.e. access
1999 special value ``*`` is equivalent to it not being set (i.e. access
1986 is permitted to all users). The contents of the allow_read list are
2000 is permitted to all users). The contents of the allow_read list are
1987 examined after the deny_read list.
2001 examined after the deny_read list.
1988
2002
1989 ``allowzip``
2003 ``allowzip``
1990 (DEPRECATED) Whether to allow .zip downloading of repository
2004 (DEPRECATED) Whether to allow .zip downloading of repository
1991 revisions. This feature creates temporary files.
2005 revisions. This feature creates temporary files.
1992 (default: False)
2006 (default: False)
1993
2007
1994 ``archivesubrepos``
2008 ``archivesubrepos``
1995 Whether to recurse into subrepositories when archiving.
2009 Whether to recurse into subrepositories when archiving.
1996 (default: False)
2010 (default: False)
1997
2011
1998 ``baseurl``
2012 ``baseurl``
1999 Base URL to use when publishing URLs in other locations, so
2013 Base URL to use when publishing URLs in other locations, so
2000 third-party tools like email notification hooks can construct
2014 third-party tools like email notification hooks can construct
2001 URLs. Example: ``http://hgserver/repos/``.
2015 URLs. Example: ``http://hgserver/repos/``.
2002
2016
2003 ``cacerts``
2017 ``cacerts``
2004 Path to file containing a list of PEM encoded certificate
2018 Path to file containing a list of PEM encoded certificate
2005 authority certificates. Environment variables and ``~user``
2019 authority certificates. Environment variables and ``~user``
2006 constructs are expanded in the filename. If specified on the
2020 constructs are expanded in the filename. If specified on the
2007 client, then it will verify the identity of remote HTTPS servers
2021 client, then it will verify the identity of remote HTTPS servers
2008 with these certificates.
2022 with these certificates.
2009
2023
2010 To disable SSL verification temporarily, specify ``--insecure`` from
2024 To disable SSL verification temporarily, specify ``--insecure`` from
2011 command line.
2025 command line.
2012
2026
2013 You can use OpenSSL's CA certificate file if your platform has
2027 You can use OpenSSL's CA certificate file if your platform has
2014 one. On most Linux systems this will be
2028 one. On most Linux systems this will be
2015 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2029 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2016 generate this file manually. The form must be as follows::
2030 generate this file manually. The form must be as follows::
2017
2031
2018 -----BEGIN CERTIFICATE-----
2032 -----BEGIN CERTIFICATE-----
2019 ... (certificate in base64 PEM encoding) ...
2033 ... (certificate in base64 PEM encoding) ...
2020 -----END CERTIFICATE-----
2034 -----END CERTIFICATE-----
2021 -----BEGIN CERTIFICATE-----
2035 -----BEGIN CERTIFICATE-----
2022 ... (certificate in base64 PEM encoding) ...
2036 ... (certificate in base64 PEM encoding) ...
2023 -----END CERTIFICATE-----
2037 -----END CERTIFICATE-----
2024
2038
2025 ``cache``
2039 ``cache``
2026 Whether to support caching in hgweb. (default: True)
2040 Whether to support caching in hgweb. (default: True)
2027
2041
2028 ``certificate``
2042 ``certificate``
2029 Certificate to use when running :hg:`serve`.
2043 Certificate to use when running :hg:`serve`.
2030
2044
2031 ``collapse``
2045 ``collapse``
2032 With ``descend`` enabled, repositories in subdirectories are shown at
2046 With ``descend`` enabled, repositories in subdirectories are shown at
2033 a single level alongside repositories in the current path. With
2047 a single level alongside repositories in the current path. With
2034 ``collapse`` also enabled, repositories residing at a deeper level than
2048 ``collapse`` also enabled, repositories residing at a deeper level than
2035 the current path are grouped behind navigable directory entries that
2049 the current path are grouped behind navigable directory entries that
2036 lead to the locations of these repositories. In effect, this setting
2050 lead to the locations of these repositories. In effect, this setting
2037 collapses each collection of repositories found within a subdirectory
2051 collapses each collection of repositories found within a subdirectory
2038 into a single entry for that subdirectory. (default: False)
2052 into a single entry for that subdirectory. (default: False)
2039
2053
2040 ``comparisoncontext``
2054 ``comparisoncontext``
2041 Number of lines of context to show in side-by-side file comparison. If
2055 Number of lines of context to show in side-by-side file comparison. If
2042 negative or the value ``full``, whole files are shown. (default: 5)
2056 negative or the value ``full``, whole files are shown. (default: 5)
2043
2057
2044 This setting can be overridden by a ``context`` request parameter to the
2058 This setting can be overridden by a ``context`` request parameter to the
2045 ``comparison`` command, taking the same values.
2059 ``comparison`` command, taking the same values.
2046
2060
2047 ``contact``
2061 ``contact``
2048 Name or email address of the person in charge of the repository.
2062 Name or email address of the person in charge of the repository.
2049 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2063 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2050
2064
2051 ``deny_push``
2065 ``deny_push``
2052 Whether to deny pushing to the repository. If empty or not set,
2066 Whether to deny pushing to the repository. If empty or not set,
2053 push is not denied. If the special value ``*``, all remote users are
2067 push is not denied. If the special value ``*``, all remote users are
2054 denied push. Otherwise, unauthenticated users are all denied, and
2068 denied push. Otherwise, unauthenticated users are all denied, and
2055 any authenticated user name present in this list is also denied. The
2069 any authenticated user name present in this list is also denied. The
2056 contents of the deny_push list are examined before the allow_push list.
2070 contents of the deny_push list are examined before the allow_push list.
2057
2071
2058 ``deny_read``
2072 ``deny_read``
2059 Whether to deny reading/viewing of the repository. If this list is
2073 Whether to deny reading/viewing of the repository. If this list is
2060 not empty, unauthenticated users are all denied, and any
2074 not empty, unauthenticated users are all denied, and any
2061 authenticated user name present in this list is also denied access to
2075 authenticated user name present in this list is also denied access to
2062 the repository. If set to the special value ``*``, all remote users
2076 the repository. If set to the special value ``*``, all remote users
2063 are denied access (rarely needed ;). If deny_read is empty or not set,
2077 are denied access (rarely needed ;). If deny_read is empty or not set,
2064 the determination of repository access depends on the presence and
2078 the determination of repository access depends on the presence and
2065 content of the allow_read list (see description). If both
2079 content of the allow_read list (see description). If both
2066 deny_read and allow_read are empty or not set, then access is
2080 deny_read and allow_read are empty or not set, then access is
2067 permitted to all users by default. If the repository is being
2081 permitted to all users by default. If the repository is being
2068 served via hgwebdir, denied users will not be able to see it in
2082 served via hgwebdir, denied users will not be able to see it in
2069 the list of repositories. The contents of the deny_read list have
2083 the list of repositories. The contents of the deny_read list have
2070 priority over (are examined before) the contents of the allow_read
2084 priority over (are examined before) the contents of the allow_read
2071 list.
2085 list.
2072
2086
2073 ``descend``
2087 ``descend``
2074 hgwebdir indexes will not descend into subdirectories. Only repositories
2088 hgwebdir indexes will not descend into subdirectories. Only repositories
2075 directly in the current path will be shown (other repositories are still
2089 directly in the current path will be shown (other repositories are still
2076 available from the index corresponding to their containing path).
2090 available from the index corresponding to their containing path).
2077
2091
2078 ``description``
2092 ``description``
2079 Textual description of the repository's purpose or contents.
2093 Textual description of the repository's purpose or contents.
2080 (default: "unknown")
2094 (default: "unknown")
2081
2095
2082 ``encoding``
2096 ``encoding``
2083 Character encoding name. (default: the current locale charset)
2097 Character encoding name. (default: the current locale charset)
2084 Example: "UTF-8".
2098 Example: "UTF-8".
2085
2099
2086 ``errorlog``
2100 ``errorlog``
2087 Where to output the error log. (default: stderr)
2101 Where to output the error log. (default: stderr)
2088
2102
2089 ``guessmime``
2103 ``guessmime``
2090 Control MIME types for raw download of file content.
2104 Control MIME types for raw download of file content.
2091 Set to True to let hgweb guess the content type from the file
2105 Set to True to let hgweb guess the content type from the file
2092 extension. This will serve HTML files as ``text/html`` and might
2106 extension. This will serve HTML files as ``text/html`` and might
2093 allow cross-site scripting attacks when serving untrusted
2107 allow cross-site scripting attacks when serving untrusted
2094 repositories. (default: False)
2108 repositories. (default: False)
2095
2109
2096 ``hidden``
2110 ``hidden``
2097 Whether to hide the repository in the hgwebdir index.
2111 Whether to hide the repository in the hgwebdir index.
2098 (default: False)
2112 (default: False)
2099
2113
2100 ``ipv6``
2114 ``ipv6``
2101 Whether to use IPv6. (default: False)
2115 Whether to use IPv6. (default: False)
2102
2116
2103 ``labels``
2117 ``labels``
2104 List of string *labels* associated with the repository.
2118 List of string *labels* associated with the repository.
2105
2119
2106 Labels are exposed as a template keyword and can be used to customize
2120 Labels are exposed as a template keyword and can be used to customize
2107 output. e.g. the ``index`` template can group or filter repositories
2121 output. e.g. the ``index`` template can group or filter repositories
2108 by labels and the ``summary`` template can display additional content
2122 by labels and the ``summary`` template can display additional content
2109 if a specific label is present.
2123 if a specific label is present.
2110
2124
2111 ``logoimg``
2125 ``logoimg``
2112 File name of the logo image that some templates display on each page.
2126 File name of the logo image that some templates display on each page.
2113 The file name is relative to ``staticurl``. That is, the full path to
2127 The file name is relative to ``staticurl``. That is, the full path to
2114 the logo image is "staticurl/logoimg".
2128 the logo image is "staticurl/logoimg".
2115 If unset, ``hglogo.png`` will be used.
2129 If unset, ``hglogo.png`` will be used.
2116
2130
2117 ``logourl``
2131 ``logourl``
2118 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2132 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2119 will be used.
2133 will be used.
2120
2134
2121 ``maxchanges``
2135 ``maxchanges``
2122 Maximum number of changes to list on the changelog. (default: 10)
2136 Maximum number of changes to list on the changelog. (default: 10)
2123
2137
2124 ``maxfiles``
2138 ``maxfiles``
2125 Maximum number of files to list per changeset. (default: 10)
2139 Maximum number of files to list per changeset. (default: 10)
2126
2140
2127 ``maxshortchanges``
2141 ``maxshortchanges``
2128 Maximum number of changes to list on the shortlog, graph or filelog
2142 Maximum number of changes to list on the shortlog, graph or filelog
2129 pages. (default: 60)
2143 pages. (default: 60)
2130
2144
2131 ``name``
2145 ``name``
2132 Repository name to use in the web interface.
2146 Repository name to use in the web interface.
2133 (default: current working directory)
2147 (default: current working directory)
2134
2148
2135 ``port``
2149 ``port``
2136 Port to listen on. (default: 8000)
2150 Port to listen on. (default: 8000)
2137
2151
2138 ``prefix``
2152 ``prefix``
2139 Prefix path to serve from. (default: '' (server root))
2153 Prefix path to serve from. (default: '' (server root))
2140
2154
2141 ``push_ssl``
2155 ``push_ssl``
2142 Whether to require that inbound pushes be transported over SSL to
2156 Whether to require that inbound pushes be transported over SSL to
2143 prevent password sniffing. (default: True)
2157 prevent password sniffing. (default: True)
2144
2158
2145 ``refreshinterval``
2159 ``refreshinterval``
2146 How frequently directory listings re-scan the filesystem for new
2160 How frequently directory listings re-scan the filesystem for new
2147 repositories, in seconds. This is relevant when wildcards are used
2161 repositories, in seconds. This is relevant when wildcards are used
2148 to define paths. Depending on how much filesystem traversal is
2162 to define paths. Depending on how much filesystem traversal is
2149 required, refreshing may negatively impact performance.
2163 required, refreshing may negatively impact performance.
2150
2164
2151 Values less than or equal to 0 always refresh.
2165 Values less than or equal to 0 always refresh.
2152 (default: 20)
2166 (default: 20)
2153
2167
2154 ``staticurl``
2168 ``staticurl``
2155 Base URL to use for static files. If unset, static files (e.g. the
2169 Base URL to use for static files. If unset, static files (e.g. the
2156 hgicon.png favicon) will be served by the CGI script itself. Use
2170 hgicon.png favicon) will be served by the CGI script itself. Use
2157 this setting to serve them directly with the HTTP server.
2171 this setting to serve them directly with the HTTP server.
2158 Example: ``http://hgserver/static/``.
2172 Example: ``http://hgserver/static/``.
2159
2173
2160 ``stripes``
2174 ``stripes``
2161 How many lines a "zebra stripe" should span in multi-line output.
2175 How many lines a "zebra stripe" should span in multi-line output.
2162 Set to 0 to disable. (default: 1)
2176 Set to 0 to disable. (default: 1)
2163
2177
2164 ``style``
2178 ``style``
2165 Which template map style to use. The available options are the names of
2179 Which template map style to use. The available options are the names of
2166 subdirectories in the HTML templates path. (default: ``paper``)
2180 subdirectories in the HTML templates path. (default: ``paper``)
2167 Example: ``monoblue``.
2181 Example: ``monoblue``.
2168
2182
2169 ``templates``
2183 ``templates``
2170 Where to find the HTML templates. The default path to the HTML templates
2184 Where to find the HTML templates. The default path to the HTML templates
2171 can be obtained from ``hg debuginstall``.
2185 can be obtained from ``hg debuginstall``.
2172
2186
2173 ``websub``
2187 ``websub``
2174 ----------
2188 ----------
2175
2189
2176 Web substitution filter definition. You can use this section to
2190 Web substitution filter definition. You can use this section to
2177 define a set of regular expression substitution patterns which
2191 define a set of regular expression substitution patterns which
2178 let you automatically modify the hgweb server output.
2192 let you automatically modify the hgweb server output.
2179
2193
2180 The default hgweb templates only apply these substitution patterns
2194 The default hgweb templates only apply these substitution patterns
2181 on the revision description fields. You can apply them anywhere
2195 on the revision description fields. You can apply them anywhere
2182 you want when you create your own templates by adding calls to the
2196 you want when you create your own templates by adding calls to the
2183 "websub" filter (usually after calling the "escape" filter).
2197 "websub" filter (usually after calling the "escape" filter).
2184
2198
2185 This can be used, for example, to convert issue references to links
2199 This can be used, for example, to convert issue references to links
2186 to your issue tracker, or to convert "markdown-like" syntax into
2200 to your issue tracker, or to convert "markdown-like" syntax into
2187 HTML (see the examples below).
2201 HTML (see the examples below).
2188
2202
2189 Each entry in this section names a substitution filter.
2203 Each entry in this section names a substitution filter.
2190 The value of each entry defines the substitution expression itself.
2204 The value of each entry defines the substitution expression itself.
2191 The websub expressions follow the old interhg extension syntax,
2205 The websub expressions follow the old interhg extension syntax,
2192 which in turn imitates the Unix sed replacement syntax::
2206 which in turn imitates the Unix sed replacement syntax::
2193
2207
2194 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2208 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
2195
2209
2196 You can use any separator other than "/". The final "i" is optional
2210 You can use any separator other than "/". The final "i" is optional
2197 and indicates that the search must be case insensitive.
2211 and indicates that the search must be case insensitive.
2198
2212
2199 Examples::
2213 Examples::
2200
2214
2201 [websub]
2215 [websub]
2202 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2216 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
2203 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2217 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
2204 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2218 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
2205
2219
2206 ``worker``
2220 ``worker``
2207 ----------
2221 ----------
2208
2222
2209 Parallel master/worker configuration. We currently perform working
2223 Parallel master/worker configuration. We currently perform working
2210 directory updates in parallel on Unix-like systems, which greatly
2224 directory updates in parallel on Unix-like systems, which greatly
2211 helps performance.
2225 helps performance.
2212
2226
2213 ``numcpus``
2227 ``numcpus``
2214 Number of CPUs to use for parallel operations. A zero or
2228 Number of CPUs to use for parallel operations. A zero or
2215 negative value is treated as ``use the default``.
2229 negative value is treated as ``use the default``.
2216 (default: 4 or the number of CPUs on the system, whichever is larger)
2230 (default: 4 or the number of CPUs on the system, whichever is larger)
2217
2231
2218 ``backgroundclose``
2232 ``backgroundclose``
2219 Whether to enable closing file handles on background threads during certain
2233 Whether to enable closing file handles on background threads during certain
2220 operations. Some platforms aren't very efficient at closing file
2234 operations. Some platforms aren't very efficient at closing file
2221 handles that have been written or appended to. By performing file closing
2235 handles that have been written or appended to. By performing file closing
2222 on background threads, file write rate can increase substantially.
2236 on background threads, file write rate can increase substantially.
2223 (default: true on Windows, false elsewhere)
2237 (default: true on Windows, false elsewhere)
2224
2238
2225 ``backgroundcloseminfilecount``
2239 ``backgroundcloseminfilecount``
2226 Minimum number of files required to trigger background file closing.
2240 Minimum number of files required to trigger background file closing.
2227 Operations not writing this many files won't start background close
2241 Operations not writing this many files won't start background close
2228 threads.
2242 threads.
2229 (default: 2048)
2243 (default: 2048)
2230
2244
2231 ``backgroundclosemaxqueue``
2245 ``backgroundclosemaxqueue``
2232 The maximum number of opened file handles waiting to be closed in the
2246 The maximum number of opened file handles waiting to be closed in the
2233 background. This option only has an effect if ``backgroundclose`` is
2247 background. This option only has an effect if ``backgroundclose`` is
2234 enabled.
2248 enabled.
2235 (default: 384)
2249 (default: 384)
2236
2250
2237 ``backgroundclosethreadcount``
2251 ``backgroundclosethreadcount``
2238 Number of threads to process background file closes. Only relevant if
2252 Number of threads to process background file closes. Only relevant if
2239 ``backgroundclose`` is enabled.
2253 ``backgroundclose`` is enabled.
2240 (default: 4)
2254 (default: 4)
@@ -1,164 +1,177 b''
1 # profiling.py - profiling functions
1 # profiling.py - profiling functions
2 #
2 #
3 # Copyright 2016 Gregory Szorc <gregory.szorc@gmail.com>
3 # Copyright 2016 Gregory Szorc <gregory.szorc@gmail.com>
4 #
4 #
5 # This software may be used and distributed according to the terms of the
5 # This software may be used and distributed according to the terms of the
6 # GNU General Public License version 2 or any later version.
6 # GNU General Public License version 2 or any later version.
7
7
8 from __future__ import absolute_import, print_function
8 from __future__ import absolute_import, print_function
9
9
10 import contextlib
10 import contextlib
11 import os
11 import os
12 import sys
12 import sys
13 import time
13 import time
14
14
15 from .i18n import _
15 from .i18n import _
16 from . import (
16 from . import (
17 error,
17 error,
18 util,
18 util,
19 )
19 )
20
20
21 @contextlib.contextmanager
21 @contextlib.contextmanager
22 def lsprofile(ui, fp):
22 def lsprofile(ui, fp):
23 format = ui.config('profiling', 'format', default='text')
23 format = ui.config('profiling', 'format', default='text')
24 field = ui.config('profiling', 'sort', default='inlinetime')
24 field = ui.config('profiling', 'sort', default='inlinetime')
25 limit = ui.configint('profiling', 'limit', default=30)
25 limit = ui.configint('profiling', 'limit', default=30)
26 climit = ui.configint('profiling', 'nested', default=0)
26 climit = ui.configint('profiling', 'nested', default=0)
27
27
28 if format not in ['text', 'kcachegrind']:
28 if format not in ['text', 'kcachegrind']:
29 ui.warn(_("unrecognized profiling format '%s'"
29 ui.warn(_("unrecognized profiling format '%s'"
30 " - Ignored\n") % format)
30 " - Ignored\n") % format)
31 format = 'text'
31 format = 'text'
32
32
33 try:
33 try:
34 from . import lsprof
34 from . import lsprof
35 except ImportError:
35 except ImportError:
36 raise error.Abort(_(
36 raise error.Abort(_(
37 'lsprof not available - install from '
37 'lsprof not available - install from '
38 'http://codespeak.net/svn/user/arigo/hack/misc/lsprof/'))
38 'http://codespeak.net/svn/user/arigo/hack/misc/lsprof/'))
39 p = lsprof.Profiler()
39 p = lsprof.Profiler()
40 p.enable(subcalls=True)
40 p.enable(subcalls=True)
41 try:
41 try:
42 yield
42 yield
43 finally:
43 finally:
44 p.disable()
44 p.disable()
45
45
46 if format == 'kcachegrind':
46 if format == 'kcachegrind':
47 from . import lsprofcalltree
47 from . import lsprofcalltree
48 calltree = lsprofcalltree.KCacheGrind(p)
48 calltree = lsprofcalltree.KCacheGrind(p)
49 calltree.output(fp)
49 calltree.output(fp)
50 else:
50 else:
51 # format == 'text'
51 # format == 'text'
52 stats = lsprof.Stats(p.getstats())
52 stats = lsprof.Stats(p.getstats())
53 stats.sort(field)
53 stats.sort(field)
54 stats.pprint(limit=limit, file=fp, climit=climit)
54 stats.pprint(limit=limit, file=fp, climit=climit)
55
55
56 @contextlib.contextmanager
56 @contextlib.contextmanager
57 def flameprofile(ui, fp):
57 def flameprofile(ui, fp):
58 try:
58 try:
59 from flamegraph import flamegraph
59 from flamegraph import flamegraph
60 except ImportError:
60 except ImportError:
61 raise error.Abort(_(
61 raise error.Abort(_(
62 'flamegraph not available - install from '
62 'flamegraph not available - install from '
63 'https://github.com/evanhempel/python-flamegraph'))
63 'https://github.com/evanhempel/python-flamegraph'))
64 # developer config: profiling.freq
64 # developer config: profiling.freq
65 freq = ui.configint('profiling', 'freq', default=1000)
65 freq = ui.configint('profiling', 'freq', default=1000)
66 filter_ = None
66 filter_ = None
67 collapse_recursion = True
67 collapse_recursion = True
68 thread = flamegraph.ProfileThread(fp, 1.0 / freq,
68 thread = flamegraph.ProfileThread(fp, 1.0 / freq,
69 filter_, collapse_recursion)
69 filter_, collapse_recursion)
70 start_time = time.clock()
70 start_time = time.clock()
71 try:
71 try:
72 thread.start()
72 thread.start()
73 yield
73 yield
74 finally:
74 finally:
75 thread.stop()
75 thread.stop()
76 thread.join()
76 thread.join()
77 print('Collected %d stack frames (%d unique) in %2.2f seconds.' % (
77 print('Collected %d stack frames (%d unique) in %2.2f seconds.' % (
78 time.clock() - start_time, thread.num_frames(),
78 time.clock() - start_time, thread.num_frames(),
79 thread.num_frames(unique=True)))
79 thread.num_frames(unique=True)))
80
80
81 @contextlib.contextmanager
81 @contextlib.contextmanager
82 def statprofile(ui, fp):
82 def statprofile(ui, fp):
83 try:
83 from . import statprof
84 import statprof
85 except ImportError:
86 raise error.Abort(_(
87 'statprof not available - install using "easy_install statprof"'))
88
84
89 freq = ui.configint('profiling', 'freq', default=1000)
85 freq = ui.configint('profiling', 'freq', default=1000)
90 if freq > 0:
86 if freq > 0:
91 # Cannot reset when profiler is already active. So silently no-op.
87 # Cannot reset when profiler is already active. So silently no-op.
92 if statprof.state.profile_level == 0:
88 if statprof.state.profile_level == 0:
93 statprof.reset(freq)
89 statprof.reset(freq)
94 else:
90 else:
95 ui.warn(_("invalid sampling frequency '%s' - ignoring\n") % freq)
91 ui.warn(_("invalid sampling frequency '%s' - ignoring\n") % freq)
96
92
97 statprof.start()
93 statprof.start(mechanism='thread')
94
98 try:
95 try:
99 yield
96 yield
100 finally:
97 finally:
101 statprof.stop()
98 data = statprof.stop()
102 statprof.display(fp)
99
100 profformat = ui.config('profiling', 'statformat', 'hotpath')
101
102 formats = {
103 'byline': statprof.DisplayFormats.ByLine,
104 'bymethod': statprof.DisplayFormats.ByMethod,
105 'hotpath': statprof.DisplayFormats.Hotpath,
106 'json': statprof.DisplayFormats.Json,
107 }
108
109 if profformat in formats:
110 displayformat = formats[profformat]
111 else:
112 ui.warn(_('unknown profiler output format: %s\n') % profformat)
113 displayformat = statprof.DisplayFormats.Hotpath
114
115 statprof.display(fp, data=data, format=displayformat)
103
116
104 @contextlib.contextmanager
117 @contextlib.contextmanager
105 def profile(ui):
118 def profile(ui):
106 """Start profiling.
119 """Start profiling.
107
120
108 Profiling is active when the context manager is active. When the context
121 Profiling is active when the context manager is active. When the context
109 manager exits, profiling results will be written to the configured output.
122 manager exits, profiling results will be written to the configured output.
110 """
123 """
111 profiler = os.getenv('HGPROF')
124 profiler = os.getenv('HGPROF')
112 if profiler is None:
125 if profiler is None:
113 profiler = ui.config('profiling', 'type', default='ls')
126 profiler = ui.config('profiling', 'type', default='ls')
114 if profiler not in ('ls', 'stat', 'flame'):
127 if profiler not in ('ls', 'stat', 'flame'):
115 ui.warn(_("unrecognized profiler '%s' - ignored\n") % profiler)
128 ui.warn(_("unrecognized profiler '%s' - ignored\n") % profiler)
116 profiler = 'ls'
129 profiler = 'ls'
117
130
118 output = ui.config('profiling', 'output')
131 output = ui.config('profiling', 'output')
119
132
120 if output == 'blackbox':
133 if output == 'blackbox':
121 fp = util.stringio()
134 fp = util.stringio()
122 elif output:
135 elif output:
123 path = ui.expandpath(output)
136 path = ui.expandpath(output)
124 fp = open(path, 'wb')
137 fp = open(path, 'wb')
125 else:
138 else:
126 fp = sys.stderr
139 fp = sys.stderr
127
140
128 try:
141 try:
129 if profiler == 'ls':
142 if profiler == 'ls':
130 proffn = lsprofile
143 proffn = lsprofile
131 elif profiler == 'flame':
144 elif profiler == 'flame':
132 proffn = flameprofile
145 proffn = flameprofile
133 else:
146 else:
134 proffn = statprofile
147 proffn = statprofile
135
148
136 with proffn(ui, fp):
149 with proffn(ui, fp):
137 yield
150 yield
138
151
139 finally:
152 finally:
140 if output:
153 if output:
141 if output == 'blackbox':
154 if output == 'blackbox':
142 val = 'Profile:\n%s' % fp.getvalue()
155 val = 'Profile:\n%s' % fp.getvalue()
143 # ui.log treats the input as a format string,
156 # ui.log treats the input as a format string,
144 # so we need to escape any % signs.
157 # so we need to escape any % signs.
145 val = val.replace('%', '%%')
158 val = val.replace('%', '%%')
146 ui.log('profile', val)
159 ui.log('profile', val)
147 fp.close()
160 fp.close()
148
161
149 @contextlib.contextmanager
162 @contextlib.contextmanager
150 def maybeprofile(ui):
163 def maybeprofile(ui):
151 """Profile if enabled, else do nothing.
164 """Profile if enabled, else do nothing.
152
165
153 This context manager can be used to optionally profile if profiling
166 This context manager can be used to optionally profile if profiling
154 is enabled. Otherwise, it does nothing.
167 is enabled. Otherwise, it does nothing.
155
168
156 The purpose of this context manager is to make calling code simpler:
169 The purpose of this context manager is to make calling code simpler:
157 just use a single code path for calling into code you may want to profile
170 just use a single code path for calling into code you may want to profile
158 and this function determines whether to start profiling.
171 and this function determines whether to start profiling.
159 """
172 """
160 if ui.configbool('profiling', 'enabled'):
173 if ui.configbool('profiling', 'enabled'):
161 with profile(ui):
174 with profile(ui):
162 yield
175 yield
163 else:
176 else:
164 yield
177 yield
@@ -1,50 +1,95 b''
1 test --time
1 test --time
2
2
3 $ hg --time help -q help 2>&1 | grep time > /dev/null
3 $ hg --time help -q help 2>&1 | grep time > /dev/null
4 $ hg init a
4 $ hg init a
5 $ cd a
5 $ cd a
6
6
7 #if lsprof
7 #if lsprof
8
8
9 test --profile
9 test --profile
10
10
11 $ prof='hg --config profiling.type=ls --profile'
11 $ prof='hg --config profiling.type=ls --profile'
12
12
13 $ $prof st 2>../out
13 $ $prof st 2>../out
14 $ grep CallCount ../out > /dev/null || cat ../out
14 $ grep CallCount ../out > /dev/null || cat ../out
15
15
16 $ $prof --config profiling.output=../out st
16 $ $prof --config profiling.output=../out st
17 $ grep CallCount ../out > /dev/null || cat ../out
17 $ grep CallCount ../out > /dev/null || cat ../out
18
18
19 $ $prof --config profiling.output=blackbox --config extensions.blackbox= st
19 $ $prof --config profiling.output=blackbox --config extensions.blackbox= st
20 $ grep CallCount .hg/blackbox.log > /dev/null || cat .hg/blackbox.log
20 $ grep CallCount .hg/blackbox.log > /dev/null || cat .hg/blackbox.log
21
21
22 $ $prof --config profiling.format=text st 2>../out
22 $ $prof --config profiling.format=text st 2>../out
23 $ grep CallCount ../out > /dev/null || cat ../out
23 $ grep CallCount ../out > /dev/null || cat ../out
24
24
25 $ echo "[profiling]" >> $HGRCPATH
25 $ echo "[profiling]" >> $HGRCPATH
26 $ echo "format=kcachegrind" >> $HGRCPATH
26 $ echo "format=kcachegrind" >> $HGRCPATH
27
27
28 $ $prof st 2>../out
28 $ $prof st 2>../out
29 $ grep 'events: Ticks' ../out > /dev/null || cat ../out
29 $ grep 'events: Ticks' ../out > /dev/null || cat ../out
30
30
31 $ $prof --config profiling.output=../out st
31 $ $prof --config profiling.output=../out st
32 $ grep 'events: Ticks' ../out > /dev/null || cat ../out
32 $ grep 'events: Ticks' ../out > /dev/null || cat ../out
33
33
34 #endif
34 #endif
35
35
36 #if lsprof serve
36 #if lsprof serve
37
37
38 Profiling of HTTP requests works
38 Profiling of HTTP requests works
39
39
40 $ $prof --config profiling.format=text --config profiling.output=../profile.log serve -d -p $HGPORT --pid-file ../hg.pid -A ../access.log
40 $ $prof --config profiling.format=text --config profiling.output=../profile.log serve -d -p $HGPORT --pid-file ../hg.pid -A ../access.log
41 $ cat ../hg.pid >> $DAEMON_PIDS
41 $ cat ../hg.pid >> $DAEMON_PIDS
42 $ hg -q clone -U http://localhost:$HGPORT ../clone
42 $ hg -q clone -U http://localhost:$HGPORT ../clone
43
43
44 A single profile is logged because file logging doesn't append
44 A single profile is logged because file logging doesn't append
45 $ grep CallCount ../profile.log | wc -l
45 $ grep CallCount ../profile.log | wc -l
46 \s*1 (re)
46 \s*1 (re)
47
47
48 #endif
48 #endif
49
49
50 Install an extension that can sleep and guarantee a profiler has time to run
51
52 $ cat >> sleepext.py << EOF
53 > import time
54 > from mercurial import cmdutil, commands
55 > cmdtable = {}
56 > command = cmdutil.command(cmdtable)
57 > @command('sleep', [], 'hg sleep')
58 > def sleep(ui, *args, **kwargs):
59 > time.sleep(0.1)
60 > EOF
61
62 $ cat >> $HGRCPATH << EOF
63 > [extensions]
64 > sleep = `pwd`/sleepext.py
65 > EOF
66
67 statistical profiler works
68
69 $ HGPROF=stat hg --profile sleep 2>../out
70 $ grep Sample ../out
71 Sample count: \d+ (re)
72
73 Various statprof formatters work
74
75 $ HGPROF=stat hg --profile --config profiling.statformat=byline sleep 2>../out
76 $ head -n 1 ../out
77 % cumulative self
78 $ grep Sample ../out
79 Sample count: \d+ (re)
80
81 $ HGPROF=stat hg --profile --config profiling.statformat=bymethod sleep 2>../out
82 $ head -n 1 ../out
83 % cumulative self
84 $ grep Sample ../out
85 Sample count: \d+ (re)
86
87 $ HGPROF=stat hg --profile --config profiling.statformat=hotpath sleep 2>../out
88 $ grep Sample ../out
89 Sample count: \d+ (re)
90
91 $ HGPROF=stat hg --profile --config profiling.statformat=json sleep 2>../out
92 $ cat ../out
93 \[\[\d+.* (re)
94
50 $ cd ..
95 $ cd ..
General Comments 0
You need to be logged in to leave comments. Login now