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