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