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