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