##// END OF EJS Templates
wireproto: config options to disable bundle1...
Gregory Szorc -
r27246:b288fb27 default
parent child Browse files
Show More
@@ -1,1884 +1,1901 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 Format
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: global configuration like
34 34 the username setting is typically put into
35 35 ``%USERPROFILE%\mercurial.ini`` or ``$HOME/.hgrc`` and local
36 36 configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
37 37
38 38 The names of these files depend on the system on which Mercurial is
39 39 installed. ``*.rc`` files from a single directory are read in
40 40 alphabetical order, later ones overriding earlier ones. Where multiple
41 41 paths are given below, settings from earlier paths override later
42 42 ones.
43 43
44 44 .. container:: verbose.unix
45 45
46 46 On Unix, the following files are consulted:
47 47
48 48 - ``<repo>/.hg/hgrc`` (per-repository)
49 49 - ``$HOME/.hgrc`` (per-user)
50 50 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
51 51 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
52 52 - ``/etc/mercurial/hgrc`` (per-system)
53 53 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
54 54 - ``<internal>/default.d/*.rc`` (defaults)
55 55
56 56 .. container:: verbose.windows
57 57
58 58 On Windows, the following files are consulted:
59 59
60 60 - ``<repo>/.hg/hgrc`` (per-repository)
61 61 - ``%USERPROFILE%\.hgrc`` (per-user)
62 62 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
63 63 - ``%HOME%\.hgrc`` (per-user)
64 64 - ``%HOME%\Mercurial.ini`` (per-user)
65 65 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
66 66 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
67 67 - ``<install-dir>\Mercurial.ini`` (per-installation)
68 68 - ``<internal>/default.d/*.rc`` (defaults)
69 69
70 70 .. note::
71 71
72 72 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
73 73 is used when running 32-bit Python on 64-bit Windows.
74 74
75 75 .. container:: verbose.plan9
76 76
77 77 On Plan9, the following files are consulted:
78 78
79 79 - ``<repo>/.hg/hgrc`` (per-repository)
80 80 - ``$home/lib/hgrc`` (per-user)
81 81 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
82 82 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
83 83 - ``/lib/mercurial/hgrc`` (per-system)
84 84 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
85 85 - ``<internal>/default.d/*.rc`` (defaults)
86 86
87 87 Per-repository configuration options only apply in a
88 88 particular repository. This file is not version-controlled, and
89 89 will not get transferred during a "clone" operation. Options in
90 90 this file override options in all other configuration files. On
91 91 Plan 9 and Unix, most of this file will be ignored if it doesn't
92 92 belong to a trusted user or to a trusted group. See
93 93 :hg:`help config.trusted` for more details.
94 94
95 95 Per-user configuration file(s) are for the user running Mercurial. On
96 96 Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in these
97 97 files apply to all Mercurial commands executed by this user in any
98 98 directory. Options in these files override per-system and per-installation
99 99 options.
100 100
101 101 Per-installation configuration files are searched for in the
102 102 directory where Mercurial is installed. ``<install-root>`` is the
103 103 parent directory of the **hg** executable (or symlink) being run. For
104 104 example, if installed in ``/shared/tools/bin/hg``, Mercurial will look
105 105 in ``/shared/tools/etc/mercurial/hgrc``. Options in these files apply
106 106 to all Mercurial commands executed by any user in any directory.
107 107
108 108 Per-installation configuration files are for the system on
109 109 which Mercurial is running. Options in these files apply to all
110 110 Mercurial commands executed by any user in any directory. Registry
111 111 keys contain PATH-like strings, every part of which must reference
112 112 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
113 113 be read. Mercurial checks each of these locations in the specified
114 114 order until one or more configuration files are detected.
115 115
116 116 Per-system configuration files are for the system on which Mercurial
117 117 is running. Options in these files apply to all Mercurial commands
118 118 executed by any user in any directory. Options in these files
119 119 override per-installation options.
120 120
121 121 Mercurial comes with some default configuration. The default configuration
122 122 files are installed with Mercurial and will be overwritten on upgrades. Default
123 123 configuration files should never be edited by users or administrators but can
124 124 be overridden in other configuration files. So far the directory only contains
125 125 merge tool configuration but packagers can also put other default configuration
126 126 there.
127 127
128 128 Syntax
129 129 ======
130 130
131 131 A configuration file consists of sections, led by a ``[section]`` header
132 132 and followed by ``name = value`` entries (sometimes called
133 133 ``configuration keys``)::
134 134
135 135 [spam]
136 136 eggs=ham
137 137 green=
138 138 eggs
139 139
140 140 Each line contains one entry. If the lines that follow are indented,
141 141 they are treated as continuations of that entry. Leading whitespace is
142 142 removed from values. Empty lines are skipped. Lines beginning with
143 143 ``#`` or ``;`` are ignored and may be used to provide comments.
144 144
145 145 Configuration keys can be set multiple times, in which case Mercurial
146 146 will use the value that was configured last. As an example::
147 147
148 148 [spam]
149 149 eggs=large
150 150 ham=serrano
151 151 eggs=small
152 152
153 153 This would set the configuration key named ``eggs`` to ``small``.
154 154
155 155 It is also possible to define a section multiple times. A section can
156 156 be redefined on the same and/or on different configuration files. For
157 157 example::
158 158
159 159 [foo]
160 160 eggs=large
161 161 ham=serrano
162 162 eggs=small
163 163
164 164 [bar]
165 165 eggs=ham
166 166 green=
167 167 eggs
168 168
169 169 [foo]
170 170 ham=prosciutto
171 171 eggs=medium
172 172 bread=toasted
173 173
174 174 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
175 175 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
176 176 respectively. As you can see there only thing that matters is the last
177 177 value that was set for each of the configuration keys.
178 178
179 179 If a configuration key is set multiple times in different
180 180 configuration files the final value will depend on the order in which
181 181 the different configuration files are read, with settings from earlier
182 182 paths overriding later ones as described on the ``Files`` section
183 183 above.
184 184
185 185 A line of the form ``%include file`` will include ``file`` into the
186 186 current configuration file. The inclusion is recursive, which means
187 187 that included files can include other files. Filenames are relative to
188 188 the configuration file in which the ``%include`` directive is found.
189 189 Environment variables and ``~user`` constructs are expanded in
190 190 ``file``. This lets you do something like::
191 191
192 192 %include ~/.hgrc.d/$HOST.rc
193 193
194 194 to include a different configuration file on each computer you use.
195 195
196 196 A line with ``%unset name`` will remove ``name`` from the current
197 197 section, if it has been set previously.
198 198
199 199 The values are either free-form text strings, lists of text strings,
200 200 or Boolean values. Boolean values can be set to true using any of "1",
201 201 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
202 202 (all case insensitive).
203 203
204 204 List values are separated by whitespace or comma, except when values are
205 205 placed in double quotation marks::
206 206
207 207 allow_read = "John Doe, PhD", brian, betty
208 208
209 209 Quotation marks can be escaped by prefixing them with a backslash. Only
210 210 quotation marks at the beginning of a word is counted as a quotation
211 211 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
212 212
213 213 Sections
214 214 ========
215 215
216 216 This section describes the different sections that may appear in a
217 217 Mercurial configuration file, the purpose of each section, its possible
218 218 keys, and their possible values.
219 219
220 220 ``alias``
221 221 ---------
222 222
223 223 Defines command aliases.
224 224
225 225 Aliases allow you to define your own commands in terms of other
226 226 commands (or aliases), optionally including arguments. Positional
227 227 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
228 228 are expanded by Mercurial before execution. Positional arguments not
229 229 already used by ``$N`` in the definition are put at the end of the
230 230 command to be executed.
231 231
232 232 Alias definitions consist of lines of the form::
233 233
234 234 <alias> = <command> [<argument>]...
235 235
236 236 For example, this definition::
237 237
238 238 latest = log --limit 5
239 239
240 240 creates a new command ``latest`` that shows only the five most recent
241 241 changesets. You can define subsequent aliases using earlier ones::
242 242
243 243 stable5 = latest -b stable
244 244
245 245 .. note::
246 246
247 247 It is possible to create aliases with the same names as
248 248 existing commands, which will then override the original
249 249 definitions. This is almost always a bad idea!
250 250
251 251 An alias can start with an exclamation point (``!``) to make it a
252 252 shell alias. A shell alias is executed with the shell and will let you
253 253 run arbitrary commands. As an example, ::
254 254
255 255 echo = !echo $@
256 256
257 257 will let you do ``hg echo foo`` to have ``foo`` printed in your
258 258 terminal. A better example might be::
259 259
260 260 purge = !$HG status --no-status --unknown -0 | xargs -0 rm
261 261
262 262 which will make ``hg purge`` delete all unknown files in the
263 263 repository in the same manner as the purge extension.
264 264
265 265 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
266 266 expand to the command arguments. Unmatched arguments are
267 267 removed. ``$0`` expands to the alias name and ``$@`` expands to all
268 268 arguments separated by a space. ``"$@"`` (with quotes) expands to all
269 269 arguments quoted individually and separated by a space. These expansions
270 270 happen before the command is passed to the shell.
271 271
272 272 Shell aliases are executed in an environment where ``$HG`` expands to
273 273 the path of the Mercurial that was used to execute the alias. This is
274 274 useful when you want to call further Mercurial commands in a shell
275 275 alias, as was done above for the purge alias. In addition,
276 276 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
277 277 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
278 278
279 279 .. note::
280 280
281 281 Some global configuration options such as ``-R`` are
282 282 processed before shell aliases and will thus not be passed to
283 283 aliases.
284 284
285 285
286 286 ``annotate``
287 287 ------------
288 288
289 289 Settings used when displaying file annotations. All values are
290 290 Booleans and default to False. See :hg:`help config.diff` for
291 291 related options for the diff command.
292 292
293 293 ``ignorews``
294 294 Ignore white space when comparing lines.
295 295
296 296 ``ignorewsamount``
297 297 Ignore changes in the amount of white space.
298 298
299 299 ``ignoreblanklines``
300 300 Ignore changes whose lines are all blank.
301 301
302 302
303 303 ``auth``
304 304 --------
305 305
306 306 Authentication credentials for HTTP authentication. This section
307 307 allows you to store usernames and passwords for use when logging
308 308 *into* HTTP servers. See :hg:`help config.web` if
309 309 you want to configure *who* can login to your HTTP server.
310 310
311 311 Each line has the following format::
312 312
313 313 <name>.<argument> = <value>
314 314
315 315 where ``<name>`` is used to group arguments into authentication
316 316 entries. Example::
317 317
318 318 foo.prefix = hg.intevation.org/mercurial
319 319 foo.username = foo
320 320 foo.password = bar
321 321 foo.schemes = http https
322 322
323 323 bar.prefix = secure.example.org
324 324 bar.key = path/to/file.key
325 325 bar.cert = path/to/file.cert
326 326 bar.schemes = https
327 327
328 328 Supported arguments:
329 329
330 330 ``prefix``
331 331 Either ``*`` or a URI prefix with or without the scheme part.
332 332 The authentication entry with the longest matching prefix is used
333 333 (where ``*`` matches everything and counts as a match of length
334 334 1). If the prefix doesn't include a scheme, the match is performed
335 335 against the URI with its scheme stripped as well, and the schemes
336 336 argument, q.v., is then subsequently consulted.
337 337
338 338 ``username``
339 339 Optional. Username to authenticate with. If not given, and the
340 340 remote site requires basic or digest authentication, the user will
341 341 be prompted for it. Environment variables are expanded in the
342 342 username letting you do ``foo.username = $USER``. If the URI
343 343 includes a username, only ``[auth]`` entries with a matching
344 344 username or without a username will be considered.
345 345
346 346 ``password``
347 347 Optional. Password to authenticate with. If not given, and the
348 348 remote site requires basic or digest authentication, the user
349 349 will be prompted for it.
350 350
351 351 ``key``
352 352 Optional. PEM encoded client certificate key file. Environment
353 353 variables are expanded in the filename.
354 354
355 355 ``cert``
356 356 Optional. PEM encoded client certificate chain file. Environment
357 357 variables are expanded in the filename.
358 358
359 359 ``schemes``
360 360 Optional. Space separated list of URI schemes to use this
361 361 authentication entry with. Only used if the prefix doesn't include
362 362 a scheme. Supported schemes are http and https. They will match
363 363 static-http and static-https respectively, as well.
364 364 (default: https)
365 365
366 366 If no suitable authentication entry is found, the user is prompted
367 367 for credentials as usual if required by the remote.
368 368
369 369
370 370 ``committemplate``
371 371 ------------------
372 372
373 373 ``changeset``
374 374 String: configuration in this section is used as the template to
375 375 customize the text shown in the editor when committing.
376 376
377 377 In addition to pre-defined template keywords, commit log specific one
378 378 below can be used for customization:
379 379
380 380 ``extramsg``
381 381 String: Extra message (typically 'Leave message empty to abort
382 382 commit.'). This may be changed by some commands or extensions.
383 383
384 384 For example, the template configuration below shows as same text as
385 385 one shown by default::
386 386
387 387 [committemplate]
388 388 changeset = {desc}\n\n
389 389 HG: Enter commit message. Lines beginning with 'HG:' are removed.
390 390 HG: {extramsg}
391 391 HG: --
392 392 HG: user: {author}\n{ifeq(p2rev, "-1", "",
393 393 "HG: branch merge\n")
394 394 }HG: branch '{branch}'\n{if(activebookmark,
395 395 "HG: bookmark '{activebookmark}'\n") }{subrepos %
396 396 "HG: subrepo {subrepo}\n" }{file_adds %
397 397 "HG: added {file}\n" }{file_mods %
398 398 "HG: changed {file}\n" }{file_dels %
399 399 "HG: removed {file}\n" }{if(files, "",
400 400 "HG: no files changed\n")}
401 401
402 402 .. note::
403 403
404 404 For some problematic encodings (see :hg:`help win32mbcs` for
405 405 detail), this customization should be configured carefully, to
406 406 avoid showing broken characters.
407 407
408 408 For example, if a multibyte character ending with backslash (0x5c) is
409 409 followed by the ASCII character 'n' in the customized template,
410 410 the sequence of backslash and 'n' is treated as line-feed unexpectedly
411 411 (and the multibyte character is broken, too).
412 412
413 413 Customized template is used for commands below (``--edit`` may be
414 414 required):
415 415
416 416 - :hg:`backout`
417 417 - :hg:`commit`
418 418 - :hg:`fetch` (for merge commit only)
419 419 - :hg:`graft`
420 420 - :hg:`histedit`
421 421 - :hg:`import`
422 422 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
423 423 - :hg:`rebase`
424 424 - :hg:`shelve`
425 425 - :hg:`sign`
426 426 - :hg:`tag`
427 427 - :hg:`transplant`
428 428
429 429 Configuring items below instead of ``changeset`` allows showing
430 430 customized message only for specific actions, or showing different
431 431 messages for each action.
432 432
433 433 - ``changeset.backout`` for :hg:`backout`
434 434 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
435 435 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
436 436 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
437 437 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
438 438 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
439 439 - ``changeset.gpg.sign`` for :hg:`sign`
440 440 - ``changeset.graft`` for :hg:`graft`
441 441 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
442 442 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
443 443 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
444 444 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
445 445 - ``changeset.import.bypass`` for :hg:`import --bypass`
446 446 - ``changeset.import.normal.merge`` for :hg:`import` on merges
447 447 - ``changeset.import.normal.normal`` for :hg:`import` on other
448 448 - ``changeset.mq.qnew`` for :hg:`qnew`
449 449 - ``changeset.mq.qfold`` for :hg:`qfold`
450 450 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
451 451 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
452 452 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
453 453 - ``changeset.rebase.normal`` for :hg:`rebase` on other
454 454 - ``changeset.shelve.shelve`` for :hg:`shelve`
455 455 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
456 456 - ``changeset.tag.remove`` for :hg:`tag --remove`
457 457 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
458 458 - ``changeset.transplant.normal`` for :hg:`transplant` on other
459 459
460 460 These dot-separated lists of names are treated as hierarchical ones.
461 461 For example, ``changeset.tag.remove`` customizes the commit message
462 462 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
463 463 commit message for :hg:`tag` regardless of ``--remove`` option.
464 464
465 465 When the external editor is invoked for a commit, the corresponding
466 466 dot-separated list of names without the ``changeset.`` prefix
467 467 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
468 468 variable.
469 469
470 470 In this section, items other than ``changeset`` can be referred from
471 471 others. For example, the configuration to list committed files up
472 472 below can be referred as ``{listupfiles}``::
473 473
474 474 [committemplate]
475 475 listupfiles = {file_adds %
476 476 "HG: added {file}\n" }{file_mods %
477 477 "HG: changed {file}\n" }{file_dels %
478 478 "HG: removed {file}\n" }{if(files, "",
479 479 "HG: no files changed\n")}
480 480
481 481 ``decode/encode``
482 482 -----------------
483 483
484 484 Filters for transforming files on checkout/checkin. This would
485 485 typically be used for newline processing or other
486 486 localization/canonicalization of files.
487 487
488 488 Filters consist of a filter pattern followed by a filter command.
489 489 Filter patterns are globs by default, rooted at the repository root.
490 490 For example, to match any file ending in ``.txt`` in the root
491 491 directory only, use the pattern ``*.txt``. To match any file ending
492 492 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
493 493 For each file only the first matching filter applies.
494 494
495 495 The filter command can start with a specifier, either ``pipe:`` or
496 496 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
497 497
498 498 A ``pipe:`` command must accept data on stdin and return the transformed
499 499 data on stdout.
500 500
501 501 Pipe example::
502 502
503 503 [encode]
504 504 # uncompress gzip files on checkin to improve delta compression
505 505 # note: not necessarily a good idea, just an example
506 506 *.gz = pipe: gunzip
507 507
508 508 [decode]
509 509 # recompress gzip files when writing them to the working dir (we
510 510 # can safely omit "pipe:", because it's the default)
511 511 *.gz = gzip
512 512
513 513 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
514 514 with the name of a temporary file that contains the data to be
515 515 filtered by the command. The string ``OUTFILE`` is replaced with the name
516 516 of an empty temporary file, where the filtered data must be written by
517 517 the command.
518 518
519 519 .. note::
520 520
521 521 The tempfile mechanism is recommended for Windows systems,
522 522 where the standard shell I/O redirection operators often have
523 523 strange effects and may corrupt the contents of your files.
524 524
525 525 This filter mechanism is used internally by the ``eol`` extension to
526 526 translate line ending characters between Windows (CRLF) and Unix (LF)
527 527 format. We suggest you use the ``eol`` extension for convenience.
528 528
529 529
530 530 ``defaults``
531 531 ------------
532 532
533 533 (defaults are deprecated. Don't use them. Use aliases instead.)
534 534
535 535 Use the ``[defaults]`` section to define command defaults, i.e. the
536 536 default options/arguments to pass to the specified commands.
537 537
538 538 The following example makes :hg:`log` run in verbose mode, and
539 539 :hg:`status` show only the modified files, by default::
540 540
541 541 [defaults]
542 542 log = -v
543 543 status = -m
544 544
545 545 The actual commands, instead of their aliases, must be used when
546 546 defining command defaults. The command defaults will also be applied
547 547 to the aliases of the commands defined.
548 548
549 549
550 550 ``diff``
551 551 --------
552 552
553 553 Settings used when displaying diffs. Everything except for ``unified``
554 554 is a Boolean and defaults to False. See :hg:`help config.annotate`
555 555 for related options for the annotate command.
556 556
557 557 ``git``
558 558 Use git extended diff format.
559 559
560 560 ``nobinary``
561 561 Omit git binary patches.
562 562
563 563 ``nodates``
564 564 Don't include dates in diff headers.
565 565
566 566 ``noprefix``
567 567 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
568 568
569 569 ``showfunc``
570 570 Show which function each change is in.
571 571
572 572 ``ignorews``
573 573 Ignore white space when comparing lines.
574 574
575 575 ``ignorewsamount``
576 576 Ignore changes in the amount of white space.
577 577
578 578 ``ignoreblanklines``
579 579 Ignore changes whose lines are all blank.
580 580
581 581 ``unified``
582 582 Number of lines of context to show.
583 583
584 584 ``email``
585 585 ---------
586 586
587 587 Settings for extensions that send email messages.
588 588
589 589 ``from``
590 590 Optional. Email address to use in "From" header and SMTP envelope
591 591 of outgoing messages.
592 592
593 593 ``to``
594 594 Optional. Comma-separated list of recipients' email addresses.
595 595
596 596 ``cc``
597 597 Optional. Comma-separated list of carbon copy recipients'
598 598 email addresses.
599 599
600 600 ``bcc``
601 601 Optional. Comma-separated list of blind carbon copy recipients'
602 602 email addresses.
603 603
604 604 ``method``
605 605 Optional. Method to use to send email messages. If value is ``smtp``
606 606 (default), use SMTP (see the ``[smtp]`` section for configuration).
607 607 Otherwise, use as name of program to run that acts like sendmail
608 608 (takes ``-f`` option for sender, list of recipients on command line,
609 609 message on stdin). Normally, setting this to ``sendmail`` or
610 610 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
611 611
612 612 ``charsets``
613 613 Optional. Comma-separated list of character sets considered
614 614 convenient for recipients. Addresses, headers, and parts not
615 615 containing patches of outgoing messages will be encoded in the
616 616 first character set to which conversion from local encoding
617 617 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
618 618 conversion fails, the text in question is sent as is.
619 619 (default: '')
620 620
621 621 Order of outgoing email character sets:
622 622
623 623 1. ``us-ascii``: always first, regardless of settings
624 624 2. ``email.charsets``: in order given by user
625 625 3. ``ui.fallbackencoding``: if not in email.charsets
626 626 4. ``$HGENCODING``: if not in email.charsets
627 627 5. ``utf-8``: always last, regardless of settings
628 628
629 629 Email example::
630 630
631 631 [email]
632 632 from = Joseph User <joe.user@example.com>
633 633 method = /usr/sbin/sendmail
634 634 # charsets for western Europeans
635 635 # us-ascii, utf-8 omitted, as they are tried first and last
636 636 charsets = iso-8859-1, iso-8859-15, windows-1252
637 637
638 638
639 639 ``extensions``
640 640 --------------
641 641
642 642 Mercurial has an extension mechanism for adding new features. To
643 643 enable an extension, create an entry for it in this section.
644 644
645 645 If you know that the extension is already in Python's search path,
646 646 you can give the name of the module, followed by ``=``, with nothing
647 647 after the ``=``.
648 648
649 649 Otherwise, give a name that you choose, followed by ``=``, followed by
650 650 the path to the ``.py`` file (including the file name extension) that
651 651 defines the extension.
652 652
653 653 To explicitly disable an extension that is enabled in an hgrc of
654 654 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
655 655 or ``foo = !`` when path is not supplied.
656 656
657 657 Example for ``~/.hgrc``::
658 658
659 659 [extensions]
660 660 # (the color extension will get loaded from Mercurial's path)
661 661 color =
662 662 # (this extension will get loaded from the file specified)
663 663 myfeature = ~/.hgext/myfeature.py
664 664
665 665
666 666 ``format``
667 667 ----------
668 668
669 669 ``usegeneraldelta``
670 670 Enable or disable the "generaldelta" repository format which improves
671 671 repository compression by allowing "revlog" to store delta against arbitrary
672 672 revision instead of the previous stored one. This provides significant
673 673 improvement for repositories with branches. Enabled by default. Disabling
674 674 this option ensures that the on-disk format of newly created repository will
675 675 be compatible with Mercurial before version 1.9.
676 676
677 677 ``usestore``
678 678 Enable or disable the "store" repository format which improves
679 679 compatibility with systems that fold case or otherwise mangle
680 680 filenames. Enabled by default. Disabling this option will allow
681 681 you to store longer filenames in some situations at the expense of
682 682 compatibility and ensures that the on-disk format of newly created
683 683 repositories will be compatible with Mercurial before version 0.9.4.
684 684
685 685 ``usefncache``
686 686 Enable or disable the "fncache" repository format which enhances
687 687 the "store" repository format (which has to be enabled to use
688 688 fncache) to allow longer filenames and avoids using Windows
689 689 reserved names, e.g. "nul". Enabled by default. Disabling this
690 690 option ensures that the on-disk format of newly created
691 691 repositories will be compatible with Mercurial before version 1.1.
692 692
693 693 ``dotencode``
694 694 Enable or disable the "dotencode" repository format which enhances
695 695 the "fncache" repository format (which has to be enabled to use
696 696 dotencode) to avoid issues with filenames starting with ._ on
697 697 Mac OS X and spaces on Windows. Enabled by default. Disabling this
698 698 option ensures that the on-disk format of newly created
699 699 repositories will be compatible with Mercurial before version 1.7.
700 700
701 701 ``graph``
702 702 ---------
703 703
704 704 Web graph view configuration. This section let you change graph
705 705 elements display properties by branches, for instance to make the
706 706 ``default`` branch stand out.
707 707
708 708 Each line has the following format::
709 709
710 710 <branch>.<argument> = <value>
711 711
712 712 where ``<branch>`` is the name of the branch being
713 713 customized. Example::
714 714
715 715 [graph]
716 716 # 2px width
717 717 default.width = 2
718 718 # red color
719 719 default.color = FF0000
720 720
721 721 Supported arguments:
722 722
723 723 ``width``
724 724 Set branch edges width in pixels.
725 725
726 726 ``color``
727 727 Set branch edges color in hexadecimal RGB notation.
728 728
729 729 ``hooks``
730 730 ---------
731 731
732 732 Commands or Python functions that get automatically executed by
733 733 various actions such as starting or finishing a commit. Multiple
734 734 hooks can be run for the same action by appending a suffix to the
735 735 action. Overriding a site-wide hook can be done by changing its
736 736 value or setting it to an empty string. Hooks can be prioritized
737 737 by adding a prefix of ``priority`` to the hook name on a new line
738 738 and setting the priority. The default priority is 0.
739 739
740 740 Example ``.hg/hgrc``::
741 741
742 742 [hooks]
743 743 # update working directory after adding changesets
744 744 changegroup.update = hg update
745 745 # do not use the site-wide hook
746 746 incoming =
747 747 incoming.email = /my/email/hook
748 748 incoming.autobuild = /my/build/hook
749 749 # force autobuild hook to run before other incoming hooks
750 750 priority.incoming.autobuild = 1
751 751
752 752 Most hooks are run with environment variables set that give useful
753 753 additional information. For each hook below, the environment
754 754 variables it is passed are listed with names of the form ``$HG_foo``.
755 755
756 756 ``changegroup``
757 757 Run after a changegroup has been added via push, pull or unbundle.
758 758 ID of the first new changeset is in ``$HG_NODE``. URL from which
759 759 changes came is in ``$HG_URL``.
760 760
761 761 ``commit``
762 762 Run after a changeset has been created in the local repository. ID
763 763 of the newly created changeset is in ``$HG_NODE``. Parent changeset
764 764 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
765 765
766 766 ``incoming``
767 767 Run after a changeset has been pulled, pushed, or unbundled into
768 768 the local repository. The ID of the newly arrived changeset is in
769 769 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
770 770
771 771 ``outgoing``
772 772 Run after sending changes from local repository to another. ID of
773 773 first changeset sent is in ``$HG_NODE``. Source of operation is in
774 774 ``$HG_SOURCE``; Also see :hg:`help config.preoutgoing` hook.
775 775
776 776 ``post-<command>``
777 777 Run after successful invocations of the associated command. The
778 778 contents of the command line are passed as ``$HG_ARGS`` and the result
779 779 code in ``$HG_RESULT``. Parsed command line arguments are passed as
780 780 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
781 781 the python data internally passed to <command>. ``$HG_OPTS`` is a
782 782 dictionary of options (with unspecified options set to their defaults).
783 783 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
784 784
785 785 ``pre-<command>``
786 786 Run before executing the associated command. The contents of the
787 787 command line are passed as ``$HG_ARGS``. Parsed command line arguments
788 788 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
789 789 representations of the data internally passed to <command>. ``$HG_OPTS``
790 790 is a dictionary of options (with unspecified options set to their
791 791 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
792 792 failure, the command doesn't execute and Mercurial returns the failure
793 793 code.
794 794
795 795 ``prechangegroup``
796 796 Run before a changegroup is added via push, pull or unbundle. Exit
797 797 status 0 allows the changegroup to proceed. Non-zero status will
798 798 cause the push, pull or unbundle to fail. URL from which changes
799 799 will come is in ``$HG_URL``.
800 800
801 801 ``precommit``
802 802 Run before starting a local commit. Exit status 0 allows the
803 803 commit to proceed. Non-zero status will cause the commit to fail.
804 804 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
805 805
806 806 ``prelistkeys``
807 807 Run before listing pushkeys (like bookmarks) in the
808 808 repository. Non-zero status will cause failure. The key namespace is
809 809 in ``$HG_NAMESPACE``.
810 810
811 811 ``preoutgoing``
812 812 Run before collecting changes to send from the local repository to
813 813 another. Non-zero status will cause failure. This lets you prevent
814 814 pull over HTTP or SSH. Also prevents against local pull, push
815 815 (outbound) or bundle commands, but not effective, since you can
816 816 just copy files instead then. Source of operation is in
817 817 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
818 818 SSH or HTTP repository. If "push", "pull" or "bundle", operation
819 819 is happening on behalf of repository on same system.
820 820
821 821 ``prepushkey``
822 822 Run before a pushkey (like a bookmark) is added to the
823 823 repository. Non-zero status will cause the key to be rejected. The
824 824 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
825 825 the old value (if any) is in ``$HG_OLD``, and the new value is in
826 826 ``$HG_NEW``.
827 827
828 828 ``pretag``
829 829 Run before creating a tag. Exit status 0 allows the tag to be
830 830 created. Non-zero status will cause the tag to fail. ID of
831 831 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
832 832 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
833 833
834 834 ``pretxnopen``
835 835 Run before any new repository transaction is open. The reason for the
836 836 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
837 837 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
838 838 transaction from being opened.
839 839
840 840 ``pretxnclose``
841 841 Run right before the transaction is actually finalized. Any
842 842 repository change will be visible to the hook program. This lets you
843 843 validate the transaction content or change it. Exit status 0 allows
844 844 the commit to proceed. Non-zero status will cause the transaction to
845 845 be rolled back. The reason for the transaction opening will be in
846 846 ``$HG_TXNNAME`` and a unique identifier for the transaction will be in
847 847 ``HG_TXNID``. The rest of the available data will vary according the
848 848 transaction type. New changesets will add ``$HG_NODE`` (id of the
849 849 first added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables,
850 850 bookmarks and phases changes will set ``HG_BOOKMARK_MOVED`` and
851 851 ``HG_PHASES_MOVED`` to ``1``, etc.
852 852
853 853 ``txnclose``
854 854 Run after any repository transaction has been committed. At this
855 855 point, the transaction can no longer be rolled back. The hook will run
856 856 after the lock is released. See :hg:`help config.pretxnclose` docs for
857 857 details about available variables.
858 858
859 859 ``txnabort``
860 860 Run when a transaction is aborted. See :hg:`help config.pretxnclose`
861 861 docs for details about available variables.
862 862
863 863 ``pretxnchangegroup``
864 864 Run after a changegroup has been added via push, pull or unbundle,
865 865 but before the transaction has been committed. Changegroup is
866 866 visible to hook program. This lets you validate incoming changes
867 867 before accepting them. Passed the ID of the first new changeset in
868 868 ``$HG_NODE``. Exit status 0 allows the transaction to commit. Non-zero
869 869 status will cause the transaction to be rolled back and the push,
870 870 pull or unbundle will fail. URL that was source of changes is in
871 871 ``$HG_URL``.
872 872
873 873 ``pretxncommit``
874 874 Run after a changeset has been created but the transaction not yet
875 875 committed. Changeset is visible to hook program. This lets you
876 876 validate commit message and changes. Exit status 0 allows the
877 877 commit to proceed. Non-zero status will cause the transaction to
878 878 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
879 879 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
880 880
881 881 ``preupdate``
882 882 Run before updating the working directory. Exit status 0 allows
883 883 the update to proceed. Non-zero status will prevent the update.
884 884 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
885 885 of second new parent is in ``$HG_PARENT2``.
886 886
887 887 ``listkeys``
888 888 Run after listing pushkeys (like bookmarks) in the repository. The
889 889 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
890 890 dictionary containing the keys and values.
891 891
892 892 ``pushkey``
893 893 Run after a pushkey (like a bookmark) is added to the
894 894 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
895 895 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
896 896 value is in ``$HG_NEW``.
897 897
898 898 ``tag``
899 899 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
900 900 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
901 901 repository if ``$HG_LOCAL=0``.
902 902
903 903 ``update``
904 904 Run after updating the working directory. Changeset ID of first
905 905 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
906 906 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
907 907 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
908 908
909 909 .. note::
910 910
911 911 It is generally better to use standard hooks rather than the
912 912 generic pre- and post- command hooks as they are guaranteed to be
913 913 called in the appropriate contexts for influencing transactions.
914 914 Also, hooks like "commit" will be called in all contexts that
915 915 generate a commit (e.g. tag) and not just the commit command.
916 916
917 917 .. note::
918 918
919 919 Environment variables with empty values may not be passed to
920 920 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
921 921 will have an empty value under Unix-like platforms for non-merge
922 922 changesets, while it will not be available at all under Windows.
923 923
924 924 The syntax for Python hooks is as follows::
925 925
926 926 hookname = python:modulename.submodule.callable
927 927 hookname = python:/path/to/python/module.py:callable
928 928
929 929 Python hooks are run within the Mercurial process. Each hook is
930 930 called with at least three keyword arguments: a ui object (keyword
931 931 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
932 932 keyword that tells what kind of hook is used. Arguments listed as
933 933 environment variables above are passed as keyword arguments, with no
934 934 ``HG_`` prefix, and names in lower case.
935 935
936 936 If a Python hook returns a "true" value or raises an exception, this
937 937 is treated as a failure.
938 938
939 939
940 940 ``hostfingerprints``
941 941 --------------------
942 942
943 943 Fingerprints of the certificates of known HTTPS servers.
944 944 A HTTPS connection to a server with a fingerprint configured here will
945 945 only succeed if the servers certificate matches the fingerprint.
946 946 This is very similar to how ssh known hosts works.
947 947 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
948 948 The CA chain and web.cacerts is not used for servers with a fingerprint.
949 949
950 950 For example::
951 951
952 952 [hostfingerprints]
953 953 hg.intevation.org = fa:1f:d9:48:f1:e7:74:30:38:8d:d8:58:b6:94:b8:58:28:7d:8b:d0
954 954
955 955 This feature is only supported when using Python 2.6 or later.
956 956
957 957
958 958 ``http_proxy``
959 959 --------------
960 960
961 961 Used to access web-based Mercurial repositories through a HTTP
962 962 proxy.
963 963
964 964 ``host``
965 965 Host name and (optional) port of the proxy server, for example
966 966 "myproxy:8000".
967 967
968 968 ``no``
969 969 Optional. Comma-separated list of host names that should bypass
970 970 the proxy.
971 971
972 972 ``passwd``
973 973 Optional. Password to authenticate with at the proxy server.
974 974
975 975 ``user``
976 976 Optional. User name to authenticate with at the proxy server.
977 977
978 978 ``always``
979 979 Optional. Always use the proxy, even for localhost and any entries
980 980 in ``http_proxy.no``. (default: False)
981 981
982 982 ``merge-patterns``
983 983 ------------------
984 984
985 985 This section specifies merge tools to associate with particular file
986 986 patterns. Tools matched here will take precedence over the default
987 987 merge tool. Patterns are globs by default, rooted at the repository
988 988 root.
989 989
990 990 Example::
991 991
992 992 [merge-patterns]
993 993 **.c = kdiff3
994 994 **.jpg = myimgmerge
995 995
996 996 ``merge-tools``
997 997 ---------------
998 998
999 999 This section configures external merge tools to use for file-level
1000 1000 merges. This section has likely been preconfigured at install time.
1001 1001 Use :hg:`config merge-tools` to check the existing configuration.
1002 1002 Also see :hg:`help merge-tools` for more details.
1003 1003
1004 1004 Example ``~/.hgrc``::
1005 1005
1006 1006 [merge-tools]
1007 1007 # Override stock tool location
1008 1008 kdiff3.executable = ~/bin/kdiff3
1009 1009 # Specify command line
1010 1010 kdiff3.args = $base $local $other -o $output
1011 1011 # Give higher priority
1012 1012 kdiff3.priority = 1
1013 1013
1014 1014 # Changing the priority of preconfigured tool
1015 1015 meld.priority = 0
1016 1016
1017 1017 # Disable a preconfigured tool
1018 1018 vimdiff.disabled = yes
1019 1019
1020 1020 # Define new tool
1021 1021 myHtmlTool.args = -m $local $other $base $output
1022 1022 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
1023 1023 myHtmlTool.priority = 1
1024 1024
1025 1025 Supported arguments:
1026 1026
1027 1027 ``priority``
1028 1028 The priority in which to evaluate this tool.
1029 1029 (default: 0)
1030 1030
1031 1031 ``executable``
1032 1032 Either just the name of the executable or its pathname. On Windows,
1033 1033 the path can use environment variables with ${ProgramFiles} syntax.
1034 1034 (default: the tool name)
1035 1035
1036 1036 ``args``
1037 1037 The arguments to pass to the tool executable. You can refer to the
1038 1038 files being merged as well as the output file through these
1039 1039 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1040 1040 of ``$local`` and ``$other`` can vary depending on which action is being
1041 1041 performed. During and update or merge, ``$local`` represents the original
1042 1042 state of the file, while ``$other`` represents the commit you are updating
1043 1043 to or the commit you are merging with. During a rebase ``$local``
1044 1044 represents the destination of the rebase, and ``$other`` represents the
1045 1045 commit being rebased.
1046 1046 (default: ``$local $base $other``)
1047 1047
1048 1048 ``premerge``
1049 1049 Attempt to run internal non-interactive 3-way merge tool before
1050 1050 launching external tool. Options are ``true``, ``false``, ``keep`` or
1051 1051 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1052 1052 premerge fails. The ``keep-merge3`` will do the same but include information
1053 1053 about the base of the merge in the marker (see internal :merge3 in
1054 1054 :hg:`help merge-tools`).
1055 1055 (default: True)
1056 1056
1057 1057 ``binary``
1058 1058 This tool can merge binary files. (default: False, unless tool
1059 1059 was selected by file pattern match)
1060 1060
1061 1061 ``symlink``
1062 1062 This tool can merge symlinks. (default: False)
1063 1063
1064 1064 ``check``
1065 1065 A list of merge success-checking options:
1066 1066
1067 1067 ``changed``
1068 1068 Ask whether merge was successful when the merged file shows no changes.
1069 1069 ``conflicts``
1070 1070 Check whether there are conflicts even though the tool reported success.
1071 1071 ``prompt``
1072 1072 Always prompt for merge success, regardless of success reported by tool.
1073 1073
1074 1074 ``fixeol``
1075 1075 Attempt to fix up EOL changes caused by the merge tool.
1076 1076 (default: False)
1077 1077
1078 1078 ``gui``
1079 1079 This tool requires a graphical interface to run. (default: False)
1080 1080
1081 1081 ``regkey``
1082 1082 Windows registry key which describes install location of this
1083 1083 tool. Mercurial will search for this key first under
1084 1084 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1085 1085 (default: None)
1086 1086
1087 1087 ``regkeyalt``
1088 1088 An alternate Windows registry key to try if the first key is not
1089 1089 found. The alternate key uses the same ``regname`` and ``regappend``
1090 1090 semantics of the primary key. The most common use for this key
1091 1091 is to search for 32bit applications on 64bit operating systems.
1092 1092 (default: None)
1093 1093
1094 1094 ``regname``
1095 1095 Name of value to read from specified registry key.
1096 1096 (default: the unnamed (default) value)
1097 1097
1098 1098 ``regappend``
1099 1099 String to append to the value read from the registry, typically
1100 1100 the executable name of the tool.
1101 1101 (default: None)
1102 1102
1103 1103
1104 1104 ``patch``
1105 1105 ---------
1106 1106
1107 1107 Settings used when applying patches, for instance through the 'import'
1108 1108 command or with Mercurial Queues extension.
1109 1109
1110 1110 ``eol``
1111 1111 When set to 'strict' patch content and patched files end of lines
1112 1112 are preserved. When set to ``lf`` or ``crlf``, both files end of
1113 1113 lines are ignored when patching and the result line endings are
1114 1114 normalized to either LF (Unix) or CRLF (Windows). When set to
1115 1115 ``auto``, end of lines are again ignored while patching but line
1116 1116 endings in patched files are normalized to their original setting
1117 1117 on a per-file basis. If target file does not exist or has no end
1118 1118 of line, patch line endings are preserved.
1119 1119 (default: strict)
1120 1120
1121 1121 ``fuzz``
1122 1122 The number of lines of 'fuzz' to allow when applying patches. This
1123 1123 controls how much context the patcher is allowed to ignore when
1124 1124 trying to apply a patch.
1125 1125 (default: 2)
1126 1126
1127 1127 ``paths``
1128 1128 ---------
1129 1129
1130 1130 Assigns symbolic names to repositories. The left side is the
1131 1131 symbolic name, and the right gives the directory or URL that is the
1132 1132 location of the repository. Default paths can be declared by setting
1133 1133 the following entries.
1134 1134
1135 1135 ``default``
1136 1136 Directory or URL to use when pulling if no source is specified.
1137 1137 (default: repository from which the current repository was cloned)
1138 1138
1139 1139 ``default-push``
1140 1140 Optional. Directory or URL to use when pushing if no destination
1141 1141 is specified.
1142 1142
1143 1143 Custom paths can be defined by assigning the path to a name that later can be
1144 1144 used from the command line. Example::
1145 1145
1146 1146 [paths]
1147 1147 my_path = http://example.com/path
1148 1148
1149 1149 To push to the path defined in ``my_path`` run the command::
1150 1150
1151 1151 hg push my_path
1152 1152
1153 1153
1154 1154 ``phases``
1155 1155 ----------
1156 1156
1157 1157 Specifies default handling of phases. See :hg:`help phases` for more
1158 1158 information about working with phases.
1159 1159
1160 1160 ``publish``
1161 1161 Controls draft phase behavior when working as a server. When true,
1162 1162 pushed changesets are set to public in both client and server and
1163 1163 pulled or cloned changesets are set to public in the client.
1164 1164 (default: True)
1165 1165
1166 1166 ``new-commit``
1167 1167 Phase of newly-created commits.
1168 1168 (default: draft)
1169 1169
1170 1170 ``checksubrepos``
1171 1171 Check the phase of the current revision of each subrepository. Allowed
1172 1172 values are "ignore", "follow" and "abort". For settings other than
1173 1173 "ignore", the phase of the current revision of each subrepository is
1174 1174 checked before committing the parent repository. If any of those phases is
1175 1175 greater than the phase of the parent repository (e.g. if a subrepo is in a
1176 1176 "secret" phase while the parent repo is in "draft" phase), the commit is
1177 1177 either aborted (if checksubrepos is set to "abort") or the higher phase is
1178 1178 used for the parent repository commit (if set to "follow").
1179 1179 (default: follow)
1180 1180
1181 1181
1182 1182 ``profiling``
1183 1183 -------------
1184 1184
1185 1185 Specifies profiling type, format, and file output. Two profilers are
1186 1186 supported: an instrumenting profiler (named ``ls``), and a sampling
1187 1187 profiler (named ``stat``).
1188 1188
1189 1189 In this section description, 'profiling data' stands for the raw data
1190 1190 collected during profiling, while 'profiling report' stands for a
1191 1191 statistical text report generated from the profiling data. The
1192 1192 profiling is done using lsprof.
1193 1193
1194 1194 ``type``
1195 1195 The type of profiler to use.
1196 1196 (default: ls)
1197 1197
1198 1198 ``ls``
1199 1199 Use Python's built-in instrumenting profiler. This profiler
1200 1200 works on all platforms, but each line number it reports is the
1201 1201 first line of a function. This restriction makes it difficult to
1202 1202 identify the expensive parts of a non-trivial function.
1203 1203 ``stat``
1204 1204 Use a third-party statistical profiler, statprof. This profiler
1205 1205 currently runs only on Unix systems, and is most useful for
1206 1206 profiling commands that run for longer than about 0.1 seconds.
1207 1207
1208 1208 ``format``
1209 1209 Profiling format. Specific to the ``ls`` instrumenting profiler.
1210 1210 (default: text)
1211 1211
1212 1212 ``text``
1213 1213 Generate a profiling report. When saving to a file, it should be
1214 1214 noted that only the report is saved, and the profiling data is
1215 1215 not kept.
1216 1216 ``kcachegrind``
1217 1217 Format profiling data for kcachegrind use: when saving to a
1218 1218 file, the generated file can directly be loaded into
1219 1219 kcachegrind.
1220 1220
1221 1221 ``frequency``
1222 1222 Sampling frequency. Specific to the ``stat`` sampling profiler.
1223 1223 (default: 1000)
1224 1224
1225 1225 ``output``
1226 1226 File path where profiling data or report should be saved. If the
1227 1227 file exists, it is replaced. (default: None, data is printed on
1228 1228 stderr)
1229 1229
1230 1230 ``sort``
1231 1231 Sort field. Specific to the ``ls`` instrumenting profiler.
1232 1232 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1233 1233 ``inlinetime``.
1234 1234 (default: inlinetime)
1235 1235
1236 1236 ``limit``
1237 1237 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1238 1238 (default: 30)
1239 1239
1240 1240 ``nested``
1241 1241 Show at most this number of lines of drill-down info after each main entry.
1242 1242 This can help explain the difference between Total and Inline.
1243 1243 Specific to the ``ls`` instrumenting profiler.
1244 1244 (default: 5)
1245 1245
1246 1246 ``progress``
1247 1247 ------------
1248 1248
1249 1249 Mercurial commands can draw progress bars that are as informative as
1250 1250 possible. Some progress bars only offer indeterminate information, while others
1251 1251 have a definite end point.
1252 1252
1253 1253 ``delay``
1254 1254 Number of seconds (float) before showing the progress bar. (default: 3)
1255 1255
1256 1256 ``changedelay``
1257 1257 Minimum delay before showing a new topic. When set to less than 3 * refresh,
1258 1258 that value will be used instead. (default: 1)
1259 1259
1260 1260 ``refresh``
1261 1261 Time in seconds between refreshes of the progress bar. (default: 0.1)
1262 1262
1263 1263 ``format``
1264 1264 Format of the progress bar.
1265 1265
1266 1266 Valid entries for the format field are ``topic``, ``bar``, ``number``,
1267 1267 ``unit``, ``estimate``, speed, and item. item defaults to the last 20
1268 1268 characters of the item, but this can be changed by adding either ``-<num>``
1269 1269 which would take the last num characters, or ``+<num>`` for the first num
1270 1270 characters.
1271 1271
1272 1272 (default: Topic bar number estimate)
1273 1273
1274 1274 ``width``
1275 1275 If set, the maximum width of the progress information (that is, min(width,
1276 1276 term width) will be used).
1277 1277
1278 1278 ``clear-complete``
1279 1279 Clear the progress bar after it's done. (default: True)
1280 1280
1281 1281 ``disable``
1282 1282 If true, don't show a progress bar.
1283 1283
1284 1284 ``assume-tty``
1285 1285 If true, ALWAYS show a progress bar, unless disable is given.
1286 1286
1287 1287 ``revsetalias``
1288 1288 ---------------
1289 1289
1290 1290 Alias definitions for revsets. See :hg:`help revsets` for details.
1291 1291
1292 1292 ``server``
1293 1293 ----------
1294 1294
1295 1295 Controls generic server settings.
1296 1296
1297 1297 ``uncompressed``
1298 1298 Whether to allow clients to clone a repository using the
1299 1299 uncompressed streaming protocol. This transfers about 40% more
1300 1300 data than a regular clone, but uses less memory and CPU on both
1301 1301 server and client. Over a LAN (100 Mbps or better) or a very fast
1302 1302 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1303 1303 regular clone. Over most WAN connections (anything slower than
1304 1304 about 6 Mbps), uncompressed streaming is slower, because of the
1305 1305 extra data transfer overhead. This mode will also temporarily hold
1306 1306 the write lock while determining what data to transfer.
1307 1307 (default: True)
1308 1308
1309 1309 ``preferuncompressed``
1310 1310 When set, clients will try to use the uncompressed streaming
1311 1311 protocol. (default: False)
1312 1312
1313 1313 ``validate``
1314 1314 Whether to validate the completeness of pushed changesets by
1315 1315 checking that all new file revisions specified in manifests are
1316 1316 present. (default: False)
1317 1317
1318 1318 ``maxhttpheaderlen``
1319 1319 Instruct HTTP clients not to send request headers longer than this
1320 1320 many bytes. (default: 1024)
1321 1321
1322 ``bundle1``
1323 Whether to allow clients to push and pull using the legacy bundle1
1324 exchange format. (default: True)
1325
1326 ``bundle1.push``
1327 Whether to allow clients to push using the legacy bundle1 exchange
1328 format. (default: True)
1329
1330 ``bundle1.pull``
1331 Whether to allow clients to pull using the legacy bundle1 exchange
1332 format. (default: True)
1333
1334 Large repositories using the *generaldelta* storage format should
1335 consider setting this option because converting *generaldelta*
1336 repositories to the exchange format required by the bundle1 data
1337 format can consume a lot of CPU.
1338
1322 1339 ``smtp``
1323 1340 --------
1324 1341
1325 1342 Configuration for extensions that need to send email messages.
1326 1343
1327 1344 ``host``
1328 1345 Host name of mail server, e.g. "mail.example.com".
1329 1346
1330 1347 ``port``
1331 1348 Optional. Port to connect to on mail server. (default: 465 if
1332 1349 ``tls`` is smtps; 25 otherwise)
1333 1350
1334 1351 ``tls``
1335 1352 Optional. Method to enable TLS when connecting to mail server: starttls,
1336 1353 smtps or none. (default: none)
1337 1354
1338 1355 ``verifycert``
1339 1356 Optional. Verification for the certificate of mail server, when
1340 1357 ``tls`` is starttls or smtps. "strict", "loose" or False. For
1341 1358 "strict" or "loose", the certificate is verified as same as the
1342 1359 verification for HTTPS connections (see ``[hostfingerprints]`` and
1343 1360 ``[web] cacerts`` also). For "strict", sending email is also
1344 1361 aborted, if there is no configuration for mail server in
1345 1362 ``[hostfingerprints]`` and ``[web] cacerts``. --insecure for
1346 1363 :hg:`email` overwrites this as "loose". (default: strict)
1347 1364
1348 1365 ``username``
1349 1366 Optional. User name for authenticating with the SMTP server.
1350 1367 (default: None)
1351 1368
1352 1369 ``password``
1353 1370 Optional. Password for authenticating with the SMTP server. If not
1354 1371 specified, interactive sessions will prompt the user for a
1355 1372 password; non-interactive sessions will fail. (default: None)
1356 1373
1357 1374 ``local_hostname``
1358 1375 Optional. The hostname that the sender can use to identify
1359 1376 itself to the MTA.
1360 1377
1361 1378
1362 1379 ``subpaths``
1363 1380 ------------
1364 1381
1365 1382 Subrepository source URLs can go stale if a remote server changes name
1366 1383 or becomes temporarily unavailable. This section lets you define
1367 1384 rewrite rules of the form::
1368 1385
1369 1386 <pattern> = <replacement>
1370 1387
1371 1388 where ``pattern`` is a regular expression matching a subrepository
1372 1389 source URL and ``replacement`` is the replacement string used to
1373 1390 rewrite it. Groups can be matched in ``pattern`` and referenced in
1374 1391 ``replacements``. For instance::
1375 1392
1376 1393 http://server/(.*)-hg/ = http://hg.server/\1/
1377 1394
1378 1395 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1379 1396
1380 1397 Relative subrepository paths are first made absolute, and the
1381 1398 rewrite rules are then applied on the full (absolute) path. The rules
1382 1399 are applied in definition order.
1383 1400
1384 1401 ``trusted``
1385 1402 -----------
1386 1403
1387 1404 Mercurial will not use the settings in the
1388 1405 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1389 1406 user or to a trusted group, as various hgrc features allow arbitrary
1390 1407 commands to be run. This issue is often encountered when configuring
1391 1408 hooks or extensions for shared repositories or servers. However,
1392 1409 the web interface will use some safe settings from the ``[web]``
1393 1410 section.
1394 1411
1395 1412 This section specifies what users and groups are trusted. The
1396 1413 current user is always trusted. To trust everybody, list a user or a
1397 1414 group with name ``*``. These settings must be placed in an
1398 1415 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1399 1416 user or service running Mercurial.
1400 1417
1401 1418 ``users``
1402 1419 Comma-separated list of trusted users.
1403 1420
1404 1421 ``groups``
1405 1422 Comma-separated list of trusted groups.
1406 1423
1407 1424
1408 1425 ``ui``
1409 1426 ------
1410 1427
1411 1428 User interface controls.
1412 1429
1413 1430 ``archivemeta``
1414 1431 Whether to include the .hg_archival.txt file containing meta data
1415 1432 (hashes for the repository base and for tip) in archives created
1416 1433 by the :hg:`archive` command or downloaded via hgweb.
1417 1434 (default: True)
1418 1435
1419 1436 ``askusername``
1420 1437 Whether to prompt for a username when committing. If True, and
1421 1438 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1422 1439 be prompted to enter a username. If no username is entered, the
1423 1440 default ``USER@HOST`` is used instead.
1424 1441 (default: False)
1425 1442
1426 1443 ``clonebundlefallback``
1427 1444 Whether failure to apply an advertised "clone bundle" from a server
1428 1445 should result in fallback to a regular clone.
1429 1446
1430 1447 This is disabled by default because servers advertising "clone
1431 1448 bundles" often do so to reduce server load. If advertised bundles
1432 1449 start mass failing and clients automatically fall back to a regular
1433 1450 clone, this would add significant and unexpected load to the server
1434 1451 since the server is expecting clone operations to be offloaded to
1435 1452 pre-generated bundles. Failing fast (the default behavior) ensures
1436 1453 clients don't overwhelm the server when "clone bundle" application
1437 1454 fails.
1438 1455
1439 1456 (default: False)
1440 1457
1441 1458 ``commitsubrepos``
1442 1459 Whether to commit modified subrepositories when committing the
1443 1460 parent repository. If False and one subrepository has uncommitted
1444 1461 changes, abort the commit.
1445 1462 (default: False)
1446 1463
1447 1464 ``debug``
1448 1465 Print debugging information. (default: False)
1449 1466
1450 1467 ``editor``
1451 1468 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
1452 1469
1453 1470 ``fallbackencoding``
1454 1471 Encoding to try if it's not possible to decode the changelog using
1455 1472 UTF-8. (default: ISO-8859-1)
1456 1473
1457 1474 ``graphnodetemplate``
1458 1475 The template used to print changeset nodes in an ASCII revision graph.
1459 1476 (default: ``{graphnode}``)
1460 1477
1461 1478 ``ignore``
1462 1479 A file to read per-user ignore patterns from. This file should be
1463 1480 in the same format as a repository-wide .hgignore file. Filenames
1464 1481 are relative to the repository root. This option supports hook syntax,
1465 1482 so if you want to specify multiple ignore files, you can do so by
1466 1483 setting something like ``ignore.other = ~/.hgignore2``. For details
1467 1484 of the ignore file format, see the ``hgignore(5)`` man page.
1468 1485
1469 1486 ``interactive``
1470 1487 Allow to prompt the user. (default: True)
1471 1488
1472 1489 ``logtemplate``
1473 1490 Template string for commands that print changesets.
1474 1491
1475 1492 ``merge``
1476 1493 The conflict resolution program to use during a manual merge.
1477 1494 For more information on merge tools see :hg:`help merge-tools`.
1478 1495 For configuring merge tools see the ``[merge-tools]`` section.
1479 1496
1480 1497 ``mergemarkers``
1481 1498 Sets the merge conflict marker label styling. The ``detailed``
1482 1499 style uses the ``mergemarkertemplate`` setting to style the labels.
1483 1500 The ``basic`` style just uses 'local' and 'other' as the marker label.
1484 1501 One of ``basic`` or ``detailed``.
1485 1502 (default: ``basic``)
1486 1503
1487 1504 ``mergemarkertemplate``
1488 1505 The template used to print the commit description next to each conflict
1489 1506 marker during merge conflicts. See :hg:`help templates` for the template
1490 1507 format.
1491 1508
1492 1509 Defaults to showing the hash, tags, branches, bookmarks, author, and
1493 1510 the first line of the commit description.
1494 1511
1495 1512 If you use non-ASCII characters in names for tags, branches, bookmarks,
1496 1513 authors, and/or commit descriptions, you must pay attention to encodings of
1497 1514 managed files. At template expansion, non-ASCII characters use the encoding
1498 1515 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1499 1516 environment variables that govern your locale. If the encoding of the merge
1500 1517 markers is different from the encoding of the merged files,
1501 1518 serious problems may occur.
1502 1519
1503 1520 ``origbackuppath``
1504 1521 The path to a directory used to store generated .orig files. If the path is
1505 1522 not a directory, one will be created.
1506 1523
1507 1524 ``patch``
1508 1525 An optional external tool that ``hg import`` and some extensions
1509 1526 will use for applying patches. By default Mercurial uses an
1510 1527 internal patch utility. The external tool must work as the common
1511 1528 Unix ``patch`` program. In particular, it must accept a ``-p``
1512 1529 argument to strip patch headers, a ``-d`` argument to specify the
1513 1530 current directory, a file name to patch, and a patch file to take
1514 1531 from stdin.
1515 1532
1516 1533 It is possible to specify a patch tool together with extra
1517 1534 arguments. For example, setting this option to ``patch --merge``
1518 1535 will use the ``patch`` program with its 2-way merge option.
1519 1536
1520 1537 ``portablefilenames``
1521 1538 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1522 1539 (default: ``warn``)
1523 1540 If set to ``warn`` (or ``true``), a warning message is printed on POSIX
1524 1541 platforms, if a file with a non-portable filename is added (e.g. a file
1525 1542 with a name that can't be created on Windows because it contains reserved
1526 1543 parts like ``AUX``, reserved characters like ``:``, or would cause a case
1527 1544 collision with an existing file).
1528 1545 If set to ``ignore`` (or ``false``), no warning is printed.
1529 1546 If set to ``abort``, the command is aborted.
1530 1547 On Windows, this configuration option is ignored and the command aborted.
1531 1548
1532 1549 ``quiet``
1533 1550 Reduce the amount of output printed. (default: False)
1534 1551
1535 1552 ``remotecmd``
1536 1553 Remote command to use for clone/push/pull operations. (default: ``hg``)
1537 1554
1538 1555 ``report_untrusted``
1539 1556 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1540 1557 trusted user or group. (default: True)
1541 1558
1542 1559 ``slash``
1543 1560 Display paths using a slash (``/``) as the path separator. This
1544 1561 only makes a difference on systems where the default path
1545 1562 separator is not the slash character (e.g. Windows uses the
1546 1563 backslash character (``\``)).
1547 1564 (default: False)
1548 1565
1549 1566 ``statuscopies``
1550 1567 Display copies in the status command.
1551 1568
1552 1569 ``ssh``
1553 1570 Command to use for SSH connections. (default: ``ssh``)
1554 1571
1555 1572 ``strict``
1556 1573 Require exact command names, instead of allowing unambiguous
1557 1574 abbreviations. (default: False)
1558 1575
1559 1576 ``style``
1560 1577 Name of style to use for command output.
1561 1578
1562 1579 ``supportcontact``
1563 1580 A URL where users should report a Mercurial traceback. Use this if you are a
1564 1581 large organisation with its own Mercurial deployment process and crash
1565 1582 reports should be addressed to your internal support.
1566 1583
1567 1584 ``timeout``
1568 1585 The timeout used when a lock is held (in seconds), a negative value
1569 1586 means no timeout. (default: 600)
1570 1587
1571 1588 ``traceback``
1572 1589 Mercurial always prints a traceback when an unknown exception
1573 1590 occurs. Setting this to True will make Mercurial print a traceback
1574 1591 on all exceptions, even those recognized by Mercurial (such as
1575 1592 IOError or MemoryError). (default: False)
1576 1593
1577 1594 ``username``
1578 1595 The committer of a changeset created when running "commit".
1579 1596 Typically a person's name and email address, e.g. ``Fred Widget
1580 1597 <fred@example.com>``. Environment variables in the
1581 1598 username are expanded.
1582 1599
1583 1600 (default: ``$EMAIL`` or ``username@hostname``. If the username in
1584 1601 hgrc is empty, e.g. if the system admin set ``username =`` in the
1585 1602 system hgrc, it has to be specified manually or in a different
1586 1603 hgrc file)
1587 1604
1588 1605 ``verbose``
1589 1606 Increase the amount of output printed. (default: False)
1590 1607
1591 1608
1592 1609 ``web``
1593 1610 -------
1594 1611
1595 1612 Web interface configuration. The settings in this section apply to
1596 1613 both the builtin webserver (started by :hg:`serve`) and the script you
1597 1614 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1598 1615 and WSGI).
1599 1616
1600 1617 The Mercurial webserver does no authentication (it does not prompt for
1601 1618 usernames and passwords to validate *who* users are), but it does do
1602 1619 authorization (it grants or denies access for *authenticated users*
1603 1620 based on settings in this section). You must either configure your
1604 1621 webserver to do authentication for you, or disable the authorization
1605 1622 checks.
1606 1623
1607 1624 For a quick setup in a trusted environment, e.g., a private LAN, where
1608 1625 you want it to accept pushes from anybody, you can use the following
1609 1626 command line::
1610 1627
1611 1628 $ hg --config web.allow_push=* --config web.push_ssl=False serve
1612 1629
1613 1630 Note that this will allow anybody to push anything to the server and
1614 1631 that this should not be used for public servers.
1615 1632
1616 1633 The full set of options is:
1617 1634
1618 1635 ``accesslog``
1619 1636 Where to output the access log. (default: stdout)
1620 1637
1621 1638 ``address``
1622 1639 Interface address to bind to. (default: all)
1623 1640
1624 1641 ``allow_archive``
1625 1642 List of archive format (bz2, gz, zip) allowed for downloading.
1626 1643 (default: empty)
1627 1644
1628 1645 ``allowbz2``
1629 1646 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
1630 1647 revisions.
1631 1648 (default: False)
1632 1649
1633 1650 ``allowgz``
1634 1651 (DEPRECATED) Whether to allow .tar.gz downloading of repository
1635 1652 revisions.
1636 1653 (default: False)
1637 1654
1638 1655 ``allowpull``
1639 1656 Whether to allow pulling from the repository. (default: True)
1640 1657
1641 1658 ``allow_push``
1642 1659 Whether to allow pushing to the repository. If empty or not set,
1643 1660 pushing is not allowed. If the special value ``*``, any remote
1644 1661 user can push, including unauthenticated users. Otherwise, the
1645 1662 remote user must have been authenticated, and the authenticated
1646 1663 user name must be present in this list. The contents of the
1647 1664 allow_push list are examined after the deny_push list.
1648 1665
1649 1666 ``allow_read``
1650 1667 If the user has not already been denied repository access due to
1651 1668 the contents of deny_read, this list determines whether to grant
1652 1669 repository access to the user. If this list is not empty, and the
1653 1670 user is unauthenticated or not present in the list, then access is
1654 1671 denied for the user. If the list is empty or not set, then access
1655 1672 is permitted to all users by default. Setting allow_read to the
1656 1673 special value ``*`` is equivalent to it not being set (i.e. access
1657 1674 is permitted to all users). The contents of the allow_read list are
1658 1675 examined after the deny_read list.
1659 1676
1660 1677 ``allowzip``
1661 1678 (DEPRECATED) Whether to allow .zip downloading of repository
1662 1679 revisions. This feature creates temporary files.
1663 1680 (default: False)
1664 1681
1665 1682 ``archivesubrepos``
1666 1683 Whether to recurse into subrepositories when archiving.
1667 1684 (default: False)
1668 1685
1669 1686 ``baseurl``
1670 1687 Base URL to use when publishing URLs in other locations, so
1671 1688 third-party tools like email notification hooks can construct
1672 1689 URLs. Example: ``http://hgserver/repos/``.
1673 1690
1674 1691 ``cacerts``
1675 1692 Path to file containing a list of PEM encoded certificate
1676 1693 authority certificates. Environment variables and ``~user``
1677 1694 constructs are expanded in the filename. If specified on the
1678 1695 client, then it will verify the identity of remote HTTPS servers
1679 1696 with these certificates.
1680 1697
1681 1698 This feature is only supported when using Python 2.6 or later. If you wish
1682 1699 to use it with earlier versions of Python, install the backported
1683 1700 version of the ssl library that is available from
1684 1701 ``http://pypi.python.org``.
1685 1702
1686 1703 To disable SSL verification temporarily, specify ``--insecure`` from
1687 1704 command line.
1688 1705
1689 1706 You can use OpenSSL's CA certificate file if your platform has
1690 1707 one. On most Linux systems this will be
1691 1708 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
1692 1709 generate this file manually. The form must be as follows::
1693 1710
1694 1711 -----BEGIN CERTIFICATE-----
1695 1712 ... (certificate in base64 PEM encoding) ...
1696 1713 -----END CERTIFICATE-----
1697 1714 -----BEGIN CERTIFICATE-----
1698 1715 ... (certificate in base64 PEM encoding) ...
1699 1716 -----END CERTIFICATE-----
1700 1717
1701 1718 ``cache``
1702 1719 Whether to support caching in hgweb. (default: True)
1703 1720
1704 1721 ``certificate``
1705 1722 Certificate to use when running :hg:`serve`.
1706 1723
1707 1724 ``collapse``
1708 1725 With ``descend`` enabled, repositories in subdirectories are shown at
1709 1726 a single level alongside repositories in the current path. With
1710 1727 ``collapse`` also enabled, repositories residing at a deeper level than
1711 1728 the current path are grouped behind navigable directory entries that
1712 1729 lead to the locations of these repositories. In effect, this setting
1713 1730 collapses each collection of repositories found within a subdirectory
1714 1731 into a single entry for that subdirectory. (default: False)
1715 1732
1716 1733 ``comparisoncontext``
1717 1734 Number of lines of context to show in side-by-side file comparison. If
1718 1735 negative or the value ``full``, whole files are shown. (default: 5)
1719 1736
1720 1737 This setting can be overridden by a ``context`` request parameter to the
1721 1738 ``comparison`` command, taking the same values.
1722 1739
1723 1740 ``contact``
1724 1741 Name or email address of the person in charge of the repository.
1725 1742 (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
1726 1743
1727 1744 ``deny_push``
1728 1745 Whether to deny pushing to the repository. If empty or not set,
1729 1746 push is not denied. If the special value ``*``, all remote users are
1730 1747 denied push. Otherwise, unauthenticated users are all denied, and
1731 1748 any authenticated user name present in this list is also denied. The
1732 1749 contents of the deny_push list are examined before the allow_push list.
1733 1750
1734 1751 ``deny_read``
1735 1752 Whether to deny reading/viewing of the repository. If this list is
1736 1753 not empty, unauthenticated users are all denied, and any
1737 1754 authenticated user name present in this list is also denied access to
1738 1755 the repository. If set to the special value ``*``, all remote users
1739 1756 are denied access (rarely needed ;). If deny_read is empty or not set,
1740 1757 the determination of repository access depends on the presence and
1741 1758 content of the allow_read list (see description). If both
1742 1759 deny_read and allow_read are empty or not set, then access is
1743 1760 permitted to all users by default. If the repository is being
1744 1761 served via hgwebdir, denied users will not be able to see it in
1745 1762 the list of repositories. The contents of the deny_read list have
1746 1763 priority over (are examined before) the contents of the allow_read
1747 1764 list.
1748 1765
1749 1766 ``descend``
1750 1767 hgwebdir indexes will not descend into subdirectories. Only repositories
1751 1768 directly in the current path will be shown (other repositories are still
1752 1769 available from the index corresponding to their containing path).
1753 1770
1754 1771 ``description``
1755 1772 Textual description of the repository's purpose or contents.
1756 1773 (default: "unknown")
1757 1774
1758 1775 ``encoding``
1759 1776 Character encoding name. (default: the current locale charset)
1760 1777 Example: "UTF-8".
1761 1778
1762 1779 ``errorlog``
1763 1780 Where to output the error log. (default: stderr)
1764 1781
1765 1782 ``guessmime``
1766 1783 Control MIME types for raw download of file content.
1767 1784 Set to True to let hgweb guess the content type from the file
1768 1785 extension. This will serve HTML files as ``text/html`` and might
1769 1786 allow cross-site scripting attacks when serving untrusted
1770 1787 repositories. (default: False)
1771 1788
1772 1789 ``hidden``
1773 1790 Whether to hide the repository in the hgwebdir index.
1774 1791 (default: False)
1775 1792
1776 1793 ``ipv6``
1777 1794 Whether to use IPv6. (default: False)
1778 1795
1779 1796 ``logoimg``
1780 1797 File name of the logo image that some templates display on each page.
1781 1798 The file name is relative to ``staticurl``. That is, the full path to
1782 1799 the logo image is "staticurl/logoimg".
1783 1800 If unset, ``hglogo.png`` will be used.
1784 1801
1785 1802 ``logourl``
1786 1803 Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
1787 1804 will be used.
1788 1805
1789 1806 ``maxchanges``
1790 1807 Maximum number of changes to list on the changelog. (default: 10)
1791 1808
1792 1809 ``maxfiles``
1793 1810 Maximum number of files to list per changeset. (default: 10)
1794 1811
1795 1812 ``maxshortchanges``
1796 1813 Maximum number of changes to list on the shortlog, graph or filelog
1797 1814 pages. (default: 60)
1798 1815
1799 1816 ``name``
1800 1817 Repository name to use in the web interface.
1801 1818 (default: current working directory)
1802 1819
1803 1820 ``port``
1804 1821 Port to listen on. (default: 8000)
1805 1822
1806 1823 ``prefix``
1807 1824 Prefix path to serve from. (default: '' (server root))
1808 1825
1809 1826 ``push_ssl``
1810 1827 Whether to require that inbound pushes be transported over SSL to
1811 1828 prevent password sniffing. (default: True)
1812 1829
1813 1830 ``refreshinterval``
1814 1831 How frequently directory listings re-scan the filesystem for new
1815 1832 repositories, in seconds. This is relevant when wildcards are used
1816 1833 to define paths. Depending on how much filesystem traversal is
1817 1834 required, refreshing may negatively impact performance.
1818 1835
1819 1836 Values less than or equal to 0 always refresh.
1820 1837 (default: 20)
1821 1838
1822 1839 ``staticurl``
1823 1840 Base URL to use for static files. If unset, static files (e.g. the
1824 1841 hgicon.png favicon) will be served by the CGI script itself. Use
1825 1842 this setting to serve them directly with the HTTP server.
1826 1843 Example: ``http://hgserver/static/``.
1827 1844
1828 1845 ``stripes``
1829 1846 How many lines a "zebra stripe" should span in multi-line output.
1830 1847 Set to 0 to disable. (default: 1)
1831 1848
1832 1849 ``style``
1833 1850 Which template map style to use. The available options are the names of
1834 1851 subdirectories in the HTML templates path. (default: ``paper``)
1835 1852 Example: ``monoblue``.
1836 1853
1837 1854 ``templates``
1838 1855 Where to find the HTML templates. The default path to the HTML templates
1839 1856 can be obtained from ``hg debuginstall``.
1840 1857
1841 1858 ``websub``
1842 1859 ----------
1843 1860
1844 1861 Web substitution filter definition. You can use this section to
1845 1862 define a set of regular expression substitution patterns which
1846 1863 let you automatically modify the hgweb server output.
1847 1864
1848 1865 The default hgweb templates only apply these substitution patterns
1849 1866 on the revision description fields. You can apply them anywhere
1850 1867 you want when you create your own templates by adding calls to the
1851 1868 "websub" filter (usually after calling the "escape" filter).
1852 1869
1853 1870 This can be used, for example, to convert issue references to links
1854 1871 to your issue tracker, or to convert "markdown-like" syntax into
1855 1872 HTML (see the examples below).
1856 1873
1857 1874 Each entry in this section names a substitution filter.
1858 1875 The value of each entry defines the substitution expression itself.
1859 1876 The websub expressions follow the old interhg extension syntax,
1860 1877 which in turn imitates the Unix sed replacement syntax::
1861 1878
1862 1879 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
1863 1880
1864 1881 You can use any separator other than "/". The final "i" is optional
1865 1882 and indicates that the search must be case insensitive.
1866 1883
1867 1884 Examples::
1868 1885
1869 1886 [websub]
1870 1887 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
1871 1888 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
1872 1889 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
1873 1890
1874 1891 ``worker``
1875 1892 ----------
1876 1893
1877 1894 Parallel master/worker configuration. We currently perform working
1878 1895 directory updates in parallel on Unix-like systems, which greatly
1879 1896 helps performance.
1880 1897
1881 1898 ``numcpus``
1882 1899 Number of CPUs to use for parallel operations. A zero or
1883 1900 negative value is treated as ``use the default``.
1884 1901 (default: 4 or the number of CPUs on the system, whichever is larger)
@@ -1,833 +1,854 b''
1 1 # wireproto.py - generic wire protocol support functions
2 2 #
3 3 # Copyright 2005-2010 Matt Mackall <mpm@selenic.com>
4 4 #
5 5 # This software may be used and distributed according to the terms of the
6 6 # GNU General Public License version 2 or any later version.
7 7
8 8 from __future__ import absolute_import
9 9
10 10 import os
11 11 import sys
12 12 import tempfile
13 13 import urllib
14 14
15 15 from .i18n import _
16 16 from .node import (
17 17 bin,
18 18 hex,
19 19 )
20 20
21 21 from . import (
22 22 bundle2,
23 23 changegroup as changegroupmod,
24 24 encoding,
25 25 error,
26 26 exchange,
27 27 peer,
28 28 pushkey as pushkeymod,
29 29 streamclone,
30 30 util,
31 31 )
32 32
33 bundle2required = _(
34 'incompatible Mercurial client; bundle2 required\n'
35 '(see https://www.mercurial-scm.org/wiki/IncompatibleClient)\n')
36
33 37 class abstractserverproto(object):
34 38 """abstract class that summarizes the protocol API
35 39
36 40 Used as reference and documentation.
37 41 """
38 42
39 43 def getargs(self, args):
40 44 """return the value for arguments in <args>
41 45
42 46 returns a list of values (same order as <args>)"""
43 47 raise NotImplementedError()
44 48
45 49 def getfile(self, fp):
46 50 """write the whole content of a file into a file like object
47 51
48 52 The file is in the form::
49 53
50 54 (<chunk-size>\n<chunk>)+0\n
51 55
52 56 chunk size is the ascii version of the int.
53 57 """
54 58 raise NotImplementedError()
55 59
56 60 def redirect(self):
57 61 """may setup interception for stdout and stderr
58 62
59 63 See also the `restore` method."""
60 64 raise NotImplementedError()
61 65
62 66 # If the `redirect` function does install interception, the `restore`
63 67 # function MUST be defined. If interception is not used, this function
64 68 # MUST NOT be defined.
65 69 #
66 70 # left commented here on purpose
67 71 #
68 72 #def restore(self):
69 73 # """reinstall previous stdout and stderr and return intercepted stdout
70 74 # """
71 75 # raise NotImplementedError()
72 76
73 77 def groupchunks(self, cg):
74 78 """return 4096 chunks from a changegroup object
75 79
76 80 Some protocols may have compressed the contents."""
77 81 raise NotImplementedError()
78 82
79 83 class remotebatch(peer.batcher):
80 84 '''batches the queued calls; uses as few roundtrips as possible'''
81 85 def __init__(self, remote):
82 86 '''remote must support _submitbatch(encbatch) and
83 87 _submitone(op, encargs)'''
84 88 peer.batcher.__init__(self)
85 89 self.remote = remote
86 90 def submit(self):
87 91 req, rsp = [], []
88 92 for name, args, opts, resref in self.calls:
89 93 mtd = getattr(self.remote, name)
90 94 batchablefn = getattr(mtd, 'batchable', None)
91 95 if batchablefn is not None:
92 96 batchable = batchablefn(mtd.im_self, *args, **opts)
93 97 encargsorres, encresref = batchable.next()
94 98 if encresref:
95 99 req.append((name, encargsorres,))
96 100 rsp.append((batchable, encresref, resref,))
97 101 else:
98 102 resref.set(encargsorres)
99 103 else:
100 104 if req:
101 105 self._submitreq(req, rsp)
102 106 req, rsp = [], []
103 107 resref.set(mtd(*args, **opts))
104 108 if req:
105 109 self._submitreq(req, rsp)
106 110 def _submitreq(self, req, rsp):
107 111 encresults = self.remote._submitbatch(req)
108 112 for encres, r in zip(encresults, rsp):
109 113 batchable, encresref, resref = r
110 114 encresref.set(encres)
111 115 resref.set(batchable.next())
112 116
113 117 # Forward a couple of names from peer to make wireproto interactions
114 118 # slightly more sensible.
115 119 batchable = peer.batchable
116 120 future = peer.future
117 121
118 122 # list of nodes encoding / decoding
119 123
120 124 def decodelist(l, sep=' '):
121 125 if l:
122 126 return map(bin, l.split(sep))
123 127 return []
124 128
125 129 def encodelist(l, sep=' '):
126 130 try:
127 131 return sep.join(map(hex, l))
128 132 except TypeError:
129 133 raise
130 134
131 135 # batched call argument encoding
132 136
133 137 def escapearg(plain):
134 138 return (plain
135 139 .replace(':', ':c')
136 140 .replace(',', ':o')
137 141 .replace(';', ':s')
138 142 .replace('=', ':e'))
139 143
140 144 def unescapearg(escaped):
141 145 return (escaped
142 146 .replace(':e', '=')
143 147 .replace(':s', ';')
144 148 .replace(':o', ',')
145 149 .replace(':c', ':'))
146 150
147 151 # mapping of options accepted by getbundle and their types
148 152 #
149 153 # Meant to be extended by extensions. It is extensions responsibility to ensure
150 154 # such options are properly processed in exchange.getbundle.
151 155 #
152 156 # supported types are:
153 157 #
154 158 # :nodes: list of binary nodes
155 159 # :csv: list of comma-separated values
156 160 # :scsv: list of comma-separated values return as set
157 161 # :plain: string with no transformation needed.
158 162 gboptsmap = {'heads': 'nodes',
159 163 'common': 'nodes',
160 164 'obsmarkers': 'boolean',
161 165 'bundlecaps': 'scsv',
162 166 'listkeys': 'csv',
163 167 'cg': 'boolean',
164 168 'cbattempted': 'boolean'}
165 169
166 170 # client side
167 171
168 172 class wirepeer(peer.peerrepository):
169 173 """Client-side interface for communicating with a peer repository.
170 174
171 175 Methods commonly call wire protocol commands of the same name.
172 176
173 177 See also httppeer.py and sshpeer.py for protocol-specific
174 178 implementations of this interface.
175 179 """
176 180 def batch(self):
177 181 if self.capable('batch'):
178 182 return remotebatch(self)
179 183 else:
180 184 return peer.localbatch(self)
181 185 def _submitbatch(self, req):
182 186 cmds = []
183 187 for op, argsdict in req:
184 188 args = ','.join('%s=%s' % (escapearg(k), escapearg(v))
185 189 for k, v in argsdict.iteritems())
186 190 cmds.append('%s %s' % (op, args))
187 191 rsp = self._call("batch", cmds=';'.join(cmds))
188 192 return [unescapearg(r) for r in rsp.split(';')]
189 193 def _submitone(self, op, args):
190 194 return self._call(op, **args)
191 195
192 196 @batchable
193 197 def lookup(self, key):
194 198 self.requirecap('lookup', _('look up remote revision'))
195 199 f = future()
196 200 yield {'key': encoding.fromlocal(key)}, f
197 201 d = f.value
198 202 success, data = d[:-1].split(" ", 1)
199 203 if int(success):
200 204 yield bin(data)
201 205 self._abort(error.RepoError(data))
202 206
203 207 @batchable
204 208 def heads(self):
205 209 f = future()
206 210 yield {}, f
207 211 d = f.value
208 212 try:
209 213 yield decodelist(d[:-1])
210 214 except ValueError:
211 215 self._abort(error.ResponseError(_("unexpected response:"), d))
212 216
213 217 @batchable
214 218 def known(self, nodes):
215 219 f = future()
216 220 yield {'nodes': encodelist(nodes)}, f
217 221 d = f.value
218 222 try:
219 223 yield [bool(int(b)) for b in d]
220 224 except ValueError:
221 225 self._abort(error.ResponseError(_("unexpected response:"), d))
222 226
223 227 @batchable
224 228 def branchmap(self):
225 229 f = future()
226 230 yield {}, f
227 231 d = f.value
228 232 try:
229 233 branchmap = {}
230 234 for branchpart in d.splitlines():
231 235 branchname, branchheads = branchpart.split(' ', 1)
232 236 branchname = encoding.tolocal(urllib.unquote(branchname))
233 237 branchheads = decodelist(branchheads)
234 238 branchmap[branchname] = branchheads
235 239 yield branchmap
236 240 except TypeError:
237 241 self._abort(error.ResponseError(_("unexpected response:"), d))
238 242
239 243 def branches(self, nodes):
240 244 n = encodelist(nodes)
241 245 d = self._call("branches", nodes=n)
242 246 try:
243 247 br = [tuple(decodelist(b)) for b in d.splitlines()]
244 248 return br
245 249 except ValueError:
246 250 self._abort(error.ResponseError(_("unexpected response:"), d))
247 251
248 252 def between(self, pairs):
249 253 batch = 8 # avoid giant requests
250 254 r = []
251 255 for i in xrange(0, len(pairs), batch):
252 256 n = " ".join([encodelist(p, '-') for p in pairs[i:i + batch]])
253 257 d = self._call("between", pairs=n)
254 258 try:
255 259 r.extend(l and decodelist(l) or [] for l in d.splitlines())
256 260 except ValueError:
257 261 self._abort(error.ResponseError(_("unexpected response:"), d))
258 262 return r
259 263
260 264 @batchable
261 265 def pushkey(self, namespace, key, old, new):
262 266 if not self.capable('pushkey'):
263 267 yield False, None
264 268 f = future()
265 269 self.ui.debug('preparing pushkey for "%s:%s"\n' % (namespace, key))
266 270 yield {'namespace': encoding.fromlocal(namespace),
267 271 'key': encoding.fromlocal(key),
268 272 'old': encoding.fromlocal(old),
269 273 'new': encoding.fromlocal(new)}, f
270 274 d = f.value
271 275 d, output = d.split('\n', 1)
272 276 try:
273 277 d = bool(int(d))
274 278 except ValueError:
275 279 raise error.ResponseError(
276 280 _('push failed (unexpected response):'), d)
277 281 for l in output.splitlines(True):
278 282 self.ui.status(_('remote: '), l)
279 283 yield d
280 284
281 285 @batchable
282 286 def listkeys(self, namespace):
283 287 if not self.capable('pushkey'):
284 288 yield {}, None
285 289 f = future()
286 290 self.ui.debug('preparing listkeys for "%s"\n' % namespace)
287 291 yield {'namespace': encoding.fromlocal(namespace)}, f
288 292 d = f.value
289 293 self.ui.debug('received listkey for "%s": %i bytes\n'
290 294 % (namespace, len(d)))
291 295 yield pushkeymod.decodekeys(d)
292 296
293 297 def stream_out(self):
294 298 return self._callstream('stream_out')
295 299
296 300 def changegroup(self, nodes, kind):
297 301 n = encodelist(nodes)
298 302 f = self._callcompressable("changegroup", roots=n)
299 303 return changegroupmod.cg1unpacker(f, 'UN')
300 304
301 305 def changegroupsubset(self, bases, heads, kind):
302 306 self.requirecap('changegroupsubset', _('look up remote changes'))
303 307 bases = encodelist(bases)
304 308 heads = encodelist(heads)
305 309 f = self._callcompressable("changegroupsubset",
306 310 bases=bases, heads=heads)
307 311 return changegroupmod.cg1unpacker(f, 'UN')
308 312
309 313 def getbundle(self, source, **kwargs):
310 314 self.requirecap('getbundle', _('look up remote changes'))
311 315 opts = {}
312 316 bundlecaps = kwargs.get('bundlecaps')
313 317 if bundlecaps is not None:
314 318 kwargs['bundlecaps'] = sorted(bundlecaps)
315 319 else:
316 320 bundlecaps = () # kwargs could have it to None
317 321 for key, value in kwargs.iteritems():
318 322 if value is None:
319 323 continue
320 324 keytype = gboptsmap.get(key)
321 325 if keytype is None:
322 326 assert False, 'unexpected'
323 327 elif keytype == 'nodes':
324 328 value = encodelist(value)
325 329 elif keytype in ('csv', 'scsv'):
326 330 value = ','.join(value)
327 331 elif keytype == 'boolean':
328 332 value = '%i' % bool(value)
329 333 elif keytype != 'plain':
330 334 raise KeyError('unknown getbundle option type %s'
331 335 % keytype)
332 336 opts[key] = value
333 337 f = self._callcompressable("getbundle", **opts)
334 338 if any((cap.startswith('HG2') for cap in bundlecaps)):
335 339 return bundle2.getunbundler(self.ui, f)
336 340 else:
337 341 return changegroupmod.cg1unpacker(f, 'UN')
338 342
339 343 def unbundle(self, cg, heads, source):
340 344 '''Send cg (a readable file-like object representing the
341 345 changegroup to push, typically a chunkbuffer object) to the
342 346 remote server as a bundle.
343 347
344 348 When pushing a bundle10 stream, return an integer indicating the
345 349 result of the push (see localrepository.addchangegroup()).
346 350
347 351 When pushing a bundle20 stream, return a bundle20 stream.'''
348 352
349 353 if heads != ['force'] and self.capable('unbundlehash'):
350 354 heads = encodelist(['hashed',
351 355 util.sha1(''.join(sorted(heads))).digest()])
352 356 else:
353 357 heads = encodelist(heads)
354 358
355 359 if util.safehasattr(cg, 'deltaheader'):
356 360 # this a bundle10, do the old style call sequence
357 361 ret, output = self._callpush("unbundle", cg, heads=heads)
358 362 if ret == "":
359 363 raise error.ResponseError(
360 364 _('push failed:'), output)
361 365 try:
362 366 ret = int(ret)
363 367 except ValueError:
364 368 raise error.ResponseError(
365 369 _('push failed (unexpected response):'), ret)
366 370
367 371 for l in output.splitlines(True):
368 372 self.ui.status(_('remote: '), l)
369 373 else:
370 374 # bundle2 push. Send a stream, fetch a stream.
371 375 stream = self._calltwowaystream('unbundle', cg, heads=heads)
372 376 ret = bundle2.getunbundler(self.ui, stream)
373 377 return ret
374 378
375 379 def debugwireargs(self, one, two, three=None, four=None, five=None):
376 380 # don't pass optional arguments left at their default value
377 381 opts = {}
378 382 if three is not None:
379 383 opts['three'] = three
380 384 if four is not None:
381 385 opts['four'] = four
382 386 return self._call('debugwireargs', one=one, two=two, **opts)
383 387
384 388 def _call(self, cmd, **args):
385 389 """execute <cmd> on the server
386 390
387 391 The command is expected to return a simple string.
388 392
389 393 returns the server reply as a string."""
390 394 raise NotImplementedError()
391 395
392 396 def _callstream(self, cmd, **args):
393 397 """execute <cmd> on the server
394 398
395 399 The command is expected to return a stream.
396 400
397 401 returns the server reply as a file like object."""
398 402 raise NotImplementedError()
399 403
400 404 def _callcompressable(self, cmd, **args):
401 405 """execute <cmd> on the server
402 406
403 407 The command is expected to return a stream.
404 408
405 409 The stream may have been compressed in some implementations. This
406 410 function takes care of the decompression. This is the only difference
407 411 with _callstream.
408 412
409 413 returns the server reply as a file like object.
410 414 """
411 415 raise NotImplementedError()
412 416
413 417 def _callpush(self, cmd, fp, **args):
414 418 """execute a <cmd> on server
415 419
416 420 The command is expected to be related to a push. Push has a special
417 421 return method.
418 422
419 423 returns the server reply as a (ret, output) tuple. ret is either
420 424 empty (error) or a stringified int.
421 425 """
422 426 raise NotImplementedError()
423 427
424 428 def _calltwowaystream(self, cmd, fp, **args):
425 429 """execute <cmd> on server
426 430
427 431 The command will send a stream to the server and get a stream in reply.
428 432 """
429 433 raise NotImplementedError()
430 434
431 435 def _abort(self, exception):
432 436 """clearly abort the wire protocol connection and raise the exception
433 437 """
434 438 raise NotImplementedError()
435 439
436 440 # server side
437 441
438 442 # wire protocol command can either return a string or one of these classes.
439 443 class streamres(object):
440 444 """wireproto reply: binary stream
441 445
442 446 The call was successful and the result is a stream.
443 447 Iterate on the `self.gen` attribute to retrieve chunks.
444 448 """
445 449 def __init__(self, gen):
446 450 self.gen = gen
447 451
448 452 class pushres(object):
449 453 """wireproto reply: success with simple integer return
450 454
451 455 The call was successful and returned an integer contained in `self.res`.
452 456 """
453 457 def __init__(self, res):
454 458 self.res = res
455 459
456 460 class pusherr(object):
457 461 """wireproto reply: failure
458 462
459 463 The call failed. The `self.res` attribute contains the error message.
460 464 """
461 465 def __init__(self, res):
462 466 self.res = res
463 467
464 468 class ooberror(object):
465 469 """wireproto reply: failure of a batch of operation
466 470
467 471 Something failed during a batch call. The error message is stored in
468 472 `self.message`.
469 473 """
470 474 def __init__(self, message):
471 475 self.message = message
472 476
473 477 def dispatch(repo, proto, command):
474 478 repo = repo.filtered("served")
475 479 func, spec = commands[command]
476 480 args = proto.getargs(spec)
477 481 return func(repo, proto, *args)
478 482
479 483 def options(cmd, keys, others):
480 484 opts = {}
481 485 for k in keys:
482 486 if k in others:
483 487 opts[k] = others[k]
484 488 del others[k]
485 489 if others:
486 490 sys.stderr.write("warning: %s ignored unexpected arguments %s\n"
487 491 % (cmd, ",".join(others)))
488 492 return opts
489 493
494 def bundle1allowed(ui, action):
495 """Whether a bundle1 operation is allowed from the server."""
496 v = ui.configbool('server', 'bundle1.%s' % action, None)
497 if v is not None:
498 return v
499
500 return ui.configbool('server', 'bundle1', True)
501
490 502 # list of commands
491 503 commands = {}
492 504
493 505 def wireprotocommand(name, args=''):
494 506 """decorator for wire protocol command"""
495 507 def register(func):
496 508 commands[name] = (func, args)
497 509 return func
498 510 return register
499 511
500 512 @wireprotocommand('batch', 'cmds *')
501 513 def batch(repo, proto, cmds, others):
502 514 repo = repo.filtered("served")
503 515 res = []
504 516 for pair in cmds.split(';'):
505 517 op, args = pair.split(' ', 1)
506 518 vals = {}
507 519 for a in args.split(','):
508 520 if a:
509 521 n, v = a.split('=')
510 522 vals[n] = unescapearg(v)
511 523 func, spec = commands[op]
512 524 if spec:
513 525 keys = spec.split()
514 526 data = {}
515 527 for k in keys:
516 528 if k == '*':
517 529 star = {}
518 530 for key in vals.keys():
519 531 if key not in keys:
520 532 star[key] = vals[key]
521 533 data['*'] = star
522 534 else:
523 535 data[k] = vals[k]
524 536 result = func(repo, proto, *[data[k] for k in keys])
525 537 else:
526 538 result = func(repo, proto)
527 539 if isinstance(result, ooberror):
528 540 return result
529 541 res.append(escapearg(result))
530 542 return ';'.join(res)
531 543
532 544 @wireprotocommand('between', 'pairs')
533 545 def between(repo, proto, pairs):
534 546 pairs = [decodelist(p, '-') for p in pairs.split(" ")]
535 547 r = []
536 548 for b in repo.between(pairs):
537 549 r.append(encodelist(b) + "\n")
538 550 return "".join(r)
539 551
540 552 @wireprotocommand('branchmap')
541 553 def branchmap(repo, proto):
542 554 branchmap = repo.branchmap()
543 555 heads = []
544 556 for branch, nodes in branchmap.iteritems():
545 557 branchname = urllib.quote(encoding.fromlocal(branch))
546 558 branchnodes = encodelist(nodes)
547 559 heads.append('%s %s' % (branchname, branchnodes))
548 560 return '\n'.join(heads)
549 561
550 562 @wireprotocommand('branches', 'nodes')
551 563 def branches(repo, proto, nodes):
552 564 nodes = decodelist(nodes)
553 565 r = []
554 566 for b in repo.branches(nodes):
555 567 r.append(encodelist(b) + "\n")
556 568 return "".join(r)
557 569
558 570 @wireprotocommand('clonebundles', '')
559 571 def clonebundles(repo, proto):
560 572 """Server command for returning info for available bundles to seed clones.
561 573
562 574 Clients will parse this response and determine what bundle to fetch.
563 575
564 576 Extensions may wrap this command to filter or dynamically emit data
565 577 depending on the request. e.g. you could advertise URLs for the closest
566 578 data center given the client's IP address.
567 579 """
568 580 return repo.opener.tryread('clonebundles.manifest')
569 581
570 582 wireprotocaps = ['lookup', 'changegroupsubset', 'branchmap', 'pushkey',
571 583 'known', 'getbundle', 'unbundlehash', 'batch']
572 584
573 585 def _capabilities(repo, proto):
574 586 """return a list of capabilities for a repo
575 587
576 588 This function exists to allow extensions to easily wrap capabilities
577 589 computation
578 590
579 591 - returns a lists: easy to alter
580 592 - change done here will be propagated to both `capabilities` and `hello`
581 593 command without any other action needed.
582 594 """
583 595 # copy to prevent modification of the global list
584 596 caps = list(wireprotocaps)
585 597 if streamclone.allowservergeneration(repo.ui):
586 598 if repo.ui.configbool('server', 'preferuncompressed', False):
587 599 caps.append('stream-preferred')
588 600 requiredformats = repo.requirements & repo.supportedformats
589 601 # if our local revlogs are just revlogv1, add 'stream' cap
590 602 if not requiredformats - set(('revlogv1',)):
591 603 caps.append('stream')
592 604 # otherwise, add 'streamreqs' detailing our local revlog format
593 605 else:
594 606 caps.append('streamreqs=%s' % ','.join(sorted(requiredformats)))
595 607 if repo.ui.configbool('experimental', 'bundle2-advertise', True):
596 608 capsblob = bundle2.encodecaps(bundle2.getrepocaps(repo))
597 609 caps.append('bundle2=' + urllib.quote(capsblob))
598 610 caps.append('unbundle=%s' % ','.join(changegroupmod.bundlepriority))
599 611 caps.append(
600 612 'httpheader=%d' % repo.ui.configint('server', 'maxhttpheaderlen', 1024))
601 613 return caps
602 614
603 615 # If you are writing an extension and consider wrapping this function. Wrap
604 616 # `_capabilities` instead.
605 617 @wireprotocommand('capabilities')
606 618 def capabilities(repo, proto):
607 619 return ' '.join(_capabilities(repo, proto))
608 620
609 621 @wireprotocommand('changegroup', 'roots')
610 622 def changegroup(repo, proto, roots):
611 623 nodes = decodelist(roots)
612 624 cg = changegroupmod.changegroup(repo, nodes, 'serve')
613 625 return streamres(proto.groupchunks(cg))
614 626
615 627 @wireprotocommand('changegroupsubset', 'bases heads')
616 628 def changegroupsubset(repo, proto, bases, heads):
617 629 bases = decodelist(bases)
618 630 heads = decodelist(heads)
619 631 cg = changegroupmod.changegroupsubset(repo, bases, heads, 'serve')
620 632 return streamres(proto.groupchunks(cg))
621 633
622 634 @wireprotocommand('debugwireargs', 'one two *')
623 635 def debugwireargs(repo, proto, one, two, others):
624 636 # only accept optional args from the known set
625 637 opts = options('debugwireargs', ['three', 'four'], others)
626 638 return repo.debugwireargs(one, two, **opts)
627 639
628 640 # List of options accepted by getbundle.
629 641 #
630 642 # Meant to be extended by extensions. It is the extension's responsibility to
631 643 # ensure such options are properly processed in exchange.getbundle.
632 644 gboptslist = ['heads', 'common', 'bundlecaps']
633 645
634 646 @wireprotocommand('getbundle', '*')
635 647 def getbundle(repo, proto, others):
636 648 opts = options('getbundle', gboptsmap.keys(), others)
637 649 for k, v in opts.iteritems():
638 650 keytype = gboptsmap[k]
639 651 if keytype == 'nodes':
640 652 opts[k] = decodelist(v)
641 653 elif keytype == 'csv':
642 654 opts[k] = list(v.split(','))
643 655 elif keytype == 'scsv':
644 656 opts[k] = set(v.split(','))
645 657 elif keytype == 'boolean':
646 658 # Client should serialize False as '0', which is a non-empty string
647 659 # so it evaluates as a True bool.
648 660 if v == '0':
649 661 opts[k] = False
650 662 else:
651 663 opts[k] = bool(v)
652 664 elif keytype != 'plain':
653 665 raise KeyError('unknown getbundle option type %s'
654 666 % keytype)
667
668 if not bundle1allowed(repo.ui, 'pull'):
669 if not exchange.bundle2requested(opts.get('bundlecaps')):
670 return ooberror(bundle2required)
671
655 672 cg = exchange.getbundle(repo, 'serve', **opts)
656 673 return streamres(proto.groupchunks(cg))
657 674
658 675 @wireprotocommand('heads')
659 676 def heads(repo, proto):
660 677 h = repo.heads()
661 678 return encodelist(h) + "\n"
662 679
663 680 @wireprotocommand('hello')
664 681 def hello(repo, proto):
665 682 '''the hello command returns a set of lines describing various
666 683 interesting things about the server, in an RFC822-like format.
667 684 Currently the only one defined is "capabilities", which
668 685 consists of a line in the form:
669 686
670 687 capabilities: space separated list of tokens
671 688 '''
672 689 return "capabilities: %s\n" % (capabilities(repo, proto))
673 690
674 691 @wireprotocommand('listkeys', 'namespace')
675 692 def listkeys(repo, proto, namespace):
676 693 d = repo.listkeys(encoding.tolocal(namespace)).items()
677 694 return pushkeymod.encodekeys(d)
678 695
679 696 @wireprotocommand('lookup', 'key')
680 697 def lookup(repo, proto, key):
681 698 try:
682 699 k = encoding.tolocal(key)
683 700 c = repo[k]
684 701 r = c.hex()
685 702 success = 1
686 703 except Exception as inst:
687 704 r = str(inst)
688 705 success = 0
689 706 return "%s %s\n" % (success, r)
690 707
691 708 @wireprotocommand('known', 'nodes *')
692 709 def known(repo, proto, nodes, others):
693 710 return ''.join(b and "1" or "0" for b in repo.known(decodelist(nodes)))
694 711
695 712 @wireprotocommand('pushkey', 'namespace key old new')
696 713 def pushkey(repo, proto, namespace, key, old, new):
697 714 # compatibility with pre-1.8 clients which were accidentally
698 715 # sending raw binary nodes rather than utf-8-encoded hex
699 716 if len(new) == 20 and new.encode('string-escape') != new:
700 717 # looks like it could be a binary node
701 718 try:
702 719 new.decode('utf-8')
703 720 new = encoding.tolocal(new) # but cleanly decodes as UTF-8
704 721 except UnicodeDecodeError:
705 722 pass # binary, leave unmodified
706 723 else:
707 724 new = encoding.tolocal(new) # normal path
708 725
709 726 if util.safehasattr(proto, 'restore'):
710 727
711 728 proto.redirect()
712 729
713 730 try:
714 731 r = repo.pushkey(encoding.tolocal(namespace), encoding.tolocal(key),
715 732 encoding.tolocal(old), new) or False
716 733 except error.Abort:
717 734 r = False
718 735
719 736 output = proto.restore()
720 737
721 738 return '%s\n%s' % (int(r), output)
722 739
723 740 r = repo.pushkey(encoding.tolocal(namespace), encoding.tolocal(key),
724 741 encoding.tolocal(old), new)
725 742 return '%s\n' % int(r)
726 743
727 744 @wireprotocommand('stream_out')
728 745 def stream(repo, proto):
729 746 '''If the server supports streaming clone, it advertises the "stream"
730 747 capability with a value representing the version and flags of the repo
731 748 it is serving. Client checks to see if it understands the format.
732 749 '''
733 750 if not streamclone.allowservergeneration(repo.ui):
734 751 return '1\n'
735 752
736 753 def getstream(it):
737 754 yield '0\n'
738 755 for chunk in it:
739 756 yield chunk
740 757
741 758 try:
742 759 # LockError may be raised before the first result is yielded. Don't
743 760 # emit output until we're sure we got the lock successfully.
744 761 it = streamclone.generatev1wireproto(repo)
745 762 return streamres(getstream(it))
746 763 except error.LockError:
747 764 return '2\n'
748 765
749 766 @wireprotocommand('unbundle', 'heads')
750 767 def unbundle(repo, proto, heads):
751 768 their_heads = decodelist(heads)
752 769
753 770 try:
754 771 proto.redirect()
755 772
756 773 exchange.check_heads(repo, their_heads, 'preparing changes')
757 774
758 775 # write bundle data to temporary file because it can be big
759 776 fd, tempname = tempfile.mkstemp(prefix='hg-unbundle-')
760 777 fp = os.fdopen(fd, 'wb+')
761 778 r = 0
762 779 try:
763 780 proto.getfile(fp)
764 781 fp.seek(0)
765 782 gen = exchange.readbundle(repo.ui, fp, None)
783 if (isinstance(gen, changegroupmod.cg1unpacker)
784 and not bundle1allowed(repo.ui, 'push')):
785 return ooberror(bundle2required)
786
766 787 r = exchange.unbundle(repo, gen, their_heads, 'serve',
767 788 proto._client())
768 789 if util.safehasattr(r, 'addpart'):
769 790 # The return looks streamable, we are in the bundle2 case and
770 791 # should return a stream.
771 792 return streamres(r.getchunks())
772 793 return pushres(r)
773 794
774 795 finally:
775 796 fp.close()
776 797 os.unlink(tempname)
777 798
778 799 except (error.BundleValueError, error.Abort, error.PushRaced) as exc:
779 800 # handle non-bundle2 case first
780 801 if not getattr(exc, 'duringunbundle2', False):
781 802 try:
782 803 raise
783 804 except error.Abort:
784 805 # The old code we moved used sys.stderr directly.
785 806 # We did not change it to minimise code change.
786 807 # This need to be moved to something proper.
787 808 # Feel free to do it.
788 809 sys.stderr.write("abort: %s\n" % exc)
789 810 return pushres(0)
790 811 except error.PushRaced:
791 812 return pusherr(str(exc))
792 813
793 814 bundler = bundle2.bundle20(repo.ui)
794 815 for out in getattr(exc, '_bundle2salvagedoutput', ()):
795 816 bundler.addpart(out)
796 817 try:
797 818 try:
798 819 raise
799 820 except error.PushkeyFailed as exc:
800 821 # check client caps
801 822 remotecaps = getattr(exc, '_replycaps', None)
802 823 if (remotecaps is not None
803 824 and 'pushkey' not in remotecaps.get('error', ())):
804 825 # no support remote side, fallback to Abort handler.
805 826 raise
806 827 part = bundler.newpart('error:pushkey')
807 828 part.addparam('in-reply-to', exc.partid)
808 829 if exc.namespace is not None:
809 830 part.addparam('namespace', exc.namespace, mandatory=False)
810 831 if exc.key is not None:
811 832 part.addparam('key', exc.key, mandatory=False)
812 833 if exc.new is not None:
813 834 part.addparam('new', exc.new, mandatory=False)
814 835 if exc.old is not None:
815 836 part.addparam('old', exc.old, mandatory=False)
816 837 if exc.ret is not None:
817 838 part.addparam('ret', exc.ret, mandatory=False)
818 839 except error.BundleValueError as exc:
819 840 errpart = bundler.newpart('error:unsupportedcontent')
820 841 if exc.parttype is not None:
821 842 errpart.addparam('parttype', exc.parttype)
822 843 if exc.params:
823 844 errpart.addparam('params', '\0'.join(exc.params))
824 845 except error.Abort as exc:
825 846 manargs = [('message', str(exc))]
826 847 advargs = []
827 848 if exc.hint is not None:
828 849 advargs.append(('hint', exc.hint))
829 850 bundler.addpart(bundle2.bundlepart('error:abort',
830 851 manargs, advargs))
831 852 except error.PushRaced as exc:
832 853 bundler.newpart('error:pushraced', [('message', str(exc))])
833 854 return streamres(bundler.getchunks())
@@ -1,953 +1,1036 b''
1 1 Test exchange of common information using bundle2
2 2
3 3
4 4 $ getmainid() {
5 5 > hg -R main log --template '{node}\n' --rev "$1"
6 6 > }
7 7
8 8 enable obsolescence
9 9
10 10 $ cp $HGRCPATH $TESTTMP/hgrc.orig
11 11 $ cat > $TESTTMP/bundle2-pushkey-hook.sh << EOF
12 12 > echo pushkey: lock state after \"\$HG_NAMESPACE\"
13 13 > hg debuglock
14 14 > EOF
15 15
16 16 $ cat >> $HGRCPATH << EOF
17 17 > [experimental]
18 18 > evolution=createmarkers,exchange
19 19 > bundle2-exp=True
20 20 > bundle2-output-capture=True
21 21 > [ui]
22 22 > ssh=python "$TESTDIR/dummyssh"
23 23 > logtemplate={rev}:{node|short} {phase} {author} {bookmarks} {desc|firstline}
24 24 > [web]
25 25 > push_ssl = false
26 26 > allow_push = *
27 27 > [phases]
28 28 > publish=False
29 29 > [hooks]
30 30 > pretxnclose.tip = hg log -r tip -T "pre-close-tip:{node|short} {phase} {bookmarks}\n"
31 31 > txnclose.tip = hg log -r tip -T "postclose-tip:{node|short} {phase} {bookmarks}\n"
32 32 > txnclose.env = sh -c "HG_LOCAL= printenv.py txnclose"
33 33 > pushkey= sh "$TESTTMP/bundle2-pushkey-hook.sh"
34 34 > EOF
35 35
36 36 The extension requires a repo (currently unused)
37 37
38 38 $ hg init main
39 39 $ cd main
40 40 $ touch a
41 41 $ hg add a
42 42 $ hg commit -m 'a'
43 43 pre-close-tip:3903775176ed draft
44 44 postclose-tip:3903775176ed draft
45 45 txnclose hook: HG_PHASES_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=commit (glob)
46 46
47 47 $ hg unbundle $TESTDIR/bundles/rebase.hg
48 48 adding changesets
49 49 adding manifests
50 50 adding file changes
51 51 added 8 changesets with 7 changes to 7 files (+3 heads)
52 52 pre-close-tip:02de42196ebe draft
53 53 postclose-tip:02de42196ebe draft
54 54 txnclose hook: HG_NODE=cd010b8cd998f3981a5a8115f94f8da4ab506089 HG_PHASES_MOVED=1 HG_SOURCE=unbundle HG_TXNID=TXN:* HG_TXNNAME=unbundle (glob)
55 55 bundle:*/tests/bundles/rebase.hg HG_URL=bundle:*/tests/bundles/rebase.hg (glob)
56 56 (run 'hg heads' to see heads, 'hg merge' to merge)
57 57
58 58 $ cd ..
59 59
60 60 Real world exchange
61 61 =====================
62 62
63 63 Add more obsolescence information
64 64
65 65 $ hg -R main debugobsolete -d '0 0' 1111111111111111111111111111111111111111 `getmainid 9520eea781bc`
66 66 pre-close-tip:02de42196ebe draft
67 67 postclose-tip:02de42196ebe draft
68 68 txnclose hook: HG_NEW_OBSMARKERS=1 HG_TXNID=TXN:* HG_TXNNAME=debugobsolete (glob)
69 69 $ hg -R main debugobsolete -d '0 0' 2222222222222222222222222222222222222222 `getmainid 24b6387c8c8c`
70 70 pre-close-tip:02de42196ebe draft
71 71 postclose-tip:02de42196ebe draft
72 72 txnclose hook: HG_NEW_OBSMARKERS=1 HG_TXNID=TXN:* HG_TXNNAME=debugobsolete (glob)
73 73
74 74 clone --pull
75 75
76 76 $ hg -R main phase --public cd010b8cd998
77 77 pre-close-tip:02de42196ebe draft
78 78 postclose-tip:02de42196ebe draft
79 79 txnclose hook: HG_PHASES_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=phase (glob)
80 80 $ hg clone main other --pull --rev 9520eea781bc
81 81 adding changesets
82 82 adding manifests
83 83 adding file changes
84 84 added 2 changesets with 2 changes to 2 files
85 85 1 new obsolescence markers
86 86 pre-close-tip:9520eea781bc draft
87 87 postclose-tip:9520eea781bc draft
88 88 txnclose hook: HG_NEW_OBSMARKERS=1 HG_NODE=cd010b8cd998f3981a5a8115f94f8da4ab506089 HG_PHASES_MOVED=1 HG_SOURCE=pull HG_TXNID=TXN:* HG_TXNNAME=pull (glob)
89 89 file:/*/$TESTTMP/main HG_URL=file:$TESTTMP/main (glob)
90 90 updating to branch default
91 91 2 files updated, 0 files merged, 0 files removed, 0 files unresolved
92 92 $ hg -R other log -G
93 93 @ 1:9520eea781bc draft Nicolas Dumazet <nicdumz.commits@gmail.com> E
94 94 |
95 95 o 0:cd010b8cd998 public Nicolas Dumazet <nicdumz.commits@gmail.com> A
96 96
97 97 $ hg -R other debugobsolete
98 98 1111111111111111111111111111111111111111 9520eea781bcca16c1e15acc0ba14335a0e8e5ba 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
99 99
100 100 pull
101 101
102 102 $ hg -R main phase --public 9520eea781bc
103 103 pre-close-tip:02de42196ebe draft
104 104 postclose-tip:02de42196ebe draft
105 105 txnclose hook: HG_PHASES_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=phase (glob)
106 106 $ hg -R other pull -r 24b6387c8c8c
107 107 pulling from $TESTTMP/main (glob)
108 108 searching for changes
109 109 adding changesets
110 110 adding manifests
111 111 adding file changes
112 112 added 1 changesets with 1 changes to 1 files (+1 heads)
113 113 1 new obsolescence markers
114 114 pre-close-tip:24b6387c8c8c draft
115 115 postclose-tip:24b6387c8c8c draft
116 116 txnclose hook: HG_NEW_OBSMARKERS=1 HG_NODE=24b6387c8c8cae37178880f3fa95ded3cb1cf785 HG_PHASES_MOVED=1 HG_SOURCE=pull HG_TXNID=TXN:* HG_TXNNAME=pull (glob)
117 117 file:/*/$TESTTMP/main HG_URL=file:$TESTTMP/main (glob)
118 118 (run 'hg heads' to see heads, 'hg merge' to merge)
119 119 $ hg -R other log -G
120 120 o 2:24b6387c8c8c draft Nicolas Dumazet <nicdumz.commits@gmail.com> F
121 121 |
122 122 | @ 1:9520eea781bc draft Nicolas Dumazet <nicdumz.commits@gmail.com> E
123 123 |/
124 124 o 0:cd010b8cd998 public Nicolas Dumazet <nicdumz.commits@gmail.com> A
125 125
126 126 $ hg -R other debugobsolete
127 127 1111111111111111111111111111111111111111 9520eea781bcca16c1e15acc0ba14335a0e8e5ba 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
128 128 2222222222222222222222222222222222222222 24b6387c8c8cae37178880f3fa95ded3cb1cf785 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
129 129
130 130 pull empty (with phase movement)
131 131
132 132 $ hg -R main phase --public 24b6387c8c8c
133 133 pre-close-tip:02de42196ebe draft
134 134 postclose-tip:02de42196ebe draft
135 135 txnclose hook: HG_PHASES_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=phase (glob)
136 136 $ hg -R other pull -r 24b6387c8c8c
137 137 pulling from $TESTTMP/main (glob)
138 138 no changes found
139 139 pre-close-tip:24b6387c8c8c public
140 140 postclose-tip:24b6387c8c8c public
141 141 txnclose hook: HG_NEW_OBSMARKERS=0 HG_PHASES_MOVED=1 HG_SOURCE=pull HG_TXNID=TXN:* HG_TXNNAME=pull (glob)
142 142 file:/*/$TESTTMP/main HG_URL=file:$TESTTMP/main (glob)
143 143 $ hg -R other log -G
144 144 o 2:24b6387c8c8c public Nicolas Dumazet <nicdumz.commits@gmail.com> F
145 145 |
146 146 | @ 1:9520eea781bc draft Nicolas Dumazet <nicdumz.commits@gmail.com> E
147 147 |/
148 148 o 0:cd010b8cd998 public Nicolas Dumazet <nicdumz.commits@gmail.com> A
149 149
150 150 $ hg -R other debugobsolete
151 151 1111111111111111111111111111111111111111 9520eea781bcca16c1e15acc0ba14335a0e8e5ba 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
152 152 2222222222222222222222222222222222222222 24b6387c8c8cae37178880f3fa95ded3cb1cf785 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
153 153
154 154 pull empty
155 155
156 156 $ hg -R other pull -r 24b6387c8c8c
157 157 pulling from $TESTTMP/main (glob)
158 158 no changes found
159 159 pre-close-tip:24b6387c8c8c public
160 160 postclose-tip:24b6387c8c8c public
161 161 txnclose hook: HG_NEW_OBSMARKERS=0 HG_SOURCE=pull HG_TXNID=TXN:* HG_TXNNAME=pull (glob)
162 162 file:/*/$TESTTMP/main HG_URL=file:$TESTTMP/main (glob)
163 163 $ hg -R other log -G
164 164 o 2:24b6387c8c8c public Nicolas Dumazet <nicdumz.commits@gmail.com> F
165 165 |
166 166 | @ 1:9520eea781bc draft Nicolas Dumazet <nicdumz.commits@gmail.com> E
167 167 |/
168 168 o 0:cd010b8cd998 public Nicolas Dumazet <nicdumz.commits@gmail.com> A
169 169
170 170 $ hg -R other debugobsolete
171 171 1111111111111111111111111111111111111111 9520eea781bcca16c1e15acc0ba14335a0e8e5ba 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
172 172 2222222222222222222222222222222222222222 24b6387c8c8cae37178880f3fa95ded3cb1cf785 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
173 173
174 174 add extra data to test their exchange during push
175 175
176 176 $ hg -R main bookmark --rev eea13746799a book_eea1
177 177 pre-close-tip:02de42196ebe draft
178 178 postclose-tip:02de42196ebe draft
179 179 txnclose hook: HG_BOOKMARK_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=bookmark (glob)
180 180 $ hg -R main debugobsolete -d '0 0' 3333333333333333333333333333333333333333 `getmainid eea13746799a`
181 181 pre-close-tip:02de42196ebe draft
182 182 postclose-tip:02de42196ebe draft
183 183 txnclose hook: HG_NEW_OBSMARKERS=1 HG_TXNID=TXN:* HG_TXNNAME=debugobsolete (glob)
184 184 $ hg -R main bookmark --rev 02de42196ebe book_02de
185 185 pre-close-tip:02de42196ebe draft book_02de
186 186 postclose-tip:02de42196ebe draft book_02de
187 187 txnclose hook: HG_BOOKMARK_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=bookmark (glob)
188 188 $ hg -R main debugobsolete -d '0 0' 4444444444444444444444444444444444444444 `getmainid 02de42196ebe`
189 189 pre-close-tip:02de42196ebe draft book_02de
190 190 postclose-tip:02de42196ebe draft book_02de
191 191 txnclose hook: HG_NEW_OBSMARKERS=1 HG_TXNID=TXN:* HG_TXNNAME=debugobsolete (glob)
192 192 $ hg -R main bookmark --rev 42ccdea3bb16 book_42cc
193 193 pre-close-tip:02de42196ebe draft book_02de
194 194 postclose-tip:02de42196ebe draft book_02de
195 195 txnclose hook: HG_BOOKMARK_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=bookmark (glob)
196 196 $ hg -R main debugobsolete -d '0 0' 5555555555555555555555555555555555555555 `getmainid 42ccdea3bb16`
197 197 pre-close-tip:02de42196ebe draft book_02de
198 198 postclose-tip:02de42196ebe draft book_02de
199 199 txnclose hook: HG_NEW_OBSMARKERS=1 HG_TXNID=TXN:* HG_TXNNAME=debugobsolete (glob)
200 200 $ hg -R main bookmark --rev 5fddd98957c8 book_5fdd
201 201 pre-close-tip:02de42196ebe draft book_02de
202 202 postclose-tip:02de42196ebe draft book_02de
203 203 txnclose hook: HG_BOOKMARK_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=bookmark (glob)
204 204 $ hg -R main debugobsolete -d '0 0' 6666666666666666666666666666666666666666 `getmainid 5fddd98957c8`
205 205 pre-close-tip:02de42196ebe draft book_02de
206 206 postclose-tip:02de42196ebe draft book_02de
207 207 txnclose hook: HG_NEW_OBSMARKERS=1 HG_TXNID=TXN:* HG_TXNNAME=debugobsolete (glob)
208 208 $ hg -R main bookmark --rev 32af7686d403 book_32af
209 209 pre-close-tip:02de42196ebe draft book_02de
210 210 postclose-tip:02de42196ebe draft book_02de
211 211 txnclose hook: HG_BOOKMARK_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=bookmark (glob)
212 212 $ hg -R main debugobsolete -d '0 0' 7777777777777777777777777777777777777777 `getmainid 32af7686d403`
213 213 pre-close-tip:02de42196ebe draft book_02de
214 214 postclose-tip:02de42196ebe draft book_02de
215 215 txnclose hook: HG_NEW_OBSMARKERS=1 HG_TXNID=TXN:* HG_TXNNAME=debugobsolete (glob)
216 216
217 217 $ hg -R other bookmark --rev cd010b8cd998 book_eea1
218 218 pre-close-tip:24b6387c8c8c public
219 219 postclose-tip:24b6387c8c8c public
220 220 txnclose hook: HG_BOOKMARK_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=bookmark (glob)
221 221 $ hg -R other bookmark --rev cd010b8cd998 book_02de
222 222 pre-close-tip:24b6387c8c8c public
223 223 postclose-tip:24b6387c8c8c public
224 224 txnclose hook: HG_BOOKMARK_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=bookmark (glob)
225 225 $ hg -R other bookmark --rev cd010b8cd998 book_42cc
226 226 pre-close-tip:24b6387c8c8c public
227 227 postclose-tip:24b6387c8c8c public
228 228 txnclose hook: HG_BOOKMARK_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=bookmark (glob)
229 229 $ hg -R other bookmark --rev cd010b8cd998 book_5fdd
230 230 pre-close-tip:24b6387c8c8c public
231 231 postclose-tip:24b6387c8c8c public
232 232 txnclose hook: HG_BOOKMARK_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=bookmark (glob)
233 233 $ hg -R other bookmark --rev cd010b8cd998 book_32af
234 234 pre-close-tip:24b6387c8c8c public
235 235 postclose-tip:24b6387c8c8c public
236 236 txnclose hook: HG_BOOKMARK_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=bookmark (glob)
237 237
238 238 $ hg -R main phase --public eea13746799a
239 239 pre-close-tip:02de42196ebe draft book_02de
240 240 postclose-tip:02de42196ebe draft book_02de
241 241 txnclose hook: HG_PHASES_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=phase (glob)
242 242
243 243 push
244 244 $ hg -R main push other --rev eea13746799a --bookmark book_eea1
245 245 pushing to other
246 246 searching for changes
247 247 remote: adding changesets
248 248 remote: adding manifests
249 249 remote: adding file changes
250 250 remote: added 1 changesets with 0 changes to 0 files (-1 heads)
251 251 remote: 1 new obsolescence markers
252 252 remote: pre-close-tip:eea13746799a public book_eea1
253 253 remote: pushkey: lock state after "phases"
254 254 remote: lock: free
255 255 remote: wlock: free
256 256 remote: pushkey: lock state after "bookmarks"
257 257 remote: lock: free
258 258 remote: wlock: free
259 259 remote: postclose-tip:eea13746799a public book_eea1
260 260 remote: txnclose hook: HG_BOOKMARK_MOVED=1 HG_BUNDLE2=1 HG_NEW_OBSMARKERS=1 HG_NODE=eea13746799a9e0bfd88f29d3c2e9dc9389f524f HG_PHASES_MOVED=1 HG_SOURCE=push HG_TXNID=TXN:* HG_TXNNAME=push HG_URL=push (glob)
261 261 updating bookmark book_eea1
262 262 pre-close-tip:02de42196ebe draft book_02de
263 263 postclose-tip:02de42196ebe draft book_02de
264 264 txnclose hook: HG_SOURCE=push-response HG_TXNID=TXN:* HG_TXNNAME=push-response (glob)
265 265 file:/*/$TESTTMP/other HG_URL=file:$TESTTMP/other (glob)
266 266 $ hg -R other log -G
267 267 o 3:eea13746799a public Nicolas Dumazet <nicdumz.commits@gmail.com> book_eea1 G
268 268 |\
269 269 | o 2:24b6387c8c8c public Nicolas Dumazet <nicdumz.commits@gmail.com> F
270 270 | |
271 271 @ | 1:9520eea781bc public Nicolas Dumazet <nicdumz.commits@gmail.com> E
272 272 |/
273 273 o 0:cd010b8cd998 public Nicolas Dumazet <nicdumz.commits@gmail.com> book_02de book_32af book_42cc book_5fdd A
274 274
275 275 $ hg -R other debugobsolete
276 276 1111111111111111111111111111111111111111 9520eea781bcca16c1e15acc0ba14335a0e8e5ba 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
277 277 2222222222222222222222222222222222222222 24b6387c8c8cae37178880f3fa95ded3cb1cf785 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
278 278 3333333333333333333333333333333333333333 eea13746799a9e0bfd88f29d3c2e9dc9389f524f 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
279 279
280 280 pull over ssh
281 281
282 282 $ hg -R other pull ssh://user@dummy/main -r 02de42196ebe --bookmark book_02de
283 283 pulling from ssh://user@dummy/main
284 284 searching for changes
285 285 adding changesets
286 286 adding manifests
287 287 adding file changes
288 288 added 1 changesets with 1 changes to 1 files (+1 heads)
289 289 1 new obsolescence markers
290 290 updating bookmark book_02de
291 291 pre-close-tip:02de42196ebe draft book_02de
292 292 postclose-tip:02de42196ebe draft book_02de
293 293 txnclose hook: HG_BOOKMARK_MOVED=1 HG_NEW_OBSMARKERS=1 HG_NODE=02de42196ebee42ef284b6780a87cdc96e8eaab6 HG_PHASES_MOVED=1 HG_SOURCE=pull HG_TXNID=TXN:* HG_TXNNAME=pull (glob)
294 294 ssh://user@dummy/main HG_URL=ssh://user@dummy/main
295 295 (run 'hg heads' to see heads, 'hg merge' to merge)
296 296 $ hg -R other debugobsolete
297 297 1111111111111111111111111111111111111111 9520eea781bcca16c1e15acc0ba14335a0e8e5ba 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
298 298 2222222222222222222222222222222222222222 24b6387c8c8cae37178880f3fa95ded3cb1cf785 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
299 299 3333333333333333333333333333333333333333 eea13746799a9e0bfd88f29d3c2e9dc9389f524f 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
300 300 4444444444444444444444444444444444444444 02de42196ebee42ef284b6780a87cdc96e8eaab6 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
301 301
302 302 pull over http
303 303
304 304 $ hg -R main serve -p $HGPORT -d --pid-file=main.pid -E main-error.log
305 305 $ cat main.pid >> $DAEMON_PIDS
306 306
307 307 $ hg -R other pull http://localhost:$HGPORT/ -r 42ccdea3bb16 --bookmark book_42cc
308 308 pulling from http://localhost:$HGPORT/
309 309 searching for changes
310 310 adding changesets
311 311 adding manifests
312 312 adding file changes
313 313 added 1 changesets with 1 changes to 1 files (+1 heads)
314 314 1 new obsolescence markers
315 315 updating bookmark book_42cc
316 316 pre-close-tip:42ccdea3bb16 draft book_42cc
317 317 postclose-tip:42ccdea3bb16 draft book_42cc
318 318 txnclose hook: HG_BOOKMARK_MOVED=1 HG_NEW_OBSMARKERS=1 HG_NODE=42ccdea3bb16d28e1848c95fe2e44c000f3f21b1 HG_PHASES_MOVED=1 HG_SOURCE=pull HG_TXNID=TXN:* HG_TXNNAME=pull (glob)
319 319 http://localhost:$HGPORT/ HG_URL=http://localhost:$HGPORT/
320 320 (run 'hg heads .' to see heads, 'hg merge' to merge)
321 321 $ cat main-error.log
322 322 $ hg -R other debugobsolete
323 323 1111111111111111111111111111111111111111 9520eea781bcca16c1e15acc0ba14335a0e8e5ba 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
324 324 2222222222222222222222222222222222222222 24b6387c8c8cae37178880f3fa95ded3cb1cf785 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
325 325 3333333333333333333333333333333333333333 eea13746799a9e0bfd88f29d3c2e9dc9389f524f 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
326 326 4444444444444444444444444444444444444444 02de42196ebee42ef284b6780a87cdc96e8eaab6 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
327 327 5555555555555555555555555555555555555555 42ccdea3bb16d28e1848c95fe2e44c000f3f21b1 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
328 328
329 329 push over ssh
330 330
331 331 $ hg -R main push ssh://user@dummy/other -r 5fddd98957c8 --bookmark book_5fdd
332 332 pushing to ssh://user@dummy/other
333 333 searching for changes
334 334 remote: adding changesets
335 335 remote: adding manifests
336 336 remote: adding file changes
337 337 remote: added 1 changesets with 1 changes to 1 files
338 338 remote: 1 new obsolescence markers
339 339 remote: pre-close-tip:5fddd98957c8 draft book_5fdd
340 340 remote: pushkey: lock state after "bookmarks"
341 341 remote: lock: free
342 342 remote: wlock: free
343 343 remote: postclose-tip:5fddd98957c8 draft book_5fdd
344 344 remote: txnclose hook: HG_BOOKMARK_MOVED=1 HG_BUNDLE2=1 HG_NEW_OBSMARKERS=1 HG_NODE=5fddd98957c8a54a4d436dfe1da9d87f21a1b97b HG_SOURCE=serve HG_TXNID=TXN:* HG_TXNNAME=serve HG_URL=remote:ssh:127.0.0.1 (glob)
345 345 updating bookmark book_5fdd
346 346 pre-close-tip:02de42196ebe draft book_02de
347 347 postclose-tip:02de42196ebe draft book_02de
348 348 txnclose hook: HG_SOURCE=push-response HG_TXNID=TXN:* HG_TXNNAME=push-response (glob)
349 349 ssh://user@dummy/other HG_URL=ssh://user@dummy/other
350 350 $ hg -R other log -G
351 351 o 6:5fddd98957c8 draft Nicolas Dumazet <nicdumz.commits@gmail.com> book_5fdd C
352 352 |
353 353 o 5:42ccdea3bb16 draft Nicolas Dumazet <nicdumz.commits@gmail.com> book_42cc B
354 354 |
355 355 | o 4:02de42196ebe draft Nicolas Dumazet <nicdumz.commits@gmail.com> book_02de H
356 356 | |
357 357 | | o 3:eea13746799a public Nicolas Dumazet <nicdumz.commits@gmail.com> book_eea1 G
358 358 | |/|
359 359 | o | 2:24b6387c8c8c public Nicolas Dumazet <nicdumz.commits@gmail.com> F
360 360 |/ /
361 361 | @ 1:9520eea781bc public Nicolas Dumazet <nicdumz.commits@gmail.com> E
362 362 |/
363 363 o 0:cd010b8cd998 public Nicolas Dumazet <nicdumz.commits@gmail.com> book_32af A
364 364
365 365 $ hg -R other debugobsolete
366 366 1111111111111111111111111111111111111111 9520eea781bcca16c1e15acc0ba14335a0e8e5ba 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
367 367 2222222222222222222222222222222222222222 24b6387c8c8cae37178880f3fa95ded3cb1cf785 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
368 368 3333333333333333333333333333333333333333 eea13746799a9e0bfd88f29d3c2e9dc9389f524f 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
369 369 4444444444444444444444444444444444444444 02de42196ebee42ef284b6780a87cdc96e8eaab6 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
370 370 5555555555555555555555555555555555555555 42ccdea3bb16d28e1848c95fe2e44c000f3f21b1 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
371 371 6666666666666666666666666666666666666666 5fddd98957c8a54a4d436dfe1da9d87f21a1b97b 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
372 372
373 373 push over http
374 374
375 375 $ hg -R other serve -p $HGPORT2 -d --pid-file=other.pid -E other-error.log
376 376 $ cat other.pid >> $DAEMON_PIDS
377 377
378 378 $ hg -R main phase --public 32af7686d403
379 379 pre-close-tip:02de42196ebe draft book_02de
380 380 postclose-tip:02de42196ebe draft book_02de
381 381 txnclose hook: HG_PHASES_MOVED=1 HG_TXNID=TXN:* HG_TXNNAME=phase (glob)
382 382 $ hg -R main push http://localhost:$HGPORT2/ -r 32af7686d403 --bookmark book_32af
383 383 pushing to http://localhost:$HGPORT2/
384 384 searching for changes
385 385 remote: adding changesets
386 386 remote: adding manifests
387 387 remote: adding file changes
388 388 remote: added 1 changesets with 1 changes to 1 files
389 389 remote: 1 new obsolescence markers
390 390 remote: pre-close-tip:32af7686d403 public book_32af
391 391 remote: pushkey: lock state after "phases"
392 392 remote: lock: free
393 393 remote: wlock: free
394 394 remote: pushkey: lock state after "bookmarks"
395 395 remote: lock: free
396 396 remote: wlock: free
397 397 remote: postclose-tip:32af7686d403 public book_32af
398 398 remote: txnclose hook: HG_BOOKMARK_MOVED=1 HG_BUNDLE2=1 HG_NEW_OBSMARKERS=1 HG_NODE=32af7686d403cf45b5d95f2d70cebea587ac806a HG_PHASES_MOVED=1 HG_SOURCE=serve HG_TXNID=TXN:* HG_TXNNAME=serve HG_URL=remote:http:127.0.0.1: (glob)
399 399 updating bookmark book_32af
400 400 pre-close-tip:02de42196ebe draft book_02de
401 401 postclose-tip:02de42196ebe draft book_02de
402 402 txnclose hook: HG_SOURCE=push-response HG_TXNID=TXN:* HG_TXNNAME=push-response (glob)
403 403 http://localhost:$HGPORT2/ HG_URL=http://localhost:$HGPORT2/
404 404 $ cat other-error.log
405 405
406 406 Check final content.
407 407
408 408 $ hg -R other log -G
409 409 o 7:32af7686d403 public Nicolas Dumazet <nicdumz.commits@gmail.com> book_32af D
410 410 |
411 411 o 6:5fddd98957c8 public Nicolas Dumazet <nicdumz.commits@gmail.com> book_5fdd C
412 412 |
413 413 o 5:42ccdea3bb16 public Nicolas Dumazet <nicdumz.commits@gmail.com> book_42cc B
414 414 |
415 415 | o 4:02de42196ebe draft Nicolas Dumazet <nicdumz.commits@gmail.com> book_02de H
416 416 | |
417 417 | | o 3:eea13746799a public Nicolas Dumazet <nicdumz.commits@gmail.com> book_eea1 G
418 418 | |/|
419 419 | o | 2:24b6387c8c8c public Nicolas Dumazet <nicdumz.commits@gmail.com> F
420 420 |/ /
421 421 | @ 1:9520eea781bc public Nicolas Dumazet <nicdumz.commits@gmail.com> E
422 422 |/
423 423 o 0:cd010b8cd998 public Nicolas Dumazet <nicdumz.commits@gmail.com> A
424 424
425 425 $ hg -R other debugobsolete
426 426 1111111111111111111111111111111111111111 9520eea781bcca16c1e15acc0ba14335a0e8e5ba 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
427 427 2222222222222222222222222222222222222222 24b6387c8c8cae37178880f3fa95ded3cb1cf785 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
428 428 3333333333333333333333333333333333333333 eea13746799a9e0bfd88f29d3c2e9dc9389f524f 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
429 429 4444444444444444444444444444444444444444 02de42196ebee42ef284b6780a87cdc96e8eaab6 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
430 430 5555555555555555555555555555555555555555 42ccdea3bb16d28e1848c95fe2e44c000f3f21b1 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
431 431 6666666666666666666666666666666666666666 5fddd98957c8a54a4d436dfe1da9d87f21a1b97b 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
432 432 7777777777777777777777777777777777777777 32af7686d403cf45b5d95f2d70cebea587ac806a 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
433 433
434 434 (check that no 'pending' files remain)
435 435
436 436 $ ls -1 other/.hg/bookmarks*
437 437 other/.hg/bookmarks
438 438 $ ls -1 other/.hg/store/phaseroots*
439 439 other/.hg/store/phaseroots
440 440 $ ls -1 other/.hg/store/00changelog.i*
441 441 other/.hg/store/00changelog.i
442 442
443 443 Error Handling
444 444 ==============
445 445
446 446 Check that errors are properly returned to the client during push.
447 447
448 448 Setting up
449 449
450 450 $ cat > failpush.py << EOF
451 451 > """A small extension that makes push fails when using bundle2
452 452 >
453 453 > used to test error handling in bundle2
454 454 > """
455 455 >
456 456 > from mercurial import error
457 457 > from mercurial import bundle2
458 458 > from mercurial import exchange
459 459 > from mercurial import extensions
460 460 >
461 461 > def _pushbundle2failpart(pushop, bundler):
462 462 > reason = pushop.ui.config('failpush', 'reason', None)
463 463 > part = None
464 464 > if reason == 'abort':
465 465 > bundler.newpart('test:abort')
466 466 > if reason == 'unknown':
467 467 > bundler.newpart('test:unknown')
468 468 > if reason == 'race':
469 469 > # 20 Bytes of crap
470 470 > bundler.newpart('check:heads', data='01234567890123456789')
471 471 >
472 472 > @bundle2.parthandler("test:abort")
473 473 > def handleabort(op, part):
474 474 > raise error.Abort('Abandon ship!', hint="don't panic")
475 475 >
476 476 > def uisetup(ui):
477 477 > exchange.b2partsgenmapping['failpart'] = _pushbundle2failpart
478 478 > exchange.b2partsgenorder.insert(0, 'failpart')
479 479 >
480 480 > EOF
481 481
482 482 $ cd main
483 483 $ hg up tip
484 484 3 files updated, 0 files merged, 1 files removed, 0 files unresolved
485 485 $ echo 'I' > I
486 486 $ hg add I
487 487 $ hg ci -m 'I'
488 488 pre-close-tip:e7ec4e813ba6 draft
489 489 postclose-tip:e7ec4e813ba6 draft
490 490 txnclose hook: HG_TXNID=TXN:* HG_TXNNAME=commit (glob)
491 491 $ hg id
492 492 e7ec4e813ba6 tip
493 493 $ cd ..
494 494
495 495 $ cat << EOF >> $HGRCPATH
496 496 > [extensions]
497 497 > failpush=$TESTTMP/failpush.py
498 498 > EOF
499 499
500 500 $ killdaemons.py
501 501 $ hg -R other serve -p $HGPORT2 -d --pid-file=other.pid -E other-error.log
502 502 $ cat other.pid >> $DAEMON_PIDS
503 503
504 504 Doing the actual push: Abort error
505 505
506 506 $ cat << EOF >> $HGRCPATH
507 507 > [failpush]
508 508 > reason = abort
509 509 > EOF
510 510
511 511 $ hg -R main push other -r e7ec4e813ba6
512 512 pushing to other
513 513 searching for changes
514 514 abort: Abandon ship!
515 515 (don't panic)
516 516 [255]
517 517
518 518 $ hg -R main push ssh://user@dummy/other -r e7ec4e813ba6
519 519 pushing to ssh://user@dummy/other
520 520 searching for changes
521 521 remote: Abandon ship!
522 522 abort: push failed on remote
523 523 (don't panic)
524 524 [255]
525 525
526 526 $ hg -R main push http://localhost:$HGPORT2/ -r e7ec4e813ba6
527 527 pushing to http://localhost:$HGPORT2/
528 528 searching for changes
529 529 remote: Abandon ship!
530 530 abort: push failed on remote
531 531 (don't panic)
532 532 [255]
533 533
534 534
535 535 Doing the actual push: unknown mandatory parts
536 536
537 537 $ cat << EOF >> $HGRCPATH
538 538 > [failpush]
539 539 > reason = unknown
540 540 > EOF
541 541
542 542 $ hg -R main push other -r e7ec4e813ba6
543 543 pushing to other
544 544 searching for changes
545 545 abort: missing support for test:unknown
546 546 [255]
547 547
548 548 $ hg -R main push ssh://user@dummy/other -r e7ec4e813ba6
549 549 pushing to ssh://user@dummy/other
550 550 searching for changes
551 551 abort: missing support for test:unknown
552 552 [255]
553 553
554 554 $ hg -R main push http://localhost:$HGPORT2/ -r e7ec4e813ba6
555 555 pushing to http://localhost:$HGPORT2/
556 556 searching for changes
557 557 abort: missing support for test:unknown
558 558 [255]
559 559
560 560 Doing the actual push: race
561 561
562 562 $ cat << EOF >> $HGRCPATH
563 563 > [failpush]
564 564 > reason = race
565 565 > EOF
566 566
567 567 $ hg -R main push other -r e7ec4e813ba6
568 568 pushing to other
569 569 searching for changes
570 570 abort: push failed:
571 571 'repository changed while pushing - please try again'
572 572 [255]
573 573
574 574 $ hg -R main push ssh://user@dummy/other -r e7ec4e813ba6
575 575 pushing to ssh://user@dummy/other
576 576 searching for changes
577 577 abort: push failed:
578 578 'repository changed while pushing - please try again'
579 579 [255]
580 580
581 581 $ hg -R main push http://localhost:$HGPORT2/ -r e7ec4e813ba6
582 582 pushing to http://localhost:$HGPORT2/
583 583 searching for changes
584 584 abort: push failed:
585 585 'repository changed while pushing - please try again'
586 586 [255]
587 587
588 588 Doing the actual push: hook abort
589 589
590 590 $ cat << EOF >> $HGRCPATH
591 591 > [failpush]
592 592 > reason =
593 593 > [hooks]
594 594 > pretxnclose.failpush = sh -c "echo 'You shall not pass!'; false"
595 595 > txnabort.failpush = sh -c "echo 'Cleaning up the mess...'"
596 596 > EOF
597 597
598 598 $ killdaemons.py
599 599 $ hg -R other serve -p $HGPORT2 -d --pid-file=other.pid -E other-error.log
600 600 $ cat other.pid >> $DAEMON_PIDS
601 601
602 602 $ hg -R main push other -r e7ec4e813ba6
603 603 pushing to other
604 604 searching for changes
605 605 remote: adding changesets
606 606 remote: adding manifests
607 607 remote: adding file changes
608 608 remote: added 1 changesets with 1 changes to 1 files
609 609 remote: pre-close-tip:e7ec4e813ba6 draft
610 610 remote: You shall not pass!
611 611 remote: transaction abort!
612 612 remote: Cleaning up the mess...
613 613 remote: rollback completed
614 614 abort: pretxnclose.failpush hook exited with status 1
615 615 [255]
616 616
617 617 $ hg -R main push ssh://user@dummy/other -r e7ec4e813ba6
618 618 pushing to ssh://user@dummy/other
619 619 searching for changes
620 620 remote: adding changesets
621 621 remote: adding manifests
622 622 remote: adding file changes
623 623 remote: added 1 changesets with 1 changes to 1 files
624 624 remote: pre-close-tip:e7ec4e813ba6 draft
625 625 remote: You shall not pass!
626 626 remote: transaction abort!
627 627 remote: Cleaning up the mess...
628 628 remote: rollback completed
629 629 remote: pretxnclose.failpush hook exited with status 1
630 630 abort: push failed on remote
631 631 [255]
632 632
633 633 $ hg -R main push http://localhost:$HGPORT2/ -r e7ec4e813ba6
634 634 pushing to http://localhost:$HGPORT2/
635 635 searching for changes
636 636 remote: adding changesets
637 637 remote: adding manifests
638 638 remote: adding file changes
639 639 remote: added 1 changesets with 1 changes to 1 files
640 640 remote: pre-close-tip:e7ec4e813ba6 draft
641 641 remote: You shall not pass!
642 642 remote: transaction abort!
643 643 remote: Cleaning up the mess...
644 644 remote: rollback completed
645 645 remote: pretxnclose.failpush hook exited with status 1
646 646 abort: push failed on remote
647 647 [255]
648 648
649 649 (check that no 'pending' files remain)
650 650
651 651 $ ls -1 other/.hg/bookmarks*
652 652 other/.hg/bookmarks
653 653 $ ls -1 other/.hg/store/phaseroots*
654 654 other/.hg/store/phaseroots
655 655 $ ls -1 other/.hg/store/00changelog.i*
656 656 other/.hg/store/00changelog.i
657 657
658 658 Check error from hook during the unbundling process itself
659 659
660 660 $ cat << EOF >> $HGRCPATH
661 661 > pretxnchangegroup = sh -c "echo 'Fail early!'; false"
662 662 > EOF
663 663 $ killdaemons.py # reload http config
664 664 $ hg -R other serve -p $HGPORT2 -d --pid-file=other.pid -E other-error.log
665 665 $ cat other.pid >> $DAEMON_PIDS
666 666
667 667 $ hg -R main push other -r e7ec4e813ba6
668 668 pushing to other
669 669 searching for changes
670 670 remote: adding changesets
671 671 remote: adding manifests
672 672 remote: adding file changes
673 673 remote: added 1 changesets with 1 changes to 1 files
674 674 remote: Fail early!
675 675 remote: transaction abort!
676 676 remote: Cleaning up the mess...
677 677 remote: rollback completed
678 678 abort: pretxnchangegroup hook exited with status 1
679 679 [255]
680 680 $ hg -R main push ssh://user@dummy/other -r e7ec4e813ba6
681 681 pushing to ssh://user@dummy/other
682 682 searching for changes
683 683 remote: adding changesets
684 684 remote: adding manifests
685 685 remote: adding file changes
686 686 remote: added 1 changesets with 1 changes to 1 files
687 687 remote: Fail early!
688 688 remote: transaction abort!
689 689 remote: Cleaning up the mess...
690 690 remote: rollback completed
691 691 remote: pretxnchangegroup hook exited with status 1
692 692 abort: push failed on remote
693 693 [255]
694 694 $ hg -R main push http://localhost:$HGPORT2/ -r e7ec4e813ba6
695 695 pushing to http://localhost:$HGPORT2/
696 696 searching for changes
697 697 remote: adding changesets
698 698 remote: adding manifests
699 699 remote: adding file changes
700 700 remote: added 1 changesets with 1 changes to 1 files
701 701 remote: Fail early!
702 702 remote: transaction abort!
703 703 remote: Cleaning up the mess...
704 704 remote: rollback completed
705 705 remote: pretxnchangegroup hook exited with status 1
706 706 abort: push failed on remote
707 707 [255]
708 708
709 709 Check output capture control.
710 710
711 711 (should be still forced for http, disabled for local and ssh)
712 712
713 713 $ cat >> $HGRCPATH << EOF
714 714 > [experimental]
715 715 > bundle2-output-capture=False
716 716 > EOF
717 717
718 718 $ hg -R main push other -r e7ec4e813ba6
719 719 pushing to other
720 720 searching for changes
721 721 adding changesets
722 722 adding manifests
723 723 adding file changes
724 724 added 1 changesets with 1 changes to 1 files
725 725 Fail early!
726 726 transaction abort!
727 727 Cleaning up the mess...
728 728 rollback completed
729 729 abort: pretxnchangegroup hook exited with status 1
730 730 [255]
731 731 $ hg -R main push ssh://user@dummy/other -r e7ec4e813ba6
732 732 pushing to ssh://user@dummy/other
733 733 searching for changes
734 734 remote: adding changesets
735 735 remote: adding manifests
736 736 remote: adding file changes
737 737 remote: added 1 changesets with 1 changes to 1 files
738 738 remote: Fail early!
739 739 remote: transaction abort!
740 740 remote: Cleaning up the mess...
741 741 remote: rollback completed
742 742 remote: pretxnchangegroup hook exited with status 1
743 743 abort: push failed on remote
744 744 [255]
745 745 $ hg -R main push http://localhost:$HGPORT2/ -r e7ec4e813ba6
746 746 pushing to http://localhost:$HGPORT2/
747 747 searching for changes
748 748 remote: adding changesets
749 749 remote: adding manifests
750 750 remote: adding file changes
751 751 remote: added 1 changesets with 1 changes to 1 files
752 752 remote: Fail early!
753 753 remote: transaction abort!
754 754 remote: Cleaning up the mess...
755 755 remote: rollback completed
756 756 remote: pretxnchangegroup hook exited with status 1
757 757 abort: push failed on remote
758 758 [255]
759 759
760 760 Check abort from mandatory pushkey
761 761
762 762 $ cat > mandatorypart.py << EOF
763 763 > from mercurial import exchange
764 764 > from mercurial import pushkey
765 765 > from mercurial import node
766 766 > from mercurial import error
767 767 > @exchange.b2partsgenerator('failingpuskey')
768 768 > def addfailingpushey(pushop, bundler):
769 769 > enc = pushkey.encode
770 770 > part = bundler.newpart('pushkey')
771 771 > part.addparam('namespace', enc('phases'))
772 772 > part.addparam('key', enc(pushop.repo['cd010b8cd998'].hex()))
773 773 > part.addparam('old', enc(str(0))) # successful update
774 774 > part.addparam('new', enc(str(0)))
775 775 > def fail(pushop, exc):
776 776 > raise error.Abort('Correct phase push failed (because hooks)')
777 777 > pushop.pkfailcb[part.id] = fail
778 778 > EOF
779 779 $ cat >> $HGRCPATH << EOF
780 780 > [hooks]
781 781 > pretxnchangegroup=
782 782 > pretxnclose.failpush=
783 783 > prepushkey.failpush = sh -c "echo 'do not push the key !'; false"
784 784 > [extensions]
785 785 > mandatorypart=$TESTTMP/mandatorypart.py
786 786 > EOF
787 787 $ "$TESTDIR/killdaemons.py" $DAEMON_PIDS # reload http config
788 788 $ hg -R other serve -p $HGPORT2 -d --pid-file=other.pid -E other-error.log
789 789 $ cat other.pid >> $DAEMON_PIDS
790 790
791 791 (Failure from a hook)
792 792
793 793 $ hg -R main push other -r e7ec4e813ba6
794 794 pushing to other
795 795 searching for changes
796 796 adding changesets
797 797 adding manifests
798 798 adding file changes
799 799 added 1 changesets with 1 changes to 1 files
800 800 do not push the key !
801 801 pushkey-abort: prepushkey.failpush hook exited with status 1
802 802 transaction abort!
803 803 Cleaning up the mess...
804 804 rollback completed
805 805 abort: Correct phase push failed (because hooks)
806 806 [255]
807 807 $ hg -R main push ssh://user@dummy/other -r e7ec4e813ba6
808 808 pushing to ssh://user@dummy/other
809 809 searching for changes
810 810 remote: adding changesets
811 811 remote: adding manifests
812 812 remote: adding file changes
813 813 remote: added 1 changesets with 1 changes to 1 files
814 814 remote: do not push the key !
815 815 remote: pushkey-abort: prepushkey.failpush hook exited with status 1
816 816 remote: transaction abort!
817 817 remote: Cleaning up the mess...
818 818 remote: rollback completed
819 819 abort: Correct phase push failed (because hooks)
820 820 [255]
821 821 $ hg -R main push http://localhost:$HGPORT2/ -r e7ec4e813ba6
822 822 pushing to http://localhost:$HGPORT2/
823 823 searching for changes
824 824 remote: adding changesets
825 825 remote: adding manifests
826 826 remote: adding file changes
827 827 remote: added 1 changesets with 1 changes to 1 files
828 828 remote: do not push the key !
829 829 remote: pushkey-abort: prepushkey.failpush hook exited with status 1
830 830 remote: transaction abort!
831 831 remote: Cleaning up the mess...
832 832 remote: rollback completed
833 833 abort: Correct phase push failed (because hooks)
834 834 [255]
835 835
836 836 (Failure from a the pushkey)
837 837
838 838 $ cat > mandatorypart.py << EOF
839 839 > from mercurial import exchange
840 840 > from mercurial import pushkey
841 841 > from mercurial import node
842 842 > from mercurial import error
843 843 > @exchange.b2partsgenerator('failingpuskey')
844 844 > def addfailingpushey(pushop, bundler):
845 845 > enc = pushkey.encode
846 846 > part = bundler.newpart('pushkey')
847 847 > part.addparam('namespace', enc('phases'))
848 848 > part.addparam('key', enc(pushop.repo['cd010b8cd998'].hex()))
849 849 > part.addparam('old', enc(str(4))) # will fail
850 850 > part.addparam('new', enc(str(3)))
851 851 > def fail(pushop, exc):
852 852 > raise error.Abort('Clown phase push failed')
853 853 > pushop.pkfailcb[part.id] = fail
854 854 > EOF
855 855 $ cat >> $HGRCPATH << EOF
856 856 > [hooks]
857 857 > prepushkey.failpush =
858 858 > EOF
859 859 $ "$TESTDIR/killdaemons.py" $DAEMON_PIDS # reload http config
860 860 $ hg -R other serve -p $HGPORT2 -d --pid-file=other.pid -E other-error.log
861 861 $ cat other.pid >> $DAEMON_PIDS
862 862
863 863 $ hg -R main push other -r e7ec4e813ba6
864 864 pushing to other
865 865 searching for changes
866 866 adding changesets
867 867 adding manifests
868 868 adding file changes
869 869 added 1 changesets with 1 changes to 1 files
870 870 transaction abort!
871 871 Cleaning up the mess...
872 872 rollback completed
873 873 pushkey: lock state after "phases"
874 874 lock: free
875 875 wlock: free
876 876 abort: Clown phase push failed
877 877 [255]
878 878 $ hg -R main push ssh://user@dummy/other -r e7ec4e813ba6
879 879 pushing to ssh://user@dummy/other
880 880 searching for changes
881 881 remote: adding changesets
882 882 remote: adding manifests
883 883 remote: adding file changes
884 884 remote: added 1 changesets with 1 changes to 1 files
885 885 remote: transaction abort!
886 886 remote: Cleaning up the mess...
887 887 remote: rollback completed
888 888 remote: pushkey: lock state after "phases"
889 889 remote: lock: free
890 890 remote: wlock: free
891 891 abort: Clown phase push failed
892 892 [255]
893 893 $ hg -R main push http://localhost:$HGPORT2/ -r e7ec4e813ba6
894 894 pushing to http://localhost:$HGPORT2/
895 895 searching for changes
896 896 remote: adding changesets
897 897 remote: adding manifests
898 898 remote: adding file changes
899 899 remote: added 1 changesets with 1 changes to 1 files
900 900 remote: transaction abort!
901 901 remote: Cleaning up the mess...
902 902 remote: rollback completed
903 903 remote: pushkey: lock state after "phases"
904 904 remote: lock: free
905 905 remote: wlock: free
906 906 abort: Clown phase push failed
907 907 [255]
908 908
909 909 Test lazily acquiring the lock during unbundle
910 910 $ cp $TESTTMP/hgrc.orig $HGRCPATH
911 911 $ cat >> $HGRCPATH <<EOF
912 912 > [ui]
913 913 > ssh=python "$TESTDIR/dummyssh"
914 914 > EOF
915 915
916 916 $ cat >> $TESTTMP/locktester.py <<EOF
917 917 > import os
918 918 > from mercurial import extensions, bundle2, util
919 919 > def checklock(orig, repo, *args, **kwargs):
920 920 > if repo.svfs.lexists("lock"):
921 921 > raise util.Abort("Lock should not be taken")
922 922 > return orig(repo, *args, **kwargs)
923 923 > def extsetup(ui):
924 924 > extensions.wrapfunction(bundle2, 'processbundle', checklock)
925 925 > EOF
926 926
927 927 $ hg init lazylock
928 928 $ cat >> lazylock/.hg/hgrc <<EOF
929 929 > [extensions]
930 930 > locktester=$TESTTMP/locktester.py
931 931 > EOF
932 932
933 933 $ hg clone -q ssh://user@dummy/lazylock lazylockclient
934 934 $ cd lazylockclient
935 935 $ touch a && hg ci -Aqm a
936 936 $ hg push
937 937 pushing to ssh://user@dummy/lazylock
938 938 searching for changes
939 939 remote: Lock should not be taken
940 940 abort: push failed on remote
941 941 [255]
942 942
943 943 $ cat >> ../lazylock/.hg/hgrc <<EOF
944 944 > [experimental]
945 945 > bundle2lazylocking=True
946 946 > EOF
947 947 $ hg push
948 948 pushing to ssh://user@dummy/lazylock
949 949 searching for changes
950 950 remote: adding changesets
951 951 remote: adding manifests
952 952 remote: adding file changes
953 953 remote: added 1 changesets with 1 changes to 1 files
954
955 $ cd ..
956
957 Servers can disable bundle1 for clone/pull operations
958
959 $ killdaemons.py
960 $ hg init bundle2onlyserver
961 $ cd bundle2onlyserver
962 $ cat > .hg/hgrc << EOF
963 > [server]
964 > bundle1.pull = false
965 > EOF
966
967 $ touch foo
968 $ hg -q commit -A -m initial
969
970 $ hg serve -p $HGPORT -d --pid-file=hg.pid
971 $ cat hg.pid >> $DAEMON_PIDS
972
973 $ hg --config experimental.bundle2-exp=false clone http://localhost:$HGPORT/ not-bundle2
974 requesting all changes
975 abort: remote error:
976 incompatible Mercurial client; bundle2 required
977 (see https://www.mercurial-scm.org/wiki/IncompatibleClient)
978 [255]
979 $ killdaemons.py
980
981 Verify the global server.bundle1 option works
982
983 $ cat > .hg/hgrc << EOF
984 > [server]
985 > bundle1 = false
986 > EOF
987 $ hg serve -p $HGPORT -d --pid-file=hg.pid
988 $ cat hg.pid >> $DAEMON_PIDS
989 $ hg --config experimental.bundle2-exp=false clone http://localhost:$HGPORT not-bundle2
990 requesting all changes
991 abort: remote error:
992 incompatible Mercurial client; bundle2 required
993 (see https://www.mercurial-scm.org/wiki/IncompatibleClient)
994 [255]
995 $ killdaemons.py
996
997 Verify bundle1 pushes can be disabled
998
999 $ cat > .hg/hgrc << EOF
1000 > [server]
1001 > bundle1.push = false
1002 > [web]
1003 > allow_push = *
1004 > push_ssl = false
1005 > EOF
1006
1007 $ hg serve -p $HGPORT -d --pid-file=hg.pid -E error.log
1008 $ cat hg.pid >> $DAEMON_PIDS
1009 $ cd ..
1010
1011 $ hg clone http://localhost:$HGPORT bundle2-only
1012 requesting all changes
1013 adding changesets
1014 adding manifests
1015 adding file changes
1016 added 1 changesets with 1 changes to 1 files
1017 updating to branch default
1018 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
1019 $ cd bundle2-only
1020 $ echo commit > foo
1021 $ hg commit -m commit
1022 $ hg --config experimental.bundle2-exp=false push
1023 pushing to http://localhost:$HGPORT/
1024 searching for changes
1025 abort: remote error:
1026 incompatible Mercurial client; bundle2 required
1027 (see https://www.mercurial-scm.org/wiki/IncompatibleClient)
1028 [255]
1029
1030 $ hg push
1031 pushing to http://localhost:$HGPORT/
1032 searching for changes
1033 remote: adding changesets
1034 remote: adding manifests
1035 remote: adding file changes
1036 remote: added 1 changesets with 1 changes to 1 files
General Comments 0
You need to be logged in to leave comments. Login now