##// END OF EJS Templates
help: document the `path://` url scheme...
marmoute -
r47667:95a5ed7d default
parent child Browse files
Show More
@@ -1,3075 +1,3078 b''
1 1 The Mercurial system uses a set of configuration files to control
2 2 aspects of its behavior.
3 3
4 4 Troubleshooting
5 5 ===============
6 6
7 7 If you're having problems with your configuration,
8 8 :hg:`config --debug` can help you understand what is introducing
9 9 a setting into your environment.
10 10
11 11 See :hg:`help config.syntax` and :hg:`help config.files`
12 12 for information about how and where to override things.
13 13
14 14 Structure
15 15 =========
16 16
17 17 The configuration files use a simple ini-file format. A configuration
18 18 file consists of sections, led by a ``[section]`` header and followed
19 19 by ``name = value`` entries::
20 20
21 21 [ui]
22 22 username = Firstname Lastname <firstname.lastname@example.net>
23 23 verbose = True
24 24
25 25 The above entries will be referred to as ``ui.username`` and
26 26 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
27 27
28 28 Files
29 29 =====
30 30
31 31 Mercurial reads configuration data from several files, if they exist.
32 32 These files do not exist by default and you will have to create the
33 33 appropriate configuration files yourself:
34 34
35 35 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
36 36
37 37 Global configuration like the username setting is typically put into:
38 38
39 39 .. container:: windows
40 40
41 41 - ``%USERPROFILE%\mercurial.ini`` (on Windows)
42 42
43 43 .. container:: unix.plan9
44 44
45 45 - ``$HOME/.hgrc`` (on Unix, Plan9)
46 46
47 47 The names of these files depend on the system on which Mercurial is
48 48 installed. ``*.rc`` files from a single directory are read in
49 49 alphabetical order, later ones overriding earlier ones. Where multiple
50 50 paths are given below, settings from earlier paths override later
51 51 ones.
52 52
53 53 .. container:: verbose.unix
54 54
55 55 On Unix, the following files are consulted:
56 56
57 57 - ``<repo>/.hg/hgrc-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``. ``abort`` always fails if the working
517 517 directory has uncommitted changes. ``none`` performs no checking, and may
518 518 result in a merge with uncommitted changes. ``linear`` allows any update
519 519 as long as it follows a straight line in the revision history, and may
520 520 trigger a merge with uncommitted changes. ``noconflict`` will allow any
521 521 update which would not trigger a merge with uncommitted changes, if any
522 522 are present.
523 523 (default: ``linear``)
524 524
525 525 ``update.requiredest``
526 526 Require that the user pass a destination when running :hg:`update`.
527 527 For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
528 528 will be disallowed.
529 529 (default: False)
530 530
531 531 ``committemplate``
532 532 ------------------
533 533
534 534 ``changeset``
535 535 String: configuration in this section is used as the template to
536 536 customize the text shown in the editor when committing.
537 537
538 538 In addition to pre-defined template keywords, commit log specific one
539 539 below can be used for customization:
540 540
541 541 ``extramsg``
542 542 String: Extra message (typically 'Leave message empty to abort
543 543 commit.'). This may be changed by some commands or extensions.
544 544
545 545 For example, the template configuration below shows as same text as
546 546 one shown by default::
547 547
548 548 [committemplate]
549 549 changeset = {desc}\n\n
550 550 HG: Enter commit message. Lines beginning with 'HG:' are removed.
551 551 HG: {extramsg}
552 552 HG: --
553 553 HG: user: {author}\n{ifeq(p2rev, "-1", "",
554 554 "HG: branch merge\n")
555 555 }HG: branch '{branch}'\n{if(activebookmark,
556 556 "HG: bookmark '{activebookmark}'\n") }{subrepos %
557 557 "HG: subrepo {subrepo}\n" }{file_adds %
558 558 "HG: added {file}\n" }{file_mods %
559 559 "HG: changed {file}\n" }{file_dels %
560 560 "HG: removed {file}\n" }{if(files, "",
561 561 "HG: no files changed\n")}
562 562
563 563 ``diff()``
564 564 String: show the diff (see :hg:`help templates` for detail)
565 565
566 566 Sometimes it is helpful to show the diff of the changeset in the editor without
567 567 having to prefix 'HG: ' to each line so that highlighting works correctly. For
568 568 this, Mercurial provides a special string which will ignore everything below
569 569 it::
570 570
571 571 HG: ------------------------ >8 ------------------------
572 572
573 573 For example, the template configuration below will show the diff below the
574 574 extra message::
575 575
576 576 [committemplate]
577 577 changeset = {desc}\n\n
578 578 HG: Enter commit message. Lines beginning with 'HG:' are removed.
579 579 HG: {extramsg}
580 580 HG: ------------------------ >8 ------------------------
581 581 HG: Do not touch the line above.
582 582 HG: Everything below will be removed.
583 583 {diff()}
584 584
585 585 .. note::
586 586
587 587 For some problematic encodings (see :hg:`help win32mbcs` for
588 588 detail), this customization should be configured carefully, to
589 589 avoid showing broken characters.
590 590
591 591 For example, if a multibyte character ending with backslash (0x5c) is
592 592 followed by the ASCII character 'n' in the customized template,
593 593 the sequence of backslash and 'n' is treated as line-feed unexpectedly
594 594 (and the multibyte character is broken, too).
595 595
596 596 Customized template is used for commands below (``--edit`` may be
597 597 required):
598 598
599 599 - :hg:`backout`
600 600 - :hg:`commit`
601 601 - :hg:`fetch` (for merge commit only)
602 602 - :hg:`graft`
603 603 - :hg:`histedit`
604 604 - :hg:`import`
605 605 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
606 606 - :hg:`rebase`
607 607 - :hg:`shelve`
608 608 - :hg:`sign`
609 609 - :hg:`tag`
610 610 - :hg:`transplant`
611 611
612 612 Configuring items below instead of ``changeset`` allows showing
613 613 customized message only for specific actions, or showing different
614 614 messages for each action.
615 615
616 616 - ``changeset.backout`` for :hg:`backout`
617 617 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
618 618 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
619 619 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
620 620 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
621 621 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
622 622 - ``changeset.gpg.sign`` for :hg:`sign`
623 623 - ``changeset.graft`` for :hg:`graft`
624 624 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
625 625 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
626 626 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
627 627 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
628 628 - ``changeset.import.bypass`` for :hg:`import --bypass`
629 629 - ``changeset.import.normal.merge`` for :hg:`import` on merges
630 630 - ``changeset.import.normal.normal`` for :hg:`import` on other
631 631 - ``changeset.mq.qnew`` for :hg:`qnew`
632 632 - ``changeset.mq.qfold`` for :hg:`qfold`
633 633 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
634 634 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
635 635 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
636 636 - ``changeset.rebase.normal`` for :hg:`rebase` on other
637 637 - ``changeset.shelve.shelve`` for :hg:`shelve`
638 638 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
639 639 - ``changeset.tag.remove`` for :hg:`tag --remove`
640 640 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
641 641 - ``changeset.transplant.normal`` for :hg:`transplant` on other
642 642
643 643 These dot-separated lists of names are treated as hierarchical ones.
644 644 For example, ``changeset.tag.remove`` customizes the commit message
645 645 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
646 646 commit message for :hg:`tag` regardless of ``--remove`` option.
647 647
648 648 When the external editor is invoked for a commit, the corresponding
649 649 dot-separated list of names without the ``changeset.`` prefix
650 650 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
651 651 variable.
652 652
653 653 In this section, items other than ``changeset`` can be referred from
654 654 others. For example, the configuration to list committed files up
655 655 below can be referred as ``{listupfiles}``::
656 656
657 657 [committemplate]
658 658 listupfiles = {file_adds %
659 659 "HG: added {file}\n" }{file_mods %
660 660 "HG: changed {file}\n" }{file_dels %
661 661 "HG: removed {file}\n" }{if(files, "",
662 662 "HG: no files changed\n")}
663 663
664 664 ``decode/encode``
665 665 -----------------
666 666
667 667 Filters for transforming files on checkout/checkin. This would
668 668 typically be used for newline processing or other
669 669 localization/canonicalization of files.
670 670
671 671 Filters consist of a filter pattern followed by a filter command.
672 672 Filter patterns are globs by default, rooted at the repository root.
673 673 For example, to match any file ending in ``.txt`` in the root
674 674 directory only, use the pattern ``*.txt``. To match any file ending
675 675 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
676 676 For each file only the first matching filter applies.
677 677
678 678 The filter command can start with a specifier, either ``pipe:`` or
679 679 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
680 680
681 681 A ``pipe:`` command must accept data on stdin and return the transformed
682 682 data on stdout.
683 683
684 684 Pipe example::
685 685
686 686 [encode]
687 687 # uncompress gzip files on checkin to improve delta compression
688 688 # note: not necessarily a good idea, just an example
689 689 *.gz = pipe: gunzip
690 690
691 691 [decode]
692 692 # recompress gzip files when writing them to the working dir (we
693 693 # can safely omit "pipe:", because it's the default)
694 694 *.gz = gzip
695 695
696 696 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
697 697 with the name of a temporary file that contains the data to be
698 698 filtered by the command. The string ``OUTFILE`` is replaced with the name
699 699 of an empty temporary file, where the filtered data must be written by
700 700 the command.
701 701
702 702 .. container:: windows
703 703
704 704 .. note::
705 705
706 706 The tempfile mechanism is recommended for Windows systems,
707 707 where the standard shell I/O redirection operators often have
708 708 strange effects and may corrupt the contents of your files.
709 709
710 710 This filter mechanism is used internally by the ``eol`` extension to
711 711 translate line ending characters between Windows (CRLF) and Unix (LF)
712 712 format. We suggest you use the ``eol`` extension for convenience.
713 713
714 714
715 715 ``defaults``
716 716 ------------
717 717
718 718 (defaults are deprecated. Don't use them. Use aliases instead.)
719 719
720 720 Use the ``[defaults]`` section to define command defaults, i.e. the
721 721 default options/arguments to pass to the specified commands.
722 722
723 723 The following example makes :hg:`log` run in verbose mode, and
724 724 :hg:`status` show only the modified files, by default::
725 725
726 726 [defaults]
727 727 log = -v
728 728 status = -m
729 729
730 730 The actual commands, instead of their aliases, must be used when
731 731 defining command defaults. The command defaults will also be applied
732 732 to the aliases of the commands defined.
733 733
734 734
735 735 ``diff``
736 736 --------
737 737
738 738 Settings used when displaying diffs. Everything except for ``unified``
739 739 is a Boolean and defaults to False. See :hg:`help config.annotate`
740 740 for related options for the annotate command.
741 741
742 742 ``git``
743 743 Use git extended diff format.
744 744
745 745 ``nobinary``
746 746 Omit git binary patches.
747 747
748 748 ``nodates``
749 749 Don't include dates in diff headers.
750 750
751 751 ``noprefix``
752 752 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
753 753
754 754 ``showfunc``
755 755 Show which function each change is in.
756 756
757 757 ``ignorews``
758 758 Ignore white space when comparing lines.
759 759
760 760 ``ignorewsamount``
761 761 Ignore changes in the amount of white space.
762 762
763 763 ``ignoreblanklines``
764 764 Ignore changes whose lines are all blank.
765 765
766 766 ``unified``
767 767 Number of lines of context to show.
768 768
769 769 ``word-diff``
770 770 Highlight changed words.
771 771
772 772 ``email``
773 773 ---------
774 774
775 775 Settings for extensions that send email messages.
776 776
777 777 ``from``
778 778 Optional. Email address to use in "From" header and SMTP envelope
779 779 of outgoing messages.
780 780
781 781 ``to``
782 782 Optional. Comma-separated list of recipients' email addresses.
783 783
784 784 ``cc``
785 785 Optional. Comma-separated list of carbon copy recipients'
786 786 email addresses.
787 787
788 788 ``bcc``
789 789 Optional. Comma-separated list of blind carbon copy recipients'
790 790 email addresses.
791 791
792 792 ``method``
793 793 Optional. Method to use to send email messages. If value is ``smtp``
794 794 (default), use SMTP (see the ``[smtp]`` section for configuration).
795 795 Otherwise, use as name of program to run that acts like sendmail
796 796 (takes ``-f`` option for sender, list of recipients on command line,
797 797 message on stdin). Normally, setting this to ``sendmail`` or
798 798 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
799 799
800 800 ``charsets``
801 801 Optional. Comma-separated list of character sets considered
802 802 convenient for recipients. Addresses, headers, and parts not
803 803 containing patches of outgoing messages will be encoded in the
804 804 first character set to which conversion from local encoding
805 805 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
806 806 conversion fails, the text in question is sent as is.
807 807 (default: '')
808 808
809 809 Order of outgoing email character sets:
810 810
811 811 1. ``us-ascii``: always first, regardless of settings
812 812 2. ``email.charsets``: in order given by user
813 813 3. ``ui.fallbackencoding``: if not in email.charsets
814 814 4. ``$HGENCODING``: if not in email.charsets
815 815 5. ``utf-8``: always last, regardless of settings
816 816
817 817 Email example::
818 818
819 819 [email]
820 820 from = Joseph User <joe.user@example.com>
821 821 method = /usr/sbin/sendmail
822 822 # charsets for western Europeans
823 823 # us-ascii, utf-8 omitted, as they are tried first and last
824 824 charsets = iso-8859-1, iso-8859-15, windows-1252
825 825
826 826
827 827 ``extensions``
828 828 --------------
829 829
830 830 Mercurial has an extension mechanism for adding new features. To
831 831 enable an extension, create an entry for it in this section.
832 832
833 833 If you know that the extension is already in Python's search path,
834 834 you can give the name of the module, followed by ``=``, with nothing
835 835 after the ``=``.
836 836
837 837 Otherwise, give a name that you choose, followed by ``=``, followed by
838 838 the path to the ``.py`` file (including the file name extension) that
839 839 defines the extension.
840 840
841 841 To explicitly disable an extension that is enabled in an hgrc of
842 842 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
843 843 or ``foo = !`` when path is not supplied.
844 844
845 845 Example for ``~/.hgrc``::
846 846
847 847 [extensions]
848 848 # (the churn extension will get loaded from Mercurial's path)
849 849 churn =
850 850 # (this extension will get loaded from the file specified)
851 851 myfeature = ~/.hgext/myfeature.py
852 852
853 853
854 854 ``format``
855 855 ----------
856 856
857 857 Configuration that controls the repository format. Newer format options are more
858 858 powerful, but incompatible with some older versions of Mercurial. Format options
859 859 are considered at repository initialization only. You need to make a new clone
860 860 for config changes to be taken into account.
861 861
862 862 For more details about repository format and version compatibility, see
863 863 https://www.mercurial-scm.org/wiki/MissingRequirement
864 864
865 865 ``usegeneraldelta``
866 866 Enable or disable the "generaldelta" repository format which improves
867 867 repository compression by allowing "revlog" to store deltas against
868 868 arbitrary revisions instead of the previously stored one. This provides
869 869 significant improvement for repositories with branches.
870 870
871 871 Repositories with this on-disk format require Mercurial version 1.9.
872 872
873 873 Enabled by default.
874 874
875 875 ``dotencode``
876 876 Enable or disable the "dotencode" repository format which enhances
877 877 the "fncache" repository format (which has to be enabled to use
878 878 dotencode) to avoid issues with filenames starting with "._" on
879 879 Mac OS X and spaces on Windows.
880 880
881 881 Repositories with this on-disk format require Mercurial version 1.7.
882 882
883 883 Enabled by default.
884 884
885 885 ``usefncache``
886 886 Enable or disable the "fncache" repository format which enhances
887 887 the "store" repository format (which has to be enabled to use
888 888 fncache) to allow longer filenames and avoids using Windows
889 889 reserved names, e.g. "nul".
890 890
891 891 Repositories with this on-disk format require Mercurial version 1.1.
892 892
893 893 Enabled by default.
894 894
895 895 ``use-persistent-nodemap``
896 896 Enable or disable the "persistent-nodemap" feature which improves
897 897 performance if the rust extensions are available.
898 898
899 899 The "persistence-nodemap" persist the "node -> rev" on disk removing the
900 900 need to dynamically build that mapping for each Mercurial invocation. This
901 901 significantly reduce the startup cost of various local and server-side
902 902 operation for larger repository.
903 903
904 904 The performance improving version of this feature is currently only
905 905 implemented in Rust, so people not using a version of Mercurial compiled
906 906 with the Rust part might actually suffer some slowdown. For this reason,
907 907 Such version will by default refuse to access such repositories. That
908 908 behavior can be controlled by configuration. Check
909 909 :hg:`help config.storage.revlog.persistent-nodemap.slowpath` for details.
910 910
911 911 Repository with this on-disk format require Mercurial version 5.4 or above.
912 912
913 913 By default this format variant is disabled if fast implementation is not
914 914 available and enabled by default if the fast implementation is available.
915 915
916 916 ``use-share-safe``
917 917 Enforce "safe" behaviors for all "shares" that access this repository.
918 918
919 919 With this feature, "shares" using this repository as a source will:
920 920
921 921 * read the source repository's configuration (`<source>/.hg/hgrc`).
922 922 * read and use the source repository's "requirements"
923 923 (except the working copy specific one).
924 924
925 925 Without this feature, "shares" using this repository as a source will:
926 926
927 927 * keep tracking the repository "requirements" in the share only, ignoring
928 928 the source "requirements", possibly diverging from them.
929 929 * ignore source repository config. This can create problems, like silently
930 930 ignoring important hooks.
931 931
932 932 Beware that existing shares will not be upgraded/downgraded, and by
933 933 default, Mercurial will refuse to interact with them until the mismatch
934 934 is resolved. See :hg:`help config share.safe-mismatch.source-safe` and
935 935 :hg:`help config share.safe-mismatch.source-not-safe` for details.
936 936
937 937 Introduced in Mercurial 5.7.
938 938
939 939 Disabled by default.
940 940
941 941 ``usestore``
942 942 Enable or disable the "store" repository format which improves
943 943 compatibility with systems that fold case or otherwise mangle
944 944 filenames. Disabling this option will allow you to store longer filenames
945 945 in some situations at the expense of compatibility.
946 946
947 947 Repositories with this on-disk format require Mercurial version 0.9.4.
948 948
949 949 Enabled by default.
950 950
951 951 ``sparse-revlog``
952 952 Enable or disable the ``sparse-revlog`` delta strategy. This format improves
953 953 delta re-use inside revlog. For very branchy repositories, it results in a
954 954 smaller store. For repositories with many revisions, it also helps
955 955 performance (by using shortened delta chains.)
956 956
957 957 Repositories with this on-disk format require Mercurial version 4.7
958 958
959 959 Enabled by default.
960 960
961 961 ``revlog-compression``
962 962 Compression algorithm used by revlog. Supported values are `zlib` and
963 963 `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is
964 964 a newer format that is usually a net win over `zlib`, operating faster at
965 965 better compression rates. Use `zstd` to reduce CPU usage. Multiple values
966 966 can be specified, the first available one will be used.
967 967
968 968 On some systems, the Mercurial installation may lack `zstd` support.
969 969
970 970 Default is `zstd` if available, `zlib` otherwise.
971 971
972 972 ``bookmarks-in-store``
973 973 Store bookmarks in .hg/store/. This means that bookmarks are shared when
974 974 using `hg share` regardless of the `-B` option.
975 975
976 976 Repositories with this on-disk format require Mercurial version 5.1.
977 977
978 978 Disabled by default.
979 979
980 980
981 981 ``graph``
982 982 ---------
983 983
984 984 Web graph view configuration. This section let you change graph
985 985 elements display properties by branches, for instance to make the
986 986 ``default`` branch stand out.
987 987
988 988 Each line has the following format::
989 989
990 990 <branch>.<argument> = <value>
991 991
992 992 where ``<branch>`` is the name of the branch being
993 993 customized. Example::
994 994
995 995 [graph]
996 996 # 2px width
997 997 default.width = 2
998 998 # red color
999 999 default.color = FF0000
1000 1000
1001 1001 Supported arguments:
1002 1002
1003 1003 ``width``
1004 1004 Set branch edges width in pixels.
1005 1005
1006 1006 ``color``
1007 1007 Set branch edges color in hexadecimal RGB notation.
1008 1008
1009 1009 ``hooks``
1010 1010 ---------
1011 1011
1012 1012 Commands or Python functions that get automatically executed by
1013 1013 various actions such as starting or finishing a commit. Multiple
1014 1014 hooks can be run for the same action by appending a suffix to the
1015 1015 action. Overriding a site-wide hook can be done by changing its
1016 1016 value or setting it to an empty string. Hooks can be prioritized
1017 1017 by adding a prefix of ``priority.`` to the hook name on a new line
1018 1018 and setting the priority. The default priority is 0.
1019 1019
1020 1020 Example ``.hg/hgrc``::
1021 1021
1022 1022 [hooks]
1023 1023 # update working directory after adding changesets
1024 1024 changegroup.update = hg update
1025 1025 # do not use the site-wide hook
1026 1026 incoming =
1027 1027 incoming.email = /my/email/hook
1028 1028 incoming.autobuild = /my/build/hook
1029 1029 # force autobuild hook to run before other incoming hooks
1030 1030 priority.incoming.autobuild = 1
1031 1031 ### control HGPLAIN setting when running autobuild hook
1032 1032 # HGPLAIN always set (default from Mercurial 5.7)
1033 1033 incoming.autobuild:run-with-plain = yes
1034 1034 # HGPLAIN never set
1035 1035 incoming.autobuild:run-with-plain = no
1036 1036 # HGPLAIN inherited from environment (default before Mercurial 5.7)
1037 1037 incoming.autobuild:run-with-plain = auto
1038 1038
1039 1039 Most hooks are run with environment variables set that give useful
1040 1040 additional information. For each hook below, the environment variables
1041 1041 it is passed are listed with names in the form ``$HG_foo``. The
1042 1042 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
1043 1043 They contain the type of hook which triggered the run and the full name
1044 1044 of the hook in the config, respectively. In the example above, this will
1045 1045 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
1046 1046
1047 1047 .. container:: windows
1048 1048
1049 1049 Some basic Unix syntax can be enabled for portability, including ``$VAR``
1050 1050 and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will
1051 1051 be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
1052 1052 on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back
1053 1053 slash or inside of a strong quote. Strong quotes will be replaced by
1054 1054 double quotes after processing.
1055 1055
1056 1056 This feature is enabled by adding a prefix of ``tonative.`` to the hook
1057 1057 name on a new line, and setting it to ``True``. For example::
1058 1058
1059 1059 [hooks]
1060 1060 incoming.autobuild = /my/build/hook
1061 1061 # enable translation to cmd.exe syntax for autobuild hook
1062 1062 tonative.incoming.autobuild = True
1063 1063
1064 1064 ``changegroup``
1065 1065 Run after a changegroup has been added via push, pull or unbundle. The ID of
1066 1066 the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
1067 1067 The URL from which changes came is in ``$HG_URL``.
1068 1068
1069 1069 ``commit``
1070 1070 Run after a changeset has been created in the local repository. The ID
1071 1071 of the newly created changeset is in ``$HG_NODE``. Parent changeset
1072 1072 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1073 1073
1074 1074 ``incoming``
1075 1075 Run after a changeset has been pulled, pushed, or unbundled into
1076 1076 the local repository. The ID of the newly arrived changeset is in
1077 1077 ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
1078 1078
1079 1079 ``outgoing``
1080 1080 Run after sending changes from the local repository to another. The ID of
1081 1081 first changeset sent is in ``$HG_NODE``. The source of operation is in
1082 1082 ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
1083 1083
1084 1084 ``post-<command>``
1085 1085 Run after successful invocations of the associated command. The
1086 1086 contents of the command line are passed as ``$HG_ARGS`` and the result
1087 1087 code in ``$HG_RESULT``. Parsed command line arguments are passed as
1088 1088 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
1089 1089 the python data internally passed to <command>. ``$HG_OPTS`` is a
1090 1090 dictionary of options (with unspecified options set to their defaults).
1091 1091 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
1092 1092
1093 1093 ``fail-<command>``
1094 1094 Run after a failed invocation of an associated command. The contents
1095 1095 of the command line are passed as ``$HG_ARGS``. Parsed command line
1096 1096 arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
1097 1097 string representations of the python data internally passed to
1098 1098 <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
1099 1099 options set to their defaults). ``$HG_PATS`` is a list of arguments.
1100 1100 Hook failure is ignored.
1101 1101
1102 1102 ``pre-<command>``
1103 1103 Run before executing the associated command. The contents of the
1104 1104 command line are passed as ``$HG_ARGS``. Parsed command line arguments
1105 1105 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
1106 1106 representations of the data internally passed to <command>. ``$HG_OPTS``
1107 1107 is a dictionary of options (with unspecified options set to their
1108 1108 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
1109 1109 failure, the command doesn't execute and Mercurial returns the failure
1110 1110 code.
1111 1111
1112 1112 ``prechangegroup``
1113 1113 Run before a changegroup is added via push, pull or unbundle. Exit
1114 1114 status 0 allows the changegroup to proceed. A non-zero status will
1115 1115 cause the push, pull or unbundle to fail. The URL from which changes
1116 1116 will come is in ``$HG_URL``.
1117 1117
1118 1118 ``precommit``
1119 1119 Run before starting a local commit. Exit status 0 allows the
1120 1120 commit to proceed. A non-zero status will cause the commit to fail.
1121 1121 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1122 1122
1123 1123 ``prelistkeys``
1124 1124 Run before listing pushkeys (like bookmarks) in the
1125 1125 repository. A non-zero status will cause failure. The key namespace is
1126 1126 in ``$HG_NAMESPACE``.
1127 1127
1128 1128 ``preoutgoing``
1129 1129 Run before collecting changes to send from the local repository to
1130 1130 another. A non-zero status will cause failure. This lets you prevent
1131 1131 pull over HTTP or SSH. It can also prevent propagating commits (via
1132 1132 local pull, push (outbound) or bundle commands), but not completely,
1133 1133 since you can just copy files instead. The source of operation is in
1134 1134 ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
1135 1135 SSH or HTTP repository. If "push", "pull" or "bundle", the operation
1136 1136 is happening on behalf of a repository on same system.
1137 1137
1138 1138 ``prepushkey``
1139 1139 Run before a pushkey (like a bookmark) is added to the
1140 1140 repository. A non-zero status will cause the key to be rejected. The
1141 1141 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
1142 1142 the old value (if any) is in ``$HG_OLD``, and the new value is in
1143 1143 ``$HG_NEW``.
1144 1144
1145 1145 ``pretag``
1146 1146 Run before creating a tag. Exit status 0 allows the tag to be
1147 1147 created. A non-zero status will cause the tag to fail. The ID of the
1148 1148 changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
1149 1149 tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
1150 1150
1151 1151 ``pretxnopen``
1152 1152 Run before any new repository transaction is open. The reason for the
1153 1153 transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
1154 1154 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
1155 1155 transaction from being opened.
1156 1156
1157 1157 ``pretxnclose``
1158 1158 Run right before the transaction is actually finalized. Any repository change
1159 1159 will be visible to the hook program. This lets you validate the transaction
1160 1160 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1161 1161 status will cause the transaction to be rolled back. The reason for the
1162 1162 transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
1163 1163 the transaction will be in ``HG_TXNID``. The rest of the available data will
1164 1164 vary according the transaction type. New changesets will add ``$HG_NODE``
1165 1165 (the ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last
1166 1166 added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables. Bookmark and
1167 1167 phase changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``
1168 1168 respectively, etc.
1169 1169
1170 1170 ``pretxnclose-bookmark``
1171 1171 Run right before a bookmark change is actually finalized. Any repository
1172 1172 change will be visible to the hook program. This lets you validate the
1173 1173 transaction content or change it. Exit status 0 allows the commit to
1174 1174 proceed. A non-zero status will cause the transaction to be rolled back.
1175 1175 The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
1176 1176 bookmark location will be available in ``$HG_NODE`` while the previous
1177 1177 location will be available in ``$HG_OLDNODE``. In case of a bookmark
1178 1178 creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
1179 1179 will be empty.
1180 1180 In addition, the reason for the transaction opening will be in
1181 1181 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1182 1182 ``HG_TXNID``.
1183 1183
1184 1184 ``pretxnclose-phase``
1185 1185 Run right before a phase change is actually finalized. Any repository change
1186 1186 will be visible to the hook program. This lets you validate the transaction
1187 1187 content or change it. Exit status 0 allows the commit to proceed. A non-zero
1188 1188 status will cause the transaction to be rolled back. The hook is called
1189 1189 multiple times, once for each revision affected by a phase change.
1190 1190 The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
1191 1191 while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
1192 1192 will be empty. In addition, the reason for the transaction opening will be in
1193 1193 ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
1194 1194 ``HG_TXNID``. The hook is also run for newly added revisions. In this case
1195 1195 the ``$HG_OLDPHASE`` entry will be empty.
1196 1196
1197 1197 ``txnclose``
1198 1198 Run after any repository transaction has been committed. At this
1199 1199 point, the transaction can no longer be rolled back. The hook will run
1200 1200 after the lock is released. See :hg:`help config.hooks.pretxnclose` for
1201 1201 details about available variables.
1202 1202
1203 1203 ``txnclose-bookmark``
1204 1204 Run after any bookmark change has been committed. At this point, the
1205 1205 transaction can no longer be rolled back. The hook will run after the lock
1206 1206 is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
1207 1207 about available variables.
1208 1208
1209 1209 ``txnclose-phase``
1210 1210 Run after any phase change has been committed. At this point, the
1211 1211 transaction can no longer be rolled back. The hook will run after the lock
1212 1212 is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
1213 1213 available variables.
1214 1214
1215 1215 ``txnabort``
1216 1216 Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
1217 1217 for details about available variables.
1218 1218
1219 1219 ``pretxnchangegroup``
1220 1220 Run after a changegroup has been added via push, pull or unbundle, but before
1221 1221 the transaction has been committed. The changegroup is visible to the hook
1222 1222 program. This allows validation of incoming changes before accepting them.
1223 1223 The ID of the first new changeset is in ``$HG_NODE`` and last is in
1224 1224 ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
1225 1225 status will cause the transaction to be rolled back, and the push, pull or
1226 1226 unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
1227 1227
1228 1228 ``pretxncommit``
1229 1229 Run after a changeset has been created, but before the transaction is
1230 1230 committed. The changeset is visible to the hook program. This allows
1231 1231 validation of the commit message and changes. Exit status 0 allows the
1232 1232 commit to proceed. A non-zero status will cause the transaction to
1233 1233 be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
1234 1234 changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
1235 1235
1236 1236 ``preupdate``
1237 1237 Run before updating the working directory. Exit status 0 allows
1238 1238 the update to proceed. A non-zero status will prevent the update.
1239 1239 The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
1240 1240 merge, the ID of second new parent is in ``$HG_PARENT2``.
1241 1241
1242 1242 ``listkeys``
1243 1243 Run after listing pushkeys (like bookmarks) in the repository. The
1244 1244 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
1245 1245 dictionary containing the keys and values.
1246 1246
1247 1247 ``pushkey``
1248 1248 Run after a pushkey (like a bookmark) is added to the
1249 1249 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
1250 1250 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
1251 1251 value is in ``$HG_NEW``.
1252 1252
1253 1253 ``tag``
1254 1254 Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
1255 1255 The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
1256 1256 the repository if ``$HG_LOCAL=0``.
1257 1257
1258 1258 ``update``
1259 1259 Run after updating the working directory. The changeset ID of first
1260 1260 new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
1261 1261 parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
1262 1262 update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
1263 1263
1264 1264 .. note::
1265 1265
1266 1266 It is generally better to use standard hooks rather than the
1267 1267 generic pre- and post- command hooks, as they are guaranteed to be
1268 1268 called in the appropriate contexts for influencing transactions.
1269 1269 Also, hooks like "commit" will be called in all contexts that
1270 1270 generate a commit (e.g. tag) and not just the commit command.
1271 1271
1272 1272 .. note::
1273 1273
1274 1274 Environment variables with empty values may not be passed to
1275 1275 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
1276 1276 will have an empty value under Unix-like platforms for non-merge
1277 1277 changesets, while it will not be available at all under Windows.
1278 1278
1279 1279 The syntax for Python hooks is as follows::
1280 1280
1281 1281 hookname = python:modulename.submodule.callable
1282 1282 hookname = python:/path/to/python/module.py:callable
1283 1283
1284 1284 Python hooks are run within the Mercurial process. Each hook is
1285 1285 called with at least three keyword arguments: a ui object (keyword
1286 1286 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
1287 1287 keyword that tells what kind of hook is used. Arguments listed as
1288 1288 environment variables above are passed as keyword arguments, with no
1289 1289 ``HG_`` prefix, and names in lower case.
1290 1290
1291 1291 If a Python hook returns a "true" value or raises an exception, this
1292 1292 is treated as a failure.
1293 1293
1294 1294
1295 1295 ``hostfingerprints``
1296 1296 --------------------
1297 1297
1298 1298 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
1299 1299
1300 1300 Fingerprints of the certificates of known HTTPS servers.
1301 1301
1302 1302 A HTTPS connection to a server with a fingerprint configured here will
1303 1303 only succeed if the servers certificate matches the fingerprint.
1304 1304 This is very similar to how ssh known hosts works.
1305 1305
1306 1306 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
1307 1307 Multiple values can be specified (separated by spaces or commas). This can
1308 1308 be used to define both old and new fingerprints while a host transitions
1309 1309 to a new certificate.
1310 1310
1311 1311 The CA chain and web.cacerts is not used for servers with a fingerprint.
1312 1312
1313 1313 For example::
1314 1314
1315 1315 [hostfingerprints]
1316 1316 hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1317 1317 hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
1318 1318
1319 1319 ``hostsecurity``
1320 1320 ----------------
1321 1321
1322 1322 Used to specify global and per-host security settings for connecting to
1323 1323 other machines.
1324 1324
1325 1325 The following options control default behavior for all hosts.
1326 1326
1327 1327 ``ciphers``
1328 1328 Defines the cryptographic ciphers to use for connections.
1329 1329
1330 1330 Value must be a valid OpenSSL Cipher List Format as documented at
1331 1331 https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
1332 1332
1333 1333 This setting is for advanced users only. Setting to incorrect values
1334 1334 can significantly lower connection security or decrease performance.
1335 1335 You have been warned.
1336 1336
1337 1337 This option requires Python 2.7.
1338 1338
1339 1339 ``minimumprotocol``
1340 1340 Defines the minimum channel encryption protocol to use.
1341 1341
1342 1342 By default, the highest version of TLS supported by both client and server
1343 1343 is used.
1344 1344
1345 1345 Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
1346 1346
1347 1347 When running on an old Python version, only ``tls1.0`` is allowed since
1348 1348 old versions of Python only support up to TLS 1.0.
1349 1349
1350 1350 When running a Python that supports modern TLS versions, the default is
1351 1351 ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
1352 1352 weakens security and should only be used as a feature of last resort if
1353 1353 a server does not support TLS 1.1+.
1354 1354
1355 1355 Options in the ``[hostsecurity]`` section can have the form
1356 1356 ``hostname``:``setting``. This allows multiple settings to be defined on a
1357 1357 per-host basis.
1358 1358
1359 1359 The following per-host settings can be defined.
1360 1360
1361 1361 ``ciphers``
1362 1362 This behaves like ``ciphers`` as described above except it only applies
1363 1363 to the host on which it is defined.
1364 1364
1365 1365 ``fingerprints``
1366 1366 A list of hashes of the DER encoded peer/remote certificate. Values have
1367 1367 the form ``algorithm``:``fingerprint``. e.g.
1368 1368 ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
1369 1369 In addition, colons (``:``) can appear in the fingerprint part.
1370 1370
1371 1371 The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
1372 1372 ``sha512``.
1373 1373
1374 1374 Use of ``sha256`` or ``sha512`` is preferred.
1375 1375
1376 1376 If a fingerprint is specified, the CA chain is not validated for this
1377 1377 host and Mercurial will require the remote certificate to match one
1378 1378 of the fingerprints specified. This means if the server updates its
1379 1379 certificate, Mercurial will abort until a new fingerprint is defined.
1380 1380 This can provide stronger security than traditional CA-based validation
1381 1381 at the expense of convenience.
1382 1382
1383 1383 This option takes precedence over ``verifycertsfile``.
1384 1384
1385 1385 ``minimumprotocol``
1386 1386 This behaves like ``minimumprotocol`` as described above except it
1387 1387 only applies to the host on which it is defined.
1388 1388
1389 1389 ``verifycertsfile``
1390 1390 Path to file a containing a list of PEM encoded certificates used to
1391 1391 verify the server certificate. Environment variables and ``~user``
1392 1392 constructs are expanded in the filename.
1393 1393
1394 1394 The server certificate or the certificate's certificate authority (CA)
1395 1395 must match a certificate from this file or certificate verification
1396 1396 will fail and connections to the server will be refused.
1397 1397
1398 1398 If defined, only certificates provided by this file will be used:
1399 1399 ``web.cacerts`` and any system/default certificates will not be
1400 1400 used.
1401 1401
1402 1402 This option has no effect if the per-host ``fingerprints`` option
1403 1403 is set.
1404 1404
1405 1405 The format of the file is as follows::
1406 1406
1407 1407 -----BEGIN CERTIFICATE-----
1408 1408 ... (certificate in base64 PEM encoding) ...
1409 1409 -----END CERTIFICATE-----
1410 1410 -----BEGIN CERTIFICATE-----
1411 1411 ... (certificate in base64 PEM encoding) ...
1412 1412 -----END CERTIFICATE-----
1413 1413
1414 1414 For example::
1415 1415
1416 1416 [hostsecurity]
1417 1417 hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
1418 1418 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
1419 1419 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
1420 1420 foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
1421 1421
1422 1422 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
1423 1423 when connecting to ``hg.example.com``::
1424 1424
1425 1425 [hostsecurity]
1426 1426 minimumprotocol = tls1.2
1427 1427 hg.example.com:minimumprotocol = tls1.1
1428 1428
1429 1429 ``http_proxy``
1430 1430 --------------
1431 1431
1432 1432 Used to access web-based Mercurial repositories through a HTTP
1433 1433 proxy.
1434 1434
1435 1435 ``host``
1436 1436 Host name and (optional) port of the proxy server, for example
1437 1437 "myproxy:8000".
1438 1438
1439 1439 ``no``
1440 1440 Optional. Comma-separated list of host names that should bypass
1441 1441 the proxy.
1442 1442
1443 1443 ``passwd``
1444 1444 Optional. Password to authenticate with at the proxy server.
1445 1445
1446 1446 ``user``
1447 1447 Optional. User name to authenticate with at the proxy server.
1448 1448
1449 1449 ``always``
1450 1450 Optional. Always use the proxy, even for localhost and any entries
1451 1451 in ``http_proxy.no``. (default: False)
1452 1452
1453 1453 ``http``
1454 1454 ----------
1455 1455
1456 1456 Used to configure access to Mercurial repositories via HTTP.
1457 1457
1458 1458 ``timeout``
1459 1459 If set, blocking operations will timeout after that many seconds.
1460 1460 (default: None)
1461 1461
1462 1462 ``merge``
1463 1463 ---------
1464 1464
1465 1465 This section specifies behavior during merges and updates.
1466 1466
1467 1467 ``checkignored``
1468 1468 Controls behavior when an ignored file on disk has the same name as a tracked
1469 1469 file in the changeset being merged or updated to, and has different
1470 1470 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
1471 1471 abort on such files. With ``warn``, warn on such files and back them up as
1472 1472 ``.orig``. With ``ignore``, don't print a warning and back them up as
1473 1473 ``.orig``. (default: ``abort``)
1474 1474
1475 1475 ``checkunknown``
1476 1476 Controls behavior when an unknown file that isn't ignored has the same name
1477 1477 as a tracked file in the changeset being merged or updated to, and has
1478 1478 different contents. Similar to ``merge.checkignored``, except for files that
1479 1479 are not ignored. (default: ``abort``)
1480 1480
1481 1481 ``on-failure``
1482 1482 When set to ``continue`` (the default), the merge process attempts to
1483 1483 merge all unresolved files using the merge chosen tool, regardless of
1484 1484 whether previous file merge attempts during the process succeeded or not.
1485 1485 Setting this to ``prompt`` will prompt after any merge failure continue
1486 1486 or halt the merge process. Setting this to ``halt`` will automatically
1487 1487 halt the merge process on any merge tool failure. The merge process
1488 1488 can be restarted by using the ``resolve`` command. When a merge is
1489 1489 halted, the repository is left in a normal ``unresolved`` merge state.
1490 1490 (default: ``continue``)
1491 1491
1492 1492 ``strict-capability-check``
1493 1493 Whether capabilities of internal merge tools are checked strictly
1494 1494 or not, while examining rules to decide merge tool to be used.
1495 1495 (default: False)
1496 1496
1497 1497 ``merge-patterns``
1498 1498 ------------------
1499 1499
1500 1500 This section specifies merge tools to associate with particular file
1501 1501 patterns. Tools matched here will take precedence over the default
1502 1502 merge tool. Patterns are globs by default, rooted at the repository
1503 1503 root.
1504 1504
1505 1505 Example::
1506 1506
1507 1507 [merge-patterns]
1508 1508 **.c = kdiff3
1509 1509 **.jpg = myimgmerge
1510 1510
1511 1511 ``merge-tools``
1512 1512 ---------------
1513 1513
1514 1514 This section configures external merge tools to use for file-level
1515 1515 merges. This section has likely been preconfigured at install time.
1516 1516 Use :hg:`config merge-tools` to check the existing configuration.
1517 1517 Also see :hg:`help merge-tools` for more details.
1518 1518
1519 1519 Example ``~/.hgrc``::
1520 1520
1521 1521 [merge-tools]
1522 1522 # Override stock tool location
1523 1523 kdiff3.executable = ~/bin/kdiff3
1524 1524 # Specify command line
1525 1525 kdiff3.args = $base $local $other -o $output
1526 1526 # Give higher priority
1527 1527 kdiff3.priority = 1
1528 1528
1529 1529 # Changing the priority of preconfigured tool
1530 1530 meld.priority = 0
1531 1531
1532 1532 # Disable a preconfigured tool
1533 1533 vimdiff.disabled = yes
1534 1534
1535 1535 # Define new tool
1536 1536 myHtmlTool.args = -m $local $other $base $output
1537 1537 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1538 1538 myHtmlTool.priority = 1
1539 1539
1540 1540 Supported arguments:
1541 1541
1542 1542 ``priority``
1543 1543 The priority in which to evaluate this tool.
1544 1544 (default: 0)
1545 1545
1546 1546 ``executable``
1547 1547 Either just the name of the executable or its pathname.
1548 1548
1549 1549 .. container:: windows
1550 1550
1551 1551 On Windows, the path can use environment variables with ${ProgramFiles}
1552 1552 syntax.
1553 1553
1554 1554 (default: the tool name)
1555 1555
1556 1556 ``args``
1557 1557 The arguments to pass to the tool executable. You can refer to the
1558 1558 files being merged as well as the output file through these
1559 1559 variables: ``$base``, ``$local``, ``$other``, ``$output``.
1560 1560
1561 1561 The meaning of ``$local`` and ``$other`` can vary depending on which action is
1562 1562 being performed. During an update or merge, ``$local`` represents the original
1563 1563 state of the file, while ``$other`` represents the commit you are updating to or
1564 1564 the commit you are merging with. During a rebase, ``$local`` represents the
1565 1565 destination of the rebase, and ``$other`` represents the commit being rebased.
1566 1566
1567 1567 Some operations define custom labels to assist with identifying the revisions,
1568 1568 accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
1569 1569 labels are not available, these will be ``local``, ``other``, and ``base``,
1570 1570 respectively.
1571 1571 (default: ``$local $base $other``)
1572 1572
1573 1573 ``premerge``
1574 1574 Attempt to run internal non-interactive 3-way merge tool before
1575 1575 launching external tool. Options are ``true``, ``false``, ``keep``,
1576 1576 ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option
1577 1577 will leave markers in the file if the premerge fails. The ``keep-merge3``
1578 1578 will do the same but include information about the base of the merge in the
1579 1579 marker (see internal :merge3 in :hg:`help merge-tools`). The
1580 1580 ``keep-mergediff`` option is similar but uses a different marker style
1581 1581 (see internal :merge3 in :hg:`help merge-tools`). (default: True)
1582 1582
1583 1583 ``binary``
1584 1584 This tool can merge binary files. (default: False, unless tool
1585 1585 was selected by file pattern match)
1586 1586
1587 1587 ``symlink``
1588 1588 This tool can merge symlinks. (default: False)
1589 1589
1590 1590 ``check``
1591 1591 A list of merge success-checking options:
1592 1592
1593 1593 ``changed``
1594 1594 Ask whether merge was successful when the merged file shows no changes.
1595 1595 ``conflicts``
1596 1596 Check whether there are conflicts even though the tool reported success.
1597 1597 ``prompt``
1598 1598 Always prompt for merge success, regardless of success reported by tool.
1599 1599
1600 1600 ``fixeol``
1601 1601 Attempt to fix up EOL changes caused by the merge tool.
1602 1602 (default: False)
1603 1603
1604 1604 ``gui``
1605 1605 This tool requires a graphical interface to run. (default: False)
1606 1606
1607 1607 ``mergemarkers``
1608 1608 Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
1609 1609 ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
1610 1610 ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
1611 1611 markers generated during premerge will be ``detailed`` if either this option or
1612 1612 the corresponding option in the ``[ui]`` section is ``detailed``.
1613 1613 (default: ``basic``)
1614 1614
1615 1615 ``mergemarkertemplate``
1616 1616 This setting can be used to override ``mergemarker`` from the
1617 1617 ``[command-templates]`` section on a per-tool basis; this applies to the
1618 1618 ``$label``-prefixed variables and to the conflict markers that are generated
1619 1619 if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable
1620 1620 in ``[ui]`` for more information.
1621 1621
1622 1622 .. container:: windows
1623 1623
1624 1624 ``regkey``
1625 1625 Windows registry key which describes install location of this
1626 1626 tool. Mercurial will search for this key first under
1627 1627 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1628 1628 (default: None)
1629 1629
1630 1630 ``regkeyalt``
1631 1631 An alternate Windows registry key to try if the first key is not
1632 1632 found. The alternate key uses the same ``regname`` and ``regappend``
1633 1633 semantics of the primary key. The most common use for this key
1634 1634 is to search for 32bit applications on 64bit operating systems.
1635 1635 (default: None)
1636 1636
1637 1637 ``regname``
1638 1638 Name of value to read from specified registry key.
1639 1639 (default: the unnamed (default) value)
1640 1640
1641 1641 ``regappend``
1642 1642 String to append to the value read from the registry, typically
1643 1643 the executable name of the tool.
1644 1644 (default: None)
1645 1645
1646 1646 ``pager``
1647 1647 ---------
1648 1648
1649 1649 Setting used to control when to paginate and with what external tool. See
1650 1650 :hg:`help pager` for details.
1651 1651
1652 1652 ``pager``
1653 1653 Define the external tool used as pager.
1654 1654
1655 1655 If no pager is set, Mercurial uses the environment variable $PAGER.
1656 1656 If neither pager.pager, nor $PAGER is set, a default pager will be
1657 1657 used, typically `less` on Unix and `more` on Windows. Example::
1658 1658
1659 1659 [pager]
1660 1660 pager = less -FRX
1661 1661
1662 1662 ``ignore``
1663 1663 List of commands to disable the pager for. Example::
1664 1664
1665 1665 [pager]
1666 1666 ignore = version, help, update
1667 1667
1668 1668 ``patch``
1669 1669 ---------
1670 1670
1671 1671 Settings used when applying patches, for instance through the 'import'
1672 1672 command or with Mercurial Queues extension.
1673 1673
1674 1674 ``eol``
1675 1675 When set to 'strict' patch content and patched files end of lines
1676 1676 are preserved. When set to ``lf`` or ``crlf``, both files end of
1677 1677 lines are ignored when patching and the result line endings are
1678 1678 normalized to either LF (Unix) or CRLF (Windows). When set to
1679 1679 ``auto``, end of lines are again ignored while patching but line
1680 1680 endings in patched files are normalized to their original setting
1681 1681 on a per-file basis. If target file does not exist or has no end
1682 1682 of line, patch line endings are preserved.
1683 1683 (default: strict)
1684 1684
1685 1685 ``fuzz``
1686 1686 The number of lines of 'fuzz' to allow when applying patches. This
1687 1687 controls how much context the patcher is allowed to ignore when
1688 1688 trying to apply a patch.
1689 1689 (default: 2)
1690 1690
1691 1691 ``paths``
1692 1692 ---------
1693 1693
1694 1694 Assigns symbolic names and behavior to repositories.
1695 1695
1696 1696 Options are symbolic names defining the URL or directory that is the
1697 1697 location of the repository. Example::
1698 1698
1699 1699 [paths]
1700 1700 my_server = https://example.com/my_repo
1701 1701 local_path = /home/me/repo
1702 1702
1703 1703 These symbolic names can be used from the command line. To pull
1704 1704 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
1705 1705 :hg:`push local_path`. You can check :hg:`help urls` for details about
1706 1706 valid URLs.
1707 1707
1708 1708 Options containing colons (``:``) denote sub-options that can influence
1709 1709 behavior for that specific path. Example::
1710 1710
1711 1711 [paths]
1712 1712 my_server = https://example.com/my_path
1713 1713 my_server:pushurl = ssh://example.com/my_path
1714 1714
1715 Paths using the `path://otherpath` scheme will inherit the sub-options value from
1716 the path they point to.
1717
1715 1718 The following sub-options can be defined:
1716 1719
1717 1720 ``pushurl``
1718 1721 The URL to use for push operations. If not defined, the location
1719 1722 defined by the path's main entry is used.
1720 1723
1721 1724 ``pushrev``
1722 1725 A revset defining which revisions to push by default.
1723 1726
1724 1727 When :hg:`push` is executed without a ``-r`` argument, the revset
1725 1728 defined by this sub-option is evaluated to determine what to push.
1726 1729
1727 1730 For example, a value of ``.`` will push the working directory's
1728 1731 revision by default.
1729 1732
1730 1733 Revsets specifying bookmarks will not result in the bookmark being
1731 1734 pushed.
1732 1735
1733 1736 The following special named paths exist:
1734 1737
1735 1738 ``default``
1736 1739 The URL or directory to use when no source or remote is specified.
1737 1740
1738 1741 :hg:`clone` will automatically define this path to the location the
1739 1742 repository was cloned from.
1740 1743
1741 1744 ``default-push``
1742 1745 (deprecated) The URL or directory for the default :hg:`push` location.
1743 1746 ``default:pushurl`` should be used instead.
1744 1747
1745 1748 ``phases``
1746 1749 ----------
1747 1750
1748 1751 Specifies default handling of phases. See :hg:`help phases` for more
1749 1752 information about working with phases.
1750 1753
1751 1754 ``publish``
1752 1755 Controls draft phase behavior when working as a server. When true,
1753 1756 pushed changesets are set to public in both client and server and
1754 1757 pulled or cloned changesets are set to public in the client.
1755 1758 (default: True)
1756 1759
1757 1760 ``new-commit``
1758 1761 Phase of newly-created commits.
1759 1762 (default: draft)
1760 1763
1761 1764 ``checksubrepos``
1762 1765 Check the phase of the current revision of each subrepository. Allowed
1763 1766 values are "ignore", "follow" and "abort". For settings other than
1764 1767 "ignore", the phase of the current revision of each subrepository is
1765 1768 checked before committing the parent repository. If any of those phases is
1766 1769 greater than the phase of the parent repository (e.g. if a subrepo is in a
1767 1770 "secret" phase while the parent repo is in "draft" phase), the commit is
1768 1771 either aborted (if checksubrepos is set to "abort") or the higher phase is
1769 1772 used for the parent repository commit (if set to "follow").
1770 1773 (default: follow)
1771 1774
1772 1775
1773 1776 ``profiling``
1774 1777 -------------
1775 1778
1776 1779 Specifies profiling type, format, and file output. Two profilers are
1777 1780 supported: an instrumenting profiler (named ``ls``), and a sampling
1778 1781 profiler (named ``stat``).
1779 1782
1780 1783 In this section description, 'profiling data' stands for the raw data
1781 1784 collected during profiling, while 'profiling report' stands for a
1782 1785 statistical text report generated from the profiling data.
1783 1786
1784 1787 ``enabled``
1785 1788 Enable the profiler.
1786 1789 (default: false)
1787 1790
1788 1791 This is equivalent to passing ``--profile`` on the command line.
1789 1792
1790 1793 ``type``
1791 1794 The type of profiler to use.
1792 1795 (default: stat)
1793 1796
1794 1797 ``ls``
1795 1798 Use Python's built-in instrumenting profiler. This profiler
1796 1799 works on all platforms, but each line number it reports is the
1797 1800 first line of a function. This restriction makes it difficult to
1798 1801 identify the expensive parts of a non-trivial function.
1799 1802 ``stat``
1800 1803 Use a statistical profiler, statprof. This profiler is most
1801 1804 useful for profiling commands that run for longer than about 0.1
1802 1805 seconds.
1803 1806
1804 1807 ``format``
1805 1808 Profiling format. Specific to the ``ls`` instrumenting profiler.
1806 1809 (default: text)
1807 1810
1808 1811 ``text``
1809 1812 Generate a profiling report. When saving to a file, it should be
1810 1813 noted that only the report is saved, and the profiling data is
1811 1814 not kept.
1812 1815 ``kcachegrind``
1813 1816 Format profiling data for kcachegrind use: when saving to a
1814 1817 file, the generated file can directly be loaded into
1815 1818 kcachegrind.
1816 1819
1817 1820 ``statformat``
1818 1821 Profiling format for the ``stat`` profiler.
1819 1822 (default: hotpath)
1820 1823
1821 1824 ``hotpath``
1822 1825 Show a tree-based display containing the hot path of execution (where
1823 1826 most time was spent).
1824 1827 ``bymethod``
1825 1828 Show a table of methods ordered by how frequently they are active.
1826 1829 ``byline``
1827 1830 Show a table of lines in files ordered by how frequently they are active.
1828 1831 ``json``
1829 1832 Render profiling data as JSON.
1830 1833
1831 1834 ``frequency``
1832 1835 Sampling frequency. Specific to the ``stat`` sampling profiler.
1833 1836 (default: 1000)
1834 1837
1835 1838 ``output``
1836 1839 File path where profiling data or report should be saved. If the
1837 1840 file exists, it is replaced. (default: None, data is printed on
1838 1841 stderr)
1839 1842
1840 1843 ``sort``
1841 1844 Sort field. Specific to the ``ls`` instrumenting profiler.
1842 1845 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1843 1846 ``inlinetime``.
1844 1847 (default: inlinetime)
1845 1848
1846 1849 ``time-track``
1847 1850 Control if the stat profiler track ``cpu`` or ``real`` time.
1848 1851 (default: ``cpu`` on Windows, otherwise ``real``)
1849 1852
1850 1853 ``limit``
1851 1854 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1852 1855 (default: 30)
1853 1856
1854 1857 ``nested``
1855 1858 Show at most this number of lines of drill-down info after each main entry.
1856 1859 This can help explain the difference between Total and Inline.
1857 1860 Specific to the ``ls`` instrumenting profiler.
1858 1861 (default: 0)
1859 1862
1860 1863 ``showmin``
1861 1864 Minimum fraction of samples an entry must have for it to be displayed.
1862 1865 Can be specified as a float between ``0.0`` and ``1.0`` or can have a
1863 1866 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
1864 1867
1865 1868 Only used by the ``stat`` profiler.
1866 1869
1867 1870 For the ``hotpath`` format, default is ``0.05``.
1868 1871 For the ``chrome`` format, default is ``0.005``.
1869 1872
1870 1873 The option is unused on other formats.
1871 1874
1872 1875 ``showmax``
1873 1876 Maximum fraction of samples an entry can have before it is ignored in
1874 1877 display. Values format is the same as ``showmin``.
1875 1878
1876 1879 Only used by the ``stat`` profiler.
1877 1880
1878 1881 For the ``chrome`` format, default is ``0.999``.
1879 1882
1880 1883 The option is unused on other formats.
1881 1884
1882 1885 ``showtime``
1883 1886 Show time taken as absolute durations, in addition to percentages.
1884 1887 Only used by the ``hotpath`` format.
1885 1888 (default: true)
1886 1889
1887 1890 ``progress``
1888 1891 ------------
1889 1892
1890 1893 Mercurial commands can draw progress bars that are as informative as
1891 1894 possible. Some progress bars only offer indeterminate information, while others
1892 1895 have a definite end point.
1893 1896
1894 1897 ``debug``
1895 1898 Whether to print debug info when updating the progress bar. (default: False)
1896 1899
1897 1900 ``delay``
1898 1901 Number of seconds (float) before showing the progress bar. (default: 3)
1899 1902
1900 1903 ``changedelay``
1901 1904 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1902 1905 that value will be used instead. (default: 1)
1903 1906
1904 1907 ``estimateinterval``
1905 1908 Maximum sampling interval in seconds for speed and estimated time
1906 1909 calculation. (default: 60)
1907 1910
1908 1911 ``refresh``
1909 1912 Time in seconds between refreshes of the progress bar. (default: 0.1)
1910 1913
1911 1914 ``format``
1912 1915 Format of the progress bar.
1913 1916
1914 1917 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1915 1918 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
1916 1919 last 20 characters of the item, but this can be changed by adding either
1917 1920 ``-<num>`` which would take the last num characters, or ``+<num>`` for the
1918 1921 first num characters.
1919 1922
1920 1923 (default: topic bar number estimate)
1921 1924
1922 1925 ``width``
1923 1926 If set, the maximum width of the progress information (that is, min(width,
1924 1927 term width) will be used).
1925 1928
1926 1929 ``clear-complete``
1927 1930 Clear the progress bar after it's done. (default: True)
1928 1931
1929 1932 ``disable``
1930 1933 If true, don't show a progress bar.
1931 1934
1932 1935 ``assume-tty``
1933 1936 If true, ALWAYS show a progress bar, unless disable is given.
1934 1937
1935 1938 ``rebase``
1936 1939 ----------
1937 1940
1938 1941 ``evolution.allowdivergence``
1939 1942 Default to False, when True allow creating divergence when performing
1940 1943 rebase of obsolete changesets.
1941 1944
1942 1945 ``revsetalias``
1943 1946 ---------------
1944 1947
1945 1948 Alias definitions for revsets. See :hg:`help revsets` for details.
1946 1949
1947 1950 ``rewrite``
1948 1951 -----------
1949 1952
1950 1953 ``backup-bundle``
1951 1954 Whether to save stripped changesets to a bundle file. (default: True)
1952 1955
1953 1956 ``update-timestamp``
1954 1957 If true, updates the date and time of the changeset to current. It is only
1955 1958 applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the
1956 1959 current version.
1957 1960
1958 1961 ``empty-successor``
1959 1962
1960 1963 Control what happens with empty successors that are the result of rewrite
1961 1964 operations. If set to ``skip``, the successor is not created. If set to
1962 1965 ``keep``, the empty successor is created and kept.
1963 1966
1964 1967 Currently, only the rebase and absorb commands consider this configuration.
1965 1968 (EXPERIMENTAL)
1966 1969
1967 1970 ``share``
1968 1971 ---------
1969 1972
1970 1973 ``safe-mismatch.source-safe``
1971 1974
1972 1975 Controls what happens when the shared repository does not use the
1973 1976 share-safe mechanism but its source repository does.
1974 1977
1975 1978 Possible values are `abort` (default), `allow`, `upgrade-abort` and
1976 1979 `upgrade-abort`.
1977 1980
1978 1981 ``abort``
1979 1982 Disallows running any command and aborts
1980 1983 ``allow``
1981 1984 Respects the feature presence in the share source
1982 1985 ``upgrade-abort``
1983 1986 tries to upgrade the share to use share-safe; if it fails, aborts
1984 1987 ``upgrade-allow``
1985 1988 tries to upgrade the share; if it fails, continue by
1986 1989 respecting the share source setting
1987 1990
1988 1991 Check :hg:`help config format.use-share-safe` for details about the
1989 1992 share-safe feature.
1990 1993
1991 1994 ``safe-mismatch.source-safe.warn``
1992 1995 Shows a warning on operations if the shared repository does not use
1993 1996 share-safe, but the source repository does.
1994 1997 (default: True)
1995 1998
1996 1999 ``safe-mismatch.source-not-safe``
1997 2000
1998 2001 Controls what happens when the shared repository uses the share-safe
1999 2002 mechanism but its source does not.
2000 2003
2001 2004 Possible values are `abort` (default), `allow`, `downgrade-abort` and
2002 2005 `downgrade-abort`.
2003 2006
2004 2007 ``abort``
2005 2008 Disallows running any command and aborts
2006 2009 ``allow``
2007 2010 Respects the feature presence in the share source
2008 2011 ``downgrade-abort``
2009 2012 tries to downgrade the share to not use share-safe; if it fails, aborts
2010 2013 ``downgrade-allow``
2011 2014 tries to downgrade the share to not use share-safe;
2012 2015 if it fails, continue by respecting the shared source setting
2013 2016
2014 2017 Check :hg:`help config format.use-share-safe` for details about the
2015 2018 share-safe feature.
2016 2019
2017 2020 ``safe-mismatch.source-not-safe.warn``
2018 2021 Shows a warning on operations if the shared repository uses share-safe,
2019 2022 but the source repository does not.
2020 2023 (default: True)
2021 2024
2022 2025 ``storage``
2023 2026 -----------
2024 2027
2025 2028 Control the strategy Mercurial uses internally to store history. Options in this
2026 2029 category impact performance and repository size.
2027 2030
2028 2031 ``revlog.optimize-delta-parent-choice``
2029 2032 When storing a merge revision, both parents will be equally considered as
2030 2033 a possible delta base. This results in better delta selection and improved
2031 2034 revlog compression. This option is enabled by default.
2032 2035
2033 2036 Turning this option off can result in large increase of repository size for
2034 2037 repository with many merges.
2035 2038
2036 2039 ``revlog.persistent-nodemap.mmap``
2037 2040 Whether to use the Operating System "memory mapping" feature (when
2038 2041 possible) to access the persistent nodemap data. This improve performance
2039 2042 and reduce memory pressure.
2040 2043
2041 2044 Default to True.
2042 2045
2043 2046 For details on the "persistent-nodemap" feature, see:
2044 2047 :hg:`help config format.use-persistent-nodemap`.
2045 2048
2046 2049 ``revlog.persistent-nodemap.slow-path``
2047 2050 Control the behavior of Merucrial when using a repository with "persistent"
2048 2051 nodemap with an installation of Mercurial without a fast implementation for
2049 2052 the feature:
2050 2053
2051 2054 ``allow``: Silently use the slower implementation to access the repository.
2052 2055 ``warn``: Warn, but use the slower implementation to access the repository.
2053 2056 ``abort``: Prevent access to such repositories. (This is the default)
2054 2057
2055 2058 For details on the "persistent-nodemap" feature, see:
2056 2059 :hg:`help config format.use-persistent-nodemap`.
2057 2060
2058 2061 ``revlog.reuse-external-delta-parent``
2059 2062 Control the order in which delta parents are considered when adding new
2060 2063 revisions from an external source.
2061 2064 (typically: apply bundle from `hg pull` or `hg push`).
2062 2065
2063 2066 New revisions are usually provided as a delta against other revisions. By
2064 2067 default, Mercurial will try to reuse this delta first, therefore using the
2065 2068 same "delta parent" as the source. Directly using delta's from the source
2066 2069 reduces CPU usage and usually speeds up operation. However, in some case,
2067 2070 the source might have sub-optimal delta bases and forcing their reevaluation
2068 2071 is useful. For example, pushes from an old client could have sub-optimal
2069 2072 delta's parent that the server want to optimize. (lack of general delta, bad
2070 2073 parents, choice, lack of sparse-revlog, etc).
2071 2074
2072 2075 This option is enabled by default. Turning it off will ensure bad delta
2073 2076 parent choices from older client do not propagate to this repository, at
2074 2077 the cost of a small increase in CPU consumption.
2075 2078
2076 2079 Note: this option only control the order in which delta parents are
2077 2080 considered. Even when disabled, the existing delta from the source will be
2078 2081 reused if the same delta parent is selected.
2079 2082
2080 2083 ``revlog.reuse-external-delta``
2081 2084 Control the reuse of delta from external source.
2082 2085 (typically: apply bundle from `hg pull` or `hg push`).
2083 2086
2084 2087 New revisions are usually provided as a delta against another revision. By
2085 2088 default, Mercurial will not recompute the same delta again, trusting
2086 2089 externally provided deltas. There have been rare cases of small adjustment
2087 2090 to the diffing algorithm in the past. So in some rare case, recomputing
2088 2091 delta provided by ancient clients can provides better results. Disabling
2089 2092 this option means going through a full delta recomputation for all incoming
2090 2093 revisions. It means a large increase in CPU usage and will slow operations
2091 2094 down.
2092 2095
2093 2096 This option is enabled by default. When disabled, it also disables the
2094 2097 related ``storage.revlog.reuse-external-delta-parent`` option.
2095 2098
2096 2099 ``revlog.zlib.level``
2097 2100 Zlib compression level used when storing data into the repository. Accepted
2098 2101 Value range from 1 (lowest compression) to 9 (highest compression). Zlib
2099 2102 default value is 6.
2100 2103
2101 2104
2102 2105 ``revlog.zstd.level``
2103 2106 zstd compression level used when storing data into the repository. Accepted
2104 2107 Value range from 1 (lowest compression) to 22 (highest compression).
2105 2108 (default 3)
2106 2109
2107 2110 ``server``
2108 2111 ----------
2109 2112
2110 2113 Controls generic server settings.
2111 2114
2112 2115 ``bookmarks-pushkey-compat``
2113 2116 Trigger pushkey hook when being pushed bookmark updates. This config exist
2114 2117 for compatibility purpose (default to True)
2115 2118
2116 2119 If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
2117 2120 movement we recommend you migrate them to ``txnclose-bookmark`` and
2118 2121 ``pretxnclose-bookmark``.
2119 2122
2120 2123 ``compressionengines``
2121 2124 List of compression engines and their relative priority to advertise
2122 2125 to clients.
2123 2126
2124 2127 The order of compression engines determines their priority, the first
2125 2128 having the highest priority. If a compression engine is not listed
2126 2129 here, it won't be advertised to clients.
2127 2130
2128 2131 If not set (the default), built-in defaults are used. Run
2129 2132 :hg:`debuginstall` to list available compression engines and their
2130 2133 default wire protocol priority.
2131 2134
2132 2135 Older Mercurial clients only support zlib compression and this setting
2133 2136 has no effect for legacy clients.
2134 2137
2135 2138 ``uncompressed``
2136 2139 Whether to allow clients to clone a repository using the
2137 2140 uncompressed streaming protocol. This transfers about 40% more
2138 2141 data than a regular clone, but uses less memory and CPU on both
2139 2142 server and client. Over a LAN (100 Mbps or better) or a very fast
2140 2143 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
2141 2144 regular clone. Over most WAN connections (anything slower than
2142 2145 about 6 Mbps), uncompressed streaming is slower, because of the
2143 2146 extra data transfer overhead. This mode will also temporarily hold
2144 2147 the write lock while determining what data to transfer.
2145 2148 (default: True)
2146 2149
2147 2150 ``uncompressedallowsecret``
2148 2151 Whether to allow stream clones when the repository contains secret
2149 2152 changesets. (default: False)
2150 2153
2151 2154 ``preferuncompressed``
2152 2155 When set, clients will try to use the uncompressed streaming
2153 2156 protocol. (default: False)
2154 2157
2155 2158 ``disablefullbundle``
2156 2159 When set, servers will refuse attempts to do pull-based clones.
2157 2160 If this option is set, ``preferuncompressed`` and/or clone bundles
2158 2161 are highly recommended. Partial clones will still be allowed.
2159 2162 (default: False)
2160 2163
2161 2164 ``streamunbundle``
2162 2165 When set, servers will apply data sent from the client directly,
2163 2166 otherwise it will be written to a temporary file first. This option
2164 2167 effectively prevents concurrent pushes.
2165 2168
2166 2169 ``pullbundle``
2167 2170 When set, the server will check pullbundle.manifest for bundles
2168 2171 covering the requested heads and common nodes. The first matching
2169 2172 entry will be streamed to the client.
2170 2173
2171 2174 For HTTP transport, the stream will still use zlib compression
2172 2175 for older clients.
2173 2176
2174 2177 ``concurrent-push-mode``
2175 2178 Level of allowed race condition between two pushing clients.
2176 2179
2177 2180 - 'strict': push is abort if another client touched the repository
2178 2181 while the push was preparing.
2179 2182 - 'check-related': push is only aborted if it affects head that got also
2180 2183 affected while the push was preparing. (default since 5.4)
2181 2184
2182 2185 'check-related' only takes effect for compatible clients (version
2183 2186 4.3 and later). Older clients will use 'strict'.
2184 2187
2185 2188 ``validate``
2186 2189 Whether to validate the completeness of pushed changesets by
2187 2190 checking that all new file revisions specified in manifests are
2188 2191 present. (default: False)
2189 2192
2190 2193 ``maxhttpheaderlen``
2191 2194 Instruct HTTP clients not to send request headers longer than this
2192 2195 many bytes. (default: 1024)
2193 2196
2194 2197 ``bundle1``
2195 2198 Whether to allow clients to push and pull using the legacy bundle1
2196 2199 exchange format. (default: True)
2197 2200
2198 2201 ``bundle1gd``
2199 2202 Like ``bundle1`` but only used if the repository is using the
2200 2203 *generaldelta* storage format. (default: True)
2201 2204
2202 2205 ``bundle1.push``
2203 2206 Whether to allow clients to push using the legacy bundle1 exchange
2204 2207 format. (default: True)
2205 2208
2206 2209 ``bundle1gd.push``
2207 2210 Like ``bundle1.push`` but only used if the repository is using the
2208 2211 *generaldelta* storage format. (default: True)
2209 2212
2210 2213 ``bundle1.pull``
2211 2214 Whether to allow clients to pull using the legacy bundle1 exchange
2212 2215 format. (default: True)
2213 2216
2214 2217 ``bundle1gd.pull``
2215 2218 Like ``bundle1.pull`` but only used if the repository is using the
2216 2219 *generaldelta* storage format. (default: True)
2217 2220
2218 2221 Large repositories using the *generaldelta* storage format should
2219 2222 consider setting this option because converting *generaldelta*
2220 2223 repositories to the exchange format required by the bundle1 data
2221 2224 format can consume a lot of CPU.
2222 2225
2223 2226 ``bundle2.stream``
2224 2227 Whether to allow clients to pull using the bundle2 streaming protocol.
2225 2228 (default: True)
2226 2229
2227 2230 ``zliblevel``
2228 2231 Integer between ``-1`` and ``9`` that controls the zlib compression level
2229 2232 for wire protocol commands that send zlib compressed output (notably the
2230 2233 commands that send repository history data).
2231 2234
2232 2235 The default (``-1``) uses the default zlib compression level, which is
2233 2236 likely equivalent to ``6``. ``0`` means no compression. ``9`` means
2234 2237 maximum compression.
2235 2238
2236 2239 Setting this option allows server operators to make trade-offs between
2237 2240 bandwidth and CPU used. Lowering the compression lowers CPU utilization
2238 2241 but sends more bytes to clients.
2239 2242
2240 2243 This option only impacts the HTTP server.
2241 2244
2242 2245 ``zstdlevel``
2243 2246 Integer between ``1`` and ``22`` that controls the zstd compression level
2244 2247 for wire protocol commands. ``1`` is the minimal amount of compression and
2245 2248 ``22`` is the highest amount of compression.
2246 2249
2247 2250 The default (``3``) should be significantly faster than zlib while likely
2248 2251 delivering better compression ratios.
2249 2252
2250 2253 This option only impacts the HTTP server.
2251 2254
2252 2255 See also ``server.zliblevel``.
2253 2256
2254 2257 ``view``
2255 2258 Repository filter used when exchanging revisions with the peer.
2256 2259
2257 2260 The default view (``served``) excludes secret and hidden changesets.
2258 2261 Another useful value is ``immutable`` (no draft, secret or hidden
2259 2262 changesets). (EXPERIMENTAL)
2260 2263
2261 2264 ``smtp``
2262 2265 --------
2263 2266
2264 2267 Configuration for extensions that need to send email messages.
2265 2268
2266 2269 ``host``
2267 2270 Host name of mail server, e.g. "mail.example.com".
2268 2271
2269 2272 ``port``
2270 2273 Optional. Port to connect to on mail server. (default: 465 if
2271 2274 ``tls`` is smtps; 25 otherwise)
2272 2275
2273 2276 ``tls``
2274 2277 Optional. Method to enable TLS when connecting to mail server: starttls,
2275 2278 smtps or none. (default: none)
2276 2279
2277 2280 ``username``
2278 2281 Optional. User name for authenticating with the SMTP server.
2279 2282 (default: None)
2280 2283
2281 2284 ``password``
2282 2285 Optional. Password for authenticating with the SMTP server. If not
2283 2286 specified, interactive sessions will prompt the user for a
2284 2287 password; non-interactive sessions will fail. (default: None)
2285 2288
2286 2289 ``local_hostname``
2287 2290 Optional. The hostname that the sender can use to identify
2288 2291 itself to the MTA.
2289 2292
2290 2293
2291 2294 ``subpaths``
2292 2295 ------------
2293 2296
2294 2297 Subrepository source URLs can go stale if a remote server changes name
2295 2298 or becomes temporarily unavailable. This section lets you define
2296 2299 rewrite rules of the form::
2297 2300
2298 2301 <pattern> = <replacement>
2299 2302
2300 2303 where ``pattern`` is a regular expression matching a subrepository
2301 2304 source URL and ``replacement`` is the replacement string used to
2302 2305 rewrite it. Groups can be matched in ``pattern`` and referenced in
2303 2306 ``replacements``. For instance::
2304 2307
2305 2308 http://server/(.*)-hg/ = http://hg.server/\1/
2306 2309
2307 2310 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
2308 2311
2309 2312 Relative subrepository paths are first made absolute, and the
2310 2313 rewrite rules are then applied on the full (absolute) path. If ``pattern``
2311 2314 doesn't match the full path, an attempt is made to apply it on the
2312 2315 relative path alone. The rules are applied in definition order.
2313 2316
2314 2317 ``subrepos``
2315 2318 ------------
2316 2319
2317 2320 This section contains options that control the behavior of the
2318 2321 subrepositories feature. See also :hg:`help subrepos`.
2319 2322
2320 2323 Security note: auditing in Mercurial is known to be insufficient to
2321 2324 prevent clone-time code execution with carefully constructed Git
2322 2325 subrepos. It is unknown if a similar detect is present in Subversion
2323 2326 subrepos. Both Git and Subversion subrepos are disabled by default
2324 2327 out of security concerns. These subrepo types can be enabled using
2325 2328 the respective options below.
2326 2329
2327 2330 ``allowed``
2328 2331 Whether subrepositories are allowed in the working directory.
2329 2332
2330 2333 When false, commands involving subrepositories (like :hg:`update`)
2331 2334 will fail for all subrepository types.
2332 2335 (default: true)
2333 2336
2334 2337 ``hg:allowed``
2335 2338 Whether Mercurial subrepositories are allowed in the working
2336 2339 directory. This option only has an effect if ``subrepos.allowed``
2337 2340 is true.
2338 2341 (default: true)
2339 2342
2340 2343 ``git:allowed``
2341 2344 Whether Git subrepositories are allowed in the working directory.
2342 2345 This option only has an effect if ``subrepos.allowed`` is true.
2343 2346
2344 2347 See the security note above before enabling Git subrepos.
2345 2348 (default: false)
2346 2349
2347 2350 ``svn:allowed``
2348 2351 Whether Subversion subrepositories are allowed in the working
2349 2352 directory. This option only has an effect if ``subrepos.allowed``
2350 2353 is true.
2351 2354
2352 2355 See the security note above before enabling Subversion subrepos.
2353 2356 (default: false)
2354 2357
2355 2358 ``templatealias``
2356 2359 -----------------
2357 2360
2358 2361 Alias definitions for templates. See :hg:`help templates` for details.
2359 2362
2360 2363 ``templates``
2361 2364 -------------
2362 2365
2363 2366 Use the ``[templates]`` section to define template strings.
2364 2367 See :hg:`help templates` for details.
2365 2368
2366 2369 ``trusted``
2367 2370 -----------
2368 2371
2369 2372 Mercurial will not use the settings in the
2370 2373 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
2371 2374 user or to a trusted group, as various hgrc features allow arbitrary
2372 2375 commands to be run. This issue is often encountered when configuring
2373 2376 hooks or extensions for shared repositories or servers. However,
2374 2377 the web interface will use some safe settings from the ``[web]``
2375 2378 section.
2376 2379
2377 2380 This section specifies what users and groups are trusted. The
2378 2381 current user is always trusted. To trust everybody, list a user or a
2379 2382 group with name ``*``. These settings must be placed in an
2380 2383 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
2381 2384 user or service running Mercurial.
2382 2385
2383 2386 ``users``
2384 2387 Comma-separated list of trusted users.
2385 2388
2386 2389 ``groups``
2387 2390 Comma-separated list of trusted groups.
2388 2391
2389 2392
2390 2393 ``ui``
2391 2394 ------
2392 2395
2393 2396 User interface controls.
2394 2397
2395 2398 ``archivemeta``
2396 2399 Whether to include the .hg_archival.txt file containing meta data
2397 2400 (hashes for the repository base and for tip) in archives created
2398 2401 by the :hg:`archive` command or downloaded via hgweb.
2399 2402 (default: True)
2400 2403
2401 2404 ``askusername``
2402 2405 Whether to prompt for a username when committing. If True, and
2403 2406 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
2404 2407 be prompted to enter a username. If no username is entered, the
2405 2408 default ``USER@HOST`` is used instead.
2406 2409 (default: False)
2407 2410
2408 2411 ``clonebundles``
2409 2412 Whether the "clone bundles" feature is enabled.
2410 2413
2411 2414 When enabled, :hg:`clone` may download and apply a server-advertised
2412 2415 bundle file from a URL instead of using the normal exchange mechanism.
2413 2416
2414 2417 This can likely result in faster and more reliable clones.
2415 2418
2416 2419 (default: True)
2417 2420
2418 2421 ``clonebundlefallback``
2419 2422 Whether failure to apply an advertised "clone bundle" from a server
2420 2423 should result in fallback to a regular clone.
2421 2424
2422 2425 This is disabled by default because servers advertising "clone
2423 2426 bundles" often do so to reduce server load. If advertised bundles
2424 2427 start mass failing and clients automatically fall back to a regular
2425 2428 clone, this would add significant and unexpected load to the server
2426 2429 since the server is expecting clone operations to be offloaded to
2427 2430 pre-generated bundles. Failing fast (the default behavior) ensures
2428 2431 clients don't overwhelm the server when "clone bundle" application
2429 2432 fails.
2430 2433
2431 2434 (default: False)
2432 2435
2433 2436 ``clonebundleprefers``
2434 2437 Defines preferences for which "clone bundles" to use.
2435 2438
2436 2439 Servers advertising "clone bundles" may advertise multiple available
2437 2440 bundles. Each bundle may have different attributes, such as the bundle
2438 2441 type and compression format. This option is used to prefer a particular
2439 2442 bundle over another.
2440 2443
2441 2444 The following keys are defined by Mercurial:
2442 2445
2443 2446 BUNDLESPEC
2444 2447 A bundle type specifier. These are strings passed to :hg:`bundle -t`.
2445 2448 e.g. ``gzip-v2`` or ``bzip2-v1``.
2446 2449
2447 2450 COMPRESSION
2448 2451 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
2449 2452
2450 2453 Server operators may define custom keys.
2451 2454
2452 2455 Example values: ``COMPRESSION=bzip2``,
2453 2456 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
2454 2457
2455 2458 By default, the first bundle advertised by the server is used.
2456 2459
2457 2460 ``color``
2458 2461 When to colorize output. Possible value are Boolean ("yes" or "no"), or
2459 2462 "debug", or "always". (default: "yes"). "yes" will use color whenever it
2460 2463 seems possible. See :hg:`help color` for details.
2461 2464
2462 2465 ``commitsubrepos``
2463 2466 Whether to commit modified subrepositories when committing the
2464 2467 parent repository. If False and one subrepository has uncommitted
2465 2468 changes, abort the commit.
2466 2469 (default: False)
2467 2470
2468 2471 ``debug``
2469 2472 Print debugging information. (default: False)
2470 2473
2471 2474 ``editor``
2472 2475 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
2473 2476
2474 2477 ``fallbackencoding``
2475 2478 Encoding to try if it's not possible to decode the changelog using
2476 2479 UTF-8. (default: ISO-8859-1)
2477 2480
2478 2481 ``graphnodetemplate``
2479 2482 (DEPRECATED) Use ``command-templates.graphnode`` instead.
2480 2483
2481 2484 ``ignore``
2482 2485 A file to read per-user ignore patterns from. This file should be
2483 2486 in the same format as a repository-wide .hgignore file. Filenames
2484 2487 are relative to the repository root. This option supports hook syntax,
2485 2488 so if you want to specify multiple ignore files, you can do so by
2486 2489 setting something like ``ignore.other = ~/.hgignore2``. For details
2487 2490 of the ignore file format, see the ``hgignore(5)`` man page.
2488 2491
2489 2492 ``interactive``
2490 2493 Allow to prompt the user. (default: True)
2491 2494
2492 2495 ``interface``
2493 2496 Select the default interface for interactive features (default: text).
2494 2497 Possible values are 'text' and 'curses'.
2495 2498
2496 2499 ``interface.chunkselector``
2497 2500 Select the interface for change recording (e.g. :hg:`commit -i`).
2498 2501 Possible values are 'text' and 'curses'.
2499 2502 This config overrides the interface specified by ui.interface.
2500 2503
2501 2504 ``large-file-limit``
2502 2505 Largest file size that gives no memory use warning.
2503 2506 Possible values are integers or 0 to disable the check.
2504 2507 (default: 10000000)
2505 2508
2506 2509 ``logtemplate``
2507 2510 (DEPRECATED) Use ``command-templates.log`` instead.
2508 2511
2509 2512 ``merge``
2510 2513 The conflict resolution program to use during a manual merge.
2511 2514 For more information on merge tools see :hg:`help merge-tools`.
2512 2515 For configuring merge tools see the ``[merge-tools]`` section.
2513 2516
2514 2517 ``mergemarkers``
2515 2518 Sets the merge conflict marker label styling. The ``detailed`` style
2516 2519 uses the ``command-templates.mergemarker`` setting to style the labels.
2517 2520 The ``basic`` style just uses 'local' and 'other' as the marker label.
2518 2521 One of ``basic`` or ``detailed``.
2519 2522 (default: ``basic``)
2520 2523
2521 2524 ``mergemarkertemplate``
2522 2525 (DEPRECATED) Use ``command-templates.mergemarker`` instead.
2523 2526
2524 2527 ``message-output``
2525 2528 Where to write status and error messages. (default: ``stdio``)
2526 2529
2527 2530 ``channel``
2528 2531 Use separate channel for structured output. (Command-server only)
2529 2532 ``stderr``
2530 2533 Everything to stderr.
2531 2534 ``stdio``
2532 2535 Status to stdout, and error to stderr.
2533 2536
2534 2537 ``origbackuppath``
2535 2538 The path to a directory used to store generated .orig files. If the path is
2536 2539 not a directory, one will be created. If set, files stored in this
2537 2540 directory have the same name as the original file and do not have a .orig
2538 2541 suffix.
2539 2542
2540 2543 ``paginate``
2541 2544 Control the pagination of command output (default: True). See :hg:`help pager`
2542 2545 for details.
2543 2546
2544 2547 ``patch``
2545 2548 An optional external tool that ``hg import`` and some extensions
2546 2549 will use for applying patches. By default Mercurial uses an
2547 2550 internal patch utility. The external tool must work as the common
2548 2551 Unix ``patch`` program. In particular, it must accept a ``-p``
2549 2552 argument to strip patch headers, a ``-d`` argument to specify the
2550 2553 current directory, a file name to patch, and a patch file to take
2551 2554 from stdin.
2552 2555
2553 2556 It is possible to specify a patch tool together with extra
2554 2557 arguments. For example, setting this option to ``patch --merge``
2555 2558 will use the ``patch`` program with its 2-way merge option.
2556 2559
2557 2560 ``portablefilenames``
2558 2561 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
2559 2562 (default: ``warn``)
2560 2563
2561 2564 ``warn``
2562 2565 Print a warning message on POSIX platforms, if a file with a non-portable
2563 2566 filename is added (e.g. a file with a name that can't be created on
2564 2567 Windows because it contains reserved parts like ``AUX``, reserved
2565 2568 characters like ``:``, or would cause a case collision with an existing
2566 2569 file).
2567 2570
2568 2571 ``ignore``
2569 2572 Don't print a warning.
2570 2573
2571 2574 ``abort``
2572 2575 The command is aborted.
2573 2576
2574 2577 ``true``
2575 2578 Alias for ``warn``.
2576 2579
2577 2580 ``false``
2578 2581 Alias for ``ignore``.
2579 2582
2580 2583 .. container:: windows
2581 2584
2582 2585 On Windows, this configuration option is ignored and the command aborted.
2583 2586
2584 2587 ``pre-merge-tool-output-template``
2585 2588 (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead.
2586 2589
2587 2590 ``quiet``
2588 2591 Reduce the amount of output printed.
2589 2592 (default: False)
2590 2593
2591 2594 ``relative-paths``
2592 2595 Prefer relative paths in the UI.
2593 2596
2594 2597 ``remotecmd``
2595 2598 Remote command to use for clone/push/pull operations.
2596 2599 (default: ``hg``)
2597 2600
2598 2601 ``report_untrusted``
2599 2602 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
2600 2603 trusted user or group.
2601 2604 (default: True)
2602 2605
2603 2606 ``slash``
2604 2607 (Deprecated. Use ``slashpath`` template filter instead.)
2605 2608
2606 2609 Display paths using a slash (``/``) as the path separator. This
2607 2610 only makes a difference on systems where the default path
2608 2611 separator is not the slash character (e.g. Windows uses the
2609 2612 backslash character (``\``)).
2610 2613 (default: False)
2611 2614
2612 2615 ``statuscopies``
2613 2616 Display copies in the status command.
2614 2617
2615 2618 ``ssh``
2616 2619 Command to use for SSH connections. (default: ``ssh``)
2617 2620
2618 2621 ``ssherrorhint``
2619 2622 A hint shown to the user in the case of SSH error (e.g.
2620 2623 ``Please see http://company/internalwiki/ssh.html``)
2621 2624
2622 2625 ``strict``
2623 2626 Require exact command names, instead of allowing unambiguous
2624 2627 abbreviations. (default: False)
2625 2628
2626 2629 ``style``
2627 2630 Name of style to use for command output.
2628 2631
2629 2632 ``supportcontact``
2630 2633 A URL where users should report a Mercurial traceback. Use this if you are a
2631 2634 large organisation with its own Mercurial deployment process and crash
2632 2635 reports should be addressed to your internal support.
2633 2636
2634 2637 ``textwidth``
2635 2638 Maximum width of help text. A longer line generated by ``hg help`` or
2636 2639 ``hg subcommand --help`` will be broken after white space to get this
2637 2640 width or the terminal width, whichever comes first.
2638 2641 A non-positive value will disable this and the terminal width will be
2639 2642 used. (default: 78)
2640 2643
2641 2644 ``timeout``
2642 2645 The timeout used when a lock is held (in seconds), a negative value
2643 2646 means no timeout. (default: 600)
2644 2647
2645 2648 ``timeout.warn``
2646 2649 Time (in seconds) before a warning is printed about held lock. A negative
2647 2650 value means no warning. (default: 0)
2648 2651
2649 2652 ``traceback``
2650 2653 Mercurial always prints a traceback when an unknown exception
2651 2654 occurs. Setting this to True will make Mercurial print a traceback
2652 2655 on all exceptions, even those recognized by Mercurial (such as
2653 2656 IOError or MemoryError). (default: False)
2654 2657
2655 2658 ``tweakdefaults``
2656 2659
2657 2660 By default Mercurial's behavior changes very little from release
2658 2661 to release, but over time the recommended config settings
2659 2662 shift. Enable this config to opt in to get automatic tweaks to
2660 2663 Mercurial's behavior over time. This config setting will have no
2661 2664 effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
2662 2665 not include ``tweakdefaults``. (default: False)
2663 2666
2664 2667 It currently means::
2665 2668
2666 2669 .. tweakdefaultsmarker
2667 2670
2668 2671 ``username``
2669 2672 The committer of a changeset created when running "commit".
2670 2673 Typically a person's name and email address, e.g. ``Fred Widget
2671 2674 <fred@example.com>``. Environment variables in the
2672 2675 username are expanded.
2673 2676
2674 2677 (default: ``$EMAIL`` or ``username@hostname``. If the username in
2675 2678 hgrc is empty, e.g. if the system admin set ``username =`` in the
2676 2679 system hgrc, it has to be specified manually or in a different
2677 2680 hgrc file)
2678 2681
2679 2682 ``verbose``
2680 2683 Increase the amount of output printed. (default: False)
2681 2684
2682 2685
2683 2686 ``command-templates``
2684 2687 ---------------------
2685 2688
2686 2689 Templates used for customizing the output of commands.
2687 2690
2688 2691 ``graphnode``
2689 2692 The template used to print changeset nodes in an ASCII revision graph.
2690 2693 (default: ``{graphnode}``)
2691 2694
2692 2695 ``log``
2693 2696 Template string for commands that print changesets.
2694 2697
2695 2698 ``mergemarker``
2696 2699 The template used to print the commit description next to each conflict
2697 2700 marker during merge conflicts. See :hg:`help templates` for the template
2698 2701 format.
2699 2702
2700 2703 Defaults to showing the hash, tags, branches, bookmarks, author, and
2701 2704 the first line of the commit description.
2702 2705
2703 2706 If you use non-ASCII characters in names for tags, branches, bookmarks,
2704 2707 authors, and/or commit descriptions, you must pay attention to encodings of
2705 2708 managed files. At template expansion, non-ASCII characters use the encoding
2706 2709 specified by the ``--encoding`` global option, ``HGENCODING`` or other
2707 2710 environment variables that govern your locale. If the encoding of the merge
2708 2711 markers is different from the encoding of the merged files,
2709 2712 serious problems may occur.
2710 2713
2711 2714 Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
2712 2715
2713 2716 ``oneline-summary``
2714 2717 A template used by `hg rebase` and other commands for showing a one-line
2715 2718 summary of a commit. If the template configured here is longer than one
2716 2719 line, then only the first line is used.
2717 2720
2718 2721 The template can be overridden per command by defining a template in
2719 2722 `oneline-summary.<command>`, where `<command>` can be e.g. "rebase".
2720 2723
2721 2724 ``pre-merge-tool-output``
2722 2725 A template that is printed before executing an external merge tool. This can
2723 2726 be used to print out additional context that might be useful to have during
2724 2727 the conflict resolution, such as the description of the various commits
2725 2728 involved or bookmarks/tags.
2726 2729
2727 2730 Additional information is available in the ``local`, ``base``, and ``other``
2728 2731 dicts. For example: ``{local.label}``, ``{base.name}``, or
2729 2732 ``{other.islink}``.
2730 2733
2731 2734
2732 2735 ``web``
2733 2736 -------
2734 2737
2735 2738 Web interface configuration. The settings in this section apply to
2736 2739 both the builtin webserver (started by :hg:`serve`) and the script you
2737 2740 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
2738 2741 and WSGI).
2739 2742
2740 2743 The Mercurial webserver does no authentication (it does not prompt for
2741 2744 usernames and passwords to validate *who* users are), but it does do
2742 2745 authorization (it grants or denies access for *authenticated users*
2743 2746 based on settings in this section). You must either configure your
2744 2747 webserver to do authentication for you, or disable the authorization
2745 2748 checks.
2746 2749
2747 2750 For a quick setup in a trusted environment, e.g., a private LAN, where
2748 2751 you want it to accept pushes from anybody, you can use the following
2749 2752 command line::
2750 2753
2751 2754 $ hg --config web.allow-push=* --config web.push_ssl=False serve
2752 2755
2753 2756 Note that this will allow anybody to push anything to the server and
2754 2757 that this should not be used for public servers.
2755 2758
2756 2759 The full set of options is:
2757 2760
2758 2761 ``accesslog``
2759 2762 Where to output the access log. (default: stdout)
2760 2763
2761 2764 ``address``
2762 2765 Interface address to bind to. (default: all)
2763 2766
2764 2767 ``allow-archive``
2765 2768 List of archive format (bz2, gz, zip) allowed for downloading.
2766 2769 (default: empty)
2767 2770
2768 2771 ``allowbz2``
2769 2772 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
2770 2773 revisions.
2771 2774 (default: False)
2772 2775
2773 2776 ``allowgz``
2774 2777 (DEPRECATED) Whether to allow .tar.gz downloading of repository
2775 2778 revisions.
2776 2779 (default: False)
2777 2780
2778 2781 ``allow-pull``
2779 2782 Whether to allow pulling from the repository. (default: True)
2780 2783
2781 2784 ``allow-push``
2782 2785 Whether to allow pushing to the repository. If empty or not set,
2783 2786 pushing is not allowed. If the special value ``*``, any remote
2784 2787 user can push, including unauthenticated users. Otherwise, the
2785 2788 remote user must have been authenticated, and the authenticated
2786 2789 user name must be present in this list. The contents of the
2787 2790 allow-push list are examined after the deny_push list.
2788 2791
2789 2792 ``allow_read``
2790 2793 If the user has not already been denied repository access due to
2791 2794 the contents of deny_read, this list determines whether to grant
2792 2795 repository access to the user. If this list is not empty, and the
2793 2796 user is unauthenticated or not present in the list, then access is
2794 2797 denied for the user. If the list is empty or not set, then access
2795 2798 is permitted to all users by default. Setting allow_read to the
2796 2799 special value ``*`` is equivalent to it not being set (i.e. access
2797 2800 is permitted to all users). The contents of the allow_read list are
2798 2801 examined after the deny_read list.
2799 2802
2800 2803 ``allowzip``
2801 2804 (DEPRECATED) Whether to allow .zip downloading of repository
2802 2805 revisions. This feature creates temporary files.
2803 2806 (default: False)
2804 2807
2805 2808 ``archivesubrepos``
2806 2809 Whether to recurse into subrepositories when archiving.
2807 2810 (default: False)
2808 2811
2809 2812 ``baseurl``
2810 2813 Base URL to use when publishing URLs in other locations, so
2811 2814 third-party tools like email notification hooks can construct
2812 2815 URLs. Example: ``http://hgserver/repos/``.
2813 2816
2814 2817 ``cacerts``
2815 2818 Path to file containing a list of PEM encoded certificate
2816 2819 authority certificates. Environment variables and ``~user``
2817 2820 constructs are expanded in the filename. If specified on the
2818 2821 client, then it will verify the identity of remote HTTPS servers
2819 2822 with these certificates.
2820 2823
2821 2824 To disable SSL verification temporarily, specify ``--insecure`` from
2822 2825 command line.
2823 2826
2824 2827 You can use OpenSSL's CA certificate file if your platform has
2825 2828 one. On most Linux systems this will be
2826 2829 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
2827 2830 generate this file manually. The form must be as follows::
2828 2831
2829 2832 -----BEGIN CERTIFICATE-----
2830 2833 ... (certificate in base64 PEM encoding) ...
2831 2834 -----END CERTIFICATE-----
2832 2835 -----BEGIN CERTIFICATE-----
2833 2836 ... (certificate in base64 PEM encoding) ...
2834 2837 -----END CERTIFICATE-----
2835 2838
2836 2839 ``cache``
2837 2840 Whether to support caching in hgweb. (default: True)
2838 2841
2839 2842 ``certificate``
2840 2843 Certificate to use when running :hg:`serve`.
2841 2844
2842 2845 ``collapse``
2843 2846 With ``descend`` enabled, repositories in subdirectories are shown at
2844 2847 a single level alongside repositories in the current path. With
2845 2848 ``collapse`` also enabled, repositories residing at a deeper level than
2846 2849 the current path are grouped behind navigable directory entries that
2847 2850 lead to the locations of these repositories. In effect, this setting
2848 2851 collapses each collection of repositories found within a subdirectory
2849 2852 into a single entry for that subdirectory. (default: False)
2850 2853
2851 2854 ``comparisoncontext``
2852 2855 Number of lines of context to show in side-by-side file comparison. If
2853 2856 negative or the value ``full``, whole files are shown. (default: 5)
2854 2857
2855 2858 This setting can be overridden by a ``context`` request parameter to the
2856 2859 ``comparison`` command, taking the same values.
2857 2860
2858 2861 ``contact``
2859 2862 Name or email address of the person in charge of the repository.
2860 2863 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
2861 2864
2862 2865 ``csp``
2863 2866 Send a ``Content-Security-Policy`` HTTP header with this value.
2864 2867
2865 2868 The value may contain a special string ``%nonce%``, which will be replaced
2866 2869 by a randomly-generated one-time use value. If the value contains
2867 2870 ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
2868 2871 one-time property of the nonce. This nonce will also be inserted into
2869 2872 ``<script>`` elements containing inline JavaScript.
2870 2873
2871 2874 Note: lots of HTML content sent by the server is derived from repository
2872 2875 data. Please consider the potential for malicious repository data to
2873 2876 "inject" itself into generated HTML content as part of your security
2874 2877 threat model.
2875 2878
2876 2879 ``deny_push``
2877 2880 Whether to deny pushing to the repository. If empty or not set,
2878 2881 push is not denied. If the special value ``*``, all remote users are
2879 2882 denied push. Otherwise, unauthenticated users are all denied, and
2880 2883 any authenticated user name present in this list is also denied. The
2881 2884 contents of the deny_push list are examined before the allow-push list.
2882 2885
2883 2886 ``deny_read``
2884 2887 Whether to deny reading/viewing of the repository. If this list is
2885 2888 not empty, unauthenticated users are all denied, and any
2886 2889 authenticated user name present in this list is also denied access to
2887 2890 the repository. If set to the special value ``*``, all remote users
2888 2891 are denied access (rarely needed ;). If deny_read is empty or not set,
2889 2892 the determination of repository access depends on the presence and
2890 2893 content of the allow_read list (see description). If both
2891 2894 deny_read and allow_read are empty or not set, then access is
2892 2895 permitted to all users by default. If the repository is being
2893 2896 served via hgwebdir, denied users will not be able to see it in
2894 2897 the list of repositories. The contents of the deny_read list have
2895 2898 priority over (are examined before) the contents of the allow_read
2896 2899 list.
2897 2900
2898 2901 ``descend``
2899 2902 hgwebdir indexes will not descend into subdirectories. Only repositories
2900 2903 directly in the current path will be shown (other repositories are still
2901 2904 available from the index corresponding to their containing path).
2902 2905
2903 2906 ``description``
2904 2907 Textual description of the repository's purpose or contents.
2905 2908 (default: "unknown")
2906 2909
2907 2910 ``encoding``
2908 2911 Character encoding name. (default: the current locale charset)
2909 2912 Example: "UTF-8".
2910 2913
2911 2914 ``errorlog``
2912 2915 Where to output the error log. (default: stderr)
2913 2916
2914 2917 ``guessmime``
2915 2918 Control MIME types for raw download of file content.
2916 2919 Set to True to let hgweb guess the content type from the file
2917 2920 extension. This will serve HTML files as ``text/html`` and might
2918 2921 allow cross-site scripting attacks when serving untrusted
2919 2922 repositories. (default: False)
2920 2923
2921 2924 ``hidden``
2922 2925 Whether to hide the repository in the hgwebdir index.
2923 2926 (default: False)
2924 2927
2925 2928 ``ipv6``
2926 2929 Whether to use IPv6. (default: False)
2927 2930
2928 2931 ``labels``
2929 2932 List of string *labels* associated with the repository.
2930 2933
2931 2934 Labels are exposed as a template keyword and can be used to customize
2932 2935 output. e.g. the ``index`` template can group or filter repositories
2933 2936 by labels and the ``summary`` template can display additional content
2934 2937 if a specific label is present.
2935 2938
2936 2939 ``logoimg``
2937 2940 File name of the logo image that some templates display on each page.
2938 2941 The file name is relative to ``staticurl``. That is, the full path to
2939 2942 the logo image is "staticurl/logoimg".
2940 2943 If unset, ``hglogo.png`` will be used.
2941 2944
2942 2945 ``logourl``
2943 2946 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
2944 2947 will be used.
2945 2948
2946 2949 ``maxchanges``
2947 2950 Maximum number of changes to list on the changelog. (default: 10)
2948 2951
2949 2952 ``maxfiles``
2950 2953 Maximum number of files to list per changeset. (default: 10)
2951 2954
2952 2955 ``maxshortchanges``
2953 2956 Maximum number of changes to list on the shortlog, graph or filelog
2954 2957 pages. (default: 60)
2955 2958
2956 2959 ``name``
2957 2960 Repository name to use in the web interface.
2958 2961 (default: current working directory)
2959 2962
2960 2963 ``port``
2961 2964 Port to listen on. (default: 8000)
2962 2965
2963 2966 ``prefix``
2964 2967 Prefix path to serve from. (default: '' (server root))
2965 2968
2966 2969 ``push_ssl``
2967 2970 Whether to require that inbound pushes be transported over SSL to
2968 2971 prevent password sniffing. (default: True)
2969 2972
2970 2973 ``refreshinterval``
2971 2974 How frequently directory listings re-scan the filesystem for new
2972 2975 repositories, in seconds. This is relevant when wildcards are used
2973 2976 to define paths. Depending on how much filesystem traversal is
2974 2977 required, refreshing may negatively impact performance.
2975 2978
2976 2979 Values less than or equal to 0 always refresh.
2977 2980 (default: 20)
2978 2981
2979 2982 ``server-header``
2980 2983 Value for HTTP ``Server`` response header.
2981 2984
2982 2985 ``static``
2983 2986 Directory where static files are served from.
2984 2987
2985 2988 ``staticurl``
2986 2989 Base URL to use for static files. If unset, static files (e.g. the
2987 2990 hgicon.png favicon) will be served by the CGI script itself. Use
2988 2991 this setting to serve them directly with the HTTP server.
2989 2992 Example: ``http://hgserver/static/``.
2990 2993
2991 2994 ``stripes``
2992 2995 How many lines a "zebra stripe" should span in multi-line output.
2993 2996 Set to 0 to disable. (default: 1)
2994 2997
2995 2998 ``style``
2996 2999 Which template map style to use. The available options are the names of
2997 3000 subdirectories in the HTML templates path. (default: ``paper``)
2998 3001 Example: ``monoblue``.
2999 3002
3000 3003 ``templates``
3001 3004 Where to find the HTML templates. The default path to the HTML templates
3002 3005 can be obtained from ``hg debuginstall``.
3003 3006
3004 3007 ``websub``
3005 3008 ----------
3006 3009
3007 3010 Web substitution filter definition. You can use this section to
3008 3011 define a set of regular expression substitution patterns which
3009 3012 let you automatically modify the hgweb server output.
3010 3013
3011 3014 The default hgweb templates only apply these substitution patterns
3012 3015 on the revision description fields. You can apply them anywhere
3013 3016 you want when you create your own templates by adding calls to the
3014 3017 "websub" filter (usually after calling the "escape" filter).
3015 3018
3016 3019 This can be used, for example, to convert issue references to links
3017 3020 to your issue tracker, or to convert "markdown-like" syntax into
3018 3021 HTML (see the examples below).
3019 3022
3020 3023 Each entry in this section names a substitution filter.
3021 3024 The value of each entry defines the substitution expression itself.
3022 3025 The websub expressions follow the old interhg extension syntax,
3023 3026 which in turn imitates the Unix sed replacement syntax::
3024 3027
3025 3028 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
3026 3029
3027 3030 You can use any separator other than "/". The final "i" is optional
3028 3031 and indicates that the search must be case insensitive.
3029 3032
3030 3033 Examples::
3031 3034
3032 3035 [websub]
3033 3036 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
3034 3037 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
3035 3038 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
3036 3039
3037 3040 ``worker``
3038 3041 ----------
3039 3042
3040 3043 Parallel master/worker configuration. We currently perform working
3041 3044 directory updates in parallel on Unix-like systems, which greatly
3042 3045 helps performance.
3043 3046
3044 3047 ``enabled``
3045 3048 Whether to enable workers code to be used.
3046 3049 (default: true)
3047 3050
3048 3051 ``numcpus``
3049 3052 Number of CPUs to use for parallel operations. A zero or
3050 3053 negative value is treated as ``use the default``.
3051 3054 (default: 4 or the number of CPUs on the system, whichever is larger)
3052 3055
3053 3056 ``backgroundclose``
3054 3057 Whether to enable closing file handles on background threads during certain
3055 3058 operations. Some platforms aren't very efficient at closing file
3056 3059 handles that have been written or appended to. By performing file closing
3057 3060 on background threads, file write rate can increase substantially.
3058 3061 (default: true on Windows, false elsewhere)
3059 3062
3060 3063 ``backgroundcloseminfilecount``
3061 3064 Minimum number of files required to trigger background file closing.
3062 3065 Operations not writing this many files won't start background close
3063 3066 threads.
3064 3067 (default: 2048)
3065 3068
3066 3069 ``backgroundclosemaxqueue``
3067 3070 The maximum number of opened file handles waiting to be closed in the
3068 3071 background. This option only has an effect if ``backgroundclose`` is
3069 3072 enabled.
3070 3073 (default: 384)
3071 3074
3072 3075 ``backgroundclosethreadcount``
3073 3076 Number of threads to process background file closes. Only relevant if
3074 3077 ``backgroundclose`` is enabled.
3075 3078 (default: 4)
@@ -1,66 +1,76 b''
1 1 Valid URLs are of the form::
2 2
3 3 local/filesystem/path[#revision]
4 4 file://local/filesystem/path[#revision]
5 5 http://[user[:pass]@]host[:port]/[path][#revision]
6 6 https://[user[:pass]@]host[:port]/[path][#revision]
7 7 ssh://[user@]host[:port]/[path][#revision]
8 path://pathname
8 9
9 10 Paths in the local filesystem can either point to Mercurial
10 11 repositories or to bundle files (as created by :hg:`bundle` or
11 12 :hg:`incoming --bundle`). See also :hg:`help paths`.
12 13
13 14 An optional identifier after # indicates a particular branch, tag, or
14 15 changeset to use from the remote repository. See also :hg:`help
15 16 revisions`.
16 17
17 18 Some features, such as pushing to http:// and https:// URLs are only
18 19 possible if the feature is explicitly enabled on the remote Mercurial
19 20 server.
20 21
21 22 Note that the security of HTTPS URLs depends on proper configuration of
22 23 web.cacerts.
23 24
24 25 Some notes about using SSH with Mercurial:
25 26
26 27 - SSH requires an accessible shell account on the destination machine
27 28 and a copy of hg in the remote path or specified with remotecmd.
28 29 - path is relative to the remote user's home directory by default. Use
29 30 an extra slash at the start of a path to specify an absolute path::
30 31
31 32 ssh://example.com//tmp/repository
32 33
33 34 - Mercurial doesn't use its own compression via SSH; the right thing
34 35 to do is to configure it in your ~/.ssh/config, e.g.::
35 36
36 37 Host *.mylocalnetwork.example.com
37 38 Compression no
38 39 Host *
39 40 Compression yes
40 41
41 42 Alternatively specify "ssh -C" as your ssh command in your
42 43 configuration file or with the --ssh command line option.
43 44
44 45 These URLs can all be stored in your configuration file with path
45 46 aliases under the [paths] section like so::
46 47
47 48 [paths]
48 49 alias1 = URL1
49 50 alias2 = URL2
50 51 ...
51 52
52 53 You can then use the alias for any command that uses a URL (for
53 54 example :hg:`pull alias1` will be treated as :hg:`pull URL1`).
54 55
55 56 Two path aliases are special because they are used as defaults when
56 57 you do not provide the URL to a command:
57 58
58 59 default:
59 60 When you create a repository with hg clone, the clone command saves
60 61 the location of the source repository as the new repository's
61 62 'default' path. This is then used when you omit path from push- and
62 63 pull-like commands (including incoming and outgoing).
63 64
64 65 default-push:
65 66 The push command will look for a path named 'default-push', and
66 67 prefer it over 'default' if both are defined.
68
69 These alias can also be use in the `path://` scheme::
70
71 [paths]
72 alias1 = URL1
73 alias2 = path://alias1
74 ...
75
76 check :hg:`help config.paths` for details about the behavior of such "sub-path".
@@ -1,3944 +1,3947 b''
1 1 Short help:
2 2
3 3 $ hg
4 4 Mercurial Distributed SCM
5 5
6 6 basic commands:
7 7
8 8 add add the specified files on the next commit
9 9 annotate show changeset information by line for each file
10 10 clone make a copy of an existing repository
11 11 commit commit the specified files or all outstanding changes
12 12 diff diff repository (or selected files)
13 13 export dump the header and diffs for one or more changesets
14 14 forget forget the specified files on the next commit
15 15 init create a new repository in the given directory
16 16 log show revision history of entire repository or files
17 17 merge merge another revision into working directory
18 18 pull pull changes from the specified source
19 19 push push changes to the specified destination
20 20 remove remove the specified files on the next commit
21 21 serve start stand-alone webserver
22 22 status show changed files in the working directory
23 23 summary summarize working directory state
24 24 update update working directory (or switch revisions)
25 25
26 26 (use 'hg help' for the full list of commands or 'hg -v' for details)
27 27
28 28 $ hg -q
29 29 add add the specified files on the next commit
30 30 annotate show changeset information by line for each file
31 31 clone make a copy of an existing repository
32 32 commit commit the specified files or all outstanding changes
33 33 diff diff repository (or selected files)
34 34 export dump the header and diffs for one or more changesets
35 35 forget forget the specified files on the next commit
36 36 init create a new repository in the given directory
37 37 log show revision history of entire repository or files
38 38 merge merge another revision into working directory
39 39 pull pull changes from the specified source
40 40 push push changes to the specified destination
41 41 remove remove the specified files on the next commit
42 42 serve start stand-alone webserver
43 43 status show changed files in the working directory
44 44 summary summarize working directory state
45 45 update update working directory (or switch revisions)
46 46
47 47 Extra extensions will be printed in help output in a non-reliable order since
48 48 the extension is unknown.
49 49 #if no-extraextensions
50 50
51 51 $ hg help
52 52 Mercurial Distributed SCM
53 53
54 54 list of commands:
55 55
56 56 Repository creation:
57 57
58 58 clone make a copy of an existing repository
59 59 init create a new repository in the given directory
60 60
61 61 Remote repository management:
62 62
63 63 incoming show new changesets found in source
64 64 outgoing show changesets not found in the destination
65 65 paths show aliases for remote repositories
66 66 pull pull changes from the specified source
67 67 push push changes to the specified destination
68 68 serve start stand-alone webserver
69 69
70 70 Change creation:
71 71
72 72 commit commit the specified files or all outstanding changes
73 73
74 74 Change manipulation:
75 75
76 76 backout reverse effect of earlier changeset
77 77 graft copy changes from other branches onto the current branch
78 78 merge merge another revision into working directory
79 79
80 80 Change organization:
81 81
82 82 bookmarks create a new bookmark or list existing bookmarks
83 83 branch set or show the current branch name
84 84 branches list repository named branches
85 85 phase set or show the current phase name
86 86 tag add one or more tags for the current or given revision
87 87 tags list repository tags
88 88
89 89 File content management:
90 90
91 91 annotate show changeset information by line for each file
92 92 cat output the current or given revision of files
93 93 copy mark files as copied for the next commit
94 94 diff diff repository (or selected files)
95 95 grep search for a pattern in specified files
96 96
97 97 Change navigation:
98 98
99 99 bisect subdivision search of changesets
100 100 heads show branch heads
101 101 identify identify the working directory or specified revision
102 102 log show revision history of entire repository or files
103 103
104 104 Working directory management:
105 105
106 106 add add the specified files on the next commit
107 107 addremove add all new files, delete all missing files
108 108 files list tracked files
109 109 forget forget the specified files on the next commit
110 110 purge removes files not tracked by Mercurial
111 111 remove remove the specified files on the next commit
112 112 rename rename files; equivalent of copy + remove
113 113 resolve redo merges or set/view the merge status of files
114 114 revert restore files to their checkout state
115 115 root print the root (top) of the current working directory
116 116 shelve save and set aside changes from the working directory
117 117 status show changed files in the working directory
118 118 summary summarize working directory state
119 119 unshelve restore a shelved change to the working directory
120 120 update update working directory (or switch revisions)
121 121
122 122 Change import/export:
123 123
124 124 archive create an unversioned archive of a repository revision
125 125 bundle create a bundle file
126 126 export dump the header and diffs for one or more changesets
127 127 import import an ordered set of patches
128 128 unbundle apply one or more bundle files
129 129
130 130 Repository maintenance:
131 131
132 132 manifest output the current or given revision of the project manifest
133 133 recover roll back an interrupted transaction
134 134 verify verify the integrity of the repository
135 135
136 136 Help:
137 137
138 138 config show combined config settings from all hgrc files
139 139 help show help for a given topic or a help overview
140 140 version output version and copyright information
141 141
142 142 additional help topics:
143 143
144 144 Mercurial identifiers:
145 145
146 146 filesets Specifying File Sets
147 147 hgignore Syntax for Mercurial Ignore Files
148 148 patterns File Name Patterns
149 149 revisions Specifying Revisions
150 150 urls URL Paths
151 151
152 152 Mercurial output:
153 153
154 154 color Colorizing Outputs
155 155 dates Date Formats
156 156 diffs Diff Formats
157 157 templating Template Usage
158 158
159 159 Mercurial configuration:
160 160
161 161 config Configuration Files
162 162 environment Environment Variables
163 163 extensions Using Additional Features
164 164 flags Command-line flags
165 165 hgweb Configuring hgweb
166 166 merge-tools Merge Tools
167 167 pager Pager Support
168 168
169 169 Concepts:
170 170
171 171 bundlespec Bundle File Formats
172 172 glossary Glossary
173 173 phases Working with Phases
174 174 subrepos Subrepositories
175 175
176 176 Miscellaneous:
177 177
178 178 deprecated Deprecated Features
179 179 internals Technical implementation topics
180 180 scripting Using Mercurial from scripts and automation
181 181
182 182 (use 'hg help -v' to show built-in aliases and global options)
183 183
184 184 $ hg -q help
185 185 Repository creation:
186 186
187 187 clone make a copy of an existing repository
188 188 init create a new repository in the given directory
189 189
190 190 Remote repository management:
191 191
192 192 incoming show new changesets found in source
193 193 outgoing show changesets not found in the destination
194 194 paths show aliases for remote repositories
195 195 pull pull changes from the specified source
196 196 push push changes to the specified destination
197 197 serve start stand-alone webserver
198 198
199 199 Change creation:
200 200
201 201 commit commit the specified files or all outstanding changes
202 202
203 203 Change manipulation:
204 204
205 205 backout reverse effect of earlier changeset
206 206 graft copy changes from other branches onto the current branch
207 207 merge merge another revision into working directory
208 208
209 209 Change organization:
210 210
211 211 bookmarks create a new bookmark or list existing bookmarks
212 212 branch set or show the current branch name
213 213 branches list repository named branches
214 214 phase set or show the current phase name
215 215 tag add one or more tags for the current or given revision
216 216 tags list repository tags
217 217
218 218 File content management:
219 219
220 220 annotate show changeset information by line for each file
221 221 cat output the current or given revision of files
222 222 copy mark files as copied for the next commit
223 223 diff diff repository (or selected files)
224 224 grep search for a pattern in specified files
225 225
226 226 Change navigation:
227 227
228 228 bisect subdivision search of changesets
229 229 heads show branch heads
230 230 identify identify the working directory or specified revision
231 231 log show revision history of entire repository or files
232 232
233 233 Working directory management:
234 234
235 235 add add the specified files on the next commit
236 236 addremove add all new files, delete all missing files
237 237 files list tracked files
238 238 forget forget the specified files on the next commit
239 239 purge removes files not tracked by Mercurial
240 240 remove remove the specified files on the next commit
241 241 rename rename files; equivalent of copy + remove
242 242 resolve redo merges or set/view the merge status of files
243 243 revert restore files to their checkout state
244 244 root print the root (top) of the current working directory
245 245 shelve save and set aside changes from the working directory
246 246 status show changed files in the working directory
247 247 summary summarize working directory state
248 248 unshelve restore a shelved change to the working directory
249 249 update update working directory (or switch revisions)
250 250
251 251 Change import/export:
252 252
253 253 archive create an unversioned archive of a repository revision
254 254 bundle create a bundle file
255 255 export dump the header and diffs for one or more changesets
256 256 import import an ordered set of patches
257 257 unbundle apply one or more bundle files
258 258
259 259 Repository maintenance:
260 260
261 261 manifest output the current or given revision of the project manifest
262 262 recover roll back an interrupted transaction
263 263 verify verify the integrity of the repository
264 264
265 265 Help:
266 266
267 267 config show combined config settings from all hgrc files
268 268 help show help for a given topic or a help overview
269 269 version output version and copyright information
270 270
271 271 additional help topics:
272 272
273 273 Mercurial identifiers:
274 274
275 275 filesets Specifying File Sets
276 276 hgignore Syntax for Mercurial Ignore Files
277 277 patterns File Name Patterns
278 278 revisions Specifying Revisions
279 279 urls URL Paths
280 280
281 281 Mercurial output:
282 282
283 283 color Colorizing Outputs
284 284 dates Date Formats
285 285 diffs Diff Formats
286 286 templating Template Usage
287 287
288 288 Mercurial configuration:
289 289
290 290 config Configuration Files
291 291 environment Environment Variables
292 292 extensions Using Additional Features
293 293 flags Command-line flags
294 294 hgweb Configuring hgweb
295 295 merge-tools Merge Tools
296 296 pager Pager Support
297 297
298 298 Concepts:
299 299
300 300 bundlespec Bundle File Formats
301 301 glossary Glossary
302 302 phases Working with Phases
303 303 subrepos Subrepositories
304 304
305 305 Miscellaneous:
306 306
307 307 deprecated Deprecated Features
308 308 internals Technical implementation topics
309 309 scripting Using Mercurial from scripts and automation
310 310
311 311 Test extension help:
312 312 $ hg help extensions --config extensions.rebase= --config extensions.children=
313 313 Using Additional Features
314 314 """""""""""""""""""""""""
315 315
316 316 Mercurial has the ability to add new features through the use of
317 317 extensions. Extensions may add new commands, add options to existing
318 318 commands, change the default behavior of commands, or implement hooks.
319 319
320 320 To enable the "foo" extension, either shipped with Mercurial or in the
321 321 Python search path, create an entry for it in your configuration file,
322 322 like this:
323 323
324 324 [extensions]
325 325 foo =
326 326
327 327 You may also specify the full path to an extension:
328 328
329 329 [extensions]
330 330 myfeature = ~/.hgext/myfeature.py
331 331
332 332 See 'hg help config' for more information on configuration files.
333 333
334 334 Extensions are not loaded by default for a variety of reasons: they can
335 335 increase startup overhead; they may be meant for advanced usage only; they
336 336 may provide potentially dangerous abilities (such as letting you destroy
337 337 or modify history); they might not be ready for prime time; or they may
338 338 alter some usual behaviors of stock Mercurial. It is thus up to the user
339 339 to activate extensions as needed.
340 340
341 341 To explicitly disable an extension enabled in a configuration file of
342 342 broader scope, prepend its path with !:
343 343
344 344 [extensions]
345 345 # disabling extension bar residing in /path/to/extension/bar.py
346 346 bar = !/path/to/extension/bar.py
347 347 # ditto, but no path was supplied for extension baz
348 348 baz = !
349 349
350 350 enabled extensions:
351 351
352 352 children command to display child changesets (DEPRECATED)
353 353 rebase command to move sets of revisions to a different ancestor
354 354
355 355 disabled extensions:
356 356
357 357 acl hooks for controlling repository access
358 358 blackbox log repository events to a blackbox for debugging
359 359 bugzilla hooks for integrating with the Bugzilla bug tracker
360 360 censor erase file content at a given revision
361 361 churn command to display statistics about repository history
362 362 clonebundles advertise pre-generated bundles to seed clones
363 363 closehead close arbitrary heads without checking them out first
364 364 convert import revisions from foreign VCS repositories into
365 365 Mercurial
366 366 eol automatically manage newlines in repository files
367 367 extdiff command to allow external programs to compare revisions
368 368 factotum http authentication with factotum
369 369 fastexport export repositories as git fast-import stream
370 370 githelp try mapping git commands to Mercurial commands
371 371 gpg commands to sign and verify changesets
372 372 hgk browse the repository in a graphical way
373 373 highlight syntax highlighting for hgweb (requires Pygments)
374 374 histedit interactive history editing
375 375 keyword expand keywords in tracked files
376 376 largefiles track large binary files
377 377 mq manage a stack of patches
378 378 notify hooks for sending email push notifications
379 379 patchbomb command to send changesets as (a series of) patch emails
380 380 relink recreates hardlinks between repository clones
381 381 schemes extend schemes with shortcuts to repository swarms
382 382 share share a common history between several working directories
383 383 transplant command to transplant changesets from another branch
384 384 win32mbcs allow the use of MBCS paths with problematic encodings
385 385 zeroconf discover and advertise repositories on the local network
386 386
387 387 #endif
388 388
389 389 Verify that deprecated extensions are included if --verbose:
390 390
391 391 $ hg -v help extensions | grep children
392 392 children command to display child changesets (DEPRECATED)
393 393
394 394 Verify that extension keywords appear in help templates
395 395
396 396 $ hg help --config extensions.transplant= templating|grep transplant > /dev/null
397 397
398 398 Test short command list with verbose option
399 399
400 400 $ hg -v help shortlist
401 401 Mercurial Distributed SCM
402 402
403 403 basic commands:
404 404
405 405 abort abort an unfinished operation (EXPERIMENTAL)
406 406 add add the specified files on the next commit
407 407 annotate, blame
408 408 show changeset information by line for each file
409 409 clone make a copy of an existing repository
410 410 commit, ci commit the specified files or all outstanding changes
411 411 continue resumes an interrupted operation (EXPERIMENTAL)
412 412 diff diff repository (or selected files)
413 413 export dump the header and diffs for one or more changesets
414 414 forget forget the specified files on the next commit
415 415 init create a new repository in the given directory
416 416 log, history show revision history of entire repository or files
417 417 merge merge another revision into working directory
418 418 pull pull changes from the specified source
419 419 push push changes to the specified destination
420 420 remove, rm remove the specified files on the next commit
421 421 serve start stand-alone webserver
422 422 status, st show changed files in the working directory
423 423 summary, sum summarize working directory state
424 424 update, up, checkout, co
425 425 update working directory (or switch revisions)
426 426
427 427 global options ([+] can be repeated):
428 428
429 429 -R --repository REPO repository root directory or name of overlay bundle
430 430 file
431 431 --cwd DIR change working directory
432 432 -y --noninteractive do not prompt, automatically pick the first choice for
433 433 all prompts
434 434 -q --quiet suppress output
435 435 -v --verbose enable additional output
436 436 --color TYPE when to colorize (boolean, always, auto, never, or
437 437 debug)
438 438 --config CONFIG [+] set/override config option (use 'section.name=value')
439 439 --debug enable debugging output
440 440 --debugger start debugger
441 441 --encoding ENCODE set the charset encoding (default: ascii)
442 442 --encodingmode MODE set the charset encoding mode (default: strict)
443 443 --traceback always print a traceback on exception
444 444 --time time how long the command takes
445 445 --profile print command execution profile
446 446 --version output version information and exit
447 447 -h --help display help and exit
448 448 --hidden consider hidden changesets
449 449 --pager TYPE when to paginate (boolean, always, auto, or never)
450 450 (default: auto)
451 451
452 452 (use 'hg help' for the full list of commands)
453 453
454 454 $ hg add -h
455 455 hg add [OPTION]... [FILE]...
456 456
457 457 add the specified files on the next commit
458 458
459 459 Schedule files to be version controlled and added to the repository.
460 460
461 461 The files will be added to the repository at the next commit. To undo an
462 462 add before that, see 'hg forget'.
463 463
464 464 If no names are given, add all files to the repository (except files
465 465 matching ".hgignore").
466 466
467 467 Returns 0 if all files are successfully added.
468 468
469 469 options ([+] can be repeated):
470 470
471 471 -I --include PATTERN [+] include names matching the given patterns
472 472 -X --exclude PATTERN [+] exclude names matching the given patterns
473 473 -S --subrepos recurse into subrepositories
474 474 -n --dry-run do not perform actions, just print output
475 475
476 476 (some details hidden, use --verbose to show complete help)
477 477
478 478 Verbose help for add
479 479
480 480 $ hg add -hv
481 481 hg add [OPTION]... [FILE]...
482 482
483 483 add the specified files on the next commit
484 484
485 485 Schedule files to be version controlled and added to the repository.
486 486
487 487 The files will be added to the repository at the next commit. To undo an
488 488 add before that, see 'hg forget'.
489 489
490 490 If no names are given, add all files to the repository (except files
491 491 matching ".hgignore").
492 492
493 493 Examples:
494 494
495 495 - New (unknown) files are added automatically by 'hg add':
496 496
497 497 $ ls
498 498 foo.c
499 499 $ hg status
500 500 ? foo.c
501 501 $ hg add
502 502 adding foo.c
503 503 $ hg status
504 504 A foo.c
505 505
506 506 - Specific files to be added can be specified:
507 507
508 508 $ ls
509 509 bar.c foo.c
510 510 $ hg status
511 511 ? bar.c
512 512 ? foo.c
513 513 $ hg add bar.c
514 514 $ hg status
515 515 A bar.c
516 516 ? foo.c
517 517
518 518 Returns 0 if all files are successfully added.
519 519
520 520 options ([+] can be repeated):
521 521
522 522 -I --include PATTERN [+] include names matching the given patterns
523 523 -X --exclude PATTERN [+] exclude names matching the given patterns
524 524 -S --subrepos recurse into subrepositories
525 525 -n --dry-run do not perform actions, just print output
526 526
527 527 global options ([+] can be repeated):
528 528
529 529 -R --repository REPO repository root directory or name of overlay bundle
530 530 file
531 531 --cwd DIR change working directory
532 532 -y --noninteractive do not prompt, automatically pick the first choice for
533 533 all prompts
534 534 -q --quiet suppress output
535 535 -v --verbose enable additional output
536 536 --color TYPE when to colorize (boolean, always, auto, never, or
537 537 debug)
538 538 --config CONFIG [+] set/override config option (use 'section.name=value')
539 539 --debug enable debugging output
540 540 --debugger start debugger
541 541 --encoding ENCODE set the charset encoding (default: ascii)
542 542 --encodingmode MODE set the charset encoding mode (default: strict)
543 543 --traceback always print a traceback on exception
544 544 --time time how long the command takes
545 545 --profile print command execution profile
546 546 --version output version information and exit
547 547 -h --help display help and exit
548 548 --hidden consider hidden changesets
549 549 --pager TYPE when to paginate (boolean, always, auto, or never)
550 550 (default: auto)
551 551
552 552 Test the textwidth config option
553 553
554 554 $ hg root -h --config ui.textwidth=50
555 555 hg root
556 556
557 557 print the root (top) of the current working
558 558 directory
559 559
560 560 Print the root directory of the current
561 561 repository.
562 562
563 563 Returns 0 on success.
564 564
565 565 options:
566 566
567 567 -T --template TEMPLATE display with template
568 568
569 569 (some details hidden, use --verbose to show
570 570 complete help)
571 571
572 572 Test help option with version option
573 573
574 574 $ hg add -h --version
575 575 Mercurial Distributed SCM (version *) (glob)
576 576 (see https://mercurial-scm.org for more information)
577 577
578 578 Copyright (C) 2005-* Olivia Mackall and others (glob)
579 579 This is free software; see the source for copying conditions. There is NO
580 580 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
581 581
582 582 $ hg add --skjdfks
583 583 hg add: option --skjdfks not recognized
584 584 hg add [OPTION]... [FILE]...
585 585
586 586 add the specified files on the next commit
587 587
588 588 options ([+] can be repeated):
589 589
590 590 -I --include PATTERN [+] include names matching the given patterns
591 591 -X --exclude PATTERN [+] exclude names matching the given patterns
592 592 -S --subrepos recurse into subrepositories
593 593 -n --dry-run do not perform actions, just print output
594 594
595 595 (use 'hg add -h' to show more help)
596 596 [10]
597 597
598 598 Test ambiguous command help
599 599
600 600 $ hg help ad
601 601 list of commands:
602 602
603 603 add add the specified files on the next commit
604 604 addremove add all new files, delete all missing files
605 605
606 606 (use 'hg help -v ad' to show built-in aliases and global options)
607 607
608 608 Test command without options
609 609
610 610 $ hg help verify
611 611 hg verify
612 612
613 613 verify the integrity of the repository
614 614
615 615 Verify the integrity of the current repository.
616 616
617 617 This will perform an extensive check of the repository's integrity,
618 618 validating the hashes and checksums of each entry in the changelog,
619 619 manifest, and tracked files, as well as the integrity of their crosslinks
620 620 and indices.
621 621
622 622 Please see https://mercurial-scm.org/wiki/RepositoryCorruption for more
623 623 information about recovery from corruption of the repository.
624 624
625 625 Returns 0 on success, 1 if errors are encountered.
626 626
627 627 options:
628 628
629 629 (some details hidden, use --verbose to show complete help)
630 630
631 631 $ hg help diff
632 632 hg diff [OPTION]... ([-c REV] | [--from REV1] [--to REV2]) [FILE]...
633 633
634 634 diff repository (or selected files)
635 635
636 636 Show differences between revisions for the specified files.
637 637
638 638 Differences between files are shown using the unified diff format.
639 639
640 640 Note:
641 641 'hg diff' may generate unexpected results for merges, as it will
642 642 default to comparing against the working directory's first parent
643 643 changeset if no revisions are specified.
644 644
645 645 By default, the working directory files are compared to its first parent.
646 646 To see the differences from another revision, use --from. To see the
647 647 difference to another revision, use --to. For example, 'hg diff --from .^'
648 648 will show the differences from the working copy's grandparent to the
649 649 working copy, 'hg diff --to .' will show the diff from the working copy to
650 650 its parent (i.e. the reverse of the default), and 'hg diff --from 1.0 --to
651 651 1.2' will show the diff between those two revisions.
652 652
653 653 Alternatively you can specify -c/--change with a revision to see the
654 654 changes in that changeset relative to its first parent (i.e. 'hg diff -c
655 655 42' is equivalent to 'hg diff --from 42^ --to 42')
656 656
657 657 Without the -a/--text option, diff will avoid generating diffs of files it
658 658 detects as binary. With -a, diff will generate a diff anyway, probably
659 659 with undesirable results.
660 660
661 661 Use the -g/--git option to generate diffs in the git extended diff format.
662 662 For more information, read 'hg help diffs'.
663 663
664 664 Returns 0 on success.
665 665
666 666 options ([+] can be repeated):
667 667
668 668 --from REV1 revision to diff from
669 669 --to REV2 revision to diff to
670 670 -c --change REV change made by revision
671 671 -a --text treat all files as text
672 672 -g --git use git extended diff format
673 673 --binary generate binary diffs in git mode (default)
674 674 --nodates omit dates from diff headers
675 675 --noprefix omit a/ and b/ prefixes from filenames
676 676 -p --show-function show which function each change is in
677 677 --reverse produce a diff that undoes the changes
678 678 -w --ignore-all-space ignore white space when comparing lines
679 679 -b --ignore-space-change ignore changes in the amount of white space
680 680 -B --ignore-blank-lines ignore changes whose lines are all blank
681 681 -Z --ignore-space-at-eol ignore changes in whitespace at EOL
682 682 -U --unified NUM number of lines of context to show
683 683 --stat output diffstat-style summary of changes
684 684 --root DIR produce diffs relative to subdirectory
685 685 -I --include PATTERN [+] include names matching the given patterns
686 686 -X --exclude PATTERN [+] exclude names matching the given patterns
687 687 -S --subrepos recurse into subrepositories
688 688
689 689 (some details hidden, use --verbose to show complete help)
690 690
691 691 $ hg help status
692 692 hg status [OPTION]... [FILE]...
693 693
694 694 aliases: st
695 695
696 696 show changed files in the working directory
697 697
698 698 Show status of files in the repository. If names are given, only files
699 699 that match are shown. Files that are clean or ignored or the source of a
700 700 copy/move operation, are not listed unless -c/--clean, -i/--ignored,
701 701 -C/--copies or -A/--all are given. Unless options described with "show
702 702 only ..." are given, the options -mardu are used.
703 703
704 704 Option -q/--quiet hides untracked (unknown and ignored) files unless
705 705 explicitly requested with -u/--unknown or -i/--ignored.
706 706
707 707 Note:
708 708 'hg status' may appear to disagree with diff if permissions have
709 709 changed or a merge has occurred. The standard diff format does not
710 710 report permission changes and diff only reports changes relative to one
711 711 merge parent.
712 712
713 713 If one revision is given, it is used as the base revision. If two
714 714 revisions are given, the differences between them are shown. The --change
715 715 option can also be used as a shortcut to list the changed files of a
716 716 revision from its first parent.
717 717
718 718 The codes used to show the status of files are:
719 719
720 720 M = modified
721 721 A = added
722 722 R = removed
723 723 C = clean
724 724 ! = missing (deleted by non-hg command, but still tracked)
725 725 ? = not tracked
726 726 I = ignored
727 727 = origin of the previous file (with --copies)
728 728
729 729 Returns 0 on success.
730 730
731 731 options ([+] can be repeated):
732 732
733 733 -A --all show status of all files
734 734 -m --modified show only modified files
735 735 -a --added show only added files
736 736 -r --removed show only removed files
737 737 -d --deleted show only missing files
738 738 -c --clean show only files without changes
739 739 -u --unknown show only unknown (not tracked) files
740 740 -i --ignored show only ignored files
741 741 -n --no-status hide status prefix
742 742 -C --copies show source of copied files
743 743 -0 --print0 end filenames with NUL, for use with xargs
744 744 --rev REV [+] show difference from revision
745 745 --change REV list the changed files of a revision
746 746 -I --include PATTERN [+] include names matching the given patterns
747 747 -X --exclude PATTERN [+] exclude names matching the given patterns
748 748 -S --subrepos recurse into subrepositories
749 749 -T --template TEMPLATE display with template
750 750
751 751 (some details hidden, use --verbose to show complete help)
752 752
753 753 $ hg -q help status
754 754 hg status [OPTION]... [FILE]...
755 755
756 756 show changed files in the working directory
757 757
758 758 $ hg help foo
759 759 abort: no such help topic: foo
760 760 (try 'hg help --keyword foo')
761 761 [10]
762 762
763 763 $ hg skjdfks
764 764 hg: unknown command 'skjdfks'
765 765 (use 'hg help' for a list of commands)
766 766 [10]
767 767
768 768 Typoed command gives suggestion
769 769 $ hg puls
770 770 hg: unknown command 'puls'
771 771 (did you mean one of pull, push?)
772 772 [10]
773 773
774 774 Not enabled extension gets suggested
775 775
776 776 $ hg rebase
777 777 hg: unknown command 'rebase'
778 778 'rebase' is provided by the following extension:
779 779
780 780 rebase command to move sets of revisions to a different ancestor
781 781
782 782 (use 'hg help extensions' for information on enabling extensions)
783 783 [10]
784 784
785 785 Disabled extension gets suggested
786 786 $ hg --config extensions.rebase=! rebase
787 787 hg: unknown command 'rebase'
788 788 'rebase' is provided by the following extension:
789 789
790 790 rebase command to move sets of revisions to a different ancestor
791 791
792 792 (use 'hg help extensions' for information on enabling extensions)
793 793 [10]
794 794
795 795 Checking that help adapts based on the config:
796 796
797 797 $ hg help diff --config ui.tweakdefaults=true | egrep -e '^ *(-g|config)'
798 798 -g --[no-]git use git extended diff format (default: on from
799 799 config)
800 800
801 801 Make sure that we don't run afoul of the help system thinking that
802 802 this is a section and erroring out weirdly.
803 803
804 804 $ hg .log
805 805 hg: unknown command '.log'
806 806 (did you mean log?)
807 807 [10]
808 808
809 809 $ hg log.
810 810 hg: unknown command 'log.'
811 811 (did you mean log?)
812 812 [10]
813 813 $ hg pu.lh
814 814 hg: unknown command 'pu.lh'
815 815 (did you mean one of pull, push?)
816 816 [10]
817 817
818 818 $ cat > helpext.py <<EOF
819 819 > import os
820 820 > from mercurial import commands, fancyopts, registrar
821 821 >
822 822 > def func(arg):
823 823 > return '%sfoo' % arg
824 824 > class customopt(fancyopts.customopt):
825 825 > def newstate(self, oldstate, newparam, abort):
826 826 > return '%sbar' % oldstate
827 827 > cmdtable = {}
828 828 > command = registrar.command(cmdtable)
829 829 >
830 830 > @command(b'nohelp',
831 831 > [(b'', b'longdesc', 3, b'x'*67),
832 832 > (b'n', b'', None, b'normal desc'),
833 833 > (b'', b'newline', b'', b'line1\nline2'),
834 834 > (b'', b'default-off', False, b'enable X'),
835 835 > (b'', b'default-on', True, b'enable Y'),
836 836 > (b'', b'callableopt', func, b'adds foo'),
837 837 > (b'', b'customopt', customopt(''), b'adds bar'),
838 838 > (b'', b'customopt-withdefault', customopt('foo'), b'adds bar')],
839 839 > b'hg nohelp',
840 840 > norepo=True)
841 841 > @command(b'debugoptADV', [(b'', b'aopt', None, b'option is (ADVANCED)')])
842 842 > @command(b'debugoptDEP', [(b'', b'dopt', None, b'option is (DEPRECATED)')])
843 843 > @command(b'debugoptEXP', [(b'', b'eopt', None, b'option is (EXPERIMENTAL)')])
844 844 > def nohelp(ui, *args, **kwargs):
845 845 > pass
846 846 >
847 847 > @command(b'hashelp', [], b'hg hashelp', norepo=True)
848 848 > def hashelp(ui, *args, **kwargs):
849 849 > """Extension command's help"""
850 850 >
851 851 > def uisetup(ui):
852 852 > ui.setconfig(b'alias', b'shellalias', b'!echo hi', b'helpext')
853 853 > ui.setconfig(b'alias', b'hgalias', b'summary', b'helpext')
854 854 > ui.setconfig(b'alias', b'hgalias:doc', b'My doc', b'helpext')
855 855 > ui.setconfig(b'alias', b'hgalias:category', b'navigation', b'helpext')
856 856 > ui.setconfig(b'alias', b'hgaliasnodoc', b'summary', b'helpext')
857 857 >
858 858 > EOF
859 859 $ echo '[extensions]' >> $HGRCPATH
860 860 $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
861 861
862 862 Test for aliases
863 863
864 864 $ hg help | grep hgalias
865 865 hgalias My doc
866 866
867 867 $ hg help hgalias
868 868 hg hgalias [--remote]
869 869
870 870 alias for: hg summary
871 871
872 872 My doc
873 873
874 874 defined by: helpext
875 875
876 876 options:
877 877
878 878 --remote check for push and pull
879 879
880 880 (some details hidden, use --verbose to show complete help)
881 881 $ hg help hgaliasnodoc
882 882 hg hgaliasnodoc [--remote]
883 883
884 884 alias for: hg summary
885 885
886 886 summarize working directory state
887 887
888 888 This generates a brief summary of the working directory state, including
889 889 parents, branch, commit status, phase and available updates.
890 890
891 891 With the --remote option, this will check the default paths for incoming
892 892 and outgoing changes. This can be time-consuming.
893 893
894 894 Returns 0 on success.
895 895
896 896 defined by: helpext
897 897
898 898 options:
899 899
900 900 --remote check for push and pull
901 901
902 902 (some details hidden, use --verbose to show complete help)
903 903
904 904 $ hg help shellalias
905 905 hg shellalias
906 906
907 907 shell alias for: echo hi
908 908
909 909 (no help text available)
910 910
911 911 defined by: helpext
912 912
913 913 (some details hidden, use --verbose to show complete help)
914 914
915 915 Test command with no help text
916 916
917 917 $ hg help nohelp
918 918 hg nohelp
919 919
920 920 (no help text available)
921 921
922 922 options:
923 923
924 924 --longdesc VALUE
925 925 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
926 926 xxxxxxxxxxxxxxxxxxxxxxx (default: 3)
927 927 -n -- normal desc
928 928 --newline VALUE line1 line2
929 929 --default-off enable X
930 930 --[no-]default-on enable Y (default: on)
931 931 --callableopt VALUE adds foo
932 932 --customopt VALUE adds bar
933 933 --customopt-withdefault VALUE adds bar (default: foo)
934 934
935 935 (some details hidden, use --verbose to show complete help)
936 936
937 937 Test that default list of commands includes extension commands that have help,
938 938 but not those that don't, except in verbose mode, when a keyword is passed, or
939 939 when help about the extension is requested.
940 940
941 941 #if no-extraextensions
942 942
943 943 $ hg help | grep hashelp
944 944 hashelp Extension command's help
945 945 $ hg help | grep nohelp
946 946 [1]
947 947 $ hg help -v | grep nohelp
948 948 nohelp (no help text available)
949 949
950 950 $ hg help -k nohelp
951 951 Commands:
952 952
953 953 nohelp hg nohelp
954 954
955 955 Extension Commands:
956 956
957 957 nohelp (no help text available)
958 958
959 959 $ hg help helpext
960 960 helpext extension - no help text available
961 961
962 962 list of commands:
963 963
964 964 hashelp Extension command's help
965 965 nohelp (no help text available)
966 966
967 967 (use 'hg help -v helpext' to show built-in aliases and global options)
968 968
969 969 #endif
970 970
971 971 Test list of internal help commands
972 972
973 973 $ hg help debug
974 974 debug commands (internal and unsupported):
975 975
976 976 debugancestor
977 977 find the ancestor revision of two revisions in a given index
978 978 debugantivirusrunning
979 979 attempt to trigger an antivirus scanner to see if one is active
980 980 debugapplystreamclonebundle
981 981 apply a stream clone bundle file
982 982 debugbackupbundle
983 983 lists the changesets available in backup bundles
984 984 debugbuilddag
985 985 builds a repo with a given DAG from scratch in the current
986 986 empty repo
987 987 debugbundle lists the contents of a bundle
988 988 debugcapabilities
989 989 lists the capabilities of a remote peer
990 990 debugchangedfiles
991 991 list the stored files changes for a revision
992 992 debugcheckstate
993 993 validate the correctness of the current dirstate
994 994 debugcolor show available color, effects or style
995 995 debugcommands
996 996 list all available commands and options
997 997 debugcomplete
998 998 returns the completion list associated with the given command
999 999 debugcreatestreamclonebundle
1000 1000 create a stream clone bundle file
1001 1001 debugdag format the changelog or an index DAG as a concise textual
1002 1002 description
1003 1003 debugdata dump the contents of a data file revision
1004 1004 debugdate parse and display a date
1005 1005 debugdeltachain
1006 1006 dump information about delta chains in a revlog
1007 1007 debugdirstate
1008 1008 show the contents of the current dirstate
1009 1009 debugdiscovery
1010 1010 runs the changeset discovery protocol in isolation
1011 1011 debugdownload
1012 1012 download a resource using Mercurial logic and config
1013 1013 debugextensions
1014 1014 show information about active extensions
1015 1015 debugfileset parse and apply a fileset specification
1016 1016 debugformat display format information about the current repository
1017 1017 debugfsinfo show information detected about current filesystem
1018 1018 debuggetbundle
1019 1019 retrieves a bundle from a repo
1020 1020 debugignore display the combined ignore pattern and information about
1021 1021 ignored files
1022 1022 debugindex dump index data for a storage primitive
1023 1023 debugindexdot
1024 1024 dump an index DAG as a graphviz dot file
1025 1025 debugindexstats
1026 1026 show stats related to the changelog index
1027 1027 debuginstall test Mercurial installation
1028 1028 debugknown test whether node ids are known to a repo
1029 1029 debuglocks show or modify state of locks
1030 1030 debugmanifestfulltextcache
1031 1031 show, clear or amend the contents of the manifest fulltext
1032 1032 cache
1033 1033 debugmergestate
1034 1034 print merge state
1035 1035 debugnamecomplete
1036 1036 complete "names" - tags, open branch names, bookmark names
1037 1037 debugnodemap write and inspect on disk nodemap
1038 1038 debugobsolete
1039 1039 create arbitrary obsolete marker
1040 1040 debugoptADV (no help text available)
1041 1041 debugoptDEP (no help text available)
1042 1042 debugoptEXP (no help text available)
1043 1043 debugp1copies
1044 1044 dump copy information compared to p1
1045 1045 debugp2copies
1046 1046 dump copy information compared to p2
1047 1047 debugpathcomplete
1048 1048 complete part or all of a tracked path
1049 1049 debugpathcopies
1050 1050 show copies between two revisions
1051 1051 debugpeer establish a connection to a peer repository
1052 1052 debugpickmergetool
1053 1053 examine which merge tool is chosen for specified file
1054 1054 debugpushkey access the pushkey key/value protocol
1055 1055 debugpvec (no help text available)
1056 1056 debugrebuilddirstate
1057 1057 rebuild the dirstate as it would look like for the given
1058 1058 revision
1059 1059 debugrebuildfncache
1060 1060 rebuild the fncache file
1061 1061 debugrename dump rename information
1062 1062 debugrequires
1063 1063 print the current repo requirements
1064 1064 debugrevlog show data and statistics about a revlog
1065 1065 debugrevlogindex
1066 1066 dump the contents of a revlog index
1067 1067 debugrevspec parse and apply a revision specification
1068 1068 debugserve run a server with advanced settings
1069 1069 debugsetparents
1070 1070 manually set the parents of the current working directory
1071 1071 (DANGEROUS)
1072 1072 debugshell run an interactive Python interpreter
1073 1073 debugsidedata
1074 1074 dump the side data for a cl/manifest/file revision
1075 1075 debugssl test a secure connection to a server
1076 1076 debugstrip strip changesets and all their descendants from the repository
1077 1077 debugsub (no help text available)
1078 1078 debugsuccessorssets
1079 1079 show set of successors for revision
1080 1080 debugtagscache
1081 1081 display the contents of .hg/cache/hgtagsfnodes1
1082 1082 debugtemplate
1083 1083 parse and apply a template
1084 1084 debuguigetpass
1085 1085 show prompt to type password
1086 1086 debuguiprompt
1087 1087 show plain prompt
1088 1088 debugupdatecaches
1089 1089 warm all known caches in the repository
1090 1090 debugupgraderepo
1091 1091 upgrade a repository to use different features
1092 1092 debugwalk show how files match on given patterns
1093 1093 debugwhyunstable
1094 1094 explain instabilities of a changeset
1095 1095 debugwireargs
1096 1096 (no help text available)
1097 1097 debugwireproto
1098 1098 send wire protocol commands to a server
1099 1099
1100 1100 (use 'hg help -v debug' to show built-in aliases and global options)
1101 1101
1102 1102 internals topic renders index of available sub-topics
1103 1103
1104 1104 $ hg help internals
1105 1105 Technical implementation topics
1106 1106 """""""""""""""""""""""""""""""
1107 1107
1108 1108 To access a subtopic, use "hg help internals.{subtopic-name}"
1109 1109
1110 1110 bid-merge Bid Merge Algorithm
1111 1111 bundle2 Bundle2
1112 1112 bundles Bundles
1113 1113 cbor CBOR
1114 1114 censor Censor
1115 1115 changegroups Changegroups
1116 1116 config Config Registrar
1117 1117 extensions Extension API
1118 1118 mergestate Mergestate
1119 1119 requirements Repository Requirements
1120 1120 revlogs Revision Logs
1121 1121 wireprotocol Wire Protocol
1122 1122 wireprotocolrpc
1123 1123 Wire Protocol RPC
1124 1124 wireprotocolv2
1125 1125 Wire Protocol Version 2
1126 1126
1127 1127 sub-topics can be accessed
1128 1128
1129 1129 $ hg help internals.changegroups
1130 1130 Changegroups
1131 1131 """"""""""""
1132 1132
1133 1133 Changegroups are representations of repository revlog data, specifically
1134 1134 the changelog data, root/flat manifest data, treemanifest data, and
1135 1135 filelogs.
1136 1136
1137 1137 There are 3 versions of changegroups: "1", "2", and "3". From a high-
1138 1138 level, versions "1" and "2" are almost exactly the same, with the only
1139 1139 difference being an additional item in the *delta header*. Version "3"
1140 1140 adds support for storage flags in the *delta header* and optionally
1141 1141 exchanging treemanifests (enabled by setting an option on the
1142 1142 "changegroup" part in the bundle2).
1143 1143
1144 1144 Changegroups when not exchanging treemanifests consist of 3 logical
1145 1145 segments:
1146 1146
1147 1147 +---------------------------------+
1148 1148 | | | |
1149 1149 | changeset | manifest | filelogs |
1150 1150 | | | |
1151 1151 | | | |
1152 1152 +---------------------------------+
1153 1153
1154 1154 When exchanging treemanifests, there are 4 logical segments:
1155 1155
1156 1156 +-------------------------------------------------+
1157 1157 | | | | |
1158 1158 | changeset | root | treemanifests | filelogs |
1159 1159 | | manifest | | |
1160 1160 | | | | |
1161 1161 +-------------------------------------------------+
1162 1162
1163 1163 The principle building block of each segment is a *chunk*. A *chunk* is a
1164 1164 framed piece of data:
1165 1165
1166 1166 +---------------------------------------+
1167 1167 | | |
1168 1168 | length | data |
1169 1169 | (4 bytes) | (<length - 4> bytes) |
1170 1170 | | |
1171 1171 +---------------------------------------+
1172 1172
1173 1173 All integers are big-endian signed integers. Each chunk starts with a
1174 1174 32-bit integer indicating the length of the entire chunk (including the
1175 1175 length field itself).
1176 1176
1177 1177 There is a special case chunk that has a value of 0 for the length
1178 1178 ("0x00000000"). We call this an *empty chunk*.
1179 1179
1180 1180 Delta Groups
1181 1181 ============
1182 1182
1183 1183 A *delta group* expresses the content of a revlog as a series of deltas,
1184 1184 or patches against previous revisions.
1185 1185
1186 1186 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
1187 1187 to signal the end of the delta group:
1188 1188
1189 1189 +------------------------------------------------------------------------+
1190 1190 | | | | | |
1191 1191 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
1192 1192 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
1193 1193 | | | | | |
1194 1194 +------------------------------------------------------------------------+
1195 1195
1196 1196 Each *chunk*'s data consists of the following:
1197 1197
1198 1198 +---------------------------------------+
1199 1199 | | |
1200 1200 | delta header | delta data |
1201 1201 | (various by version) | (various) |
1202 1202 | | |
1203 1203 +---------------------------------------+
1204 1204
1205 1205 The *delta data* is a series of *delta*s that describe a diff from an
1206 1206 existing entry (either that the recipient already has, or previously
1207 1207 specified in the bundle/changegroup).
1208 1208
1209 1209 The *delta header* is different between versions "1", "2", and "3" of the
1210 1210 changegroup format.
1211 1211
1212 1212 Version 1 (headerlen=80):
1213 1213
1214 1214 +------------------------------------------------------+
1215 1215 | | | | |
1216 1216 | node | p1 node | p2 node | link node |
1217 1217 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
1218 1218 | | | | |
1219 1219 +------------------------------------------------------+
1220 1220
1221 1221 Version 2 (headerlen=100):
1222 1222
1223 1223 +------------------------------------------------------------------+
1224 1224 | | | | | |
1225 1225 | node | p1 node | p2 node | base node | link node |
1226 1226 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
1227 1227 | | | | | |
1228 1228 +------------------------------------------------------------------+
1229 1229
1230 1230 Version 3 (headerlen=102):
1231 1231
1232 1232 +------------------------------------------------------------------------------+
1233 1233 | | | | | | |
1234 1234 | node | p1 node | p2 node | base node | link node | flags |
1235 1235 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
1236 1236 | | | | | | |
1237 1237 +------------------------------------------------------------------------------+
1238 1238
1239 1239 The *delta data* consists of "chunklen - 4 - headerlen" bytes, which
1240 1240 contain a series of *delta*s, densely packed (no separators). These deltas
1241 1241 describe a diff from an existing entry (either that the recipient already
1242 1242 has, or previously specified in the bundle/changegroup). The format is
1243 1243 described more fully in "hg help internals.bdiff", but briefly:
1244 1244
1245 1245 +---------------------------------------------------------------+
1246 1246 | | | | |
1247 1247 | start offset | end offset | new length | content |
1248 1248 | (4 bytes) | (4 bytes) | (4 bytes) | (<new length> bytes) |
1249 1249 | | | | |
1250 1250 +---------------------------------------------------------------+
1251 1251
1252 1252 Please note that the length field in the delta data does *not* include
1253 1253 itself.
1254 1254
1255 1255 In version 1, the delta is always applied against the previous node from
1256 1256 the changegroup or the first parent if this is the first entry in the
1257 1257 changegroup.
1258 1258
1259 1259 In version 2 and up, the delta base node is encoded in the entry in the
1260 1260 changegroup. This allows the delta to be expressed against any parent,
1261 1261 which can result in smaller deltas and more efficient encoding of data.
1262 1262
1263 1263 The *flags* field holds bitwise flags affecting the processing of revision
1264 1264 data. The following flags are defined:
1265 1265
1266 1266 32768
1267 1267 Censored revision. The revision's fulltext has been replaced by censor
1268 1268 metadata. May only occur on file revisions.
1269 1269
1270 1270 16384
1271 1271 Ellipsis revision. Revision hash does not match data (likely due to
1272 1272 rewritten parents).
1273 1273
1274 1274 8192
1275 1275 Externally stored. The revision fulltext contains "key:value" "\n"
1276 1276 delimited metadata defining an object stored elsewhere. Used by the LFS
1277 1277 extension.
1278 1278
1279 1279 For historical reasons, the integer values are identical to revlog version
1280 1280 1 per-revision storage flags and correspond to bits being set in this
1281 1281 2-byte field. Bits were allocated starting from the most-significant bit,
1282 1282 hence the reverse ordering and allocation of these flags.
1283 1283
1284 1284 Changeset Segment
1285 1285 =================
1286 1286
1287 1287 The *changeset segment* consists of a single *delta group* holding
1288 1288 changelog data. The *empty chunk* at the end of the *delta group* denotes
1289 1289 the boundary to the *manifest segment*.
1290 1290
1291 1291 Manifest Segment
1292 1292 ================
1293 1293
1294 1294 The *manifest segment* consists of a single *delta group* holding manifest
1295 1295 data. If treemanifests are in use, it contains only the manifest for the
1296 1296 root directory of the repository. Otherwise, it contains the entire
1297 1297 manifest data. The *empty chunk* at the end of the *delta group* denotes
1298 1298 the boundary to the next segment (either the *treemanifests segment* or
1299 1299 the *filelogs segment*, depending on version and the request options).
1300 1300
1301 1301 Treemanifests Segment
1302 1302 ---------------------
1303 1303
1304 1304 The *treemanifests segment* only exists in changegroup version "3", and
1305 1305 only if the 'treemanifest' param is part of the bundle2 changegroup part
1306 1306 (it is not possible to use changegroup version 3 outside of bundle2).
1307 1307 Aside from the filenames in the *treemanifests segment* containing a
1308 1308 trailing "/" character, it behaves identically to the *filelogs segment*
1309 1309 (see below). The final sub-segment is followed by an *empty chunk*
1310 1310 (logically, a sub-segment with filename size 0). This denotes the boundary
1311 1311 to the *filelogs segment*.
1312 1312
1313 1313 Filelogs Segment
1314 1314 ================
1315 1315
1316 1316 The *filelogs segment* consists of multiple sub-segments, each
1317 1317 corresponding to an individual file whose data is being described:
1318 1318
1319 1319 +--------------------------------------------------+
1320 1320 | | | | | |
1321 1321 | filelog0 | filelog1 | filelog2 | ... | 0x0 |
1322 1322 | | | | | (4 bytes) |
1323 1323 | | | | | |
1324 1324 +--------------------------------------------------+
1325 1325
1326 1326 The final filelog sub-segment is followed by an *empty chunk* (logically,
1327 1327 a sub-segment with filename size 0). This denotes the end of the segment
1328 1328 and of the overall changegroup.
1329 1329
1330 1330 Each filelog sub-segment consists of the following:
1331 1331
1332 1332 +------------------------------------------------------+
1333 1333 | | | |
1334 1334 | filename length | filename | delta group |
1335 1335 | (4 bytes) | (<length - 4> bytes) | (various) |
1336 1336 | | | |
1337 1337 +------------------------------------------------------+
1338 1338
1339 1339 That is, a *chunk* consisting of the filename (not terminated or padded)
1340 1340 followed by N chunks constituting the *delta group* for this file. The
1341 1341 *empty chunk* at the end of each *delta group* denotes the boundary to the
1342 1342 next filelog sub-segment.
1343 1343
1344 1344 non-existent subtopics print an error
1345 1345
1346 1346 $ hg help internals.foo
1347 1347 abort: no such help topic: internals.foo
1348 1348 (try 'hg help --keyword foo')
1349 1349 [10]
1350 1350
1351 1351 test advanced, deprecated and experimental options are hidden in command help
1352 1352 $ hg help debugoptADV
1353 1353 hg debugoptADV
1354 1354
1355 1355 (no help text available)
1356 1356
1357 1357 options:
1358 1358
1359 1359 (some details hidden, use --verbose to show complete help)
1360 1360 $ hg help debugoptDEP
1361 1361 hg debugoptDEP
1362 1362
1363 1363 (no help text available)
1364 1364
1365 1365 options:
1366 1366
1367 1367 (some details hidden, use --verbose to show complete help)
1368 1368
1369 1369 $ hg help debugoptEXP
1370 1370 hg debugoptEXP
1371 1371
1372 1372 (no help text available)
1373 1373
1374 1374 options:
1375 1375
1376 1376 (some details hidden, use --verbose to show complete help)
1377 1377
1378 1378 test advanced, deprecated and experimental options are shown with -v
1379 1379 $ hg help -v debugoptADV | grep aopt
1380 1380 --aopt option is (ADVANCED)
1381 1381 $ hg help -v debugoptDEP | grep dopt
1382 1382 --dopt option is (DEPRECATED)
1383 1383 $ hg help -v debugoptEXP | grep eopt
1384 1384 --eopt option is (EXPERIMENTAL)
1385 1385
1386 1386 #if gettext
1387 1387 test deprecated option is hidden with translation with untranslated description
1388 1388 (use many globy for not failing on changed transaction)
1389 1389 $ LANGUAGE=sv hg help debugoptDEP
1390 1390 hg debugoptDEP
1391 1391
1392 1392 (*) (glob)
1393 1393
1394 1394 options:
1395 1395
1396 1396 (some details hidden, use --verbose to show complete help)
1397 1397 #endif
1398 1398
1399 1399 Test commands that collide with topics (issue4240)
1400 1400
1401 1401 $ hg config -hq
1402 1402 hg config [-u] [NAME]...
1403 1403
1404 1404 show combined config settings from all hgrc files
1405 1405 $ hg showconfig -hq
1406 1406 hg config [-u] [NAME]...
1407 1407
1408 1408 show combined config settings from all hgrc files
1409 1409
1410 1410 Test a help topic
1411 1411
1412 1412 $ hg help dates
1413 1413 Date Formats
1414 1414 """"""""""""
1415 1415
1416 1416 Some commands allow the user to specify a date, e.g.:
1417 1417
1418 1418 - backout, commit, import, tag: Specify the commit date.
1419 1419 - log, revert, update: Select revision(s) by date.
1420 1420
1421 1421 Many date formats are valid. Here are some examples:
1422 1422
1423 1423 - "Wed Dec 6 13:18:29 2006" (local timezone assumed)
1424 1424 - "Dec 6 13:18 -0600" (year assumed, time offset provided)
1425 1425 - "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
1426 1426 - "Dec 6" (midnight)
1427 1427 - "13:18" (today assumed)
1428 1428 - "3:39" (3:39AM assumed)
1429 1429 - "3:39pm" (15:39)
1430 1430 - "2006-12-06 13:18:29" (ISO 8601 format)
1431 1431 - "2006-12-6 13:18"
1432 1432 - "2006-12-6"
1433 1433 - "12-6"
1434 1434 - "12/6"
1435 1435 - "12/6/6" (Dec 6 2006)
1436 1436 - "today" (midnight)
1437 1437 - "yesterday" (midnight)
1438 1438 - "now" - right now
1439 1439
1440 1440 Lastly, there is Mercurial's internal format:
1441 1441
1442 1442 - "1165411109 0" (Wed Dec 6 13:18:29 2006 UTC)
1443 1443
1444 1444 This is the internal representation format for dates. The first number is
1445 1445 the number of seconds since the epoch (1970-01-01 00:00 UTC). The second
1446 1446 is the offset of the local timezone, in seconds west of UTC (negative if
1447 1447 the timezone is east of UTC).
1448 1448
1449 1449 The log command also accepts date ranges:
1450 1450
1451 1451 - "<DATE" - at or before a given date/time
1452 1452 - ">DATE" - on or after a given date/time
1453 1453 - "DATE to DATE" - a date range, inclusive
1454 1454 - "-DAYS" - within a given number of days from today
1455 1455
1456 1456 Test repeated config section name
1457 1457
1458 1458 $ hg help config.host
1459 1459 "http_proxy.host"
1460 1460 Host name and (optional) port of the proxy server, for example
1461 1461 "myproxy:8000".
1462 1462
1463 1463 "smtp.host"
1464 1464 Host name of mail server, e.g. "mail.example.com".
1465 1465
1466 1466
1467 1467 Test section name with dot
1468 1468
1469 1469 $ hg help config.ui.username
1470 1470 "ui.username"
1471 1471 The committer of a changeset created when running "commit". Typically
1472 1472 a person's name and email address, e.g. "Fred Widget
1473 1473 <fred@example.com>". Environment variables in the username are
1474 1474 expanded.
1475 1475
1476 1476 (default: "$EMAIL" or "username@hostname". If the username in hgrc is
1477 1477 empty, e.g. if the system admin set "username =" in the system hgrc,
1478 1478 it has to be specified manually or in a different hgrc file)
1479 1479
1480 1480
1481 1481 $ hg help config.annotate.git
1482 1482 abort: help section not found: config.annotate.git
1483 1483 [10]
1484 1484
1485 1485 $ hg help config.update.check
1486 1486 "commands.update.check"
1487 1487 Determines what level of checking 'hg update' will perform before
1488 1488 moving to a destination revision. Valid values are "abort", "none",
1489 1489 "linear", and "noconflict". "abort" always fails if the working
1490 1490 directory has uncommitted changes. "none" performs no checking, and
1491 1491 may result in a merge with uncommitted changes. "linear" allows any
1492 1492 update as long as it follows a straight line in the revision history,
1493 1493 and may trigger a merge with uncommitted changes. "noconflict" will
1494 1494 allow any update which would not trigger a merge with uncommitted
1495 1495 changes, if any are present. (default: "linear")
1496 1496
1497 1497
1498 1498 $ hg help config.commands.update.check
1499 1499 "commands.update.check"
1500 1500 Determines what level of checking 'hg update' will perform before
1501 1501 moving to a destination revision. Valid values are "abort", "none",
1502 1502 "linear", and "noconflict". "abort" always fails if the working
1503 1503 directory has uncommitted changes. "none" performs no checking, and
1504 1504 may result in a merge with uncommitted changes. "linear" allows any
1505 1505 update as long as it follows a straight line in the revision history,
1506 1506 and may trigger a merge with uncommitted changes. "noconflict" will
1507 1507 allow any update which would not trigger a merge with uncommitted
1508 1508 changes, if any are present. (default: "linear")
1509 1509
1510 1510
1511 1511 $ hg help config.ommands.update.check
1512 1512 abort: help section not found: config.ommands.update.check
1513 1513 [10]
1514 1514
1515 1515 Unrelated trailing paragraphs shouldn't be included
1516 1516
1517 1517 $ hg help config.extramsg | grep '^$'
1518 1518
1519 1519
1520 1520 Test capitalized section name
1521 1521
1522 1522 $ hg help scripting.HGPLAIN > /dev/null
1523 1523
1524 1524 Help subsection:
1525 1525
1526 1526 $ hg help config.charsets |grep "Email example:" > /dev/null
1527 1527 [1]
1528 1528
1529 1529 Show nested definitions
1530 1530 ("profiling.type"[break]"ls"[break]"stat"[break])
1531 1531
1532 1532 $ hg help config.type | egrep '^$'|wc -l
1533 1533 \s*3 (re)
1534 1534
1535 1535 $ hg help config.profiling.type.ls
1536 1536 "profiling.type.ls"
1537 1537 Use Python's built-in instrumenting profiler. This profiler works on
1538 1538 all platforms, but each line number it reports is the first line of
1539 1539 a function. This restriction makes it difficult to identify the
1540 1540 expensive parts of a non-trivial function.
1541 1541
1542 1542
1543 1543 Separate sections from subsections
1544 1544
1545 1545 $ hg help config.format | egrep '^ ("|-)|^\s*$' | uniq
1546 1546 "format"
1547 1547 --------
1548 1548
1549 1549 "usegeneraldelta"
1550 1550
1551 1551 "dotencode"
1552 1552
1553 1553 "usefncache"
1554 1554
1555 1555 "use-persistent-nodemap"
1556 1556
1557 1557 "use-share-safe"
1558 1558
1559 1559 "usestore"
1560 1560
1561 1561 "sparse-revlog"
1562 1562
1563 1563 "revlog-compression"
1564 1564
1565 1565 "bookmarks-in-store"
1566 1566
1567 1567 "profiling"
1568 1568 -----------
1569 1569
1570 1570 "format"
1571 1571
1572 1572 "progress"
1573 1573 ----------
1574 1574
1575 1575 "format"
1576 1576
1577 1577
1578 1578 Last item in help config.*:
1579 1579
1580 1580 $ hg help config.`hg help config|grep '^ "'| \
1581 1581 > tail -1|sed 's![ "]*!!g'`| \
1582 1582 > grep 'hg help -c config' > /dev/null
1583 1583 [1]
1584 1584
1585 1585 note to use help -c for general hg help config:
1586 1586
1587 1587 $ hg help config |grep 'hg help -c config' > /dev/null
1588 1588
1589 1589 Test templating help
1590 1590
1591 1591 $ hg help templating | egrep '(desc|diffstat|firstline|nonempty) '
1592 1592 desc String. The text of the changeset description.
1593 1593 diffstat String. Statistics of changes with the following format:
1594 1594 firstline Any text. Returns the first line of text.
1595 1595 nonempty Any text. Returns '(none)' if the string is empty.
1596 1596
1597 1597 Test deprecated items
1598 1598
1599 1599 $ hg help -v templating | grep currentbookmark
1600 1600 currentbookmark
1601 1601 $ hg help templating | (grep currentbookmark || true)
1602 1602
1603 1603 Test help hooks
1604 1604
1605 1605 $ cat > helphook1.py <<EOF
1606 1606 > from mercurial import help
1607 1607 >
1608 1608 > def rewrite(ui, topic, doc):
1609 1609 > return doc + b'\nhelphook1\n'
1610 1610 >
1611 1611 > def extsetup(ui):
1612 1612 > help.addtopichook(b'revisions', rewrite)
1613 1613 > EOF
1614 1614 $ cat > helphook2.py <<EOF
1615 1615 > from mercurial import help
1616 1616 >
1617 1617 > def rewrite(ui, topic, doc):
1618 1618 > return doc + b'\nhelphook2\n'
1619 1619 >
1620 1620 > def extsetup(ui):
1621 1621 > help.addtopichook(b'revisions', rewrite)
1622 1622 > EOF
1623 1623 $ echo '[extensions]' >> $HGRCPATH
1624 1624 $ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
1625 1625 $ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
1626 1626 $ hg help revsets | grep helphook
1627 1627 helphook1
1628 1628 helphook2
1629 1629
1630 1630 help -c should only show debug --debug
1631 1631
1632 1632 $ hg help -c --debug|egrep debug|wc -l|egrep '^\s*0\s*$'
1633 1633 [1]
1634 1634
1635 1635 help -c should only show deprecated for -v
1636 1636
1637 1637 $ hg help -c -v|egrep DEPRECATED|wc -l|egrep '^\s*0\s*$'
1638 1638 [1]
1639 1639
1640 1640 Test -s / --system
1641 1641
1642 1642 $ hg help config.files -s windows |grep 'etc/mercurial' | \
1643 1643 > wc -l | sed -e 's/ //g'
1644 1644 0
1645 1645 $ hg help config.files --system unix | grep 'USER' | \
1646 1646 > wc -l | sed -e 's/ //g'
1647 1647 0
1648 1648
1649 1649 Test -e / -c / -k combinations
1650 1650
1651 1651 $ hg help -c|egrep '^[A-Z].*:|^ debug'
1652 1652 Commands:
1653 1653 $ hg help -e|egrep '^[A-Z].*:|^ debug'
1654 1654 Extensions:
1655 1655 $ hg help -k|egrep '^[A-Z].*:|^ debug'
1656 1656 Topics:
1657 1657 Commands:
1658 1658 Extensions:
1659 1659 Extension Commands:
1660 1660 $ hg help -c schemes
1661 1661 abort: no such help topic: schemes
1662 1662 (try 'hg help --keyword schemes')
1663 1663 [10]
1664 1664 $ hg help -e schemes |head -1
1665 1665 schemes extension - extend schemes with shortcuts to repository swarms
1666 1666 $ hg help -c -k dates |egrep '^(Topics|Extensions|Commands):'
1667 1667 Commands:
1668 1668 $ hg help -e -k a |egrep '^(Topics|Extensions|Commands):'
1669 1669 Extensions:
1670 1670 $ hg help -e -c -k date |egrep '^(Topics|Extensions|Commands):'
1671 1671 Extensions:
1672 1672 Commands:
1673 1673 $ hg help -c commit > /dev/null
1674 1674 $ hg help -e -c commit > /dev/null
1675 1675 $ hg help -e commit
1676 1676 abort: no such help topic: commit
1677 1677 (try 'hg help --keyword commit')
1678 1678 [10]
1679 1679
1680 1680 Test keyword search help
1681 1681
1682 1682 $ cat > prefixedname.py <<EOF
1683 1683 > '''matched against word "clone"
1684 1684 > '''
1685 1685 > EOF
1686 1686 $ echo '[extensions]' >> $HGRCPATH
1687 1687 $ echo "dot.dot.prefixedname = `pwd`/prefixedname.py" >> $HGRCPATH
1688 1688 $ hg help -k clone
1689 1689 Topics:
1690 1690
1691 1691 config Configuration Files
1692 1692 extensions Using Additional Features
1693 1693 glossary Glossary
1694 1694 phases Working with Phases
1695 1695 subrepos Subrepositories
1696 1696 urls URL Paths
1697 1697
1698 1698 Commands:
1699 1699
1700 1700 bookmarks create a new bookmark or list existing bookmarks
1701 1701 clone make a copy of an existing repository
1702 1702 paths show aliases for remote repositories
1703 1703 pull pull changes from the specified source
1704 1704 update update working directory (or switch revisions)
1705 1705
1706 1706 Extensions:
1707 1707
1708 1708 clonebundles advertise pre-generated bundles to seed clones
1709 1709 narrow create clones which fetch history data for subset of files
1710 1710 (EXPERIMENTAL)
1711 1711 prefixedname matched against word "clone"
1712 1712 relink recreates hardlinks between repository clones
1713 1713
1714 1714 Extension Commands:
1715 1715
1716 1716 qclone clone main and patch repository at same time
1717 1717
1718 1718 Test unfound topic
1719 1719
1720 1720 $ hg help nonexistingtopicthatwillneverexisteverever
1721 1721 abort: no such help topic: nonexistingtopicthatwillneverexisteverever
1722 1722 (try 'hg help --keyword nonexistingtopicthatwillneverexisteverever')
1723 1723 [10]
1724 1724
1725 1725 Test unfound keyword
1726 1726
1727 1727 $ hg help --keyword nonexistingwordthatwillneverexisteverever
1728 1728 abort: no matches
1729 1729 (try 'hg help' for a list of topics)
1730 1730 [10]
1731 1731
1732 1732 Test omit indicating for help
1733 1733
1734 1734 $ cat > addverboseitems.py <<EOF
1735 1735 > r'''extension to test omit indicating.
1736 1736 >
1737 1737 > This paragraph is never omitted (for extension)
1738 1738 >
1739 1739 > .. container:: verbose
1740 1740 >
1741 1741 > This paragraph is omitted,
1742 1742 > if :hg:\`help\` is invoked without \`\`-v\`\` (for extension)
1743 1743 >
1744 1744 > This paragraph is never omitted, too (for extension)
1745 1745 > '''
1746 1746 > from __future__ import absolute_import
1747 1747 > from mercurial import commands, help
1748 1748 > testtopic = br"""This paragraph is never omitted (for topic).
1749 1749 >
1750 1750 > .. container:: verbose
1751 1751 >
1752 1752 > This paragraph is omitted,
1753 1753 > if :hg:\`help\` is invoked without \`\`-v\`\` (for topic)
1754 1754 >
1755 1755 > This paragraph is never omitted, too (for topic)
1756 1756 > """
1757 1757 > def extsetup(ui):
1758 1758 > help.helptable.append(([b"topic-containing-verbose"],
1759 1759 > b"This is the topic to test omit indicating.",
1760 1760 > lambda ui: testtopic))
1761 1761 > EOF
1762 1762 $ echo '[extensions]' >> $HGRCPATH
1763 1763 $ echo "addverboseitems = `pwd`/addverboseitems.py" >> $HGRCPATH
1764 1764 $ hg help addverboseitems
1765 1765 addverboseitems extension - extension to test omit indicating.
1766 1766
1767 1767 This paragraph is never omitted (for extension)
1768 1768
1769 1769 This paragraph is never omitted, too (for extension)
1770 1770
1771 1771 (some details hidden, use --verbose to show complete help)
1772 1772
1773 1773 no commands defined
1774 1774 $ hg help -v addverboseitems
1775 1775 addverboseitems extension - extension to test omit indicating.
1776 1776
1777 1777 This paragraph is never omitted (for extension)
1778 1778
1779 1779 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
1780 1780 extension)
1781 1781
1782 1782 This paragraph is never omitted, too (for extension)
1783 1783
1784 1784 no commands defined
1785 1785 $ hg help topic-containing-verbose
1786 1786 This is the topic to test omit indicating.
1787 1787 """"""""""""""""""""""""""""""""""""""""""
1788 1788
1789 1789 This paragraph is never omitted (for topic).
1790 1790
1791 1791 This paragraph is never omitted, too (for topic)
1792 1792
1793 1793 (some details hidden, use --verbose to show complete help)
1794 1794 $ hg help -v topic-containing-verbose
1795 1795 This is the topic to test omit indicating.
1796 1796 """"""""""""""""""""""""""""""""""""""""""
1797 1797
1798 1798 This paragraph is never omitted (for topic).
1799 1799
1800 1800 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
1801 1801 topic)
1802 1802
1803 1803 This paragraph is never omitted, too (for topic)
1804 1804
1805 1805 Test section lookup
1806 1806
1807 1807 $ hg help revset.merge
1808 1808 "merge()"
1809 1809 Changeset is a merge changeset.
1810 1810
1811 1811 $ hg help glossary.dag
1812 1812 DAG
1813 1813 The repository of changesets of a distributed version control system
1814 1814 (DVCS) can be described as a directed acyclic graph (DAG), consisting
1815 1815 of nodes and edges, where nodes correspond to changesets and edges
1816 1816 imply a parent -> child relation. This graph can be visualized by
1817 1817 graphical tools such as 'hg log --graph'. In Mercurial, the DAG is
1818 1818 limited by the requirement for children to have at most two parents.
1819 1819
1820 1820
1821 1821 $ hg help hgrc.paths
1822 1822 "paths"
1823 1823 -------
1824 1824
1825 1825 Assigns symbolic names and behavior to repositories.
1826 1826
1827 1827 Options are symbolic names defining the URL or directory that is the
1828 1828 location of the repository. Example:
1829 1829
1830 1830 [paths]
1831 1831 my_server = https://example.com/my_repo
1832 1832 local_path = /home/me/repo
1833 1833
1834 1834 These symbolic names can be used from the command line. To pull from
1835 1835 "my_server": 'hg pull my_server'. To push to "local_path": 'hg push
1836 1836 local_path'. You can check 'hg help urls' for details about valid URLs.
1837 1837
1838 1838 Options containing colons (":") denote sub-options that can influence
1839 1839 behavior for that specific path. Example:
1840 1840
1841 1841 [paths]
1842 1842 my_server = https://example.com/my_path
1843 1843 my_server:pushurl = ssh://example.com/my_path
1844 1844
1845 Paths using the 'path://otherpath' scheme will inherit the sub-options
1846 value from the path they point to.
1847
1845 1848 The following sub-options can be defined:
1846 1849
1847 1850 "pushurl"
1848 1851 The URL to use for push operations. If not defined, the location
1849 1852 defined by the path's main entry is used.
1850 1853
1851 1854 "pushrev"
1852 1855 A revset defining which revisions to push by default.
1853 1856
1854 1857 When 'hg push' is executed without a "-r" argument, the revset defined
1855 1858 by this sub-option is evaluated to determine what to push.
1856 1859
1857 1860 For example, a value of "." will push the working directory's revision
1858 1861 by default.
1859 1862
1860 1863 Revsets specifying bookmarks will not result in the bookmark being
1861 1864 pushed.
1862 1865
1863 1866 The following special named paths exist:
1864 1867
1865 1868 "default"
1866 1869 The URL or directory to use when no source or remote is specified.
1867 1870
1868 1871 'hg clone' will automatically define this path to the location the
1869 1872 repository was cloned from.
1870 1873
1871 1874 "default-push"
1872 1875 (deprecated) The URL or directory for the default 'hg push' location.
1873 1876 "default:pushurl" should be used instead.
1874 1877
1875 1878 $ hg help glossary.mcguffin
1876 1879 abort: help section not found: glossary.mcguffin
1877 1880 [10]
1878 1881
1879 1882 $ hg help glossary.mc.guffin
1880 1883 abort: help section not found: glossary.mc.guffin
1881 1884 [10]
1882 1885
1883 1886 $ hg help template.files
1884 1887 files List of strings. All files modified, added, or removed by
1885 1888 this changeset.
1886 1889 files(pattern)
1887 1890 All files of the current changeset matching the pattern. See
1888 1891 'hg help patterns'.
1889 1892
1890 1893 Test section lookup by translated message
1891 1894
1892 1895 str.lower() instead of encoding.lower(str) on translated message might
1893 1896 make message meaningless, because some encoding uses 0x41(A) - 0x5a(Z)
1894 1897 as the second or later byte of multi-byte character.
1895 1898
1896 1899 For example, "\x8bL\x98^" (translation of "record" in ja_JP.cp932)
1897 1900 contains 0x4c (L). str.lower() replaces 0x4c(L) by 0x6c(l) and this
1898 1901 replacement makes message meaningless.
1899 1902
1900 1903 This tests that section lookup by translated string isn't broken by
1901 1904 such str.lower().
1902 1905
1903 1906 $ "$PYTHON" <<EOF
1904 1907 > def escape(s):
1905 1908 > return b''.join(b'\\u%x' % ord(uc) for uc in s.decode('cp932'))
1906 1909 > # translation of "record" in ja_JP.cp932
1907 1910 > upper = b"\x8bL\x98^"
1908 1911 > # str.lower()-ed section name should be treated as different one
1909 1912 > lower = b"\x8bl\x98^"
1910 1913 > with open('ambiguous.py', 'wb') as fp:
1911 1914 > fp.write(b"""# ambiguous section names in ja_JP.cp932
1912 1915 > u'''summary of extension
1913 1916 >
1914 1917 > %s
1915 1918 > ----
1916 1919 >
1917 1920 > Upper name should show only this message
1918 1921 >
1919 1922 > %s
1920 1923 > ----
1921 1924 >
1922 1925 > Lower name should show only this message
1923 1926 >
1924 1927 > subsequent section
1925 1928 > ------------------
1926 1929 >
1927 1930 > This should be hidden at 'hg help ambiguous' with section name.
1928 1931 > '''
1929 1932 > """ % (escape(upper), escape(lower)))
1930 1933 > EOF
1931 1934
1932 1935 $ cat >> $HGRCPATH <<EOF
1933 1936 > [extensions]
1934 1937 > ambiguous = ./ambiguous.py
1935 1938 > EOF
1936 1939
1937 1940 $ "$PYTHON" <<EOF | sh
1938 1941 > from mercurial.utils import procutil
1939 1942 > upper = b"\x8bL\x98^"
1940 1943 > procutil.stdout.write(b"hg --encoding cp932 help -e ambiguous.%s\n" % upper)
1941 1944 > EOF
1942 1945 \x8bL\x98^ (esc)
1943 1946 ----
1944 1947
1945 1948 Upper name should show only this message
1946 1949
1947 1950
1948 1951 $ "$PYTHON" <<EOF | sh
1949 1952 > from mercurial.utils import procutil
1950 1953 > lower = b"\x8bl\x98^"
1951 1954 > procutil.stdout.write(b"hg --encoding cp932 help -e ambiguous.%s\n" % lower)
1952 1955 > EOF
1953 1956 \x8bl\x98^ (esc)
1954 1957 ----
1955 1958
1956 1959 Lower name should show only this message
1957 1960
1958 1961
1959 1962 $ cat >> $HGRCPATH <<EOF
1960 1963 > [extensions]
1961 1964 > ambiguous = !
1962 1965 > EOF
1963 1966
1964 1967 Show help content of disabled extensions
1965 1968
1966 1969 $ cat >> $HGRCPATH <<EOF
1967 1970 > [extensions]
1968 1971 > ambiguous = !./ambiguous.py
1969 1972 > EOF
1970 1973 $ hg help -e ambiguous
1971 1974 ambiguous extension - (no help text available)
1972 1975
1973 1976 (use 'hg help extensions' for information on enabling extensions)
1974 1977
1975 1978 Test dynamic list of merge tools only shows up once
1976 1979 $ hg help merge-tools
1977 1980 Merge Tools
1978 1981 """""""""""
1979 1982
1980 1983 To merge files Mercurial uses merge tools.
1981 1984
1982 1985 A merge tool combines two different versions of a file into a merged file.
1983 1986 Merge tools are given the two files and the greatest common ancestor of
1984 1987 the two file versions, so they can determine the changes made on both
1985 1988 branches.
1986 1989
1987 1990 Merge tools are used both for 'hg resolve', 'hg merge', 'hg update', 'hg
1988 1991 backout' and in several extensions.
1989 1992
1990 1993 Usually, the merge tool tries to automatically reconcile the files by
1991 1994 combining all non-overlapping changes that occurred separately in the two
1992 1995 different evolutions of the same initial base file. Furthermore, some
1993 1996 interactive merge programs make it easier to manually resolve conflicting
1994 1997 merges, either in a graphical way, or by inserting some conflict markers.
1995 1998 Mercurial does not include any interactive merge programs but relies on
1996 1999 external tools for that.
1997 2000
1998 2001 Available merge tools
1999 2002 =====================
2000 2003
2001 2004 External merge tools and their properties are configured in the merge-
2002 2005 tools configuration section - see hgrc(5) - but they can often just be
2003 2006 named by their executable.
2004 2007
2005 2008 A merge tool is generally usable if its executable can be found on the
2006 2009 system and if it can handle the merge. The executable is found if it is an
2007 2010 absolute or relative executable path or the name of an application in the
2008 2011 executable search path. The tool is assumed to be able to handle the merge
2009 2012 if it can handle symlinks if the file is a symlink, if it can handle
2010 2013 binary files if the file is binary, and if a GUI is available if the tool
2011 2014 requires a GUI.
2012 2015
2013 2016 There are some internal merge tools which can be used. The internal merge
2014 2017 tools are:
2015 2018
2016 2019 ":dump"
2017 2020 Creates three versions of the files to merge, containing the contents of
2018 2021 local, other and base. These files can then be used to perform a merge
2019 2022 manually. If the file to be merged is named "a.txt", these files will
2020 2023 accordingly be named "a.txt.local", "a.txt.other" and "a.txt.base" and
2021 2024 they will be placed in the same directory as "a.txt".
2022 2025
2023 2026 This implies premerge. Therefore, files aren't dumped, if premerge runs
2024 2027 successfully. Use :forcedump to forcibly write files out.
2025 2028
2026 2029 (actual capabilities: binary, symlink)
2027 2030
2028 2031 ":fail"
2029 2032 Rather than attempting to merge files that were modified on both
2030 2033 branches, it marks them as unresolved. The resolve command must be used
2031 2034 to resolve these conflicts.
2032 2035
2033 2036 (actual capabilities: binary, symlink)
2034 2037
2035 2038 ":forcedump"
2036 2039 Creates three versions of the files as same as :dump, but omits
2037 2040 premerge.
2038 2041
2039 2042 (actual capabilities: binary, symlink)
2040 2043
2041 2044 ":local"
2042 2045 Uses the local 'p1()' version of files as the merged version.
2043 2046
2044 2047 (actual capabilities: binary, symlink)
2045 2048
2046 2049 ":merge"
2047 2050 Uses the internal non-interactive simple merge algorithm for merging
2048 2051 files. It will fail if there are any conflicts and leave markers in the
2049 2052 partially merged file. Markers will have two sections, one for each side
2050 2053 of merge.
2051 2054
2052 2055 ":merge-local"
2053 2056 Like :merge, but resolve all conflicts non-interactively in favor of the
2054 2057 local 'p1()' changes.
2055 2058
2056 2059 ":merge-other"
2057 2060 Like :merge, but resolve all conflicts non-interactively in favor of the
2058 2061 other 'p2()' changes.
2059 2062
2060 2063 ":merge3"
2061 2064 Uses the internal non-interactive simple merge algorithm for merging
2062 2065 files. It will fail if there are any conflicts and leave markers in the
2063 2066 partially merged file. Marker will have three sections, one from each
2064 2067 side of the merge and one for the base content.
2065 2068
2066 2069 ":mergediff"
2067 2070 Uses the internal non-interactive simple merge algorithm for merging
2068 2071 files. It will fail if there are any conflicts and leave markers in the
2069 2072 partially merged file. The marker will have two sections, one with the
2070 2073 content from one side of the merge, and one with a diff from the base
2071 2074 content to the content on the other side. (experimental)
2072 2075
2073 2076 ":other"
2074 2077 Uses the other 'p2()' version of files as the merged version.
2075 2078
2076 2079 (actual capabilities: binary, symlink)
2077 2080
2078 2081 ":prompt"
2079 2082 Asks the user which of the local 'p1()' or the other 'p2()' version to
2080 2083 keep as the merged version.
2081 2084
2082 2085 (actual capabilities: binary, symlink)
2083 2086
2084 2087 ":tagmerge"
2085 2088 Uses the internal tag merge algorithm (experimental).
2086 2089
2087 2090 ":union"
2088 2091 Uses the internal non-interactive simple merge algorithm for merging
2089 2092 files. It will use both left and right sides for conflict regions. No
2090 2093 markers are inserted.
2091 2094
2092 2095 Internal tools are always available and do not require a GUI but will by
2093 2096 default not handle symlinks or binary files. See next section for detail
2094 2097 about "actual capabilities" described above.
2095 2098
2096 2099 Choosing a merge tool
2097 2100 =====================
2098 2101
2099 2102 Mercurial uses these rules when deciding which merge tool to use:
2100 2103
2101 2104 1. If a tool has been specified with the --tool option to merge or
2102 2105 resolve, it is used. If it is the name of a tool in the merge-tools
2103 2106 configuration, its configuration is used. Otherwise the specified tool
2104 2107 must be executable by the shell.
2105 2108 2. If the "HGMERGE" environment variable is present, its value is used and
2106 2109 must be executable by the shell.
2107 2110 3. If the filename of the file to be merged matches any of the patterns in
2108 2111 the merge-patterns configuration section, the first usable merge tool
2109 2112 corresponding to a matching pattern is used.
2110 2113 4. If ui.merge is set it will be considered next. If the value is not the
2111 2114 name of a configured tool, the specified value is used and must be
2112 2115 executable by the shell. Otherwise the named tool is used if it is
2113 2116 usable.
2114 2117 5. If any usable merge tools are present in the merge-tools configuration
2115 2118 section, the one with the highest priority is used.
2116 2119 6. If a program named "hgmerge" can be found on the system, it is used -
2117 2120 but it will by default not be used for symlinks and binary files.
2118 2121 7. If the file to be merged is not binary and is not a symlink, then
2119 2122 internal ":merge" is used.
2120 2123 8. Otherwise, ":prompt" is used.
2121 2124
2122 2125 For historical reason, Mercurial treats merge tools as below while
2123 2126 examining rules above.
2124 2127
2125 2128 step specified via binary symlink
2126 2129 ----------------------------------
2127 2130 1. --tool o/o o/o
2128 2131 2. HGMERGE o/o o/o
2129 2132 3. merge-patterns o/o(*) x/?(*)
2130 2133 4. ui.merge x/?(*) x/?(*)
2131 2134
2132 2135 Each capability column indicates Mercurial behavior for internal/external
2133 2136 merge tools at examining each rule.
2134 2137
2135 2138 - "o": "assume that a tool has capability"
2136 2139 - "x": "assume that a tool does not have capability"
2137 2140 - "?": "check actual capability of a tool"
2138 2141
2139 2142 If "merge.strict-capability-check" configuration is true, Mercurial checks
2140 2143 capabilities of merge tools strictly in (*) cases above (= each capability
2141 2144 column becomes "?/?"). It is false by default for backward compatibility.
2142 2145
2143 2146 Note:
2144 2147 After selecting a merge program, Mercurial will by default attempt to
2145 2148 merge the files using a simple merge algorithm first. Only if it
2146 2149 doesn't succeed because of conflicting changes will Mercurial actually
2147 2150 execute the merge program. Whether to use the simple merge algorithm
2148 2151 first can be controlled by the premerge setting of the merge tool.
2149 2152 Premerge is enabled by default unless the file is binary or a symlink.
2150 2153
2151 2154 See the merge-tools and ui sections of hgrc(5) for details on the
2152 2155 configuration of merge tools.
2153 2156
2154 2157 Compression engines listed in `hg help bundlespec`
2155 2158
2156 2159 $ hg help bundlespec | grep gzip
2157 2160 "v1" bundles can only use the "gzip", "bzip2", and "none" compression
2158 2161 An algorithm that produces smaller bundles than "gzip".
2159 2162 This engine will likely produce smaller bundles than "gzip" but will be
2160 2163 "gzip"
2161 2164 better compression than "gzip". It also frequently yields better (?)
2162 2165
2163 2166 Test usage of section marks in help documents
2164 2167
2165 2168 $ cd "$TESTDIR"/../doc
2166 2169 $ "$PYTHON" check-seclevel.py
2167 2170 $ cd $TESTTMP
2168 2171
2169 2172 #if serve
2170 2173
2171 2174 Test the help pages in hgweb.
2172 2175
2173 2176 Dish up an empty repo; serve it cold.
2174 2177
2175 2178 $ hg init "$TESTTMP/test"
2176 2179 $ hg serve -R "$TESTTMP/test" -n test -p $HGPORT -d --pid-file=hg.pid
2177 2180 $ cat hg.pid >> $DAEMON_PIDS
2178 2181
2179 2182 $ get-with-headers.py $LOCALIP:$HGPORT "help"
2180 2183 200 Script output follows
2181 2184
2182 2185 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2183 2186 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2184 2187 <head>
2185 2188 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2186 2189 <meta name="robots" content="index, nofollow" />
2187 2190 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2188 2191 <script type="text/javascript" src="/static/mercurial.js"></script>
2189 2192
2190 2193 <title>Help: Index</title>
2191 2194 </head>
2192 2195 <body>
2193 2196
2194 2197 <div class="container">
2195 2198 <div class="menu">
2196 2199 <div class="logo">
2197 2200 <a href="https://mercurial-scm.org/">
2198 2201 <img src="/static/hglogo.png" alt="mercurial" /></a>
2199 2202 </div>
2200 2203 <ul>
2201 2204 <li><a href="/shortlog">log</a></li>
2202 2205 <li><a href="/graph">graph</a></li>
2203 2206 <li><a href="/tags">tags</a></li>
2204 2207 <li><a href="/bookmarks">bookmarks</a></li>
2205 2208 <li><a href="/branches">branches</a></li>
2206 2209 </ul>
2207 2210 <ul>
2208 2211 <li class="active">help</li>
2209 2212 </ul>
2210 2213 </div>
2211 2214
2212 2215 <div class="main">
2213 2216 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2214 2217
2215 2218 <form class="search" action="/log">
2216 2219
2217 2220 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2218 2221 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2219 2222 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2220 2223 </form>
2221 2224 <table class="bigtable">
2222 2225 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
2223 2226
2224 2227 <tr><td>
2225 2228 <a href="/help/bundlespec">
2226 2229 bundlespec
2227 2230 </a>
2228 2231 </td><td>
2229 2232 Bundle File Formats
2230 2233 </td></tr>
2231 2234 <tr><td>
2232 2235 <a href="/help/color">
2233 2236 color
2234 2237 </a>
2235 2238 </td><td>
2236 2239 Colorizing Outputs
2237 2240 </td></tr>
2238 2241 <tr><td>
2239 2242 <a href="/help/config">
2240 2243 config
2241 2244 </a>
2242 2245 </td><td>
2243 2246 Configuration Files
2244 2247 </td></tr>
2245 2248 <tr><td>
2246 2249 <a href="/help/dates">
2247 2250 dates
2248 2251 </a>
2249 2252 </td><td>
2250 2253 Date Formats
2251 2254 </td></tr>
2252 2255 <tr><td>
2253 2256 <a href="/help/deprecated">
2254 2257 deprecated
2255 2258 </a>
2256 2259 </td><td>
2257 2260 Deprecated Features
2258 2261 </td></tr>
2259 2262 <tr><td>
2260 2263 <a href="/help/diffs">
2261 2264 diffs
2262 2265 </a>
2263 2266 </td><td>
2264 2267 Diff Formats
2265 2268 </td></tr>
2266 2269 <tr><td>
2267 2270 <a href="/help/environment">
2268 2271 environment
2269 2272 </a>
2270 2273 </td><td>
2271 2274 Environment Variables
2272 2275 </td></tr>
2273 2276 <tr><td>
2274 2277 <a href="/help/extensions">
2275 2278 extensions
2276 2279 </a>
2277 2280 </td><td>
2278 2281 Using Additional Features
2279 2282 </td></tr>
2280 2283 <tr><td>
2281 2284 <a href="/help/filesets">
2282 2285 filesets
2283 2286 </a>
2284 2287 </td><td>
2285 2288 Specifying File Sets
2286 2289 </td></tr>
2287 2290 <tr><td>
2288 2291 <a href="/help/flags">
2289 2292 flags
2290 2293 </a>
2291 2294 </td><td>
2292 2295 Command-line flags
2293 2296 </td></tr>
2294 2297 <tr><td>
2295 2298 <a href="/help/glossary">
2296 2299 glossary
2297 2300 </a>
2298 2301 </td><td>
2299 2302 Glossary
2300 2303 </td></tr>
2301 2304 <tr><td>
2302 2305 <a href="/help/hgignore">
2303 2306 hgignore
2304 2307 </a>
2305 2308 </td><td>
2306 2309 Syntax for Mercurial Ignore Files
2307 2310 </td></tr>
2308 2311 <tr><td>
2309 2312 <a href="/help/hgweb">
2310 2313 hgweb
2311 2314 </a>
2312 2315 </td><td>
2313 2316 Configuring hgweb
2314 2317 </td></tr>
2315 2318 <tr><td>
2316 2319 <a href="/help/internals">
2317 2320 internals
2318 2321 </a>
2319 2322 </td><td>
2320 2323 Technical implementation topics
2321 2324 </td></tr>
2322 2325 <tr><td>
2323 2326 <a href="/help/merge-tools">
2324 2327 merge-tools
2325 2328 </a>
2326 2329 </td><td>
2327 2330 Merge Tools
2328 2331 </td></tr>
2329 2332 <tr><td>
2330 2333 <a href="/help/pager">
2331 2334 pager
2332 2335 </a>
2333 2336 </td><td>
2334 2337 Pager Support
2335 2338 </td></tr>
2336 2339 <tr><td>
2337 2340 <a href="/help/patterns">
2338 2341 patterns
2339 2342 </a>
2340 2343 </td><td>
2341 2344 File Name Patterns
2342 2345 </td></tr>
2343 2346 <tr><td>
2344 2347 <a href="/help/phases">
2345 2348 phases
2346 2349 </a>
2347 2350 </td><td>
2348 2351 Working with Phases
2349 2352 </td></tr>
2350 2353 <tr><td>
2351 2354 <a href="/help/revisions">
2352 2355 revisions
2353 2356 </a>
2354 2357 </td><td>
2355 2358 Specifying Revisions
2356 2359 </td></tr>
2357 2360 <tr><td>
2358 2361 <a href="/help/scripting">
2359 2362 scripting
2360 2363 </a>
2361 2364 </td><td>
2362 2365 Using Mercurial from scripts and automation
2363 2366 </td></tr>
2364 2367 <tr><td>
2365 2368 <a href="/help/subrepos">
2366 2369 subrepos
2367 2370 </a>
2368 2371 </td><td>
2369 2372 Subrepositories
2370 2373 </td></tr>
2371 2374 <tr><td>
2372 2375 <a href="/help/templating">
2373 2376 templating
2374 2377 </a>
2375 2378 </td><td>
2376 2379 Template Usage
2377 2380 </td></tr>
2378 2381 <tr><td>
2379 2382 <a href="/help/urls">
2380 2383 urls
2381 2384 </a>
2382 2385 </td><td>
2383 2386 URL Paths
2384 2387 </td></tr>
2385 2388 <tr><td>
2386 2389 <a href="/help/topic-containing-verbose">
2387 2390 topic-containing-verbose
2388 2391 </a>
2389 2392 </td><td>
2390 2393 This is the topic to test omit indicating.
2391 2394 </td></tr>
2392 2395
2393 2396
2394 2397 <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
2395 2398
2396 2399 <tr><td>
2397 2400 <a href="/help/abort">
2398 2401 abort
2399 2402 </a>
2400 2403 </td><td>
2401 2404 abort an unfinished operation (EXPERIMENTAL)
2402 2405 </td></tr>
2403 2406 <tr><td>
2404 2407 <a href="/help/add">
2405 2408 add
2406 2409 </a>
2407 2410 </td><td>
2408 2411 add the specified files on the next commit
2409 2412 </td></tr>
2410 2413 <tr><td>
2411 2414 <a href="/help/annotate">
2412 2415 annotate
2413 2416 </a>
2414 2417 </td><td>
2415 2418 show changeset information by line for each file
2416 2419 </td></tr>
2417 2420 <tr><td>
2418 2421 <a href="/help/clone">
2419 2422 clone
2420 2423 </a>
2421 2424 </td><td>
2422 2425 make a copy of an existing repository
2423 2426 </td></tr>
2424 2427 <tr><td>
2425 2428 <a href="/help/commit">
2426 2429 commit
2427 2430 </a>
2428 2431 </td><td>
2429 2432 commit the specified files or all outstanding changes
2430 2433 </td></tr>
2431 2434 <tr><td>
2432 2435 <a href="/help/continue">
2433 2436 continue
2434 2437 </a>
2435 2438 </td><td>
2436 2439 resumes an interrupted operation (EXPERIMENTAL)
2437 2440 </td></tr>
2438 2441 <tr><td>
2439 2442 <a href="/help/diff">
2440 2443 diff
2441 2444 </a>
2442 2445 </td><td>
2443 2446 diff repository (or selected files)
2444 2447 </td></tr>
2445 2448 <tr><td>
2446 2449 <a href="/help/export">
2447 2450 export
2448 2451 </a>
2449 2452 </td><td>
2450 2453 dump the header and diffs for one or more changesets
2451 2454 </td></tr>
2452 2455 <tr><td>
2453 2456 <a href="/help/forget">
2454 2457 forget
2455 2458 </a>
2456 2459 </td><td>
2457 2460 forget the specified files on the next commit
2458 2461 </td></tr>
2459 2462 <tr><td>
2460 2463 <a href="/help/init">
2461 2464 init
2462 2465 </a>
2463 2466 </td><td>
2464 2467 create a new repository in the given directory
2465 2468 </td></tr>
2466 2469 <tr><td>
2467 2470 <a href="/help/log">
2468 2471 log
2469 2472 </a>
2470 2473 </td><td>
2471 2474 show revision history of entire repository or files
2472 2475 </td></tr>
2473 2476 <tr><td>
2474 2477 <a href="/help/merge">
2475 2478 merge
2476 2479 </a>
2477 2480 </td><td>
2478 2481 merge another revision into working directory
2479 2482 </td></tr>
2480 2483 <tr><td>
2481 2484 <a href="/help/pull">
2482 2485 pull
2483 2486 </a>
2484 2487 </td><td>
2485 2488 pull changes from the specified source
2486 2489 </td></tr>
2487 2490 <tr><td>
2488 2491 <a href="/help/push">
2489 2492 push
2490 2493 </a>
2491 2494 </td><td>
2492 2495 push changes to the specified destination
2493 2496 </td></tr>
2494 2497 <tr><td>
2495 2498 <a href="/help/remove">
2496 2499 remove
2497 2500 </a>
2498 2501 </td><td>
2499 2502 remove the specified files on the next commit
2500 2503 </td></tr>
2501 2504 <tr><td>
2502 2505 <a href="/help/serve">
2503 2506 serve
2504 2507 </a>
2505 2508 </td><td>
2506 2509 start stand-alone webserver
2507 2510 </td></tr>
2508 2511 <tr><td>
2509 2512 <a href="/help/status">
2510 2513 status
2511 2514 </a>
2512 2515 </td><td>
2513 2516 show changed files in the working directory
2514 2517 </td></tr>
2515 2518 <tr><td>
2516 2519 <a href="/help/summary">
2517 2520 summary
2518 2521 </a>
2519 2522 </td><td>
2520 2523 summarize working directory state
2521 2524 </td></tr>
2522 2525 <tr><td>
2523 2526 <a href="/help/update">
2524 2527 update
2525 2528 </a>
2526 2529 </td><td>
2527 2530 update working directory (or switch revisions)
2528 2531 </td></tr>
2529 2532
2530 2533
2531 2534
2532 2535 <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
2533 2536
2534 2537 <tr><td>
2535 2538 <a href="/help/addremove">
2536 2539 addremove
2537 2540 </a>
2538 2541 </td><td>
2539 2542 add all new files, delete all missing files
2540 2543 </td></tr>
2541 2544 <tr><td>
2542 2545 <a href="/help/archive">
2543 2546 archive
2544 2547 </a>
2545 2548 </td><td>
2546 2549 create an unversioned archive of a repository revision
2547 2550 </td></tr>
2548 2551 <tr><td>
2549 2552 <a href="/help/backout">
2550 2553 backout
2551 2554 </a>
2552 2555 </td><td>
2553 2556 reverse effect of earlier changeset
2554 2557 </td></tr>
2555 2558 <tr><td>
2556 2559 <a href="/help/bisect">
2557 2560 bisect
2558 2561 </a>
2559 2562 </td><td>
2560 2563 subdivision search of changesets
2561 2564 </td></tr>
2562 2565 <tr><td>
2563 2566 <a href="/help/bookmarks">
2564 2567 bookmarks
2565 2568 </a>
2566 2569 </td><td>
2567 2570 create a new bookmark or list existing bookmarks
2568 2571 </td></tr>
2569 2572 <tr><td>
2570 2573 <a href="/help/branch">
2571 2574 branch
2572 2575 </a>
2573 2576 </td><td>
2574 2577 set or show the current branch name
2575 2578 </td></tr>
2576 2579 <tr><td>
2577 2580 <a href="/help/branches">
2578 2581 branches
2579 2582 </a>
2580 2583 </td><td>
2581 2584 list repository named branches
2582 2585 </td></tr>
2583 2586 <tr><td>
2584 2587 <a href="/help/bundle">
2585 2588 bundle
2586 2589 </a>
2587 2590 </td><td>
2588 2591 create a bundle file
2589 2592 </td></tr>
2590 2593 <tr><td>
2591 2594 <a href="/help/cat">
2592 2595 cat
2593 2596 </a>
2594 2597 </td><td>
2595 2598 output the current or given revision of files
2596 2599 </td></tr>
2597 2600 <tr><td>
2598 2601 <a href="/help/config">
2599 2602 config
2600 2603 </a>
2601 2604 </td><td>
2602 2605 show combined config settings from all hgrc files
2603 2606 </td></tr>
2604 2607 <tr><td>
2605 2608 <a href="/help/copy">
2606 2609 copy
2607 2610 </a>
2608 2611 </td><td>
2609 2612 mark files as copied for the next commit
2610 2613 </td></tr>
2611 2614 <tr><td>
2612 2615 <a href="/help/files">
2613 2616 files
2614 2617 </a>
2615 2618 </td><td>
2616 2619 list tracked files
2617 2620 </td></tr>
2618 2621 <tr><td>
2619 2622 <a href="/help/graft">
2620 2623 graft
2621 2624 </a>
2622 2625 </td><td>
2623 2626 copy changes from other branches onto the current branch
2624 2627 </td></tr>
2625 2628 <tr><td>
2626 2629 <a href="/help/grep">
2627 2630 grep
2628 2631 </a>
2629 2632 </td><td>
2630 2633 search for a pattern in specified files
2631 2634 </td></tr>
2632 2635 <tr><td>
2633 2636 <a href="/help/hashelp">
2634 2637 hashelp
2635 2638 </a>
2636 2639 </td><td>
2637 2640 Extension command's help
2638 2641 </td></tr>
2639 2642 <tr><td>
2640 2643 <a href="/help/heads">
2641 2644 heads
2642 2645 </a>
2643 2646 </td><td>
2644 2647 show branch heads
2645 2648 </td></tr>
2646 2649 <tr><td>
2647 2650 <a href="/help/help">
2648 2651 help
2649 2652 </a>
2650 2653 </td><td>
2651 2654 show help for a given topic or a help overview
2652 2655 </td></tr>
2653 2656 <tr><td>
2654 2657 <a href="/help/hgalias">
2655 2658 hgalias
2656 2659 </a>
2657 2660 </td><td>
2658 2661 My doc
2659 2662 </td></tr>
2660 2663 <tr><td>
2661 2664 <a href="/help/hgaliasnodoc">
2662 2665 hgaliasnodoc
2663 2666 </a>
2664 2667 </td><td>
2665 2668 summarize working directory state
2666 2669 </td></tr>
2667 2670 <tr><td>
2668 2671 <a href="/help/identify">
2669 2672 identify
2670 2673 </a>
2671 2674 </td><td>
2672 2675 identify the working directory or specified revision
2673 2676 </td></tr>
2674 2677 <tr><td>
2675 2678 <a href="/help/import">
2676 2679 import
2677 2680 </a>
2678 2681 </td><td>
2679 2682 import an ordered set of patches
2680 2683 </td></tr>
2681 2684 <tr><td>
2682 2685 <a href="/help/incoming">
2683 2686 incoming
2684 2687 </a>
2685 2688 </td><td>
2686 2689 show new changesets found in source
2687 2690 </td></tr>
2688 2691 <tr><td>
2689 2692 <a href="/help/manifest">
2690 2693 manifest
2691 2694 </a>
2692 2695 </td><td>
2693 2696 output the current or given revision of the project manifest
2694 2697 </td></tr>
2695 2698 <tr><td>
2696 2699 <a href="/help/nohelp">
2697 2700 nohelp
2698 2701 </a>
2699 2702 </td><td>
2700 2703 (no help text available)
2701 2704 </td></tr>
2702 2705 <tr><td>
2703 2706 <a href="/help/outgoing">
2704 2707 outgoing
2705 2708 </a>
2706 2709 </td><td>
2707 2710 show changesets not found in the destination
2708 2711 </td></tr>
2709 2712 <tr><td>
2710 2713 <a href="/help/paths">
2711 2714 paths
2712 2715 </a>
2713 2716 </td><td>
2714 2717 show aliases for remote repositories
2715 2718 </td></tr>
2716 2719 <tr><td>
2717 2720 <a href="/help/phase">
2718 2721 phase
2719 2722 </a>
2720 2723 </td><td>
2721 2724 set or show the current phase name
2722 2725 </td></tr>
2723 2726 <tr><td>
2724 2727 <a href="/help/purge">
2725 2728 purge
2726 2729 </a>
2727 2730 </td><td>
2728 2731 removes files not tracked by Mercurial
2729 2732 </td></tr>
2730 2733 <tr><td>
2731 2734 <a href="/help/recover">
2732 2735 recover
2733 2736 </a>
2734 2737 </td><td>
2735 2738 roll back an interrupted transaction
2736 2739 </td></tr>
2737 2740 <tr><td>
2738 2741 <a href="/help/rename">
2739 2742 rename
2740 2743 </a>
2741 2744 </td><td>
2742 2745 rename files; equivalent of copy + remove
2743 2746 </td></tr>
2744 2747 <tr><td>
2745 2748 <a href="/help/resolve">
2746 2749 resolve
2747 2750 </a>
2748 2751 </td><td>
2749 2752 redo merges or set/view the merge status of files
2750 2753 </td></tr>
2751 2754 <tr><td>
2752 2755 <a href="/help/revert">
2753 2756 revert
2754 2757 </a>
2755 2758 </td><td>
2756 2759 restore files to their checkout state
2757 2760 </td></tr>
2758 2761 <tr><td>
2759 2762 <a href="/help/root">
2760 2763 root
2761 2764 </a>
2762 2765 </td><td>
2763 2766 print the root (top) of the current working directory
2764 2767 </td></tr>
2765 2768 <tr><td>
2766 2769 <a href="/help/shellalias">
2767 2770 shellalias
2768 2771 </a>
2769 2772 </td><td>
2770 2773 (no help text available)
2771 2774 </td></tr>
2772 2775 <tr><td>
2773 2776 <a href="/help/shelve">
2774 2777 shelve
2775 2778 </a>
2776 2779 </td><td>
2777 2780 save and set aside changes from the working directory
2778 2781 </td></tr>
2779 2782 <tr><td>
2780 2783 <a href="/help/tag">
2781 2784 tag
2782 2785 </a>
2783 2786 </td><td>
2784 2787 add one or more tags for the current or given revision
2785 2788 </td></tr>
2786 2789 <tr><td>
2787 2790 <a href="/help/tags">
2788 2791 tags
2789 2792 </a>
2790 2793 </td><td>
2791 2794 list repository tags
2792 2795 </td></tr>
2793 2796 <tr><td>
2794 2797 <a href="/help/unbundle">
2795 2798 unbundle
2796 2799 </a>
2797 2800 </td><td>
2798 2801 apply one or more bundle files
2799 2802 </td></tr>
2800 2803 <tr><td>
2801 2804 <a href="/help/unshelve">
2802 2805 unshelve
2803 2806 </a>
2804 2807 </td><td>
2805 2808 restore a shelved change to the working directory
2806 2809 </td></tr>
2807 2810 <tr><td>
2808 2811 <a href="/help/verify">
2809 2812 verify
2810 2813 </a>
2811 2814 </td><td>
2812 2815 verify the integrity of the repository
2813 2816 </td></tr>
2814 2817 <tr><td>
2815 2818 <a href="/help/version">
2816 2819 version
2817 2820 </a>
2818 2821 </td><td>
2819 2822 output version and copyright information
2820 2823 </td></tr>
2821 2824
2822 2825
2823 2826 </table>
2824 2827 </div>
2825 2828 </div>
2826 2829
2827 2830
2828 2831
2829 2832 </body>
2830 2833 </html>
2831 2834
2832 2835
2833 2836 $ get-with-headers.py $LOCALIP:$HGPORT "help/add"
2834 2837 200 Script output follows
2835 2838
2836 2839 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2837 2840 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
2838 2841 <head>
2839 2842 <link rel="icon" href="/static/hgicon.png" type="image/png" />
2840 2843 <meta name="robots" content="index, nofollow" />
2841 2844 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
2842 2845 <script type="text/javascript" src="/static/mercurial.js"></script>
2843 2846
2844 2847 <title>Help: add</title>
2845 2848 </head>
2846 2849 <body>
2847 2850
2848 2851 <div class="container">
2849 2852 <div class="menu">
2850 2853 <div class="logo">
2851 2854 <a href="https://mercurial-scm.org/">
2852 2855 <img src="/static/hglogo.png" alt="mercurial" /></a>
2853 2856 </div>
2854 2857 <ul>
2855 2858 <li><a href="/shortlog">log</a></li>
2856 2859 <li><a href="/graph">graph</a></li>
2857 2860 <li><a href="/tags">tags</a></li>
2858 2861 <li><a href="/bookmarks">bookmarks</a></li>
2859 2862 <li><a href="/branches">branches</a></li>
2860 2863 </ul>
2861 2864 <ul>
2862 2865 <li class="active"><a href="/help">help</a></li>
2863 2866 </ul>
2864 2867 </div>
2865 2868
2866 2869 <div class="main">
2867 2870 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
2868 2871 <h3>Help: add</h3>
2869 2872
2870 2873 <form class="search" action="/log">
2871 2874
2872 2875 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
2873 2876 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2874 2877 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2875 2878 </form>
2876 2879 <div id="doc">
2877 2880 <p>
2878 2881 hg add [OPTION]... [FILE]...
2879 2882 </p>
2880 2883 <p>
2881 2884 add the specified files on the next commit
2882 2885 </p>
2883 2886 <p>
2884 2887 Schedule files to be version controlled and added to the
2885 2888 repository.
2886 2889 </p>
2887 2890 <p>
2888 2891 The files will be added to the repository at the next commit. To
2889 2892 undo an add before that, see 'hg forget'.
2890 2893 </p>
2891 2894 <p>
2892 2895 If no names are given, add all files to the repository (except
2893 2896 files matching &quot;.hgignore&quot;).
2894 2897 </p>
2895 2898 <p>
2896 2899 Examples:
2897 2900 </p>
2898 2901 <ul>
2899 2902 <li> New (unknown) files are added automatically by 'hg add':
2900 2903 <pre>
2901 2904 \$ ls (re)
2902 2905 foo.c
2903 2906 \$ hg status (re)
2904 2907 ? foo.c
2905 2908 \$ hg add (re)
2906 2909 adding foo.c
2907 2910 \$ hg status (re)
2908 2911 A foo.c
2909 2912 </pre>
2910 2913 <li> Specific files to be added can be specified:
2911 2914 <pre>
2912 2915 \$ ls (re)
2913 2916 bar.c foo.c
2914 2917 \$ hg status (re)
2915 2918 ? bar.c
2916 2919 ? foo.c
2917 2920 \$ hg add bar.c (re)
2918 2921 \$ hg status (re)
2919 2922 A bar.c
2920 2923 ? foo.c
2921 2924 </pre>
2922 2925 </ul>
2923 2926 <p>
2924 2927 Returns 0 if all files are successfully added.
2925 2928 </p>
2926 2929 <p>
2927 2930 options ([+] can be repeated):
2928 2931 </p>
2929 2932 <table>
2930 2933 <tr><td>-I</td>
2931 2934 <td>--include PATTERN [+]</td>
2932 2935 <td>include names matching the given patterns</td></tr>
2933 2936 <tr><td>-X</td>
2934 2937 <td>--exclude PATTERN [+]</td>
2935 2938 <td>exclude names matching the given patterns</td></tr>
2936 2939 <tr><td>-S</td>
2937 2940 <td>--subrepos</td>
2938 2941 <td>recurse into subrepositories</td></tr>
2939 2942 <tr><td>-n</td>
2940 2943 <td>--dry-run</td>
2941 2944 <td>do not perform actions, just print output</td></tr>
2942 2945 </table>
2943 2946 <p>
2944 2947 global options ([+] can be repeated):
2945 2948 </p>
2946 2949 <table>
2947 2950 <tr><td>-R</td>
2948 2951 <td>--repository REPO</td>
2949 2952 <td>repository root directory or name of overlay bundle file</td></tr>
2950 2953 <tr><td></td>
2951 2954 <td>--cwd DIR</td>
2952 2955 <td>change working directory</td></tr>
2953 2956 <tr><td>-y</td>
2954 2957 <td>--noninteractive</td>
2955 2958 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
2956 2959 <tr><td>-q</td>
2957 2960 <td>--quiet</td>
2958 2961 <td>suppress output</td></tr>
2959 2962 <tr><td>-v</td>
2960 2963 <td>--verbose</td>
2961 2964 <td>enable additional output</td></tr>
2962 2965 <tr><td></td>
2963 2966 <td>--color TYPE</td>
2964 2967 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
2965 2968 <tr><td></td>
2966 2969 <td>--config CONFIG [+]</td>
2967 2970 <td>set/override config option (use 'section.name=value')</td></tr>
2968 2971 <tr><td></td>
2969 2972 <td>--debug</td>
2970 2973 <td>enable debugging output</td></tr>
2971 2974 <tr><td></td>
2972 2975 <td>--debugger</td>
2973 2976 <td>start debugger</td></tr>
2974 2977 <tr><td></td>
2975 2978 <td>--encoding ENCODE</td>
2976 2979 <td>set the charset encoding (default: ascii)</td></tr>
2977 2980 <tr><td></td>
2978 2981 <td>--encodingmode MODE</td>
2979 2982 <td>set the charset encoding mode (default: strict)</td></tr>
2980 2983 <tr><td></td>
2981 2984 <td>--traceback</td>
2982 2985 <td>always print a traceback on exception</td></tr>
2983 2986 <tr><td></td>
2984 2987 <td>--time</td>
2985 2988 <td>time how long the command takes</td></tr>
2986 2989 <tr><td></td>
2987 2990 <td>--profile</td>
2988 2991 <td>print command execution profile</td></tr>
2989 2992 <tr><td></td>
2990 2993 <td>--version</td>
2991 2994 <td>output version information and exit</td></tr>
2992 2995 <tr><td>-h</td>
2993 2996 <td>--help</td>
2994 2997 <td>display help and exit</td></tr>
2995 2998 <tr><td></td>
2996 2999 <td>--hidden</td>
2997 3000 <td>consider hidden changesets</td></tr>
2998 3001 <tr><td></td>
2999 3002 <td>--pager TYPE</td>
3000 3003 <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
3001 3004 </table>
3002 3005
3003 3006 </div>
3004 3007 </div>
3005 3008 </div>
3006 3009
3007 3010
3008 3011
3009 3012 </body>
3010 3013 </html>
3011 3014
3012 3015
3013 3016 $ get-with-headers.py $LOCALIP:$HGPORT "help/remove"
3014 3017 200 Script output follows
3015 3018
3016 3019 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3017 3020 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3018 3021 <head>
3019 3022 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3020 3023 <meta name="robots" content="index, nofollow" />
3021 3024 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3022 3025 <script type="text/javascript" src="/static/mercurial.js"></script>
3023 3026
3024 3027 <title>Help: remove</title>
3025 3028 </head>
3026 3029 <body>
3027 3030
3028 3031 <div class="container">
3029 3032 <div class="menu">
3030 3033 <div class="logo">
3031 3034 <a href="https://mercurial-scm.org/">
3032 3035 <img src="/static/hglogo.png" alt="mercurial" /></a>
3033 3036 </div>
3034 3037 <ul>
3035 3038 <li><a href="/shortlog">log</a></li>
3036 3039 <li><a href="/graph">graph</a></li>
3037 3040 <li><a href="/tags">tags</a></li>
3038 3041 <li><a href="/bookmarks">bookmarks</a></li>
3039 3042 <li><a href="/branches">branches</a></li>
3040 3043 </ul>
3041 3044 <ul>
3042 3045 <li class="active"><a href="/help">help</a></li>
3043 3046 </ul>
3044 3047 </div>
3045 3048
3046 3049 <div class="main">
3047 3050 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3048 3051 <h3>Help: remove</h3>
3049 3052
3050 3053 <form class="search" action="/log">
3051 3054
3052 3055 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3053 3056 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3054 3057 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3055 3058 </form>
3056 3059 <div id="doc">
3057 3060 <p>
3058 3061 hg remove [OPTION]... FILE...
3059 3062 </p>
3060 3063 <p>
3061 3064 aliases: rm
3062 3065 </p>
3063 3066 <p>
3064 3067 remove the specified files on the next commit
3065 3068 </p>
3066 3069 <p>
3067 3070 Schedule the indicated files for removal from the current branch.
3068 3071 </p>
3069 3072 <p>
3070 3073 This command schedules the files to be removed at the next commit.
3071 3074 To undo a remove before that, see 'hg revert'. To undo added
3072 3075 files, see 'hg forget'.
3073 3076 </p>
3074 3077 <p>
3075 3078 -A/--after can be used to remove only files that have already
3076 3079 been deleted, -f/--force can be used to force deletion, and -Af
3077 3080 can be used to remove files from the next revision without
3078 3081 deleting them from the working directory.
3079 3082 </p>
3080 3083 <p>
3081 3084 The following table details the behavior of remove for different
3082 3085 file states (columns) and option combinations (rows). The file
3083 3086 states are Added [A], Clean [C], Modified [M] and Missing [!]
3084 3087 (as reported by 'hg status'). The actions are Warn, Remove
3085 3088 (from branch) and Delete (from disk):
3086 3089 </p>
3087 3090 <table>
3088 3091 <tr><td>opt/state</td>
3089 3092 <td>A</td>
3090 3093 <td>C</td>
3091 3094 <td>M</td>
3092 3095 <td>!</td></tr>
3093 3096 <tr><td>none</td>
3094 3097 <td>W</td>
3095 3098 <td>RD</td>
3096 3099 <td>W</td>
3097 3100 <td>R</td></tr>
3098 3101 <tr><td>-f</td>
3099 3102 <td>R</td>
3100 3103 <td>RD</td>
3101 3104 <td>RD</td>
3102 3105 <td>R</td></tr>
3103 3106 <tr><td>-A</td>
3104 3107 <td>W</td>
3105 3108 <td>W</td>
3106 3109 <td>W</td>
3107 3110 <td>R</td></tr>
3108 3111 <tr><td>-Af</td>
3109 3112 <td>R</td>
3110 3113 <td>R</td>
3111 3114 <td>R</td>
3112 3115 <td>R</td></tr>
3113 3116 </table>
3114 3117 <p>
3115 3118 <b>Note:</b>
3116 3119 </p>
3117 3120 <p>
3118 3121 'hg remove' never deletes files in Added [A] state from the
3119 3122 working directory, not even if &quot;--force&quot; is specified.
3120 3123 </p>
3121 3124 <p>
3122 3125 Returns 0 on success, 1 if any warnings encountered.
3123 3126 </p>
3124 3127 <p>
3125 3128 options ([+] can be repeated):
3126 3129 </p>
3127 3130 <table>
3128 3131 <tr><td>-A</td>
3129 3132 <td>--after</td>
3130 3133 <td>record delete for missing files</td></tr>
3131 3134 <tr><td>-f</td>
3132 3135 <td>--force</td>
3133 3136 <td>forget added files, delete modified files</td></tr>
3134 3137 <tr><td>-S</td>
3135 3138 <td>--subrepos</td>
3136 3139 <td>recurse into subrepositories</td></tr>
3137 3140 <tr><td>-I</td>
3138 3141 <td>--include PATTERN [+]</td>
3139 3142 <td>include names matching the given patterns</td></tr>
3140 3143 <tr><td>-X</td>
3141 3144 <td>--exclude PATTERN [+]</td>
3142 3145 <td>exclude names matching the given patterns</td></tr>
3143 3146 <tr><td>-n</td>
3144 3147 <td>--dry-run</td>
3145 3148 <td>do not perform actions, just print output</td></tr>
3146 3149 </table>
3147 3150 <p>
3148 3151 global options ([+] can be repeated):
3149 3152 </p>
3150 3153 <table>
3151 3154 <tr><td>-R</td>
3152 3155 <td>--repository REPO</td>
3153 3156 <td>repository root directory or name of overlay bundle file</td></tr>
3154 3157 <tr><td></td>
3155 3158 <td>--cwd DIR</td>
3156 3159 <td>change working directory</td></tr>
3157 3160 <tr><td>-y</td>
3158 3161 <td>--noninteractive</td>
3159 3162 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
3160 3163 <tr><td>-q</td>
3161 3164 <td>--quiet</td>
3162 3165 <td>suppress output</td></tr>
3163 3166 <tr><td>-v</td>
3164 3167 <td>--verbose</td>
3165 3168 <td>enable additional output</td></tr>
3166 3169 <tr><td></td>
3167 3170 <td>--color TYPE</td>
3168 3171 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
3169 3172 <tr><td></td>
3170 3173 <td>--config CONFIG [+]</td>
3171 3174 <td>set/override config option (use 'section.name=value')</td></tr>
3172 3175 <tr><td></td>
3173 3176 <td>--debug</td>
3174 3177 <td>enable debugging output</td></tr>
3175 3178 <tr><td></td>
3176 3179 <td>--debugger</td>
3177 3180 <td>start debugger</td></tr>
3178 3181 <tr><td></td>
3179 3182 <td>--encoding ENCODE</td>
3180 3183 <td>set the charset encoding (default: ascii)</td></tr>
3181 3184 <tr><td></td>
3182 3185 <td>--encodingmode MODE</td>
3183 3186 <td>set the charset encoding mode (default: strict)</td></tr>
3184 3187 <tr><td></td>
3185 3188 <td>--traceback</td>
3186 3189 <td>always print a traceback on exception</td></tr>
3187 3190 <tr><td></td>
3188 3191 <td>--time</td>
3189 3192 <td>time how long the command takes</td></tr>
3190 3193 <tr><td></td>
3191 3194 <td>--profile</td>
3192 3195 <td>print command execution profile</td></tr>
3193 3196 <tr><td></td>
3194 3197 <td>--version</td>
3195 3198 <td>output version information and exit</td></tr>
3196 3199 <tr><td>-h</td>
3197 3200 <td>--help</td>
3198 3201 <td>display help and exit</td></tr>
3199 3202 <tr><td></td>
3200 3203 <td>--hidden</td>
3201 3204 <td>consider hidden changesets</td></tr>
3202 3205 <tr><td></td>
3203 3206 <td>--pager TYPE</td>
3204 3207 <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
3205 3208 </table>
3206 3209
3207 3210 </div>
3208 3211 </div>
3209 3212 </div>
3210 3213
3211 3214
3212 3215
3213 3216 </body>
3214 3217 </html>
3215 3218
3216 3219
3217 3220 $ get-with-headers.py $LOCALIP:$HGPORT "help/dates"
3218 3221 200 Script output follows
3219 3222
3220 3223 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3221 3224 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3222 3225 <head>
3223 3226 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3224 3227 <meta name="robots" content="index, nofollow" />
3225 3228 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3226 3229 <script type="text/javascript" src="/static/mercurial.js"></script>
3227 3230
3228 3231 <title>Help: dates</title>
3229 3232 </head>
3230 3233 <body>
3231 3234
3232 3235 <div class="container">
3233 3236 <div class="menu">
3234 3237 <div class="logo">
3235 3238 <a href="https://mercurial-scm.org/">
3236 3239 <img src="/static/hglogo.png" alt="mercurial" /></a>
3237 3240 </div>
3238 3241 <ul>
3239 3242 <li><a href="/shortlog">log</a></li>
3240 3243 <li><a href="/graph">graph</a></li>
3241 3244 <li><a href="/tags">tags</a></li>
3242 3245 <li><a href="/bookmarks">bookmarks</a></li>
3243 3246 <li><a href="/branches">branches</a></li>
3244 3247 </ul>
3245 3248 <ul>
3246 3249 <li class="active"><a href="/help">help</a></li>
3247 3250 </ul>
3248 3251 </div>
3249 3252
3250 3253 <div class="main">
3251 3254 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3252 3255 <h3>Help: dates</h3>
3253 3256
3254 3257 <form class="search" action="/log">
3255 3258
3256 3259 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3257 3260 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3258 3261 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3259 3262 </form>
3260 3263 <div id="doc">
3261 3264 <h1>Date Formats</h1>
3262 3265 <p>
3263 3266 Some commands allow the user to specify a date, e.g.:
3264 3267 </p>
3265 3268 <ul>
3266 3269 <li> backout, commit, import, tag: Specify the commit date.
3267 3270 <li> log, revert, update: Select revision(s) by date.
3268 3271 </ul>
3269 3272 <p>
3270 3273 Many date formats are valid. Here are some examples:
3271 3274 </p>
3272 3275 <ul>
3273 3276 <li> &quot;Wed Dec 6 13:18:29 2006&quot; (local timezone assumed)
3274 3277 <li> &quot;Dec 6 13:18 -0600&quot; (year assumed, time offset provided)
3275 3278 <li> &quot;Dec 6 13:18 UTC&quot; (UTC and GMT are aliases for +0000)
3276 3279 <li> &quot;Dec 6&quot; (midnight)
3277 3280 <li> &quot;13:18&quot; (today assumed)
3278 3281 <li> &quot;3:39&quot; (3:39AM assumed)
3279 3282 <li> &quot;3:39pm&quot; (15:39)
3280 3283 <li> &quot;2006-12-06 13:18:29&quot; (ISO 8601 format)
3281 3284 <li> &quot;2006-12-6 13:18&quot;
3282 3285 <li> &quot;2006-12-6&quot;
3283 3286 <li> &quot;12-6&quot;
3284 3287 <li> &quot;12/6&quot;
3285 3288 <li> &quot;12/6/6&quot; (Dec 6 2006)
3286 3289 <li> &quot;today&quot; (midnight)
3287 3290 <li> &quot;yesterday&quot; (midnight)
3288 3291 <li> &quot;now&quot; - right now
3289 3292 </ul>
3290 3293 <p>
3291 3294 Lastly, there is Mercurial's internal format:
3292 3295 </p>
3293 3296 <ul>
3294 3297 <li> &quot;1165411109 0&quot; (Wed Dec 6 13:18:29 2006 UTC)
3295 3298 </ul>
3296 3299 <p>
3297 3300 This is the internal representation format for dates. The first number
3298 3301 is the number of seconds since the epoch (1970-01-01 00:00 UTC). The
3299 3302 second is the offset of the local timezone, in seconds west of UTC
3300 3303 (negative if the timezone is east of UTC).
3301 3304 </p>
3302 3305 <p>
3303 3306 The log command also accepts date ranges:
3304 3307 </p>
3305 3308 <ul>
3306 3309 <li> &quot;&lt;DATE&quot; - at or before a given date/time
3307 3310 <li> &quot;&gt;DATE&quot; - on or after a given date/time
3308 3311 <li> &quot;DATE to DATE&quot; - a date range, inclusive
3309 3312 <li> &quot;-DAYS&quot; - within a given number of days from today
3310 3313 </ul>
3311 3314
3312 3315 </div>
3313 3316 </div>
3314 3317 </div>
3315 3318
3316 3319
3317 3320
3318 3321 </body>
3319 3322 </html>
3320 3323
3321 3324
3322 3325 $ get-with-headers.py $LOCALIP:$HGPORT "help/pager"
3323 3326 200 Script output follows
3324 3327
3325 3328 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3326 3329 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3327 3330 <head>
3328 3331 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3329 3332 <meta name="robots" content="index, nofollow" />
3330 3333 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3331 3334 <script type="text/javascript" src="/static/mercurial.js"></script>
3332 3335
3333 3336 <title>Help: pager</title>
3334 3337 </head>
3335 3338 <body>
3336 3339
3337 3340 <div class="container">
3338 3341 <div class="menu">
3339 3342 <div class="logo">
3340 3343 <a href="https://mercurial-scm.org/">
3341 3344 <img src="/static/hglogo.png" alt="mercurial" /></a>
3342 3345 </div>
3343 3346 <ul>
3344 3347 <li><a href="/shortlog">log</a></li>
3345 3348 <li><a href="/graph">graph</a></li>
3346 3349 <li><a href="/tags">tags</a></li>
3347 3350 <li><a href="/bookmarks">bookmarks</a></li>
3348 3351 <li><a href="/branches">branches</a></li>
3349 3352 </ul>
3350 3353 <ul>
3351 3354 <li class="active"><a href="/help">help</a></li>
3352 3355 </ul>
3353 3356 </div>
3354 3357
3355 3358 <div class="main">
3356 3359 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3357 3360 <h3>Help: pager</h3>
3358 3361
3359 3362 <form class="search" action="/log">
3360 3363
3361 3364 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3362 3365 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3363 3366 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3364 3367 </form>
3365 3368 <div id="doc">
3366 3369 <h1>Pager Support</h1>
3367 3370 <p>
3368 3371 Some Mercurial commands can produce a lot of output, and Mercurial will
3369 3372 attempt to use a pager to make those commands more pleasant.
3370 3373 </p>
3371 3374 <p>
3372 3375 To set the pager that should be used, set the application variable:
3373 3376 </p>
3374 3377 <pre>
3375 3378 [pager]
3376 3379 pager = less -FRX
3377 3380 </pre>
3378 3381 <p>
3379 3382 If no pager is set in the user or repository configuration, Mercurial uses the
3380 3383 environment variable $PAGER. If $PAGER is not set, pager.pager from the default
3381 3384 or system configuration is used. If none of these are set, a default pager will
3382 3385 be used, typically 'less' on Unix and 'more' on Windows.
3383 3386 </p>
3384 3387 <p>
3385 3388 You can disable the pager for certain commands by adding them to the
3386 3389 pager.ignore list:
3387 3390 </p>
3388 3391 <pre>
3389 3392 [pager]
3390 3393 ignore = version, help, update
3391 3394 </pre>
3392 3395 <p>
3393 3396 To ignore global commands like 'hg version' or 'hg help', you have
3394 3397 to specify them in your user configuration file.
3395 3398 </p>
3396 3399 <p>
3397 3400 To control whether the pager is used at all for an individual command,
3398 3401 you can use --pager=&lt;value&gt;:
3399 3402 </p>
3400 3403 <ul>
3401 3404 <li> use as needed: 'auto'.
3402 3405 <li> require the pager: 'yes' or 'on'.
3403 3406 <li> suppress the pager: 'no' or 'off' (any unrecognized value will also work).
3404 3407 </ul>
3405 3408 <p>
3406 3409 To globally turn off all attempts to use a pager, set:
3407 3410 </p>
3408 3411 <pre>
3409 3412 [ui]
3410 3413 paginate = never
3411 3414 </pre>
3412 3415 <p>
3413 3416 which will prevent the pager from running.
3414 3417 </p>
3415 3418
3416 3419 </div>
3417 3420 </div>
3418 3421 </div>
3419 3422
3420 3423
3421 3424
3422 3425 </body>
3423 3426 </html>
3424 3427
3425 3428
3426 3429 Sub-topic indexes rendered properly
3427 3430
3428 3431 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals"
3429 3432 200 Script output follows
3430 3433
3431 3434 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3432 3435 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3433 3436 <head>
3434 3437 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3435 3438 <meta name="robots" content="index, nofollow" />
3436 3439 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3437 3440 <script type="text/javascript" src="/static/mercurial.js"></script>
3438 3441
3439 3442 <title>Help: internals</title>
3440 3443 </head>
3441 3444 <body>
3442 3445
3443 3446 <div class="container">
3444 3447 <div class="menu">
3445 3448 <div class="logo">
3446 3449 <a href="https://mercurial-scm.org/">
3447 3450 <img src="/static/hglogo.png" alt="mercurial" /></a>
3448 3451 </div>
3449 3452 <ul>
3450 3453 <li><a href="/shortlog">log</a></li>
3451 3454 <li><a href="/graph">graph</a></li>
3452 3455 <li><a href="/tags">tags</a></li>
3453 3456 <li><a href="/bookmarks">bookmarks</a></li>
3454 3457 <li><a href="/branches">branches</a></li>
3455 3458 </ul>
3456 3459 <ul>
3457 3460 <li><a href="/help">help</a></li>
3458 3461 </ul>
3459 3462 </div>
3460 3463
3461 3464 <div class="main">
3462 3465 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3463 3466
3464 3467 <form class="search" action="/log">
3465 3468
3466 3469 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3467 3470 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3468 3471 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3469 3472 </form>
3470 3473 <table class="bigtable">
3471 3474 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
3472 3475
3473 3476 <tr><td>
3474 3477 <a href="/help/internals.bid-merge">
3475 3478 bid-merge
3476 3479 </a>
3477 3480 </td><td>
3478 3481 Bid Merge Algorithm
3479 3482 </td></tr>
3480 3483 <tr><td>
3481 3484 <a href="/help/internals.bundle2">
3482 3485 bundle2
3483 3486 </a>
3484 3487 </td><td>
3485 3488 Bundle2
3486 3489 </td></tr>
3487 3490 <tr><td>
3488 3491 <a href="/help/internals.bundles">
3489 3492 bundles
3490 3493 </a>
3491 3494 </td><td>
3492 3495 Bundles
3493 3496 </td></tr>
3494 3497 <tr><td>
3495 3498 <a href="/help/internals.cbor">
3496 3499 cbor
3497 3500 </a>
3498 3501 </td><td>
3499 3502 CBOR
3500 3503 </td></tr>
3501 3504 <tr><td>
3502 3505 <a href="/help/internals.censor">
3503 3506 censor
3504 3507 </a>
3505 3508 </td><td>
3506 3509 Censor
3507 3510 </td></tr>
3508 3511 <tr><td>
3509 3512 <a href="/help/internals.changegroups">
3510 3513 changegroups
3511 3514 </a>
3512 3515 </td><td>
3513 3516 Changegroups
3514 3517 </td></tr>
3515 3518 <tr><td>
3516 3519 <a href="/help/internals.config">
3517 3520 config
3518 3521 </a>
3519 3522 </td><td>
3520 3523 Config Registrar
3521 3524 </td></tr>
3522 3525 <tr><td>
3523 3526 <a href="/help/internals.extensions">
3524 3527 extensions
3525 3528 </a>
3526 3529 </td><td>
3527 3530 Extension API
3528 3531 </td></tr>
3529 3532 <tr><td>
3530 3533 <a href="/help/internals.mergestate">
3531 3534 mergestate
3532 3535 </a>
3533 3536 </td><td>
3534 3537 Mergestate
3535 3538 </td></tr>
3536 3539 <tr><td>
3537 3540 <a href="/help/internals.requirements">
3538 3541 requirements
3539 3542 </a>
3540 3543 </td><td>
3541 3544 Repository Requirements
3542 3545 </td></tr>
3543 3546 <tr><td>
3544 3547 <a href="/help/internals.revlogs">
3545 3548 revlogs
3546 3549 </a>
3547 3550 </td><td>
3548 3551 Revision Logs
3549 3552 </td></tr>
3550 3553 <tr><td>
3551 3554 <a href="/help/internals.wireprotocol">
3552 3555 wireprotocol
3553 3556 </a>
3554 3557 </td><td>
3555 3558 Wire Protocol
3556 3559 </td></tr>
3557 3560 <tr><td>
3558 3561 <a href="/help/internals.wireprotocolrpc">
3559 3562 wireprotocolrpc
3560 3563 </a>
3561 3564 </td><td>
3562 3565 Wire Protocol RPC
3563 3566 </td></tr>
3564 3567 <tr><td>
3565 3568 <a href="/help/internals.wireprotocolv2">
3566 3569 wireprotocolv2
3567 3570 </a>
3568 3571 </td><td>
3569 3572 Wire Protocol Version 2
3570 3573 </td></tr>
3571 3574
3572 3575
3573 3576
3574 3577
3575 3578
3576 3579 </table>
3577 3580 </div>
3578 3581 </div>
3579 3582
3580 3583
3581 3584
3582 3585 </body>
3583 3586 </html>
3584 3587
3585 3588
3586 3589 Sub-topic topics rendered properly
3587 3590
3588 3591 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals.changegroups"
3589 3592 200 Script output follows
3590 3593
3591 3594 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3592 3595 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3593 3596 <head>
3594 3597 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3595 3598 <meta name="robots" content="index, nofollow" />
3596 3599 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3597 3600 <script type="text/javascript" src="/static/mercurial.js"></script>
3598 3601
3599 3602 <title>Help: internals.changegroups</title>
3600 3603 </head>
3601 3604 <body>
3602 3605
3603 3606 <div class="container">
3604 3607 <div class="menu">
3605 3608 <div class="logo">
3606 3609 <a href="https://mercurial-scm.org/">
3607 3610 <img src="/static/hglogo.png" alt="mercurial" /></a>
3608 3611 </div>
3609 3612 <ul>
3610 3613 <li><a href="/shortlog">log</a></li>
3611 3614 <li><a href="/graph">graph</a></li>
3612 3615 <li><a href="/tags">tags</a></li>
3613 3616 <li><a href="/bookmarks">bookmarks</a></li>
3614 3617 <li><a href="/branches">branches</a></li>
3615 3618 </ul>
3616 3619 <ul>
3617 3620 <li class="active"><a href="/help">help</a></li>
3618 3621 </ul>
3619 3622 </div>
3620 3623
3621 3624 <div class="main">
3622 3625 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3623 3626 <h3>Help: internals.changegroups</h3>
3624 3627
3625 3628 <form class="search" action="/log">
3626 3629
3627 3630 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3628 3631 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3629 3632 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3630 3633 </form>
3631 3634 <div id="doc">
3632 3635 <h1>Changegroups</h1>
3633 3636 <p>
3634 3637 Changegroups are representations of repository revlog data, specifically
3635 3638 the changelog data, root/flat manifest data, treemanifest data, and
3636 3639 filelogs.
3637 3640 </p>
3638 3641 <p>
3639 3642 There are 3 versions of changegroups: &quot;1&quot;, &quot;2&quot;, and &quot;3&quot;. From a
3640 3643 high-level, versions &quot;1&quot; and &quot;2&quot; are almost exactly the same, with the
3641 3644 only difference being an additional item in the *delta header*. Version
3642 3645 &quot;3&quot; adds support for storage flags in the *delta header* and optionally
3643 3646 exchanging treemanifests (enabled by setting an option on the
3644 3647 &quot;changegroup&quot; part in the bundle2).
3645 3648 </p>
3646 3649 <p>
3647 3650 Changegroups when not exchanging treemanifests consist of 3 logical
3648 3651 segments:
3649 3652 </p>
3650 3653 <pre>
3651 3654 +---------------------------------+
3652 3655 | | | |
3653 3656 | changeset | manifest | filelogs |
3654 3657 | | | |
3655 3658 | | | |
3656 3659 +---------------------------------+
3657 3660 </pre>
3658 3661 <p>
3659 3662 When exchanging treemanifests, there are 4 logical segments:
3660 3663 </p>
3661 3664 <pre>
3662 3665 +-------------------------------------------------+
3663 3666 | | | | |
3664 3667 | changeset | root | treemanifests | filelogs |
3665 3668 | | manifest | | |
3666 3669 | | | | |
3667 3670 +-------------------------------------------------+
3668 3671 </pre>
3669 3672 <p>
3670 3673 The principle building block of each segment is a *chunk*. A *chunk*
3671 3674 is a framed piece of data:
3672 3675 </p>
3673 3676 <pre>
3674 3677 +---------------------------------------+
3675 3678 | | |
3676 3679 | length | data |
3677 3680 | (4 bytes) | (&lt;length - 4&gt; bytes) |
3678 3681 | | |
3679 3682 +---------------------------------------+
3680 3683 </pre>
3681 3684 <p>
3682 3685 All integers are big-endian signed integers. Each chunk starts with a 32-bit
3683 3686 integer indicating the length of the entire chunk (including the length field
3684 3687 itself).
3685 3688 </p>
3686 3689 <p>
3687 3690 There is a special case chunk that has a value of 0 for the length
3688 3691 (&quot;0x00000000&quot;). We call this an *empty chunk*.
3689 3692 </p>
3690 3693 <h2>Delta Groups</h2>
3691 3694 <p>
3692 3695 A *delta group* expresses the content of a revlog as a series of deltas,
3693 3696 or patches against previous revisions.
3694 3697 </p>
3695 3698 <p>
3696 3699 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
3697 3700 to signal the end of the delta group:
3698 3701 </p>
3699 3702 <pre>
3700 3703 +------------------------------------------------------------------------+
3701 3704 | | | | | |
3702 3705 | chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
3703 3706 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
3704 3707 | | | | | |
3705 3708 +------------------------------------------------------------------------+
3706 3709 </pre>
3707 3710 <p>
3708 3711 Each *chunk*'s data consists of the following:
3709 3712 </p>
3710 3713 <pre>
3711 3714 +---------------------------------------+
3712 3715 | | |
3713 3716 | delta header | delta data |
3714 3717 | (various by version) | (various) |
3715 3718 | | |
3716 3719 +---------------------------------------+
3717 3720 </pre>
3718 3721 <p>
3719 3722 The *delta data* is a series of *delta*s that describe a diff from an existing
3720 3723 entry (either that the recipient already has, or previously specified in the
3721 3724 bundle/changegroup).
3722 3725 </p>
3723 3726 <p>
3724 3727 The *delta header* is different between versions &quot;1&quot;, &quot;2&quot;, and
3725 3728 &quot;3&quot; of the changegroup format.
3726 3729 </p>
3727 3730 <p>
3728 3731 Version 1 (headerlen=80):
3729 3732 </p>
3730 3733 <pre>
3731 3734 +------------------------------------------------------+
3732 3735 | | | | |
3733 3736 | node | p1 node | p2 node | link node |
3734 3737 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
3735 3738 | | | | |
3736 3739 +------------------------------------------------------+
3737 3740 </pre>
3738 3741 <p>
3739 3742 Version 2 (headerlen=100):
3740 3743 </p>
3741 3744 <pre>
3742 3745 +------------------------------------------------------------------+
3743 3746 | | | | | |
3744 3747 | node | p1 node | p2 node | base node | link node |
3745 3748 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
3746 3749 | | | | | |
3747 3750 +------------------------------------------------------------------+
3748 3751 </pre>
3749 3752 <p>
3750 3753 Version 3 (headerlen=102):
3751 3754 </p>
3752 3755 <pre>
3753 3756 +------------------------------------------------------------------------------+
3754 3757 | | | | | | |
3755 3758 | node | p1 node | p2 node | base node | link node | flags |
3756 3759 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
3757 3760 | | | | | | |
3758 3761 +------------------------------------------------------------------------------+
3759 3762 </pre>
3760 3763 <p>
3761 3764 The *delta data* consists of &quot;chunklen - 4 - headerlen&quot; bytes, which contain a
3762 3765 series of *delta*s, densely packed (no separators). These deltas describe a diff
3763 3766 from an existing entry (either that the recipient already has, or previously
3764 3767 specified in the bundle/changegroup). The format is described more fully in
3765 3768 &quot;hg help internals.bdiff&quot;, but briefly:
3766 3769 </p>
3767 3770 <pre>
3768 3771 +---------------------------------------------------------------+
3769 3772 | | | | |
3770 3773 | start offset | end offset | new length | content |
3771 3774 | (4 bytes) | (4 bytes) | (4 bytes) | (&lt;new length&gt; bytes) |
3772 3775 | | | | |
3773 3776 +---------------------------------------------------------------+
3774 3777 </pre>
3775 3778 <p>
3776 3779 Please note that the length field in the delta data does *not* include itself.
3777 3780 </p>
3778 3781 <p>
3779 3782 In version 1, the delta is always applied against the previous node from
3780 3783 the changegroup or the first parent if this is the first entry in the
3781 3784 changegroup.
3782 3785 </p>
3783 3786 <p>
3784 3787 In version 2 and up, the delta base node is encoded in the entry in the
3785 3788 changegroup. This allows the delta to be expressed against any parent,
3786 3789 which can result in smaller deltas and more efficient encoding of data.
3787 3790 </p>
3788 3791 <p>
3789 3792 The *flags* field holds bitwise flags affecting the processing of revision
3790 3793 data. The following flags are defined:
3791 3794 </p>
3792 3795 <dl>
3793 3796 <dt>32768
3794 3797 <dd>Censored revision. The revision's fulltext has been replaced by censor metadata. May only occur on file revisions.
3795 3798 <dt>16384
3796 3799 <dd>Ellipsis revision. Revision hash does not match data (likely due to rewritten parents).
3797 3800 <dt>8192
3798 3801 <dd>Externally stored. The revision fulltext contains &quot;key:value&quot; &quot;\n&quot; delimited metadata defining an object stored elsewhere. Used by the LFS extension.
3799 3802 </dl>
3800 3803 <p>
3801 3804 For historical reasons, the integer values are identical to revlog version 1
3802 3805 per-revision storage flags and correspond to bits being set in this 2-byte
3803 3806 field. Bits were allocated starting from the most-significant bit, hence the
3804 3807 reverse ordering and allocation of these flags.
3805 3808 </p>
3806 3809 <h2>Changeset Segment</h2>
3807 3810 <p>
3808 3811 The *changeset segment* consists of a single *delta group* holding
3809 3812 changelog data. The *empty chunk* at the end of the *delta group* denotes
3810 3813 the boundary to the *manifest segment*.
3811 3814 </p>
3812 3815 <h2>Manifest Segment</h2>
3813 3816 <p>
3814 3817 The *manifest segment* consists of a single *delta group* holding manifest
3815 3818 data. If treemanifests are in use, it contains only the manifest for the
3816 3819 root directory of the repository. Otherwise, it contains the entire
3817 3820 manifest data. The *empty chunk* at the end of the *delta group* denotes
3818 3821 the boundary to the next segment (either the *treemanifests segment* or the
3819 3822 *filelogs segment*, depending on version and the request options).
3820 3823 </p>
3821 3824 <h3>Treemanifests Segment</h3>
3822 3825 <p>
3823 3826 The *treemanifests segment* only exists in changegroup version &quot;3&quot;, and
3824 3827 only if the 'treemanifest' param is part of the bundle2 changegroup part
3825 3828 (it is not possible to use changegroup version 3 outside of bundle2).
3826 3829 Aside from the filenames in the *treemanifests segment* containing a
3827 3830 trailing &quot;/&quot; character, it behaves identically to the *filelogs segment*
3828 3831 (see below). The final sub-segment is followed by an *empty chunk* (logically,
3829 3832 a sub-segment with filename size 0). This denotes the boundary to the
3830 3833 *filelogs segment*.
3831 3834 </p>
3832 3835 <h2>Filelogs Segment</h2>
3833 3836 <p>
3834 3837 The *filelogs segment* consists of multiple sub-segments, each
3835 3838 corresponding to an individual file whose data is being described:
3836 3839 </p>
3837 3840 <pre>
3838 3841 +--------------------------------------------------+
3839 3842 | | | | | |
3840 3843 | filelog0 | filelog1 | filelog2 | ... | 0x0 |
3841 3844 | | | | | (4 bytes) |
3842 3845 | | | | | |
3843 3846 +--------------------------------------------------+
3844 3847 </pre>
3845 3848 <p>
3846 3849 The final filelog sub-segment is followed by an *empty chunk* (logically,
3847 3850 a sub-segment with filename size 0). This denotes the end of the segment
3848 3851 and of the overall changegroup.
3849 3852 </p>
3850 3853 <p>
3851 3854 Each filelog sub-segment consists of the following:
3852 3855 </p>
3853 3856 <pre>
3854 3857 +------------------------------------------------------+
3855 3858 | | | |
3856 3859 | filename length | filename | delta group |
3857 3860 | (4 bytes) | (&lt;length - 4&gt; bytes) | (various) |
3858 3861 | | | |
3859 3862 +------------------------------------------------------+
3860 3863 </pre>
3861 3864 <p>
3862 3865 That is, a *chunk* consisting of the filename (not terminated or padded)
3863 3866 followed by N chunks constituting the *delta group* for this file. The
3864 3867 *empty chunk* at the end of each *delta group* denotes the boundary to the
3865 3868 next filelog sub-segment.
3866 3869 </p>
3867 3870
3868 3871 </div>
3869 3872 </div>
3870 3873 </div>
3871 3874
3872 3875
3873 3876
3874 3877 </body>
3875 3878 </html>
3876 3879
3877 3880
3878 3881 $ get-with-headers.py 127.0.0.1:$HGPORT "help/unknowntopic"
3879 3882 404 Not Found
3880 3883
3881 3884 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3882 3885 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
3883 3886 <head>
3884 3887 <link rel="icon" href="/static/hgicon.png" type="image/png" />
3885 3888 <meta name="robots" content="index, nofollow" />
3886 3889 <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
3887 3890 <script type="text/javascript" src="/static/mercurial.js"></script>
3888 3891
3889 3892 <title>test: error</title>
3890 3893 </head>
3891 3894 <body>
3892 3895
3893 3896 <div class="container">
3894 3897 <div class="menu">
3895 3898 <div class="logo">
3896 3899 <a href="https://mercurial-scm.org/">
3897 3900 <img src="/static/hglogo.png" width=75 height=90 border=0 alt="mercurial" /></a>
3898 3901 </div>
3899 3902 <ul>
3900 3903 <li><a href="/shortlog">log</a></li>
3901 3904 <li><a href="/graph">graph</a></li>
3902 3905 <li><a href="/tags">tags</a></li>
3903 3906 <li><a href="/bookmarks">bookmarks</a></li>
3904 3907 <li><a href="/branches">branches</a></li>
3905 3908 </ul>
3906 3909 <ul>
3907 3910 <li><a href="/help">help</a></li>
3908 3911 </ul>
3909 3912 </div>
3910 3913
3911 3914 <div class="main">
3912 3915
3913 3916 <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
3914 3917 <h3>error</h3>
3915 3918
3916 3919
3917 3920 <form class="search" action="/log">
3918 3921
3919 3922 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
3920 3923 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
3921 3924 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
3922 3925 </form>
3923 3926
3924 3927 <div class="description">
3925 3928 <p>
3926 3929 An error occurred while processing your request:
3927 3930 </p>
3928 3931 <p>
3929 3932 Not Found
3930 3933 </p>
3931 3934 </div>
3932 3935 </div>
3933 3936 </div>
3934 3937
3935 3938
3936 3939
3937 3940 </body>
3938 3941 </html>
3939 3942
3940 3943 [1]
3941 3944
3942 3945 $ killdaemons.py
3943 3946
3944 3947 #endif
General Comments 0
You need to be logged in to leave comments. Login now