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