##// END OF EJS Templates
ssl: drop support for Python < 2.6, require ssl module...
Yuya Nishihara -
r25430:19fa0cb7 default
parent child Browse files
Show More
@@ -1,1755 +1,1751
1 1 The Mercurial system uses a set of configuration files to control
2 2 aspects of its behavior.
3 3
4 4 The configuration files use a simple ini-file format. A configuration
5 5 file consists of sections, led by a ``[section]`` header and followed
6 6 by ``name = value`` entries::
7 7
8 8 [ui]
9 9 username = Firstname Lastname <firstname.lastname@example.net>
10 10 verbose = True
11 11
12 12 The above entries will be referred to as ``ui.username`` and
13 13 ``ui.verbose``, respectively. See the Syntax section below.
14 14
15 15 Files
16 16 =====
17 17
18 18 Mercurial reads configuration data from several files, if they exist.
19 19 These files do not exist by default and you will have to create the
20 20 appropriate configuration files yourself: global configuration like
21 21 the username setting is typically put into
22 22 ``%USERPROFILE%\mercurial.ini`` or ``$HOME/.hgrc`` and local
23 23 configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
24 24
25 25 The names of these files depend on the system on which Mercurial is
26 26 installed. ``*.rc`` files from a single directory are read in
27 27 alphabetical order, later ones overriding earlier ones. Where multiple
28 28 paths are given below, settings from earlier paths override later
29 29 ones.
30 30
31 31 .. container:: verbose.unix
32 32
33 33 On Unix, the following files are consulted:
34 34
35 35 - ``<repo>/.hg/hgrc`` (per-repository)
36 36 - ``$HOME/.hgrc`` (per-user)
37 37 - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
38 38 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
39 39 - ``/etc/mercurial/hgrc`` (per-system)
40 40 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
41 41 - ``<internal>/default.d/*.rc`` (defaults)
42 42
43 43 .. container:: verbose.windows
44 44
45 45 On Windows, the following files are consulted:
46 46
47 47 - ``<repo>/.hg/hgrc`` (per-repository)
48 48 - ``%USERPROFILE%\.hgrc`` (per-user)
49 49 - ``%USERPROFILE%\Mercurial.ini`` (per-user)
50 50 - ``%HOME%\.hgrc`` (per-user)
51 51 - ``%HOME%\Mercurial.ini`` (per-user)
52 52 - ``<install-dir>\Mercurial.ini`` (per-installation)
53 53 - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
54 54 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
55 55 - ``<internal>/default.d/*.rc`` (defaults)
56 56
57 57 .. note::
58 58
59 59 The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
60 60 is used when running 32-bit Python on 64-bit Windows.
61 61
62 62 .. container:: verbose.plan9
63 63
64 64 On Plan9, the following files are consulted:
65 65
66 66 - ``<repo>/.hg/hgrc`` (per-repository)
67 67 - ``$home/lib/hgrc`` (per-user)
68 68 - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
69 69 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
70 70 - ``/lib/mercurial/hgrc`` (per-system)
71 71 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
72 72 - ``<internal>/default.d/*.rc`` (defaults)
73 73
74 74 Per-repository configuration options only apply in a
75 75 particular repository. This file is not version-controlled, and
76 76 will not get transferred during a "clone" operation. Options in
77 77 this file override options in all other configuration files. On
78 78 Plan 9 and Unix, most of this file will be ignored if it doesn't
79 79 belong to a trusted user or to a trusted group. See the documentation
80 80 for the ``[trusted]`` section below for more details.
81 81
82 82 Per-user configuration file(s) are for the user running Mercurial. On
83 83 Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in these
84 84 files apply to all Mercurial commands executed by this user in any
85 85 directory. Options in these files override per-system and per-installation
86 86 options.
87 87
88 88 Per-installation configuration files are searched for in the
89 89 directory where Mercurial is installed. ``<install-root>`` is the
90 90 parent directory of the **hg** executable (or symlink) being run. For
91 91 example, if installed in ``/shared/tools/bin/hg``, Mercurial will look
92 92 in ``/shared/tools/etc/mercurial/hgrc``. Options in these files apply
93 93 to all Mercurial commands executed by any user in any directory.
94 94
95 95 Per-installation configuration files are for the system on
96 96 which Mercurial is running. Options in these files apply to all
97 97 Mercurial commands executed by any user in any directory. Registry
98 98 keys contain PATH-like strings, every part of which must reference
99 99 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
100 100 be read. Mercurial checks each of these locations in the specified
101 101 order until one or more configuration files are detected.
102 102
103 103 Per-system configuration files are for the system on which Mercurial
104 104 is running. Options in these files apply to all Mercurial commands
105 105 executed by any user in any directory. Options in these files
106 106 override per-installation options.
107 107
108 108 Mercurial comes with some default configuration. The default configuration
109 109 files are installed with Mercurial and will be overwritten on upgrades. Default
110 110 configuration files should never be edited by users or administrators but can
111 111 be overridden in other configuration files. So far the directory only contains
112 112 merge tool configuration but packagers can also put other default configuration
113 113 there.
114 114
115 115 Syntax
116 116 ======
117 117
118 118 A configuration file consists of sections, led by a ``[section]`` header
119 119 and followed by ``name = value`` entries (sometimes called
120 120 ``configuration keys``)::
121 121
122 122 [spam]
123 123 eggs=ham
124 124 green=
125 125 eggs
126 126
127 127 Each line contains one entry. If the lines that follow are indented,
128 128 they are treated as continuations of that entry. Leading whitespace is
129 129 removed from values. Empty lines are skipped. Lines beginning with
130 130 ``#`` or ``;`` are ignored and may be used to provide comments.
131 131
132 132 Configuration keys can be set multiple times, in which case Mercurial
133 133 will use the value that was configured last. As an example::
134 134
135 135 [spam]
136 136 eggs=large
137 137 ham=serrano
138 138 eggs=small
139 139
140 140 This would set the configuration key named ``eggs`` to ``small``.
141 141
142 142 It is also possible to define a section multiple times. A section can
143 143 be redefined on the same and/or on different configuration files. For
144 144 example::
145 145
146 146 [foo]
147 147 eggs=large
148 148 ham=serrano
149 149 eggs=small
150 150
151 151 [bar]
152 152 eggs=ham
153 153 green=
154 154 eggs
155 155
156 156 [foo]
157 157 ham=prosciutto
158 158 eggs=medium
159 159 bread=toasted
160 160
161 161 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
162 162 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
163 163 respectively. As you can see there only thing that matters is the last
164 164 value that was set for each of the configuration keys.
165 165
166 166 If a configuration key is set multiple times in different
167 167 configuration files the final value will depend on the order in which
168 168 the different configuration files are read, with settings from earlier
169 169 paths overriding later ones as described on the ``Files`` section
170 170 above.
171 171
172 172 A line of the form ``%include file`` will include ``file`` into the
173 173 current configuration file. The inclusion is recursive, which means
174 174 that included files can include other files. Filenames are relative to
175 175 the configuration file in which the ``%include`` directive is found.
176 176 Environment variables and ``~user`` constructs are expanded in
177 177 ``file``. This lets you do something like::
178 178
179 179 %include ~/.hgrc.d/$HOST.rc
180 180
181 181 to include a different configuration file on each computer you use.
182 182
183 183 A line with ``%unset name`` will remove ``name`` from the current
184 184 section, if it has been set previously.
185 185
186 186 The values are either free-form text strings, lists of text strings,
187 187 or Boolean values. Boolean values can be set to true using any of "1",
188 188 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
189 189 (all case insensitive).
190 190
191 191 List values are separated by whitespace or comma, except when values are
192 192 placed in double quotation marks::
193 193
194 194 allow_read = "John Doe, PhD", brian, betty
195 195
196 196 Quotation marks can be escaped by prefixing them with a backslash. Only
197 197 quotation marks at the beginning of a word is counted as a quotation
198 198 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
199 199
200 200 Sections
201 201 ========
202 202
203 203 This section describes the different sections that may appear in a
204 204 Mercurial configuration file, the purpose of each section, its possible
205 205 keys, and their possible values.
206 206
207 207 ``alias``
208 208 ---------
209 209
210 210 Defines command aliases.
211 211 Aliases allow you to define your own commands in terms of other
212 212 commands (or aliases), optionally including arguments. Positional
213 213 arguments in the form of ``$1``, ``$2``, etc in the alias definition
214 214 are expanded by Mercurial before execution. Positional arguments not
215 215 already used by ``$N`` in the definition are put at the end of the
216 216 command to be executed.
217 217
218 218 Alias definitions consist of lines of the form::
219 219
220 220 <alias> = <command> [<argument>]...
221 221
222 222 For example, this definition::
223 223
224 224 latest = log --limit 5
225 225
226 226 creates a new command ``latest`` that shows only the five most recent
227 227 changesets. You can define subsequent aliases using earlier ones::
228 228
229 229 stable5 = latest -b stable
230 230
231 231 .. note::
232 232
233 233 It is possible to create aliases with the same names as
234 234 existing commands, which will then override the original
235 235 definitions. This is almost always a bad idea!
236 236
237 237 An alias can start with an exclamation point (``!``) to make it a
238 238 shell alias. A shell alias is executed with the shell and will let you
239 239 run arbitrary commands. As an example, ::
240 240
241 241 echo = !echo $@
242 242
243 243 will let you do ``hg echo foo`` to have ``foo`` printed in your
244 244 terminal. A better example might be::
245 245
246 246 purge = !$HG status --no-status --unknown -0 | xargs -0 rm
247 247
248 248 which will make ``hg purge`` delete all unknown files in the
249 249 repository in the same manner as the purge extension.
250 250
251 251 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
252 252 expand to the command arguments. Unmatched arguments are
253 253 removed. ``$0`` expands to the alias name and ``$@`` expands to all
254 254 arguments separated by a space. ``"$@"`` (with quotes) expands to all
255 255 arguments quoted individually and separated by a space. These expansions
256 256 happen before the command is passed to the shell.
257 257
258 258 Shell aliases are executed in an environment where ``$HG`` expands to
259 259 the path of the Mercurial that was used to execute the alias. This is
260 260 useful when you want to call further Mercurial commands in a shell
261 261 alias, as was done above for the purge alias. In addition,
262 262 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
263 263 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
264 264
265 265 .. note::
266 266
267 267 Some global configuration options such as ``-R`` are
268 268 processed before shell aliases and will thus not be passed to
269 269 aliases.
270 270
271 271
272 272 ``annotate``
273 273 ------------
274 274
275 275 Settings used when displaying file annotations. All values are
276 276 Booleans and default to False. See ``diff`` section for related
277 277 options for the diff command.
278 278
279 279 ``ignorews``
280 280 Ignore white space when comparing lines.
281 281
282 282 ``ignorewsamount``
283 283 Ignore changes in the amount of white space.
284 284
285 285 ``ignoreblanklines``
286 286 Ignore changes whose lines are all blank.
287 287
288 288
289 289 ``auth``
290 290 --------
291 291
292 292 Authentication credentials for HTTP authentication. This section
293 293 allows you to store usernames and passwords for use when logging
294 294 *into* HTTP servers. See the ``[web]`` configuration section if
295 295 you want to configure *who* can login to your HTTP server.
296 296
297 297 Each line has the following format::
298 298
299 299 <name>.<argument> = <value>
300 300
301 301 where ``<name>`` is used to group arguments into authentication
302 302 entries. Example::
303 303
304 304 foo.prefix = hg.intevation.org/mercurial
305 305 foo.username = foo
306 306 foo.password = bar
307 307 foo.schemes = http https
308 308
309 309 bar.prefix = secure.example.org
310 310 bar.key = path/to/file.key
311 311 bar.cert = path/to/file.cert
312 312 bar.schemes = https
313 313
314 314 Supported arguments:
315 315
316 316 ``prefix``
317 317 Either ``*`` or a URI prefix with or without the scheme part.
318 318 The authentication entry with the longest matching prefix is used
319 319 (where ``*`` matches everything and counts as a match of length
320 320 1). If the prefix doesn't include a scheme, the match is performed
321 321 against the URI with its scheme stripped as well, and the schemes
322 322 argument, q.v., is then subsequently consulted.
323 323
324 324 ``username``
325 325 Optional. Username to authenticate with. If not given, and the
326 326 remote site requires basic or digest authentication, the user will
327 327 be prompted for it. Environment variables are expanded in the
328 328 username letting you do ``foo.username = $USER``. If the URI
329 329 includes a username, only ``[auth]`` entries with a matching
330 330 username or without a username will be considered.
331 331
332 332 ``password``
333 333 Optional. Password to authenticate with. If not given, and the
334 334 remote site requires basic or digest authentication, the user
335 335 will be prompted for it.
336 336
337 337 ``key``
338 338 Optional. PEM encoded client certificate key file. Environment
339 339 variables are expanded in the filename.
340 340
341 341 ``cert``
342 342 Optional. PEM encoded client certificate chain file. Environment
343 343 variables are expanded in the filename.
344 344
345 345 ``schemes``
346 346 Optional. Space separated list of URI schemes to use this
347 347 authentication entry with. Only used if the prefix doesn't include
348 348 a scheme. Supported schemes are http and https. They will match
349 349 static-http and static-https respectively, as well.
350 350 Default: https.
351 351
352 352 If no suitable authentication entry is found, the user is prompted
353 353 for credentials as usual if required by the remote.
354 354
355 355
356 356 ``committemplate``
357 357 ------------------
358 358
359 359 ``changeset`` configuration in this section is used as the template to
360 360 customize the text shown in the editor when committing.
361 361
362 362 In addition to pre-defined template keywords, commit log specific one
363 363 below can be used for customization:
364 364
365 365 ``extramsg``
366 366 String: Extra message (typically 'Leave message empty to abort
367 367 commit.'). This may be changed by some commands or extensions.
368 368
369 369 For example, the template configuration below shows as same text as
370 370 one shown by default::
371 371
372 372 [committemplate]
373 373 changeset = {desc}\n\n
374 374 HG: Enter commit message. Lines beginning with 'HG:' are removed.
375 375 HG: {extramsg}
376 376 HG: --
377 377 HG: user: {author}\n{ifeq(p2rev, "-1", "",
378 378 "HG: branch merge\n")
379 379 }HG: branch '{branch}'\n{if(activebookmark,
380 380 "HG: bookmark '{activebookmark}'\n") }{subrepos %
381 381 "HG: subrepo {subrepo}\n" }{file_adds %
382 382 "HG: added {file}\n" }{file_mods %
383 383 "HG: changed {file}\n" }{file_dels %
384 384 "HG: removed {file}\n" }{if(files, "",
385 385 "HG: no files changed\n")}
386 386
387 387 .. note::
388 388
389 389 For some problematic encodings (see :hg:`help win32mbcs` for
390 390 detail), this customization should be configured carefully, to
391 391 avoid showing broken characters.
392 392
393 393 For example, if multibyte character ending with backslash (0x5c) is
394 394 followed by ASCII character 'n' in the customized template,
395 395 sequence of backslash and 'n' is treated as line-feed unexpectedly
396 396 (and multibyte character is broken, too).
397 397
398 398 Customized template is used for commands below (``--edit`` may be
399 399 required):
400 400
401 401 - :hg:`backout`
402 402 - :hg:`commit`
403 403 - :hg:`fetch` (for merge commit only)
404 404 - :hg:`graft`
405 405 - :hg:`histedit`
406 406 - :hg:`import`
407 407 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
408 408 - :hg:`rebase`
409 409 - :hg:`shelve`
410 410 - :hg:`sign`
411 411 - :hg:`tag`
412 412 - :hg:`transplant`
413 413
414 414 Configuring items below instead of ``changeset`` allows showing
415 415 customized message only for specific actions, or showing different
416 416 messages for each action.
417 417
418 418 - ``changeset.backout`` for :hg:`backout`
419 419 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
420 420 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
421 421 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
422 422 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
423 423 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
424 424 - ``changeset.gpg.sign`` for :hg:`sign`
425 425 - ``changeset.graft`` for :hg:`graft`
426 426 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
427 427 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
428 428 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
429 429 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
430 430 - ``changeset.import.bypass`` for :hg:`import --bypass`
431 431 - ``changeset.import.normal.merge`` for :hg:`import` on merges
432 432 - ``changeset.import.normal.normal`` for :hg:`import` on other
433 433 - ``changeset.mq.qnew`` for :hg:`qnew`
434 434 - ``changeset.mq.qfold`` for :hg:`qfold`
435 435 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
436 436 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
437 437 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
438 438 - ``changeset.rebase.normal`` for :hg:`rebase` on other
439 439 - ``changeset.shelve.shelve`` for :hg:`shelve`
440 440 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
441 441 - ``changeset.tag.remove`` for :hg:`tag --remove`
442 442 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
443 443 - ``changeset.transplant.normal`` for :hg:`transplant` on other
444 444
445 445 These dot-separated lists of names are treated as hierarchical ones.
446 446 For example, ``changeset.tag.remove`` customizes the commit message
447 447 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
448 448 commit message for :hg:`tag` regardless of ``--remove`` option.
449 449
450 450 At the external editor invocation for committing, corresponding
451 451 dot-separated list of names without ``changeset.`` prefix
452 452 (e.g. ``commit.normal.normal``) is in ``HGEDITFORM`` environment variable.
453 453
454 454 In this section, items other than ``changeset`` can be referred from
455 455 others. For example, the configuration to list committed files up
456 456 below can be referred as ``{listupfiles}``::
457 457
458 458 [committemplate]
459 459 listupfiles = {file_adds %
460 460 "HG: added {file}\n" }{file_mods %
461 461 "HG: changed {file}\n" }{file_dels %
462 462 "HG: removed {file}\n" }{if(files, "",
463 463 "HG: no files changed\n")}
464 464
465 465 ``decode/encode``
466 466 -----------------
467 467
468 468 Filters for transforming files on checkout/checkin. This would
469 469 typically be used for newline processing or other
470 470 localization/canonicalization of files.
471 471
472 472 Filters consist of a filter pattern followed by a filter command.
473 473 Filter patterns are globs by default, rooted at the repository root.
474 474 For example, to match any file ending in ``.txt`` in the root
475 475 directory only, use the pattern ``*.txt``. To match any file ending
476 476 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
477 477 For each file only the first matching filter applies.
478 478
479 479 The filter command can start with a specifier, either ``pipe:`` or
480 480 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
481 481
482 482 A ``pipe:`` command must accept data on stdin and return the transformed
483 483 data on stdout.
484 484
485 485 Pipe example::
486 486
487 487 [encode]
488 488 # uncompress gzip files on checkin to improve delta compression
489 489 # note: not necessarily a good idea, just an example
490 490 *.gz = pipe: gunzip
491 491
492 492 [decode]
493 493 # recompress gzip files when writing them to the working dir (we
494 494 # can safely omit "pipe:", because it's the default)
495 495 *.gz = gzip
496 496
497 497 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
498 498 with the name of a temporary file that contains the data to be
499 499 filtered by the command. The string ``OUTFILE`` is replaced with the name
500 500 of an empty temporary file, where the filtered data must be written by
501 501 the command.
502 502
503 503 .. note::
504 504
505 505 The tempfile mechanism is recommended for Windows systems,
506 506 where the standard shell I/O redirection operators often have
507 507 strange effects and may corrupt the contents of your files.
508 508
509 509 This filter mechanism is used internally by the ``eol`` extension to
510 510 translate line ending characters between Windows (CRLF) and Unix (LF)
511 511 format. We suggest you use the ``eol`` extension for convenience.
512 512
513 513
514 514 ``defaults``
515 515 ------------
516 516
517 517 (defaults are deprecated. Don't use them. Use aliases instead)
518 518
519 519 Use the ``[defaults]`` section to define command defaults, i.e. the
520 520 default options/arguments to pass to the specified commands.
521 521
522 522 The following example makes :hg:`log` run in verbose mode, and
523 523 :hg:`status` show only the modified files, by default::
524 524
525 525 [defaults]
526 526 log = -v
527 527 status = -m
528 528
529 529 The actual commands, instead of their aliases, must be used when
530 530 defining command defaults. The command defaults will also be applied
531 531 to the aliases of the commands defined.
532 532
533 533
534 534 ``diff``
535 535 --------
536 536
537 537 Settings used when displaying diffs. Everything except for ``unified``
538 538 is a Boolean and defaults to False. See ``annotate`` section for
539 539 related options for the annotate command.
540 540
541 541 ``git``
542 542 Use git extended diff format.
543 543
544 544 ``nobinary``
545 545 Omit git binary patches.
546 546
547 547 ``nodates``
548 548 Don't include dates in diff headers.
549 549
550 550 ``noprefix``
551 551 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
552 552
553 553 ``showfunc``
554 554 Show which function each change is in.
555 555
556 556 ``ignorews``
557 557 Ignore white space when comparing lines.
558 558
559 559 ``ignorewsamount``
560 560 Ignore changes in the amount of white space.
561 561
562 562 ``ignoreblanklines``
563 563 Ignore changes whose lines are all blank.
564 564
565 565 ``unified``
566 566 Number of lines of context to show.
567 567
568 568 ``email``
569 569 ---------
570 570
571 571 Settings for extensions that send email messages.
572 572
573 573 ``from``
574 574 Optional. Email address to use in "From" header and SMTP envelope
575 575 of outgoing messages.
576 576
577 577 ``to``
578 578 Optional. Comma-separated list of recipients' email addresses.
579 579
580 580 ``cc``
581 581 Optional. Comma-separated list of carbon copy recipients'
582 582 email addresses.
583 583
584 584 ``bcc``
585 585 Optional. Comma-separated list of blind carbon copy recipients'
586 586 email addresses.
587 587
588 588 ``method``
589 589 Optional. Method to use to send email messages. If value is ``smtp``
590 590 (default), use SMTP (see the ``[smtp]`` section for configuration).
591 591 Otherwise, use as name of program to run that acts like sendmail
592 592 (takes ``-f`` option for sender, list of recipients on command line,
593 593 message on stdin). Normally, setting this to ``sendmail`` or
594 594 ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
595 595
596 596 ``charsets``
597 597 Optional. Comma-separated list of character sets considered
598 598 convenient for recipients. Addresses, headers, and parts not
599 599 containing patches of outgoing messages will be encoded in the
600 600 first character set to which conversion from local encoding
601 601 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
602 602 conversion fails, the text in question is sent as is. Defaults to
603 603 empty (explicit) list.
604 604
605 605 Order of outgoing email character sets:
606 606
607 607 1. ``us-ascii``: always first, regardless of settings
608 608 2. ``email.charsets``: in order given by user
609 609 3. ``ui.fallbackencoding``: if not in email.charsets
610 610 4. ``$HGENCODING``: if not in email.charsets
611 611 5. ``utf-8``: always last, regardless of settings
612 612
613 613 Email example::
614 614
615 615 [email]
616 616 from = Joseph User <joe.user@example.com>
617 617 method = /usr/sbin/sendmail
618 618 # charsets for western Europeans
619 619 # us-ascii, utf-8 omitted, as they are tried first and last
620 620 charsets = iso-8859-1, iso-8859-15, windows-1252
621 621
622 622
623 623 ``extensions``
624 624 --------------
625 625
626 626 Mercurial has an extension mechanism for adding new features. To
627 627 enable an extension, create an entry for it in this section.
628 628
629 629 If you know that the extension is already in Python's search path,
630 630 you can give the name of the module, followed by ``=``, with nothing
631 631 after the ``=``.
632 632
633 633 Otherwise, give a name that you choose, followed by ``=``, followed by
634 634 the path to the ``.py`` file (including the file name extension) that
635 635 defines the extension.
636 636
637 637 To explicitly disable an extension that is enabled in an hgrc of
638 638 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
639 639 or ``foo = !`` when path is not supplied.
640 640
641 641 Example for ``~/.hgrc``::
642 642
643 643 [extensions]
644 644 # (the progress extension will get loaded from Mercurial's path)
645 645 progress =
646 646 # (this extension will get loaded from the file specified)
647 647 myfeature = ~/.hgext/myfeature.py
648 648
649 649
650 650 ``format``
651 651 ----------
652 652
653 653 ``usestore``
654 654 Enable or disable the "store" repository format which improves
655 655 compatibility with systems that fold case or otherwise mangle
656 656 filenames. Enabled by default. Disabling this option will allow
657 657 you to store longer filenames in some situations at the expense of
658 658 compatibility and ensures that the on-disk format of newly created
659 659 repositories will be compatible with Mercurial before version 0.9.4.
660 660
661 661 ``usefncache``
662 662 Enable or disable the "fncache" repository format which enhances
663 663 the "store" repository format (which has to be enabled to use
664 664 fncache) to allow longer filenames and avoids using Windows
665 665 reserved names, e.g. "nul". Enabled by default. Disabling this
666 666 option ensures that the on-disk format of newly created
667 667 repositories will be compatible with Mercurial before version 1.1.
668 668
669 669 ``dotencode``
670 670 Enable or disable the "dotencode" repository format which enhances
671 671 the "fncache" repository format (which has to be enabled to use
672 672 dotencode) to avoid issues with filenames starting with ._ on
673 673 Mac OS X and spaces on Windows. Enabled by default. Disabling this
674 674 option ensures that the on-disk format of newly created
675 675 repositories will be compatible with Mercurial before version 1.7.
676 676
677 677 ``graph``
678 678 ---------
679 679
680 680 Web graph view configuration. This section let you change graph
681 681 elements display properties by branches, for instance to make the
682 682 ``default`` branch stand out.
683 683
684 684 Each line has the following format::
685 685
686 686 <branch>.<argument> = <value>
687 687
688 688 where ``<branch>`` is the name of the branch being
689 689 customized. Example::
690 690
691 691 [graph]
692 692 # 2px width
693 693 default.width = 2
694 694 # red color
695 695 default.color = FF0000
696 696
697 697 Supported arguments:
698 698
699 699 ``width``
700 700 Set branch edges width in pixels.
701 701
702 702 ``color``
703 703 Set branch edges color in hexadecimal RGB notation.
704 704
705 705 ``hooks``
706 706 ---------
707 707
708 708 Commands or Python functions that get automatically executed by
709 709 various actions such as starting or finishing a commit. Multiple
710 710 hooks can be run for the same action by appending a suffix to the
711 711 action. Overriding a site-wide hook can be done by changing its
712 712 value or setting it to an empty string. Hooks can be prioritized
713 713 by adding a prefix of ``priority`` to the hook name on a new line
714 714 and setting the priority. The default priority is 0 if
715 715 not specified.
716 716
717 717 Example ``.hg/hgrc``::
718 718
719 719 [hooks]
720 720 # update working directory after adding changesets
721 721 changegroup.update = hg update
722 722 # do not use the site-wide hook
723 723 incoming =
724 724 incoming.email = /my/email/hook
725 725 incoming.autobuild = /my/build/hook
726 726 # force autobuild hook to run before other incoming hooks
727 727 priority.incoming.autobuild = 1
728 728
729 729 Most hooks are run with environment variables set that give useful
730 730 additional information. For each hook below, the environment
731 731 variables it is passed are listed with names of the form ``$HG_foo``.
732 732
733 733 ``changegroup``
734 734 Run after a changegroup has been added via push, pull or unbundle.
735 735 ID of the first new changeset is in ``$HG_NODE``. URL from which
736 736 changes came is in ``$HG_URL``.
737 737
738 738 ``commit``
739 739 Run after a changeset has been created in the local repository. ID
740 740 of the newly created changeset is in ``$HG_NODE``. Parent changeset
741 741 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
742 742
743 743 ``incoming``
744 744 Run after a changeset has been pulled, pushed, or unbundled into
745 745 the local repository. The ID of the newly arrived changeset is in
746 746 ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
747 747
748 748 ``outgoing``
749 749 Run after sending changes from local repository to another. ID of
750 750 first changeset sent is in ``$HG_NODE``. Source of operation is in
751 751 ``$HG_SOURCE``; see "preoutgoing" hook for description.
752 752
753 753 ``post-<command>``
754 754 Run after successful invocations of the associated command. The
755 755 contents of the command line are passed as ``$HG_ARGS`` and the result
756 756 code in ``$HG_RESULT``. Parsed command line arguments are passed as
757 757 ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
758 758 the python data internally passed to <command>. ``$HG_OPTS`` is a
759 759 dictionary of options (with unspecified options set to their defaults).
760 760 ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
761 761
762 762 ``pre-<command>``
763 763 Run before executing the associated command. The contents of the
764 764 command line are passed as ``$HG_ARGS``. Parsed command line arguments
765 765 are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
766 766 representations of the data internally passed to <command>. ``$HG_OPTS``
767 767 is a dictionary of options (with unspecified options set to their
768 768 defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
769 769 failure, the command doesn't execute and Mercurial returns the failure
770 770 code.
771 771
772 772 ``prechangegroup``
773 773 Run before a changegroup is added via push, pull or unbundle. Exit
774 774 status 0 allows the changegroup to proceed. Non-zero status will
775 775 cause the push, pull or unbundle to fail. URL from which changes
776 776 will come is in ``$HG_URL``.
777 777
778 778 ``precommit``
779 779 Run before starting a local commit. Exit status 0 allows the
780 780 commit to proceed. Non-zero status will cause the commit to fail.
781 781 Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
782 782
783 783 ``prelistkeys``
784 784 Run before listing pushkeys (like bookmarks) in the
785 785 repository. Non-zero status will cause failure. The key namespace is
786 786 in ``$HG_NAMESPACE``.
787 787
788 788 ``preoutgoing``
789 789 Run before collecting changes to send from the local repository to
790 790 another. Non-zero status will cause failure. This lets you prevent
791 791 pull over HTTP or SSH. Also prevents against local pull, push
792 792 (outbound) or bundle commands, but not effective, since you can
793 793 just copy files instead then. Source of operation is in
794 794 ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
795 795 SSH or HTTP repository. If "push", "pull" or "bundle", operation
796 796 is happening on behalf of repository on same system.
797 797
798 798 ``prepushkey``
799 799 Run before a pushkey (like a bookmark) is added to the
800 800 repository. Non-zero status will cause the key to be rejected. The
801 801 key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
802 802 the old value (if any) is in ``$HG_OLD``, and the new value is in
803 803 ``$HG_NEW``.
804 804
805 805 ``pretag``
806 806 Run before creating a tag. Exit status 0 allows the tag to be
807 807 created. Non-zero status will cause the tag to fail. ID of
808 808 changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
809 809 local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
810 810
811 811 ``pretxnopen``
812 812 Run before any new repository transaction is open. The reason for the
813 813 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
814 814 transaction will be in ``HG_TXNID``. A non-zero status will prevent the
815 815 transaction from being opened.
816 816
817 817 ``pretxnclose``
818 818 Run right before the transaction is actually finalized. Any
819 819 repository change will be visible to the hook program. This lets you
820 820 validate the transaction content or change it. Exit status 0 allows
821 821 the commit to proceed. Non-zero status will cause the transaction to
822 822 be rolled back. The reason for the transaction opening will be in
823 823 ``$HG_TXNNAME`` and a unique identifier for the transaction will be in
824 824 ``HG_TXNID``. The rest of the available data will vary according the
825 825 transaction type. New changesets will add ``$HG_NODE`` (id of the
826 826 first added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables,
827 827 bookmarks and phases changes will set ``HG_BOOKMARK_MOVED`` and
828 828 ``HG_PHASES_MOVED`` to ``1``, etc.
829 829
830 830 ``txnclose``
831 831 Run after any repository transaction has been committed. At this
832 832 point, the transaction can no longer be rolled back. The hook will run
833 833 after the lock is released. See ``pretxnclose`` docs for details about
834 834 available variables.
835 835
836 836 ``txnabort``
837 837 Run when a transaction is aborted. See ``pretxnclose`` docs for details about
838 838 available variables.
839 839
840 840 ``pretxnchangegroup``
841 841 Run after a changegroup has been added via push, pull or unbundle,
842 842 but before the transaction has been committed. Changegroup is
843 843 visible to hook program. This lets you validate incoming changes
844 844 before accepting them. Passed the ID of the first new changeset in
845 845 ``$HG_NODE``. Exit status 0 allows the transaction to commit. Non-zero
846 846 status will cause the transaction to be rolled back and the push,
847 847 pull or unbundle will fail. URL that was source of changes is in
848 848 ``$HG_URL``.
849 849
850 850 ``pretxncommit``
851 851 Run after a changeset has been created but the transaction not yet
852 852 committed. Changeset is visible to hook program. This lets you
853 853 validate commit message and changes. Exit status 0 allows the
854 854 commit to proceed. Non-zero status will cause the transaction to
855 855 be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
856 856 IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
857 857
858 858 ``preupdate``
859 859 Run before updating the working directory. Exit status 0 allows
860 860 the update to proceed. Non-zero status will prevent the update.
861 861 Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
862 862 of second new parent is in ``$HG_PARENT2``.
863 863
864 864 ``listkeys``
865 865 Run after listing pushkeys (like bookmarks) in the repository. The
866 866 key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
867 867 dictionary containing the keys and values.
868 868
869 869 ``pushkey``
870 870 Run after a pushkey (like a bookmark) is added to the
871 871 repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
872 872 ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
873 873 value is in ``$HG_NEW``.
874 874
875 875 ``tag``
876 876 Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
877 877 Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
878 878 repository if ``$HG_LOCAL=0``.
879 879
880 880 ``update``
881 881 Run after updating the working directory. Changeset ID of first
882 882 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
883 883 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
884 884 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
885 885
886 886 .. note::
887 887
888 888 It is generally better to use standard hooks rather than the
889 889 generic pre- and post- command hooks as they are guaranteed to be
890 890 called in the appropriate contexts for influencing transactions.
891 891 Also, hooks like "commit" will be called in all contexts that
892 892 generate a commit (e.g. tag) and not just the commit command.
893 893
894 894 .. note::
895 895
896 896 Environment variables with empty values may not be passed to
897 897 hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
898 898 will have an empty value under Unix-like platforms for non-merge
899 899 changesets, while it will not be available at all under Windows.
900 900
901 901 The syntax for Python hooks is as follows::
902 902
903 903 hookname = python:modulename.submodule.callable
904 904 hookname = python:/path/to/python/module.py:callable
905 905
906 906 Python hooks are run within the Mercurial process. Each hook is
907 907 called with at least three keyword arguments: a ui object (keyword
908 908 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
909 909 keyword that tells what kind of hook is used. Arguments listed as
910 910 environment variables above are passed as keyword arguments, with no
911 911 ``HG_`` prefix, and names in lower case.
912 912
913 913 If a Python hook returns a "true" value or raises an exception, this
914 914 is treated as a failure.
915 915
916 916
917 917 ``hostfingerprints``
918 918 --------------------
919 919
920 920 Fingerprints of the certificates of known HTTPS servers.
921 921 A HTTPS connection to a server with a fingerprint configured here will
922 922 only succeed if the servers certificate matches the fingerprint.
923 923 This is very similar to how ssh known hosts works.
924 924 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
925 925 The CA chain and web.cacerts is not used for servers with a fingerprint.
926 926
927 927 For example::
928 928
929 929 [hostfingerprints]
930 930 hg.intevation.org = fa:1f:d9:48:f1:e7:74:30:38:8d:d8:58:b6:94:b8:58:28:7d:8b:d0
931 931
932 932 This feature is only supported when using Python 2.6 or later.
933 933
934 934
935 935 ``http_proxy``
936 936 --------------
937 937
938 938 Used to access web-based Mercurial repositories through a HTTP
939 939 proxy.
940 940
941 941 ``host``
942 942 Host name and (optional) port of the proxy server, for example
943 943 "myproxy:8000".
944 944
945 945 ``no``
946 946 Optional. Comma-separated list of host names that should bypass
947 947 the proxy.
948 948
949 949 ``passwd``
950 950 Optional. Password to authenticate with at the proxy server.
951 951
952 952 ``user``
953 953 Optional. User name to authenticate with at the proxy server.
954 954
955 955 ``always``
956 956 Optional. Always use the proxy, even for localhost and any entries
957 957 in ``http_proxy.no``. True or False. Default: False.
958 958
959 959 ``merge-patterns``
960 960 ------------------
961 961
962 962 This section specifies merge tools to associate with particular file
963 963 patterns. Tools matched here will take precedence over the default
964 964 merge tool. Patterns are globs by default, rooted at the repository
965 965 root.
966 966
967 967 Example::
968 968
969 969 [merge-patterns]
970 970 **.c = kdiff3
971 971 **.jpg = myimgmerge
972 972
973 973 ``merge-tools``
974 974 ---------------
975 975
976 976 This section configures external merge tools to use for file-level
977 977 merges. This section has likely been preconfigured at install time.
978 978 Use :hg:`config merge-tools` to check the existing configuration.
979 979 Also see :hg:`help merge-tools` for more details.
980 980
981 981 Example ``~/.hgrc``::
982 982
983 983 [merge-tools]
984 984 # Override stock tool location
985 985 kdiff3.executable = ~/bin/kdiff3
986 986 # Specify command line
987 987 kdiff3.args = $base $local $other -o $output
988 988 # Give higher priority
989 989 kdiff3.priority = 1
990 990
991 991 # Changing the priority of preconfigured tool
992 992 vimdiff.priority = 0
993 993
994 994 # Define new tool
995 995 myHtmlTool.args = -m $local $other $base $output
996 996 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
997 997 myHtmlTool.priority = 1
998 998
999 999 Supported arguments:
1000 1000
1001 1001 ``priority``
1002 1002 The priority in which to evaluate this tool.
1003 1003 Default: 0.
1004 1004
1005 1005 ``executable``
1006 1006 Either just the name of the executable or its pathname. On Windows,
1007 1007 the path can use environment variables with ${ProgramFiles} syntax.
1008 1008 Default: the tool name.
1009 1009
1010 1010 ``args``
1011 1011 The arguments to pass to the tool executable. You can refer to the
1012 1012 files being merged as well as the output file through these
1013 1013 variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
1014 1014 of ``$local`` and ``$other`` can vary depending on which action is being
1015 1015 performed. During and update or merge, ``$local`` represents the original
1016 1016 state of the file, while ``$other`` represents the commit you are updating
1017 1017 to or the commit you are merging with. During a rebase ``$local``
1018 1018 represents the destination of the rebase, and ``$other`` represents the
1019 1019 commit being rebased.
1020 1020 Default: ``$local $base $other``
1021 1021
1022 1022 ``premerge``
1023 1023 Attempt to run internal non-interactive 3-way merge tool before
1024 1024 launching external tool. Options are ``true``, ``false``, ``keep`` or
1025 1025 ``keep-merge3``. The ``keep`` option will leave markers in the file if the
1026 1026 premerge fails. The ``keep-merge3`` will do the same but include information
1027 1027 about the base of the merge in the marker (see internal :merge3 in
1028 1028 :hg:`help merge-tools`).
1029 1029 Default: True
1030 1030
1031 1031 ``binary``
1032 1032 This tool can merge binary files. Defaults to False, unless tool
1033 1033 was selected by file pattern match.
1034 1034
1035 1035 ``symlink``
1036 1036 This tool can merge symlinks. Defaults to False, even if tool was
1037 1037 selected by file pattern match.
1038 1038
1039 1039 ``check``
1040 1040 A list of merge success-checking options:
1041 1041
1042 1042 ``changed``
1043 1043 Ask whether merge was successful when the merged file shows no changes.
1044 1044 ``conflicts``
1045 1045 Check whether there are conflicts even though the tool reported success.
1046 1046 ``prompt``
1047 1047 Always prompt for merge success, regardless of success reported by tool.
1048 1048
1049 1049 ``fixeol``
1050 1050 Attempt to fix up EOL changes caused by the merge tool.
1051 1051 Default: False
1052 1052
1053 1053 ``gui``
1054 1054 This tool requires a graphical interface to run. Default: False
1055 1055
1056 1056 ``regkey``
1057 1057 Windows registry key which describes install location of this
1058 1058 tool. Mercurial will search for this key first under
1059 1059 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
1060 1060 Default: None
1061 1061
1062 1062 ``regkeyalt``
1063 1063 An alternate Windows registry key to try if the first key is not
1064 1064 found. The alternate key uses the same ``regname`` and ``regappend``
1065 1065 semantics of the primary key. The most common use for this key
1066 1066 is to search for 32bit applications on 64bit operating systems.
1067 1067 Default: None
1068 1068
1069 1069 ``regname``
1070 1070 Name of value to read from specified registry key. Defaults to the
1071 1071 unnamed (default) value.
1072 1072
1073 1073 ``regappend``
1074 1074 String to append to the value read from the registry, typically
1075 1075 the executable name of the tool.
1076 1076 Default: None
1077 1077
1078 1078
1079 1079 ``patch``
1080 1080 ---------
1081 1081
1082 1082 Settings used when applying patches, for instance through the 'import'
1083 1083 command or with Mercurial Queues extension.
1084 1084
1085 1085 ``eol``
1086 1086 When set to 'strict' patch content and patched files end of lines
1087 1087 are preserved. When set to ``lf`` or ``crlf``, both files end of
1088 1088 lines are ignored when patching and the result line endings are
1089 1089 normalized to either LF (Unix) or CRLF (Windows). When set to
1090 1090 ``auto``, end of lines are again ignored while patching but line
1091 1091 endings in patched files are normalized to their original setting
1092 1092 on a per-file basis. If target file does not exist or has no end
1093 1093 of line, patch line endings are preserved.
1094 1094 Default: strict.
1095 1095
1096 1096
1097 1097 ``paths``
1098 1098 ---------
1099 1099
1100 1100 Assigns symbolic names to repositories. The left side is the
1101 1101 symbolic name, and the right gives the directory or URL that is the
1102 1102 location of the repository. Default paths can be declared by setting
1103 1103 the following entries.
1104 1104
1105 1105 ``default``
1106 1106 Directory or URL to use when pulling if no source is specified.
1107 1107 Default is set to repository from which the current repository was
1108 1108 cloned.
1109 1109
1110 1110 ``default-push``
1111 1111 Optional. Directory or URL to use when pushing if no destination
1112 1112 is specified.
1113 1113
1114 1114 Custom paths can be defined by assigning the path to a name that later can be
1115 1115 used from the command line. Example::
1116 1116
1117 1117 [paths]
1118 1118 my_path = http://example.com/path
1119 1119
1120 1120 To push to the path defined in ``my_path`` run the command::
1121 1121
1122 1122 hg push my_path
1123 1123
1124 1124
1125 1125 ``phases``
1126 1126 ----------
1127 1127
1128 1128 Specifies default handling of phases. See :hg:`help phases` for more
1129 1129 information about working with phases.
1130 1130
1131 1131 ``publish``
1132 1132 Controls draft phase behavior when working as a server. When true,
1133 1133 pushed changesets are set to public in both client and server and
1134 1134 pulled or cloned changesets are set to public in the client.
1135 1135 Default: True
1136 1136
1137 1137 ``new-commit``
1138 1138 Phase of newly-created commits.
1139 1139 Default: draft
1140 1140
1141 1141 ``checksubrepos``
1142 1142 Check the phase of the current revision of each subrepository. Allowed
1143 1143 values are "ignore", "follow" and "abort". For settings other than
1144 1144 "ignore", the phase of the current revision of each subrepository is
1145 1145 checked before committing the parent repository. If any of those phases is
1146 1146 greater than the phase of the parent repository (e.g. if a subrepo is in a
1147 1147 "secret" phase while the parent repo is in "draft" phase), the commit is
1148 1148 either aborted (if checksubrepos is set to "abort") or the higher phase is
1149 1149 used for the parent repository commit (if set to "follow").
1150 1150 Default: "follow"
1151 1151
1152 1152
1153 1153 ``profiling``
1154 1154 -------------
1155 1155
1156 1156 Specifies profiling type, format, and file output. Two profilers are
1157 1157 supported: an instrumenting profiler (named ``ls``), and a sampling
1158 1158 profiler (named ``stat``).
1159 1159
1160 1160 In this section description, 'profiling data' stands for the raw data
1161 1161 collected during profiling, while 'profiling report' stands for a
1162 1162 statistical text report generated from the profiling data. The
1163 1163 profiling is done using lsprof.
1164 1164
1165 1165 ``type``
1166 1166 The type of profiler to use.
1167 1167 Default: ls.
1168 1168
1169 1169 ``ls``
1170 1170 Use Python's built-in instrumenting profiler. This profiler
1171 1171 works on all platforms, but each line number it reports is the
1172 1172 first line of a function. This restriction makes it difficult to
1173 1173 identify the expensive parts of a non-trivial function.
1174 1174 ``stat``
1175 1175 Use a third-party statistical profiler, statprof. This profiler
1176 1176 currently runs only on Unix systems, and is most useful for
1177 1177 profiling commands that run for longer than about 0.1 seconds.
1178 1178
1179 1179 ``format``
1180 1180 Profiling format. Specific to the ``ls`` instrumenting profiler.
1181 1181 Default: text.
1182 1182
1183 1183 ``text``
1184 1184 Generate a profiling report. When saving to a file, it should be
1185 1185 noted that only the report is saved, and the profiling data is
1186 1186 not kept.
1187 1187 ``kcachegrind``
1188 1188 Format profiling data for kcachegrind use: when saving to a
1189 1189 file, the generated file can directly be loaded into
1190 1190 kcachegrind.
1191 1191
1192 1192 ``frequency``
1193 1193 Sampling frequency. Specific to the ``stat`` sampling profiler.
1194 1194 Default: 1000.
1195 1195
1196 1196 ``output``
1197 1197 File path where profiling data or report should be saved. If the
1198 1198 file exists, it is replaced. Default: None, data is printed on
1199 1199 stderr
1200 1200
1201 1201 ``sort``
1202 1202 Sort field. Specific to the ``ls`` instrumenting profiler.
1203 1203 One of ``callcount``, ``reccallcount``, ``totaltime`` and
1204 1204 ``inlinetime``.
1205 1205 Default: inlinetime.
1206 1206
1207 1207 ``limit``
1208 1208 Number of lines to show. Specific to the ``ls`` instrumenting profiler.
1209 1209 Default: 30.
1210 1210
1211 1211 ``nested``
1212 1212 Show at most this number of lines of drill-down info after each main entry.
1213 1213 This can help explain the difference between Total and Inline.
1214 1214 Specific to the ``ls`` instrumenting profiler.
1215 1215 Default: 5.
1216 1216
1217 1217 ``revsetalias``
1218 1218 ---------------
1219 1219
1220 1220 Alias definitions for revsets. See :hg:`help revsets` for details.
1221 1221
1222 1222 ``server``
1223 1223 ----------
1224 1224
1225 1225 Controls generic server settings.
1226 1226
1227 1227 ``uncompressed``
1228 1228 Whether to allow clients to clone a repository using the
1229 1229 uncompressed streaming protocol. This transfers about 40% more
1230 1230 data than a regular clone, but uses less memory and CPU on both
1231 1231 server and client. Over a LAN (100 Mbps or better) or a very fast
1232 1232 WAN, an uncompressed streaming clone is a lot faster (~10x) than a
1233 1233 regular clone. Over most WAN connections (anything slower than
1234 1234 about 6 Mbps), uncompressed streaming is slower, because of the
1235 1235 extra data transfer overhead. This mode will also temporarily hold
1236 1236 the write lock while determining what data to transfer.
1237 1237 Default is True.
1238 1238
1239 1239 ``preferuncompressed``
1240 1240 When set, clients will try to use the uncompressed streaming
1241 1241 protocol. Default is False.
1242 1242
1243 1243 ``validate``
1244 1244 Whether to validate the completeness of pushed changesets by
1245 1245 checking that all new file revisions specified in manifests are
1246 1246 present. Default is False.
1247 1247
1248 1248 ``smtp``
1249 1249 --------
1250 1250
1251 1251 Configuration for extensions that need to send email messages.
1252 1252
1253 1253 ``host``
1254 1254 Host name of mail server, e.g. "mail.example.com".
1255 1255
1256 1256 ``port``
1257 1257 Optional. Port to connect to on mail server. Default: 465 (if
1258 1258 ``tls`` is smtps) or 25 (otherwise).
1259 1259
1260 1260 ``tls``
1261 1261 Optional. Method to enable TLS when connecting to mail server: starttls,
1262 1262 smtps or none. Default: none.
1263 1263
1264 1264 ``verifycert``
1265 1265 Optional. Verification for the certificate of mail server, when
1266 1266 ``tls`` is starttls or smtps. "strict", "loose" or False. For
1267 1267 "strict" or "loose", the certificate is verified as same as the
1268 1268 verification for HTTPS connections (see ``[hostfingerprints]`` and
1269 1269 ``[web] cacerts`` also). For "strict", sending email is also
1270 1270 aborted, if there is no configuration for mail server in
1271 1271 ``[hostfingerprints]`` and ``[web] cacerts``. --insecure for
1272 1272 :hg:`email` overwrites this as "loose". Default: "strict".
1273 1273
1274 1274 ``username``
1275 1275 Optional. User name for authenticating with the SMTP server.
1276 1276 Default: none.
1277 1277
1278 1278 ``password``
1279 1279 Optional. Password for authenticating with the SMTP server. If not
1280 1280 specified, interactive sessions will prompt the user for a
1281 1281 password; non-interactive sessions will fail. Default: none.
1282 1282
1283 1283 ``local_hostname``
1284 1284 Optional. It's the hostname that the sender can use to identify
1285 1285 itself to the MTA.
1286 1286
1287 1287
1288 1288 ``subpaths``
1289 1289 ------------
1290 1290
1291 1291 Subrepository source URLs can go stale if a remote server changes name
1292 1292 or becomes temporarily unavailable. This section lets you define
1293 1293 rewrite rules of the form::
1294 1294
1295 1295 <pattern> = <replacement>
1296 1296
1297 1297 where ``pattern`` is a regular expression matching a subrepository
1298 1298 source URL and ``replacement`` is the replacement string used to
1299 1299 rewrite it. Groups can be matched in ``pattern`` and referenced in
1300 1300 ``replacements``. For instance::
1301 1301
1302 1302 http://server/(.*)-hg/ = http://hg.server/\1/
1303 1303
1304 1304 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
1305 1305
1306 1306 Relative subrepository paths are first made absolute, and the
1307 1307 rewrite rules are then applied on the full (absolute) path. The rules
1308 1308 are applied in definition order.
1309 1309
1310 1310 ``trusted``
1311 1311 -----------
1312 1312
1313 1313 Mercurial will not use the settings in the
1314 1314 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
1315 1315 user or to a trusted group, as various hgrc features allow arbitrary
1316 1316 commands to be run. This issue is often encountered when configuring
1317 1317 hooks or extensions for shared repositories or servers. However,
1318 1318 the web interface will use some safe settings from the ``[web]``
1319 1319 section.
1320 1320
1321 1321 This section specifies what users and groups are trusted. The
1322 1322 current user is always trusted. To trust everybody, list a user or a
1323 1323 group with name ``*``. These settings must be placed in an
1324 1324 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
1325 1325 user or service running Mercurial.
1326 1326
1327 1327 ``users``
1328 1328 Comma-separated list of trusted users.
1329 1329
1330 1330 ``groups``
1331 1331 Comma-separated list of trusted groups.
1332 1332
1333 1333
1334 1334 ``ui``
1335 1335 ------
1336 1336
1337 1337 User interface controls.
1338 1338
1339 1339 ``archivemeta``
1340 1340 Whether to include the .hg_archival.txt file containing meta data
1341 1341 (hashes for the repository base and for tip) in archives created
1342 1342 by the :hg:`archive` command or downloaded via hgweb.
1343 1343 Default is True.
1344 1344
1345 1345 ``askusername``
1346 1346 Whether to prompt for a username when committing. If True, and
1347 1347 neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
1348 1348 be prompted to enter a username. If no username is entered, the
1349 1349 default ``USER@HOST`` is used instead.
1350 1350 Default is False.
1351 1351
1352 1352 ``commitsubrepos``
1353 1353 Whether to commit modified subrepositories when committing the
1354 1354 parent repository. If False and one subrepository has uncommitted
1355 1355 changes, abort the commit.
1356 1356 Default is False.
1357 1357
1358 1358 ``debug``
1359 1359 Print debugging information. True or False. Default is False.
1360 1360
1361 1361 ``editor``
1362 1362 The editor to use during a commit. Default is ``$EDITOR`` or ``vi``.
1363 1363
1364 1364 ``fallbackencoding``
1365 1365 Encoding to try if it's not possible to decode the changelog using
1366 1366 UTF-8. Default is ISO-8859-1.
1367 1367
1368 1368 ``ignore``
1369 1369 A file to read per-user ignore patterns from. This file should be
1370 1370 in the same format as a repository-wide .hgignore file. Filenames
1371 1371 are relative to the repository root. This option supports hook syntax,
1372 1372 so if you want to specify multiple ignore files, you can do so by
1373 1373 setting something like ``ignore.other = ~/.hgignore2``. For details
1374 1374 of the ignore file format, see the ``hgignore(5)`` man page.
1375 1375
1376 1376 ``interactive``
1377 1377 Allow to prompt the user. True or False. Default is True.
1378 1378
1379 1379 ``logtemplate``
1380 1380 Template string for commands that print changesets.
1381 1381
1382 1382 ``merge``
1383 1383 The conflict resolution program to use during a manual merge.
1384 1384 For more information on merge tools see :hg:`help merge-tools`.
1385 1385 For configuring merge tools see the ``[merge-tools]`` section.
1386 1386
1387 1387 ``mergemarkers``
1388 1388 Sets the merge conflict marker label styling. The ``detailed``
1389 1389 style uses the ``mergemarkertemplate`` setting to style the labels.
1390 1390 The ``basic`` style just uses 'local' and 'other' as the marker label.
1391 1391 One of ``basic`` or ``detailed``.
1392 1392 Default is ``basic``.
1393 1393
1394 1394 ``mergemarkertemplate``
1395 1395 The template used to print the commit description next to each conflict
1396 1396 marker during merge conflicts. See :hg:`help templates` for the template
1397 1397 format.
1398 1398 Defaults to showing the hash, tags, branches, bookmarks, author, and
1399 1399 the first line of the commit description.
1400 1400 If you use non-ASCII characters in names for tags, branches, bookmarks,
1401 1401 authors, and/or commit descriptions, you must pay attention to encodings of
1402 1402 managed files. At template expansion, non-ASCII characters use the encoding
1403 1403 specified by the ``--encoding`` global option, ``HGENCODING`` or other
1404 1404 environment variables that govern your locale. If the encoding of the merge
1405 1405 markers is different from the encoding of the merged files,
1406 1406 serious problems may occur.
1407 1407
1408 1408 ``portablefilenames``
1409 1409 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
1410 1410 Default is ``warn``.
1411 1411 If set to ``warn`` (or ``true``), a warning message is printed on POSIX
1412 1412 platforms, if a file with a non-portable filename is added (e.g. a file
1413 1413 with a name that can't be created on Windows because it contains reserved
1414 1414 parts like ``AUX``, reserved characters like ``:``, or would cause a case
1415 1415 collision with an existing file).
1416 1416 If set to ``ignore`` (or ``false``), no warning is printed.
1417 1417 If set to ``abort``, the command is aborted.
1418 1418 On Windows, this configuration option is ignored and the command aborted.
1419 1419
1420 1420 ``quiet``
1421 1421 Reduce the amount of output printed. True or False. Default is False.
1422 1422
1423 1423 ``remotecmd``
1424 1424 remote command to use for clone/push/pull operations. Default is ``hg``.
1425 1425
1426 ``reportoldssl``
1427 Warn if an SSL certificate is unable to be used due to using Python
1428 2.5 or earlier. True or False. Default is True.
1429
1430 1426 ``report_untrusted``
1431 1427 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
1432 1428 trusted user or group. True or False. Default is True.
1433 1429
1434 1430 ``slash``
1435 1431 Display paths using a slash (``/``) as the path separator. This
1436 1432 only makes a difference on systems where the default path
1437 1433 separator is not the slash character (e.g. Windows uses the
1438 1434 backslash character (``\``)).
1439 1435 Default is False.
1440 1436
1441 1437 ``statuscopies``
1442 1438 Display copies in the status command.
1443 1439
1444 1440 ``ssh``
1445 1441 command to use for SSH connections. Default is ``ssh``.
1446 1442
1447 1443 ``strict``
1448 1444 Require exact command names, instead of allowing unambiguous
1449 1445 abbreviations. True or False. Default is False.
1450 1446
1451 1447 ``style``
1452 1448 Name of style to use for command output.
1453 1449
1454 1450 ``timeout``
1455 1451 The timeout used when a lock is held (in seconds), a negative value
1456 1452 means no timeout. Default is 600.
1457 1453
1458 1454 ``traceback``
1459 1455 Mercurial always prints a traceback when an unknown exception
1460 1456 occurs. Setting this to True will make Mercurial print a traceback
1461 1457 on all exceptions, even those recognized by Mercurial (such as
1462 1458 IOError or MemoryError). Default is False.
1463 1459
1464 1460 ``username``
1465 1461 The committer of a changeset created when running "commit".
1466 1462 Typically a person's name and email address, e.g. ``Fred Widget
1467 1463 <fred@example.com>``. Default is ``$EMAIL`` or ``username@hostname``. If
1468 1464 the username in hgrc is empty, it has to be specified manually or
1469 1465 in a different hgrc file (e.g. ``$HOME/.hgrc``, if the admin set
1470 1466 ``username =`` in the system hgrc). Environment variables in the
1471 1467 username are expanded.
1472 1468
1473 1469 ``verbose``
1474 1470 Increase the amount of output printed. True or False. Default is False.
1475 1471
1476 1472
1477 1473 ``web``
1478 1474 -------
1479 1475
1480 1476 Web interface configuration. The settings in this section apply to
1481 1477 both the builtin webserver (started by :hg:`serve`) and the script you
1482 1478 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
1483 1479 and WSGI).
1484 1480
1485 1481 The Mercurial webserver does no authentication (it does not prompt for
1486 1482 usernames and passwords to validate *who* users are), but it does do
1487 1483 authorization (it grants or denies access for *authenticated users*
1488 1484 based on settings in this section). You must either configure your
1489 1485 webserver to do authentication for you, or disable the authorization
1490 1486 checks.
1491 1487
1492 1488 For a quick setup in a trusted environment, e.g., a private LAN, where
1493 1489 you want it to accept pushes from anybody, you can use the following
1494 1490 command line::
1495 1491
1496 1492 $ hg --config web.allow_push=* --config web.push_ssl=False serve
1497 1493
1498 1494 Note that this will allow anybody to push anything to the server and
1499 1495 that this should not be used for public servers.
1500 1496
1501 1497 The full set of options is:
1502 1498
1503 1499 ``accesslog``
1504 1500 Where to output the access log. Default is stdout.
1505 1501
1506 1502 ``address``
1507 1503 Interface address to bind to. Default is all.
1508 1504
1509 1505 ``allow_archive``
1510 1506 List of archive format (bz2, gz, zip) allowed for downloading.
1511 1507 Default is empty.
1512 1508
1513 1509 ``allowbz2``
1514 1510 (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
1515 1511 revisions.
1516 1512 Default is False.
1517 1513
1518 1514 ``allowgz``
1519 1515 (DEPRECATED) Whether to allow .tar.gz downloading of repository
1520 1516 revisions.
1521 1517 Default is False.
1522 1518
1523 1519 ``allowpull``
1524 1520 Whether to allow pulling from the repository. Default is True.
1525 1521
1526 1522 ``allow_push``
1527 1523 Whether to allow pushing to the repository. If empty or not set,
1528 1524 push is not allowed. If the special value ``*``, any remote user can
1529 1525 push, including unauthenticated users. Otherwise, the remote user
1530 1526 must have been authenticated, and the authenticated user name must
1531 1527 be present in this list. The contents of the allow_push list are
1532 1528 examined after the deny_push list.
1533 1529
1534 1530 ``allow_read``
1535 1531 If the user has not already been denied repository access due to
1536 1532 the contents of deny_read, this list determines whether to grant
1537 1533 repository access to the user. If this list is not empty, and the
1538 1534 user is unauthenticated or not present in the list, then access is
1539 1535 denied for the user. If the list is empty or not set, then access
1540 1536 is permitted to all users by default. Setting allow_read to the
1541 1537 special value ``*`` is equivalent to it not being set (i.e. access
1542 1538 is permitted to all users). The contents of the allow_read list are
1543 1539 examined after the deny_read list.
1544 1540
1545 1541 ``allowzip``
1546 1542 (DEPRECATED) Whether to allow .zip downloading of repository
1547 1543 revisions. Default is False. This feature creates temporary files.
1548 1544
1549 1545 ``archivesubrepos``
1550 1546 Whether to recurse into subrepositories when archiving. Default is
1551 1547 False.
1552 1548
1553 1549 ``baseurl``
1554 1550 Base URL to use when publishing URLs in other locations, so
1555 1551 third-party tools like email notification hooks can construct
1556 1552 URLs. Example: ``http://hgserver/repos/``.
1557 1553
1558 1554 ``cacerts``
1559 1555 Path to file containing a list of PEM encoded certificate
1560 1556 authority certificates. Environment variables and ``~user``
1561 1557 constructs are expanded in the filename. If specified on the
1562 1558 client, then it will verify the identity of remote HTTPS servers
1563 1559 with these certificates.
1564 1560
1565 1561 This feature is only supported when using Python 2.6 or later. If you wish
1566 1562 to use it with earlier versions of Python, install the backported
1567 1563 version of the ssl library that is available from
1568 1564 ``http://pypi.python.org``.
1569 1565
1570 1566 To disable SSL verification temporarily, specify ``--insecure`` from
1571 1567 command line.
1572 1568
1573 1569 You can use OpenSSL's CA certificate file if your platform has
1574 1570 one. On most Linux systems this will be
1575 1571 ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
1576 1572 generate this file manually. The form must be as follows::
1577 1573
1578 1574 -----BEGIN CERTIFICATE-----
1579 1575 ... (certificate in base64 PEM encoding) ...
1580 1576 -----END CERTIFICATE-----
1581 1577 -----BEGIN CERTIFICATE-----
1582 1578 ... (certificate in base64 PEM encoding) ...
1583 1579 -----END CERTIFICATE-----
1584 1580
1585 1581 ``cache``
1586 1582 Whether to support caching in hgweb. Defaults to True.
1587 1583
1588 1584 ``collapse``
1589 1585 With ``descend`` enabled, repositories in subdirectories are shown at
1590 1586 a single level alongside repositories in the current path. With
1591 1587 ``collapse`` also enabled, repositories residing at a deeper level than
1592 1588 the current path are grouped behind navigable directory entries that
1593 1589 lead to the locations of these repositories. In effect, this setting
1594 1590 collapses each collection of repositories found within a subdirectory
1595 1591 into a single entry for that subdirectory. Default is False.
1596 1592
1597 1593 ``comparisoncontext``
1598 1594 Number of lines of context to show in side-by-side file comparison. If
1599 1595 negative or the value ``full``, whole files are shown. Default is 5.
1600 1596 This setting can be overridden by a ``context`` request parameter to the
1601 1597 ``comparison`` command, taking the same values.
1602 1598
1603 1599 ``contact``
1604 1600 Name or email address of the person in charge of the repository.
1605 1601 Defaults to ui.username or ``$EMAIL`` or "unknown" if unset or empty.
1606 1602
1607 1603 ``deny_push``
1608 1604 Whether to deny pushing to the repository. If empty or not set,
1609 1605 push is not denied. If the special value ``*``, all remote users are
1610 1606 denied push. Otherwise, unauthenticated users are all denied, and
1611 1607 any authenticated user name present in this list is also denied. The
1612 1608 contents of the deny_push list are examined before the allow_push list.
1613 1609
1614 1610 ``deny_read``
1615 1611 Whether to deny reading/viewing of the repository. If this list is
1616 1612 not empty, unauthenticated users are all denied, and any
1617 1613 authenticated user name present in this list is also denied access to
1618 1614 the repository. If set to the special value ``*``, all remote users
1619 1615 are denied access (rarely needed ;). If deny_read is empty or not set,
1620 1616 the determination of repository access depends on the presence and
1621 1617 content of the allow_read list (see description). If both
1622 1618 deny_read and allow_read are empty or not set, then access is
1623 1619 permitted to all users by default. If the repository is being
1624 1620 served via hgwebdir, denied users will not be able to see it in
1625 1621 the list of repositories. The contents of the deny_read list have
1626 1622 priority over (are examined before) the contents of the allow_read
1627 1623 list.
1628 1624
1629 1625 ``descend``
1630 1626 hgwebdir indexes will not descend into subdirectories. Only repositories
1631 1627 directly in the current path will be shown (other repositories are still
1632 1628 available from the index corresponding to their containing path).
1633 1629
1634 1630 ``description``
1635 1631 Textual description of the repository's purpose or contents.
1636 1632 Default is "unknown".
1637 1633
1638 1634 ``encoding``
1639 1635 Character encoding name. Default is the current locale charset.
1640 1636 Example: "UTF-8"
1641 1637
1642 1638 ``errorlog``
1643 1639 Where to output the error log. Default is stderr.
1644 1640
1645 1641 ``guessmime``
1646 1642 Control MIME types for raw download of file content.
1647 1643 Set to True to let hgweb guess the content type from the file
1648 1644 extension. This will serve HTML files as ``text/html`` and might
1649 1645 allow cross-site scripting attacks when serving untrusted
1650 1646 repositories. Default is False.
1651 1647
1652 1648 ``hidden``
1653 1649 Whether to hide the repository in the hgwebdir index.
1654 1650 Default is False.
1655 1651
1656 1652 ``ipv6``
1657 1653 Whether to use IPv6. Default is False.
1658 1654
1659 1655 ``logoimg``
1660 1656 File name of the logo image that some templates display on each page.
1661 1657 The file name is relative to ``staticurl``. That is, the full path to
1662 1658 the logo image is "staticurl/logoimg".
1663 1659 If unset, ``hglogo.png`` will be used.
1664 1660
1665 1661 ``logourl``
1666 1662 Base URL to use for logos. If unset, ``http://mercurial.selenic.com/``
1667 1663 will be used.
1668 1664
1669 1665 ``maxchanges``
1670 1666 Maximum number of changes to list on the changelog. Default is 10.
1671 1667
1672 1668 ``maxfiles``
1673 1669 Maximum number of files to list per changeset. Default is 10.
1674 1670
1675 1671 ``maxshortchanges``
1676 1672 Maximum number of changes to list on the shortlog, graph or filelog
1677 1673 pages. Default is 60.
1678 1674
1679 1675 ``name``
1680 1676 Repository name to use in the web interface. Default is current
1681 1677 working directory.
1682 1678
1683 1679 ``port``
1684 1680 Port to listen on. Default is 8000.
1685 1681
1686 1682 ``prefix``
1687 1683 Prefix path to serve from. Default is '' (server root).
1688 1684
1689 1685 ``push_ssl``
1690 1686 Whether to require that inbound pushes be transported over SSL to
1691 1687 prevent password sniffing. Default is True.
1692 1688
1693 1689 ``staticurl``
1694 1690 Base URL to use for static files. If unset, static files (e.g. the
1695 1691 hgicon.png favicon) will be served by the CGI script itself. Use
1696 1692 this setting to serve them directly with the HTTP server.
1697 1693 Example: ``http://hgserver/static/``.
1698 1694
1699 1695 ``stripes``
1700 1696 How many lines a "zebra stripe" should span in multi-line output.
1701 1697 Default is 1; set to 0 to disable.
1702 1698
1703 1699 ``style``
1704 1700 Which template map style to use. The available options are the names of
1705 1701 subdirectories in the HTML templates path. Default is ``paper``.
1706 1702 Example: ``monoblue``
1707 1703
1708 1704 ``templates``
1709 1705 Where to find the HTML templates. The default path to the HTML templates
1710 1706 can be obtained from ``hg debuginstall``.
1711 1707
1712 1708 ``websub``
1713 1709 ----------
1714 1710
1715 1711 Web substitution filter definition. You can use this section to
1716 1712 define a set of regular expression substitution patterns which
1717 1713 let you automatically modify the hgweb server output.
1718 1714
1719 1715 The default hgweb templates only apply these substitution patterns
1720 1716 on the revision description fields. You can apply them anywhere
1721 1717 you want when you create your own templates by adding calls to the
1722 1718 "websub" filter (usually after calling the "escape" filter).
1723 1719
1724 1720 This can be used, for example, to convert issue references to links
1725 1721 to your issue tracker, or to convert "markdown-like" syntax into
1726 1722 HTML (see the examples below).
1727 1723
1728 1724 Each entry in this section names a substitution filter.
1729 1725 The value of each entry defines the substitution expression itself.
1730 1726 The websub expressions follow the old interhg extension syntax,
1731 1727 which in turn imitates the Unix sed replacement syntax::
1732 1728
1733 1729 patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
1734 1730
1735 1731 You can use any separator other than "/". The final "i" is optional
1736 1732 and indicates that the search must be case insensitive.
1737 1733
1738 1734 Examples::
1739 1735
1740 1736 [websub]
1741 1737 issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
1742 1738 italic = s/\b_(\S+)_\b/<i>\1<\/i>/
1743 1739 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
1744 1740
1745 1741 ``worker``
1746 1742 ----------
1747 1743
1748 1744 Parallel master/worker configuration. We currently perform working
1749 1745 directory updates in parallel on Unix-like systems, which greatly
1750 1746 helps performance.
1751 1747
1752 1748 ``numcpus``
1753 1749 Number of CPUs to use for parallel operations. Default is 4 or the
1754 1750 number of CPUs on the system, whichever is larger. A zero or
1755 1751 negative value is treated as ``use the default``.
@@ -1,237 +1,207
1 1 # sslutil.py - SSL handling for mercurial
2 2 #
3 3 # Copyright 2005, 2006, 2007, 2008 Matt Mackall <mpm@selenic.com>
4 4 # Copyright 2006, 2007 Alexis S. L. Carvalho <alexis@cecm.usp.br>
5 5 # Copyright 2006 Vadim Gelfer <vadim.gelfer@gmail.com>
6 6 #
7 7 # This software may be used and distributed according to the terms of the
8 8 # GNU General Public License version 2 or any later version.
9 import os, sys
9 import os, sys, ssl
10 10
11 11 from mercurial import util
12 12 from mercurial.i18n import _
13 13
14 14 _canloaddefaultcerts = False
15 15 try:
16 # avoid using deprecated/broken FakeSocket in python 2.6
17 import ssl
18 16 CERT_REQUIRED = ssl.CERT_REQUIRED
19 17 try:
20 18 ssl_context = ssl.SSLContext
21 19 _canloaddefaultcerts = util.safehasattr(ssl_context,
22 20 'load_default_certs')
23 21
24 22 def wrapsocket(sock, keyfile, certfile, ui,
25 23 cert_reqs=ssl.CERT_NONE,
26 24 ca_certs=None, serverhostname=None):
27 25 # Allow any version of SSL starting with TLSv1 and
28 26 # up. Note that specifying TLSv1 here prohibits use of
29 27 # newer standards (like TLSv1_2), so this is the right way
30 28 # to do this. Note that in the future it'd be better to
31 29 # support using ssl.create_default_context(), which sets
32 30 # up a bunch of things in smart ways (strong ciphers,
33 31 # protocol versions, etc) and is upgraded by Python
34 32 # maintainers for us, but that breaks too many things to
35 33 # do it in a hurry.
36 34 sslcontext = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
37 35 sslcontext.options &= ssl.OP_NO_SSLv2 & ssl.OP_NO_SSLv3
38 36 if certfile is not None:
39 37 def password():
40 38 f = keyfile or certfile
41 39 return ui.getpass(_('passphrase for %s: ') % f, '')
42 40 sslcontext.load_cert_chain(certfile, keyfile, password)
43 41 sslcontext.verify_mode = cert_reqs
44 42 if ca_certs is not None:
45 43 sslcontext.load_verify_locations(cafile=ca_certs)
46 44 elif _canloaddefaultcerts:
47 45 sslcontext.load_default_certs()
48 46
49 47 sslsocket = sslcontext.wrap_socket(sock,
50 48 server_hostname=serverhostname)
51 49 # check if wrap_socket failed silently because socket had been
52 50 # closed
53 51 # - see http://bugs.python.org/issue13721
54 52 if not sslsocket.cipher():
55 53 raise util.Abort(_('ssl connection failed'))
56 54 return sslsocket
57 55 except AttributeError:
58 56 def wrapsocket(sock, keyfile, certfile, ui,
59 57 cert_reqs=ssl.CERT_NONE,
60 58 ca_certs=None, serverhostname=None):
61 59 sslsocket = ssl.wrap_socket(sock, keyfile, certfile,
62 60 cert_reqs=cert_reqs, ca_certs=ca_certs,
63 61 ssl_version=ssl.PROTOCOL_TLSv1)
64 62 # check if wrap_socket failed silently because socket had been
65 63 # closed
66 64 # - see http://bugs.python.org/issue13721
67 65 if not sslsocket.cipher():
68 66 raise util.Abort(_('ssl connection failed'))
69 67 return sslsocket
70 68 except ImportError:
71 CERT_REQUIRED = 2
72
73 import socket, httplib
74
75 def wrapsocket(sock, keyfile, certfile, ui,
76 cert_reqs=CERT_REQUIRED,
77 ca_certs=None, serverhostname=None):
78 if not util.safehasattr(socket, 'ssl'):
79 raise util.Abort(_('Python SSL support not found'))
80 if ca_certs:
81 raise util.Abort(_(
82 'certificate checking requires Python 2.6'))
83
84 ssl = socket.ssl(sock, keyfile, certfile)
85 return httplib.FakeSocket(sock, ssl)
69 raise
86 70
87 71 def _verifycert(cert, hostname):
88 72 '''Verify that cert (in socket.getpeercert() format) matches hostname.
89 73 CRLs is not handled.
90 74
91 75 Returns error message if any problems are found and None on success.
92 76 '''
93 77 if not cert:
94 78 return _('no certificate received')
95 79 dnsname = hostname.lower()
96 80 def matchdnsname(certname):
97 81 return (certname == dnsname or
98 82 '.' in dnsname and certname == '*.' + dnsname.split('.', 1)[1])
99 83
100 84 san = cert.get('subjectAltName', [])
101 85 if san:
102 86 certnames = [value.lower() for key, value in san if key == 'DNS']
103 87 for name in certnames:
104 88 if matchdnsname(name):
105 89 return None
106 90 if certnames:
107 91 return _('certificate is for %s') % ', '.join(certnames)
108 92
109 93 # subject is only checked when subjectAltName is empty
110 94 for s in cert.get('subject', []):
111 95 key, value = s[0]
112 96 if key == 'commonName':
113 97 try:
114 98 # 'subject' entries are unicode
115 99 certname = value.lower().encode('ascii')
116 100 except UnicodeEncodeError:
117 101 return _('IDN in certificate not supported')
118 102 if matchdnsname(certname):
119 103 return None
120 104 return _('certificate is for %s') % certname
121 105 return _('no commonName or subjectAltName found in certificate')
122 106
123 107
124 108 # CERT_REQUIRED means fetch the cert from the server all the time AND
125 109 # validate it against the CA store provided in web.cacerts.
126 #
127 # We COMPLETELY ignore CERT_REQUIRED on Python <= 2.5, as it's totally
128 # busted on those versions.
129 110
130 111 def _plainapplepython():
131 112 """return true if this seems to be a pure Apple Python that
132 113 * is unfrozen and presumably has the whole mercurial module in the file
133 114 system
134 115 * presumably is an Apple Python that uses Apple OpenSSL which has patches
135 116 for using system certificate store CAs in addition to the provided
136 117 cacerts file
137 118 """
138 119 if sys.platform != 'darwin' or util.mainfrozen() or not sys.executable:
139 120 return False
140 121 exe = os.path.realpath(sys.executable).lower()
141 122 return (exe.startswith('/usr/bin/python') or
142 123 exe.startswith('/system/library/frameworks/python.framework/'))
143 124
144 125 def _defaultcacerts():
145 126 """return path to CA certificates; None for system's store; ! to disable"""
146 127 if _plainapplepython():
147 128 dummycert = os.path.join(os.path.dirname(__file__), 'dummycert.pem')
148 129 if os.path.exists(dummycert):
149 130 return dummycert
150 131 if _canloaddefaultcerts:
151 132 return None
152 133 return '!'
153 134
154 135 def sslkwargs(ui, host):
155 136 kws = {'ui': ui}
156 137 hostfingerprint = ui.config('hostfingerprints', host)
157 138 if hostfingerprint:
158 139 return kws
159 140 cacerts = ui.config('web', 'cacerts')
160 141 if cacerts == '!':
161 142 pass
162 143 elif cacerts:
163 144 cacerts = util.expandpath(cacerts)
164 145 if not os.path.exists(cacerts):
165 146 raise util.Abort(_('could not find web.cacerts: %s') % cacerts)
166 147 else:
167 148 cacerts = _defaultcacerts()
168 149 if cacerts and cacerts != '!':
169 150 ui.debug('using %s to enable OS X system CA\n' % cacerts)
170 151 ui.setconfig('web', 'cacerts', cacerts, 'defaultcacerts')
171 152 if cacerts != '!':
172 153 kws.update({'ca_certs': cacerts,
173 154 'cert_reqs': CERT_REQUIRED,
174 155 })
175 156 return kws
176 157
177 158 class validator(object):
178 159 def __init__(self, ui, host):
179 160 self.ui = ui
180 161 self.host = host
181 162
182 163 def __call__(self, sock, strict=False):
183 164 host = self.host
184 165 cacerts = self.ui.config('web', 'cacerts')
185 166 hostfingerprint = self.ui.config('hostfingerprints', host)
186 if not getattr(sock, 'getpeercert', False): # python 2.5 ?
187 if hostfingerprint:
188 raise util.Abort(_("host fingerprint for %s can't be "
189 "verified (Python too old)") % host)
190 if strict:
191 raise util.Abort(_("certificate for %s can't be verified "
192 "(Python too old)") % host)
193 if self.ui.configbool('ui', 'reportoldssl', True):
194 self.ui.warn(_("warning: certificate for %s can't be verified "
195 "(Python too old)\n") % host)
196 return
197 167
198 168 if not sock.cipher(): # work around http://bugs.python.org/issue13721
199 169 raise util.Abort(_('%s ssl connection error') % host)
200 170 try:
201 171 peercert = sock.getpeercert(True)
202 172 peercert2 = sock.getpeercert()
203 173 except AttributeError:
204 174 raise util.Abort(_('%s ssl connection error') % host)
205 175
206 176 if not peercert:
207 177 raise util.Abort(_('%s certificate error: '
208 178 'no certificate received') % host)
209 179 peerfingerprint = util.sha1(peercert).hexdigest()
210 180 nicefingerprint = ":".join([peerfingerprint[x:x + 2]
211 181 for x in xrange(0, len(peerfingerprint), 2)])
212 182 if hostfingerprint:
213 183 if peerfingerprint.lower() != \
214 184 hostfingerprint.replace(':', '').lower():
215 185 raise util.Abort(_('certificate for %s has unexpected '
216 186 'fingerprint %s') % (host, nicefingerprint),
217 187 hint=_('check hostfingerprint configuration'))
218 188 self.ui.debug('%s certificate matched fingerprint %s\n' %
219 189 (host, nicefingerprint))
220 190 elif cacerts != '!':
221 191 msg = _verifycert(peercert2, host)
222 192 if msg:
223 193 raise util.Abort(_('%s certificate error: %s') % (host, msg),
224 194 hint=_('configure hostfingerprint %s or use '
225 195 '--insecure to connect insecurely') %
226 196 nicefingerprint)
227 197 self.ui.debug('%s certificate successfully verified\n' % host)
228 198 elif strict:
229 199 raise util.Abort(_('%s certificate with fingerprint %s not '
230 200 'verified') % (host, nicefingerprint),
231 201 hint=_('check hostfingerprints or web.cacerts '
232 202 'config setting'))
233 203 else:
234 204 self.ui.warn(_('warning: %s certificate with fingerprint %s not '
235 205 'verified (check hostfingerprints or web.cacerts '
236 206 'config setting)\n') %
237 207 (host, nicefingerprint))
General Comments 0
You need to be logged in to leave comments. Login now