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