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