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