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