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