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