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