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