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