Mercurial > hg
annotate mercurial/help/config.txt @ 27738:a0e783d26e81
exchange: make clone bundles non-experimental and enabled by default
The clone bundles feature was introduced in Mercurial 3.6 behind an
experimental and disabled by default flag. The feature has been enabled
on hg.mozilla.org for a few months and has served many terabytes of
clones. Users have been encouraged to use the feature and reception
has been very positive (mainly due to faster clones as a result of
connecting to a CDN). I have heard no feedback about changing the
feature other than inquiries about when it will be enabled by default.
So, I think the feature is ready to be enabled by default.
This patch renames experimental.clonebundles to ui.clonebundles,
documents the option, and enables it by default. References to the
experimental state of clone bundles have been removed. The remaining
config option docs in clonebundles.py have been removed because they
are redudant with `hg help config`.
There are some oddities with behavior of clone bundles. Because clones
with clone bundles are effectively 2 `hg pull` operations, there may be
2 transactions. This could result in hooks running twice. If the
subsequent pull is aborted, it could result in partial rollback and an
incomplete clone. This behavior is a bit wonky and should probably
be documented. If this patch is accepted, I'll send a follow-up to
document it. I don't think this behavior should prevent the feature
being enabled by default. Reworking the clone mechanism to support
interrupted or multi-part clones feels like a major new feature and
something that when implemented can change the hook and rollback
semantics of clone bundles. Besides, partial clone is better than
full rollback and hooks running on initial clone are likely rare, so I
think the impact is minimal.
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Fri, 08 Jan 2016 10:58:04 -0800 |
parents | 482eb357fe98 |
children | d6d3cf5fda6f |
rev | line source |
---|---|
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 |
26365
33af0c53aeff
help: add config.troubleshooting section at the top
timeless@mozdev.org
parents:
26313
diff
changeset
|
4 Troubleshooting |
33af0c53aeff
help: add config.troubleshooting section at the top
timeless@mozdev.org
parents:
26313
diff
changeset
|
5 =============== |
33af0c53aeff
help: add config.troubleshooting section at the top
timeless@mozdev.org
parents:
26313
diff
changeset
|
6 |
33af0c53aeff
help: add config.troubleshooting section at the top
timeless@mozdev.org
parents:
26313
diff
changeset
|
7 If you're having problems with your configuration, |
33af0c53aeff
help: add config.troubleshooting section at the top
timeless@mozdev.org
parents:
26313
diff
changeset
|
8 :hg:`config --debug` can help you understand what is introducing |
33af0c53aeff
help: add config.troubleshooting section at the top
timeless@mozdev.org
parents:
26313
diff
changeset
|
9 a setting into your environment. |
33af0c53aeff
help: add config.troubleshooting section at the top
timeless@mozdev.org
parents:
26313
diff
changeset
|
10 |
33af0c53aeff
help: add config.troubleshooting section at the top
timeless@mozdev.org
parents:
26313
diff
changeset
|
11 See :hg:`help config.syntax` and :hg:`help config.files` |
33af0c53aeff
help: add config.troubleshooting section at the top
timeless@mozdev.org
parents:
26313
diff
changeset
|
12 for information about how and where to override things. |
33af0c53aeff
help: add config.troubleshooting section at the top
timeless@mozdev.org
parents:
26313
diff
changeset
|
13 |
27607
ee27d461bf5b
help: rename the Format section to Structure
timeless <timeless@mozdev.org>
parents:
27606
diff
changeset
|
14 Structure |
ee27d461bf5b
help: rename the Format section to Structure
timeless <timeless@mozdev.org>
parents:
27606
diff
changeset
|
15 ========= |
26365
33af0c53aeff
help: add config.troubleshooting section at the top
timeless@mozdev.org
parents:
26313
diff
changeset
|
16 |
14460
d5f616132c10
doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents:
14458
diff
changeset
|
17 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
|
18 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
|
19 by ``name = value`` entries:: |
9785
b52f0f221325
help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
20 |
14460
d5f616132c10
doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents:
14458
diff
changeset
|
21 [ui] |
d5f616132c10
doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents:
14458
diff
changeset
|
22 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
|
23 verbose = True |
9785
b52f0f221325
help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
24 |
14460
d5f616132c10
doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents:
14458
diff
changeset
|
25 The above entries will be referred to as ``ui.username`` and |
26280
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
26 ``ui.verbose``, respectively. See :hg:`help config.syntax`. |
9785
b52f0f221325
help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
27 |
14460
d5f616132c10
doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents:
14458
diff
changeset
|
28 Files |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
29 ===== |
9785
b52f0f221325
help: add "hg help config" topic
Martin Geisler <mg@lazybytes.net>
parents:
diff
changeset
|
30 |
14460
d5f616132c10
doc: improve merge between hgrc.5 and config help topic
Martin Geisler <mg@lazybytes.net>
parents:
14458
diff
changeset
|
31 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
|
32 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
|
33 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
|
34 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
|
35 ``%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
|
36 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
|
37 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
38 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
|
39 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
|
40 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
|
41 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
|
42 ones. |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
43 |
22586
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
44 .. container:: verbose.unix |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
45 |
22586
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
46 On Unix, the following files are consulted: |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
47 |
22586
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
48 - ``<repo>/.hg/hgrc`` (per-repository) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
49 - ``$HOME/.hgrc`` (per-user) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
50 - ``<install-root>/etc/mercurial/hgrc`` (per-installation) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
51 - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
52 - ``/etc/mercurial/hgrc`` (per-system) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
53 - ``/etc/mercurial/hgrc.d/*.rc`` (per-system) |
23142
c4ce077588d0
config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents:
23121
diff
changeset
|
54 - ``<internal>/default.d/*.rc`` (defaults) |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
55 |
22586
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
56 .. container:: verbose.windows |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
57 |
22586
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
58 On Windows, the following files are consulted: |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
59 |
22586
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
60 - ``<repo>/.hg/hgrc`` (per-repository) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
61 - ``%USERPROFILE%\.hgrc`` (per-user) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
62 - ``%USERPROFILE%\Mercurial.ini`` (per-user) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
63 - ``%HOME%\.hgrc`` (per-user) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
64 - ``%HOME%\Mercurial.ini`` (per-user) |
26625
adae8928fe09
windows: read all global config files, not just the first (issue4491) (BC)
Mads Kiilerich <madski@unity3d.com>
parents:
26623
diff
changeset
|
65 - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation) |
22586
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
66 - ``<install-dir>\hgrc.d\*.rc`` (per-installation) |
26625
adae8928fe09
windows: read all global config files, not just the first (issue4491) (BC)
Mads Kiilerich <madski@unity3d.com>
parents:
26623
diff
changeset
|
67 - ``<install-dir>\Mercurial.ini`` (per-installation) |
23142
c4ce077588d0
config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents:
23121
diff
changeset
|
68 - ``<internal>/default.d/*.rc`` (defaults) |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
69 |
22586
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
70 .. note:: |
20532
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
71 |
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
72 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
|
73 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
|
74 |
22586
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
75 .. container:: verbose.plan9 |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
76 |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
77 On Plan9, the following files are consulted: |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
78 |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
79 - ``<repo>/.hg/hgrc`` (per-repository) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
80 - ``$home/lib/hgrc`` (per-user) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
81 - ``<install-root>/lib/mercurial/hgrc`` (per-installation) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
82 - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
83 - ``/lib/mercurial/hgrc`` (per-system) |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
84 - ``/lib/mercurial/hgrc.d/*.rc`` (per-system) |
23142
c4ce077588d0
config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents:
23121
diff
changeset
|
85 - ``<internal>/default.d/*.rc`` (defaults) |
22586
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
86 |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
87 Per-repository configuration options only apply in a |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
88 particular repository. This file is not version-controlled, and |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
89 will not get transferred during a "clone" operation. Options in |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
90 this file override options in all other configuration files. On |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
91 Plan 9 and Unix, most of this file will be ignored if it doesn't |
26280
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
92 belong to a trusted user or to a trusted group. See |
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
93 :hg:`help config.trusted` for more details. |
22586
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
94 |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
95 Per-user configuration file(s) are for the user running Mercurial. On |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
96 Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. Options in these |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
97 files apply to all Mercurial commands executed by this user in any |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
98 directory. Options in these files override per-system and per-installation |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
99 options. |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
100 |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
101 Per-installation configuration files are searched for in the |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
102 directory where Mercurial is installed. ``<install-root>`` is the |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
103 parent directory of the **hg** executable (or symlink) being run. For |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
104 example, if installed in ``/shared/tools/bin/hg``, Mercurial will look |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
105 in ``/shared/tools/etc/mercurial/hgrc``. Options in these files apply |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
106 to all Mercurial commands executed by any user in any directory. |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
107 |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
108 Per-installation configuration files are for the system on |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
109 which Mercurial is running. Options in these files apply to all |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
110 Mercurial commands executed by any user in any directory. Registry |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
111 keys contain PATH-like strings, every part of which must reference |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
112 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
113 be read. Mercurial checks each of these locations in the specified |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
114 order until one or more configuration files are detected. |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
115 |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
116 Per-system configuration files are for the system on which Mercurial |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
117 is running. Options in these files apply to all Mercurial commands |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
118 executed by any user in any directory. Options in these files |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
119 override per-installation options. |
6e5657ce9e8c
help: use OS containers for config file lists
Matt Mackall <mpm@selenic.com>
parents:
22550
diff
changeset
|
120 |
23142
c4ce077588d0
config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents:
23121
diff
changeset
|
121 Mercurial comes with some default configuration. The default configuration |
c4ce077588d0
config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents:
23121
diff
changeset
|
122 files are installed with Mercurial and will be overwritten on upgrades. Default |
c4ce077588d0
config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents:
23121
diff
changeset
|
123 configuration files should never be edited by users or administrators but can |
c4ce077588d0
config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents:
23121
diff
changeset
|
124 be overridden in other configuration files. So far the directory only contains |
c4ce077588d0
config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents:
23121
diff
changeset
|
125 merge tool configuration but packagers can also put other default configuration |
c4ce077588d0
config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents:
23121
diff
changeset
|
126 there. |
c4ce077588d0
config: introduce "built-in" default configuration settings in default.d
Mads Kiilerich <madski@unity3d.com>
parents:
23121
diff
changeset
|
127 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
128 Syntax |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
129 ====== |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
130 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
131 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
|
132 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
|
133 ``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
|
134 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
135 [spam] |
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=ham |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
137 green= |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
138 eggs |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
139 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
140 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
|
141 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
|
142 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
|
143 ``#`` 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
|
144 |
14651
e9e4e9ab62bd
help/config: fix 'Mercurial' casing
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
14460
diff
changeset
|
145 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
|
146 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
|
147 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
148 [spam] |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
149 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
|
150 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
|
151 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
|
152 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
153 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
|
154 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
155 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
|
156 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
|
157 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
|
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 [foo] |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
160 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
|
161 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
|
162 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
|
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 [bar] |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
165 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
|
166 green= |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
167 eggs |
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 [foo] |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
170 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
|
171 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
|
172 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
|
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 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
|
175 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
|
176 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
|
177 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
|
178 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
179 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
|
180 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
|
181 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
|
182 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
|
183 above. |
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 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
|
186 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
|
187 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
|
188 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
|
189 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
|
190 ``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
|
191 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
192 %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
|
193 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
194 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
|
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 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
|
197 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
|
198 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
199 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
|
200 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
|
201 "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
|
202 (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
|
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 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
|
205 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
|
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 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
|
208 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
209 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
|
210 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
|
211 (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
|
212 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
213 Sections |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
214 ======== |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
215 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
216 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
|
217 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
|
218 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
|
219 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
220 ``alias`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
221 --------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
222 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
223 Defines command aliases. |
26172 | 224 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
225 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
|
226 commands (or aliases), optionally including arguments. Positional |
26176
3fb59f43a430
help/config: alias, ui.mergemarkertemplate add period for etc.
timeless@mozdev.org
parents:
26172
diff
changeset
|
227 arguments in the form of ``$1``, ``$2``, etc. in the alias definition |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
228 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
|
229 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
|
230 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
|
231 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
232 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
|
233 |
14653
6f96c7a908bd
help/config: fix small typo
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
14652
diff
changeset
|
234 <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
|
235 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
236 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
|
237 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
238 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
|
239 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
240 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
|
241 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
|
242 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
243 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
|
244 |
20532
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
245 .. note:: |
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
246 |
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
247 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
|
248 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
|
249 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
|
250 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
251 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
|
252 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
|
253 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
|
254 |
16513
aa252059a98f
alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents:
16399
diff
changeset
|
255 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
|
256 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
257 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
|
258 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
|
259 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
260 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
|
261 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
262 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
|
263 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
|
264 |
16513
aa252059a98f
alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents:
16399
diff
changeset
|
265 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
|
266 expand to the command arguments. Unmatched arguments are |
aa252059a98f
alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents:
16399
diff
changeset
|
267 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
|
268 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
|
269 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
|
270 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
|
271 |
aa252059a98f
alias: fix shell alias documentation (issue3374)
Patrick Mezard <patrick@mezard.eu>
parents:
16399
diff
changeset
|
272 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
|
273 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
|
274 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
|
275 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
|
276 ``$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
|
277 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
|
278 |
20532
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
279 .. note:: |
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
280 |
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
281 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
|
282 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
|
283 aliases. |
62122c1c830b
alias: note interaction of shell aliases with early opts in help
Matt Mackall <mpm@selenic.com>
parents:
14691
diff
changeset
|
284 |
15528
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
285 |
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
286 ``annotate`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
287 ------------ |
15528
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
288 |
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
289 Settings used when displaying file annotations. All values are |
26280
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
290 Booleans and default to False. See :hg:`help config.diff` for |
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
291 related options for the diff command. |
15528
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
292 |
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
293 ``ignorews`` |
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
294 Ignore white space when comparing lines. |
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
295 |
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
296 ``ignorewsamount`` |
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
297 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
|
298 |
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
299 ``ignoreblanklines`` |
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
300 Ignore changes whose lines are all blank. |
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
301 |
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
302 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
303 ``auth`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
304 -------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
305 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
306 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
|
307 allows you to store usernames and passwords for use when logging |
26280
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
308 *into* HTTP servers. See :hg:`help config.web` if |
14654
e21fd445c297
help/config: quote config section names consistently
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
14653
diff
changeset
|
309 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
|
310 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
311 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
|
312 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
313 <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
|
314 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
315 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
|
316 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
|
317 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
318 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
|
319 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
|
320 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
|
321 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
|
322 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
323 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
|
324 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
|
325 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
|
326 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
|
327 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
328 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
|
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 ``prefix`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
331 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
|
332 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
|
333 (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
|
334 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
|
335 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
|
336 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
|
337 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
338 ``username`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
339 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
|
340 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
|
341 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
|
342 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
|
343 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
|
344 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
|
345 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
346 ``password`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
347 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
|
348 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
|
349 will be prompted for it. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
350 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
351 ``key`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
352 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
|
353 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
|
354 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
355 ``cert`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
356 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
|
357 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
|
358 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
359 ``schemes`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
360 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
|
361 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
|
362 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
|
363 static-http and static-https respectively, as well. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
364 (default: https) |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
365 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
366 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
|
367 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
|
368 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
369 |
21924
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
370 ``committemplate`` |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
371 ------------------ |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
372 |
26169
ea888285311f
help: config indent committemplate.changeset section
timeless@mozdev.org
parents:
26072
diff
changeset
|
373 ``changeset`` |
ea888285311f
help: config indent committemplate.changeset section
timeless@mozdev.org
parents:
26072
diff
changeset
|
374 String: configuration in this section is used as the template to |
ea888285311f
help: config indent committemplate.changeset section
timeless@mozdev.org
parents:
26072
diff
changeset
|
375 customize the text shown in the editor when committing. |
21924
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
376 |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
377 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
|
378 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
|
379 |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
380 ``extramsg`` |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
381 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
|
382 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
|
383 |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
384 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
|
385 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
|
386 |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
387 [committemplate] |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
388 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
|
389 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
|
390 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
|
391 HG: -- |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
392 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
|
393 "HG: branch merge\n") |
25014
7e5d5160073b
templatekw: replace currentbookmark with activebookmark keyword
Ryan McElroy <rmcelroy@fb.com>
parents:
24830
diff
changeset
|
394 }HG: branch '{branch}'\n{if(activebookmark, |
7e5d5160073b
templatekw: replace currentbookmark with activebookmark keyword
Ryan McElroy <rmcelroy@fb.com>
parents:
24830
diff
changeset
|
395 "HG: bookmark '{activebookmark}'\n") }{subrepos % |
21924
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
396 "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
|
397 "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
|
398 "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
|
399 "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
|
400 "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
|
401 |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
402 .. note:: |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
403 |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
404 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
|
405 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
|
406 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
|
407 |
26281
5cac3bdb3c67
help/config: reword committemplate multibyte character text
timeless@mozdev.org
parents:
26280
diff
changeset
|
408 For example, if a multibyte character ending with backslash (0x5c) is |
5cac3bdb3c67
help/config: reword committemplate multibyte character text
timeless@mozdev.org
parents:
26280
diff
changeset
|
409 followed by the ASCII character 'n' in the customized template, |
5cac3bdb3c67
help/config: reword committemplate multibyte character text
timeless@mozdev.org
parents:
26280
diff
changeset
|
410 the sequence of backslash and 'n' is treated as line-feed unexpectedly |
5cac3bdb3c67
help/config: reword committemplate multibyte character text
timeless@mozdev.org
parents:
26280
diff
changeset
|
411 (and the multibyte character is broken, too). |
21924
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
412 |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
413 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
|
414 required): |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
415 |
5375ba75df40
cmdutil: make commit message shown in text editor customizable by template
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21918
diff
changeset
|
416 - :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
|
417 - :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
|
418 - :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
|
419 - :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
|
420 - :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
|
421 - :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
|
422 - :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
|
423 - :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
|
424 - :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
|
425 - :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
|
426 - :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
|
427 - :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
|
428 |
22012
9d92b9d1e282
cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21924
diff
changeset
|
429 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
|
430 customized message only for specific actions, or showing different |
23075
2b3189ec3d14
help/config: fix typo
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
22607
diff
changeset
|
431 messages for each action. |
22012
9d92b9d1e282
cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21924
diff
changeset
|
432 |
9d92b9d1e282
cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21924
diff
changeset
|
433 - ``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
|
434 - ``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
|
435 - ``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
|
436 - ``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
|
437 - ``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
|
438 - ``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
|
439 - ``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
|
440 - ``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
|
441 - ``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
|
442 - ``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
|
443 - ``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
|
444 - ``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
|
445 - ``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
|
446 - ``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
|
447 - ``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
|
448 - ``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
|
449 - ``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
|
450 - ``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
|
451 - ``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
|
452 - ``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
|
453 - ``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
|
454 - ``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
|
455 - ``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
|
456 - ``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
|
457 - ``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
|
458 - ``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
|
459 |
9d92b9d1e282
cmdutil: look commit template definition up by specified 'editform'
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
21924
diff
changeset
|
460 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
|
461 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
|
462 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
|
463 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
|
464 |
26282
436f5ab16079
help/config: reword committemplate external editor text
timeless@mozdev.org
parents:
26281
diff
changeset
|
465 When the external editor is invoked for a commit, the corresponding |
436f5ab16079
help/config: reword committemplate external editor text
timeless@mozdev.org
parents:
26281
diff
changeset
|
466 dot-separated list of names without the ``changeset.`` prefix |
436f5ab16079
help/config: reword committemplate external editor text
timeless@mozdev.org
parents:
26281
diff
changeset
|
467 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment |
436f5ab16079
help/config: reword committemplate external editor text
timeless@mozdev.org
parents:
26281
diff
changeset
|
468 variable. |
22205
9fa429723f26
ui: invoke editor for committing with HGEDITFORM environment variable
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
22158
diff
changeset
|
469 |
22013
de5cee8ba088
cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
22012
diff
changeset
|
470 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
|
471 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
|
472 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
|
473 |
de5cee8ba088
cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
22012
diff
changeset
|
474 [committemplate] |
de5cee8ba088
cmdutil: use '[committemplate]' section like as map file for style definition
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
22012
diff
changeset
|
475 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
|
476 "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
|
477 "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
|
478 "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
|
479 "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
|
480 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
481 ``decode/encode`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
482 ----------------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
483 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
484 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
|
485 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
|
486 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
|
487 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
488 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
|
489 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
|
490 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
|
491 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
|
492 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
|
493 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
|
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 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
|
496 ``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
|
497 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
498 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
|
499 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
|
500 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
501 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
|
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 [encode] |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
504 # 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
|
505 # 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
|
506 *.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
|
507 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
508 [decode] |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
509 # 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
|
510 # 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
|
511 *.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
|
512 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
513 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
|
514 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
|
515 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
|
516 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
|
517 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
|
518 |
20532
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
519 .. note:: |
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
520 |
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
521 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
|
522 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
|
523 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
|
524 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
525 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
|
526 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
|
527 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
|
528 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
529 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
530 ``defaults`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
531 ------------ |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
532 |
26177 | 533 (defaults are deprecated. Don't use them. Use aliases instead.) |
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 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
535 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
|
536 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
|
537 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
538 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
|
539 :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
|
540 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
541 [defaults] |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
542 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
|
543 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
|
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 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
|
546 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
|
547 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
|
548 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
549 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
550 ``diff`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
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 |
15528
a84698badf0b
annotate: support diff whitespace filtering flags (issue3030)
Patrick Mezard <pmezard@gmail.com>
parents:
15321
diff
changeset
|
553 Settings used when displaying diffs. Everything except for ``unified`` |
26280
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
554 is a Boolean and defaults to False. See :hg:`help config.annotate` |
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
555 for 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
|
556 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
557 ``git`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
558 Use git extended diff format. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
559 |
22602
551d776a0a9a
diff: document the nobinary option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
21924
diff
changeset
|
560 ``nobinary`` |
551d776a0a9a
diff: document the nobinary option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
21924
diff
changeset
|
561 Omit git binary patches. |
551d776a0a9a
diff: document the nobinary option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
21924
diff
changeset
|
562 |
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 ``nodates`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
564 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
|
565 |
23297
d7abae94a7a0
patch.diffopts: add support for noprefix
Siddharth Agarwal <sid0@fb.com>
parents:
23142
diff
changeset
|
566 ``noprefix`` |
d7abae94a7a0
patch.diffopts: add support for noprefix
Siddharth Agarwal <sid0@fb.com>
parents:
23142
diff
changeset
|
567 Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode. |
d7abae94a7a0
patch.diffopts: add support for noprefix
Siddharth Agarwal <sid0@fb.com>
parents:
23142
diff
changeset
|
568 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
569 ``showfunc`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
570 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
|
571 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
572 ``ignorews`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
573 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
|
574 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
575 ``ignorewsamount`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
576 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
|
577 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
578 ``ignoreblanklines`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
579 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
|
580 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
581 ``unified`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
582 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
|
583 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
584 ``email`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
585 --------- |
14456
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 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
|
588 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
589 ``from`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
590 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
|
591 of outgoing messages. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
592 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
593 ``to`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
594 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
|
595 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
596 ``cc`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
597 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
|
598 email addresses. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
599 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
600 ``bcc`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
601 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
|
602 email addresses. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
603 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
604 ``method`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
605 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
|
606 (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
|
607 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
|
608 (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
|
609 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
|
610 ``/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
|
611 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
612 ``charsets`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
613 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
|
614 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
|
615 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
|
616 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
|
617 (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
618 conversion fails, the text in question is sent as is. |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
619 (default: '') |
14456
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 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
|
622 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
623 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
|
624 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
|
625 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
|
626 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
|
627 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
|
628 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
629 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
|
630 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
631 [email] |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
632 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
|
633 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
|
634 # 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
|
635 # 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
|
636 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
|
637 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
638 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
639 ``extensions`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
640 -------------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
641 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
642 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
|
643 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
|
644 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
645 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
|
646 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
|
647 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
|
648 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
649 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
|
650 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
|
651 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
|
652 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
653 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
|
654 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
|
655 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
|
656 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
657 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
|
658 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
659 [extensions] |
25523
bde670e58ae0
help: use 'color' as an example (instead of 'progress')
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25520
diff
changeset
|
660 # (the color extension will get loaded from Mercurial's path) |
bde670e58ae0
help: use 'color' as an example (instead of 'progress')
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25520
diff
changeset
|
661 color = |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
662 # (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
|
663 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
|
664 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
665 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
666 ``format`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
667 ---------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
668 |
26907
dfab6edb98e3
format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
26730
diff
changeset
|
669 ``usegeneraldelta`` |
dfab6edb98e3
format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
26730
diff
changeset
|
670 Enable or disable the "generaldelta" repository format which improves |
dfab6edb98e3
format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
26730
diff
changeset
|
671 repository compression by allowing "revlog" to store delta against arbitrary |
dfab6edb98e3
format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
26730
diff
changeset
|
672 revision instead of the previous stored one. This provides significant |
27606
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
673 improvement for repositories with branches. |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
674 |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
675 Repositories with this on-disk format require Mercurial version 1.9. |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
676 |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
677 Enabled by default. |
26907
dfab6edb98e3
format: introduce 'format.usegeneraldelta`
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
26730
diff
changeset
|
678 |
27605
7793b3e220f6
help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents:
27552
diff
changeset
|
679 ``dotencode`` |
7793b3e220f6
help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents:
27552
diff
changeset
|
680 Enable or disable the "dotencode" repository format which enhances |
7793b3e220f6
help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents:
27552
diff
changeset
|
681 the "fncache" repository format (which has to be enabled to use |
7793b3e220f6
help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents:
27552
diff
changeset
|
682 dotencode) to avoid issues with filenames starting with ._ on |
27606
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
683 Mac OS X and spaces on Windows. |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
684 |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
685 Repositories with this on-disk format require Mercurial version 1.7. |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
686 |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
687 Enabled by default. |
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 ``usefncache`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
690 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
|
691 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
|
692 fncache) to allow longer filenames and avoids using Windows |
27606
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
693 reserved names, e.g. "nul". |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
694 |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
695 Repositories with this on-disk format require Mercurial version 1.1. |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
696 |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
697 Enabled by default. |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
698 |
27605
7793b3e220f6
help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents:
27552
diff
changeset
|
699 ``usestore`` |
7793b3e220f6
help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents:
27552
diff
changeset
|
700 Enable or disable the "store" repository format which improves |
7793b3e220f6
help: sort format section from newest to oldest
timeless <timeless@mozdev.org>
parents:
27552
diff
changeset
|
701 compatibility with systems that fold case or otherwise mangle |
27606
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
702 filenames. Disabling this option will allow you to store longer filenames |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
703 in some situations at the expense of compatibility. |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
704 |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
705 Repositories with this on-disk format require Mercurial version 0.9.4. |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
706 |
ebe57ccd4822
help: refactor version/defaults from format section
timeless <timeless@mozdev.org>
parents:
27605
diff
changeset
|
707 Enabled by default. |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
708 |
16129
5e50982c633c
graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents:
16005
diff
changeset
|
709 ``graph`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
710 --------- |
16129
5e50982c633c
graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents:
16005
diff
changeset
|
711 |
16139
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
712 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
|
713 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
|
714 ``default`` branch stand out. |
16129
5e50982c633c
graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents:
16005
diff
changeset
|
715 |
16139
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
716 Each line has the following format:: |
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
717 |
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
718 <branch>.<argument> = <value> |
16129
5e50982c633c
graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents:
16005
diff
changeset
|
719 |
16139
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
720 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
|
721 customized. Example:: |
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
722 |
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
723 [graph] |
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
724 # 2px width |
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
725 default.width = 2 |
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
726 # red color |
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
727 default.color = FF0000 |
16129
5e50982c633c
graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents:
16005
diff
changeset
|
728 |
5e50982c633c
graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents:
16005
diff
changeset
|
729 Supported arguments: |
5e50982c633c
graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents:
16005
diff
changeset
|
730 |
5e50982c633c
graph: in hgrc specify line width for main branch
Constantine Linnick <theaspect@gmail.com>
parents:
16005
diff
changeset
|
731 ``width`` |
16139
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
732 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
|
733 |
16130
33f702e52906
graph: in hgrc specify line color for main branch
Constantine Linnick <theaspect@gmail.com>
parents:
16129
diff
changeset
|
734 ``color`` |
16139
461a59e2765a
doc: minor fixes to [graph] section documentation
Patrick Mezard <patrick@mezard.eu>
parents:
16130
diff
changeset
|
735 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
|
736 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
737 ``hooks`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
738 --------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
739 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
740 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
|
741 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
|
742 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
|
743 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
|
744 value or setting it to an empty string. Hooks can be prioritized |
27551
822927d4d930
help: clarify that the config hook priority prefix includes a period
timeless <timeless@mozdev.org>
parents:
27266
diff
changeset
|
745 by adding a prefix of ``priority.`` to the hook name on a new line |
26178 | 746 and setting the priority. The default priority is 0. |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
747 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
748 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
|
749 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
750 [hooks] |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
751 # 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
|
752 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
|
753 # 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
|
754 incoming = |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
755 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
|
756 incoming.autobuild = /my/build/hook |
15896
30c34fde40cc
hooks: prioritize run order of hooks
Matt Zuba <matt.zuba@goodwillaz.org>
parents:
15612
diff
changeset
|
757 # 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
|
758 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
|
759 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
760 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
|
761 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
|
762 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
|
763 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
764 ``changegroup`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
765 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
|
766 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
|
767 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
|
768 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
769 ``commit`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
770 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
|
771 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
|
772 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
|
773 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
774 ``incoming`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
775 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
|
776 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
|
777 ``$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
|
778 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
779 ``outgoing`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
780 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
|
781 first changeset sent is in ``$HG_NODE``. Source of operation is in |
26280
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
782 ``$HG_SOURCE``; Also see :hg:`help config.preoutgoing` hook. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
783 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
784 ``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
|
785 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
|
786 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
|
787 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
|
788 ``$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
|
789 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
|
790 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
|
791 ``$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
|
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 ``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
|
794 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
|
795 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
|
796 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
|
797 representations of the data internally passed to <command>. ``$HG_OPTS`` |
27552
20589d3bda6d
help: remove stray double spaces from config help
timeless <timeless@mozdev.org>
parents:
27551
diff
changeset
|
798 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
|
799 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
|
800 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
|
801 code. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
802 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
803 ``prechangegroup`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
804 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
|
805 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
|
806 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
|
807 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
|
808 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
809 ``precommit`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
810 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
|
811 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
|
812 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
|
813 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
814 ``prelistkeys`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
815 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
|
816 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
|
817 in ``$HG_NAMESPACE``. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
818 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
819 ``preoutgoing`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
820 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
|
821 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
|
822 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
|
823 (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
|
824 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
|
825 ``$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
|
826 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
|
827 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
|
828 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
829 ``prepushkey`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
830 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
|
831 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
|
832 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
|
833 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
|
834 ``$HG_NEW``. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
835 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
836 ``pretag`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
837 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
|
838 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
|
839 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
|
840 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
|
841 |
24281
e9ede9b4c2f8
hook: have a generic hook for transaction opening
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
23629
diff
changeset
|
842 ``pretxnopen`` |
e9ede9b4c2f8
hook: have a generic hook for transaction opening
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
23629
diff
changeset
|
843 Run before any new repository transaction is open. The reason for the |
24791
89c5881d692c
help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24663
diff
changeset
|
844 transaction will be in ``$HG_TXNNAME`` and a unique identifier for the |
89c5881d692c
help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24663
diff
changeset
|
845 transaction will be in ``HG_TXNID``. A non-zero status will prevent the |
89c5881d692c
help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24663
diff
changeset
|
846 transaction from being opened. |
24281
e9ede9b4c2f8
hook: have a generic hook for transaction opening
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
23629
diff
changeset
|
847 |
24284
ff14b26fe5f4
hook: add a generic hook right before we commit a transaction
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24282
diff
changeset
|
848 ``pretxnclose`` |
ff14b26fe5f4
hook: add a generic hook right before we commit a transaction
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24282
diff
changeset
|
849 Run right before the transaction is actually finalized. Any |
ff14b26fe5f4
hook: add a generic hook right before we commit a transaction
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24282
diff
changeset
|
850 repository change will be visible to the hook program. This lets you |
ff14b26fe5f4
hook: add a generic hook right before we commit a transaction
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24282
diff
changeset
|
851 validate the transaction content or change it. Exit status 0 allows |
ff14b26fe5f4
hook: add a generic hook right before we commit a transaction
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24282
diff
changeset
|
852 the commit to proceed. Non-zero status will cause the transaction to |
ff14b26fe5f4
hook: add a generic hook right before we commit a transaction
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24282
diff
changeset
|
853 be rolled back. The reason for the transaction opening will be in |
24791
89c5881d692c
help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24663
diff
changeset
|
854 ``$HG_TXNNAME`` and a unique identifier for the transaction will be in |
89c5881d692c
help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24663
diff
changeset
|
855 ``HG_TXNID``. The rest of the available data will vary according the |
89c5881d692c
help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24663
diff
changeset
|
856 transaction type. New changesets will add ``$HG_NODE`` (id of the |
89c5881d692c
help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24663
diff
changeset
|
857 first added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, |
89c5881d692c
help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24663
diff
changeset
|
858 bookmarks and phases changes will set ``HG_BOOKMARK_MOVED`` and |
89c5881d692c
help: document the ''HG_TXNID'' environment variable during hooks
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24663
diff
changeset
|
859 ``HG_PHASES_MOVED`` to ``1``, etc. |
24284
ff14b26fe5f4
hook: add a generic hook right before we commit a transaction
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24282
diff
changeset
|
860 |
24282
db8679812f84
hook: add a generic hook after transaction has been closed
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24281
diff
changeset
|
861 ``txnclose`` |
24814
60e4258b2052
help: fix typo commited -> committed
Javi Merino <merino.jav@gmail.com>
parents:
24792
diff
changeset
|
862 Run after any repository transaction has been committed. At this |
24282
db8679812f84
hook: add a generic hook after transaction has been closed
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24281
diff
changeset
|
863 point, the transaction can no longer be rolled back. The hook will run |
26280
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
864 after the lock is released. See :hg:`help config.pretxnclose` docs for |
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
865 details about available variables. |
24282
db8679812f84
hook: add a generic hook after transaction has been closed
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24281
diff
changeset
|
866 |
24792
7d0421de8de3
hooks: add a 'txnabort' hook
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24791
diff
changeset
|
867 ``txnabort`` |
26280
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
868 Run when a transaction is aborted. See :hg:`help config.pretxnclose` |
5edf3dccb6f7
help/config: use :hg:`help config....` notation
timeless@mozdev.org
parents:
26279
diff
changeset
|
869 docs for details about available variables. |
24792
7d0421de8de3
hooks: add a 'txnabort' hook
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
24791
diff
changeset
|
870 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
871 ``pretxnchangegroup`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
872 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
|
873 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
|
874 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
|
875 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
|
876 ``$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
|
877 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
|
878 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
|
879 ``$HG_URL``. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
880 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
881 ``pretxncommit`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
882 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
|
883 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
|
884 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
|
885 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
|
886 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
|
887 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
|
888 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
889 ``preupdate`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
890 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
|
891 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
|
892 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
|
893 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
|
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 ``listkeys`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
896 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
|
897 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
|
898 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
|
899 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
900 ``pushkey`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
901 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
|
902 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
|
903 ``$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
|
904 value is in ``$HG_NEW``. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
905 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
906 ``tag`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
907 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
|
908 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
|
909 repository if ``$HG_LOCAL=0``. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
910 |
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 ``update`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
912 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
|
913 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
|
914 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
|
915 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
|
916 |
20532
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
917 .. note:: |
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
918 |
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
919 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
|
920 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
|
921 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
|
922 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
|
923 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
|
924 |
20532
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
925 .. note:: |
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
926 |
f1a3ae7c15df
help: remove last occurrences of ".. note::" without two newlines
Simon Heimberg <simohe@besonet.ch>
parents:
20490
diff
changeset
|
927 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
|
928 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
|
929 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
|
930 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
|
931 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
932 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
|
933 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
934 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
|
935 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
|
936 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
937 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
|
938 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
|
939 ``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
|
940 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
|
941 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
|
942 ``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
|
943 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
944 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
|
945 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
|
946 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
947 |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
948 ``hostfingerprints`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
949 -------------------- |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
950 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
951 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
|
952 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
|
953 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
|
954 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
|
955 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
|
956 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
|
957 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
958 For example:: |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
959 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
960 [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
|
961 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
|
962 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
963 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
|
964 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
965 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
966 ``http_proxy`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
967 -------------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
968 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
969 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
|
970 proxy. |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
971 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
972 ``host`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
973 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
|
974 "myproxy:8000". |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
975 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
976 ``no`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
977 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
|
978 the proxy. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
979 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
980 ``passwd`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
981 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
|
982 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
983 ``user`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
984 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
|
985 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
986 ``always`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
987 Optional. Always use the proxy, even for localhost and any entries |
26279 | 988 in ``http_proxy.no``. (default: False) |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
989 |
27657
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
990 ``merge`` |
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
991 --------- |
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
992 |
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
993 This section specifies behavior during merges and updates. |
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
994 |
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
995 ``checkunknown`` |
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
996 Controls behavior when an unknown file on disk has the same name as a tracked |
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
997 file in the changeset being merged or updated to, and has different |
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
998 contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``, |
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
999 abort on such files. With ``warn``, warn on such files and back them up as |
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
1000 .orig. With ``ignore``, don't print a warning and back them up as |
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
1001 .orig. (default: ``abort``) |
7b5c8c8a2f8c
merge: add options to warn or ignore on colliding unknown files
Siddharth Agarwal <sid0@fb.com>
parents:
27633
diff
changeset
|
1002 |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1003 ``merge-patterns`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1004 ------------------ |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1005 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1006 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
|
1007 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
|
1008 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
|
1009 root. |
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 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
|
1012 |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1013 [merge-patterns] |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1014 **.c = kdiff3 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1015 **.jpg = myimgmerge |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1016 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1017 ``merge-tools`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1018 --------------- |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1019 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1020 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
|
1021 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
|
1022 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
|
1023 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
|
1024 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1025 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
|
1026 |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1027 [merge-tools] |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1028 # Override stock tool location |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1029 kdiff3.executable = ~/bin/kdiff3 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1030 # Specify command line |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1031 kdiff3.args = $base $local $other -o $output |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1032 # Give higher priority |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1033 kdiff3.priority = 1 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1034 |
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
|
1035 # Changing the priority of preconfigured tool |
26730
a1e43e85d294
merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents:
26625
diff
changeset
|
1036 meld.priority = 0 |
a1e43e85d294
merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents:
26625
diff
changeset
|
1037 |
a1e43e85d294
merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents:
26625
diff
changeset
|
1038 # Disable a preconfigured tool |
a1e43e85d294
merge-tools: allow marking a mergetool as completely disabled
Augie Fackler <augie@google.com>
parents:
26625
diff
changeset
|
1039 vimdiff.disabled = yes |
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
|
1040 |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1041 # Define new tool |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1042 myHtmlTool.args = -m $local $other $base $output |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1043 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1044 myHtmlTool.priority = 1 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1045 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1046 Supported arguments: |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1047 |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1048 ``priority`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1049 The priority in which to evaluate this tool. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1050 (default: 0) |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1051 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1052 ``executable`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1053 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
|
1054 the path can use environment variables with ${ProgramFiles} syntax. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1055 (default: the tool name) |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1056 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1057 ``args`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1058 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
|
1059 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
|
1060 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
|
1061 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
|
1062 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
|
1063 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
|
1064 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
|
1065 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
|
1066 commit being rebased. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1067 (default: ``$local $base $other``) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1068 |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1069 ``premerge`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1070 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
|
1071 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
|
1072 ``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
|
1073 premerge fails. The ``keep-merge3`` will do the same but include information |
23111
0dae9147c3b6
help: refer ":merge3" instead of "internal:merge3"
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
23075
diff
changeset
|
1074 about the base of the merge in the marker (see internal :merge3 in |
0dae9147c3b6
help: refer ":merge3" instead of "internal:merge3"
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
23075
diff
changeset
|
1075 :hg:`help merge-tools`). |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1076 (default: True) |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1077 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1078 ``binary`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1079 This tool can merge binary files. (default: False, unless tool |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1080 was selected by file pattern match) |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1081 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1082 ``symlink`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1083 This tool can merge symlinks. (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1084 |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1085 ``check`` |
26225
e257df7a9974
help/config: back out 5f2a1ebd6e78
Augie Fackler <augie@google.com>
parents:
26182
diff
changeset
|
1086 A list of merge success-checking options: |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1087 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1088 ``changed`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1089 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
|
1090 ``conflicts`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1091 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
|
1092 ``prompt`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1093 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
|
1094 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1095 ``fixeol`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1096 Attempt to fix up EOL changes caused by the merge tool. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1097 (default: False) |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1098 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1099 ``gui`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1100 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
|
1101 |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1102 ``regkey`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1103 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
|
1104 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
|
1105 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1106 (default: None) |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1107 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1108 ``regkeyalt`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1109 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
|
1110 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
|
1111 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
|
1112 is to search for 32bit applications on 64bit operating systems. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1113 (default: None) |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1114 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1115 ``regname`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1116 Name of value to read from specified registry key. |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1117 (default: the unnamed (default) value) |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1118 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1119 ``regappend`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1120 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
|
1121 the executable name of the tool. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1122 (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
|
1123 |
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 ``patch`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1126 --------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1127 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1128 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
|
1129 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
|
1130 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1131 ``eol`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1132 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
|
1133 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
|
1134 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
|
1135 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
|
1136 ``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
|
1137 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
|
1138 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
|
1139 of line, patch line endings are preserved. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1140 (default: strict) |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1141 |
25631
2748bf78a5bf
patch: add fuzz config flag (issue4697)
Matt Mackall <mpm@selenic.com>
parents:
25523
diff
changeset
|
1142 ``fuzz`` |
2748bf78a5bf
patch: add fuzz config flag (issue4697)
Matt Mackall <mpm@selenic.com>
parents:
25523
diff
changeset
|
1143 The number of lines of 'fuzz' to allow when applying patches. This |
2748bf78a5bf
patch: add fuzz config flag (issue4697)
Matt Mackall <mpm@selenic.com>
parents:
25523
diff
changeset
|
1144 controls how much context the patcher is allowed to ignore when |
2748bf78a5bf
patch: add fuzz config flag (issue4697)
Matt Mackall <mpm@selenic.com>
parents:
25523
diff
changeset
|
1145 trying to apply a patch. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1146 (default: 2) |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1147 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1148 ``paths`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1149 --------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1150 |
27266
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1151 Assigns symbolic names and behavior to repositories. |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1152 |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1153 Options are symbolic names defining the URL or directory that is the |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1154 location of the repository. Example:: |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1155 |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1156 [paths] |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1157 my_server = https://example.com/my_repo |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1158 local_path = /home/me/repo |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1159 |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1160 These symbolic names can be used from the command line. To pull |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1161 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``: |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1162 :hg:`push local_path`. |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1163 |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1164 Options containing colons (``:``) denote sub-options that can influence |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1165 behavior for that specific path. Example:: |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1166 |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1167 [paths] |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1168 my_server = https://example.com/my_path |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1169 my_server:pushurl = ssh://example.com/my_path |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1170 |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1171 The following sub-options can be defined: |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1172 |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1173 ``pushurl`` |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1174 The URL to use for push operations. If not defined, the location |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1175 defined by the path's main entry is used. |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1176 |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1177 The following special named paths exist: |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1178 |
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`` |
27266
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1180 The URL or directory to use when no source or remote is specified. |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1181 |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1182 :hg:`clone` will automatically define this path to the location the |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1183 repository was cloned from. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
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 ``default-push`` |
27266
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1186 (deprecated) The URL or directory for the default :hg:`push` location. |
4dccc37b87bd
ui: support declaring path push urls as sub-options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27246
diff
changeset
|
1187 ``default:pushurl`` should be used instead. |
17685
8fcef9614150
help: add example of paths other than default in hgrc
Juan Pablo Carbajal (desktop) <carbajal@ifi.uzh.ch>
parents:
17680
diff
changeset
|
1188 |
15999
76625324bd55
help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents:
15896
diff
changeset
|
1189 ``phases`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1190 ---------- |
15999
76625324bd55
help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents:
15896
diff
changeset
|
1191 |
16005
591f258ae630
help/config: fix help command markup
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
15999
diff
changeset
|
1192 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
|
1193 information about working with phases. |
76625324bd55
help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents:
15896
diff
changeset
|
1194 |
76625324bd55
help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents:
15896
diff
changeset
|
1195 ``publish`` |
76625324bd55
help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents:
15896
diff
changeset
|
1196 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
|
1197 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
|
1198 pulled or cloned changesets are set to public in the client. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1199 (default: True) |
15999
76625324bd55
help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents:
15896
diff
changeset
|
1200 |
76625324bd55
help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents:
15896
diff
changeset
|
1201 ``new-commit`` |
76625324bd55
help: add missing phase config items to config topic
Matt Mackall <mpm@selenic.com>
parents:
15896
diff
changeset
|
1202 Phase of newly-created commits. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1203 (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
|
1204 |
20176
4c96c50ef937
subrepo: check phase of state in each subrepositories before committing
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
20142
diff
changeset
|
1205 ``checksubrepos`` |
20333
fa6cb300ded4
help: improve description of phases.checksubrepos setting
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
20176
diff
changeset
|
1206 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
|
1207 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
|
1208 "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
|
1209 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
|
1210 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
|
1211 "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
|
1212 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
|
1213 used for the parent repository commit (if set to "follow"). |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1214 (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
|
1215 |
4c96c50ef937
subrepo: check phase of state in each subrepositories before committing
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
20142
diff
changeset
|
1216 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1217 ``profiling`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1218 ------------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1219 |
16392
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1220 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
|
1221 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
|
1222 profiler (named ``stat``). |
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1223 |
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1224 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
|
1225 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
|
1226 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
|
1227 profiling is done using lsprof. |
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1228 |
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1229 ``type`` |
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1230 The type of profiler to use. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1231 (default: ls) |
16392
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1232 |
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1233 ``ls`` |
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1234 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
|
1235 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
|
1236 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
|
1237 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
|
1238 ``stat`` |
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1239 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
|
1240 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
|
1241 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
|
1242 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1243 ``format`` |
16392
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1244 Profiling format. Specific to the ``ls`` instrumenting profiler. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1245 (default: text) |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1246 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1247 ``text`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1248 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
|
1249 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
|
1250 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
|
1251 ``kcachegrind`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1252 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
|
1253 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
|
1254 kcachegrind. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1255 |
16392
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1256 ``frequency`` |
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1257 Sampling frequency. Specific to the ``stat`` sampling profiler. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1258 (default: 1000) |
16392
ee3f423df1b4
dispatch: add support for statprof as a profiler
Bryan O'Sullivan <bryano@fb.com>
parents:
16391
diff
changeset
|
1259 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1260 ``output`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1261 File path where profiling data or report should be saved. If the |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1262 file exists, it is replaced. (default: None, data is printed on |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1263 stderr) |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1264 |
18502
68eecbaf1bd3
profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents:
18385
diff
changeset
|
1265 ``sort`` |
68eecbaf1bd3
profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents:
18385
diff
changeset
|
1266 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
|
1267 One of ``callcount``, ``reccallcount``, ``totaltime`` and |
68eecbaf1bd3
profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents:
18385
diff
changeset
|
1268 ``inlinetime``. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1269 (default: inlinetime) |
18502
68eecbaf1bd3
profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents:
18385
diff
changeset
|
1270 |
18548
e71c2ff93167
profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents:
18502
diff
changeset
|
1271 ``limit`` |
e71c2ff93167
profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents:
18502
diff
changeset
|
1272 Number of lines to show. Specific to the ``ls`` instrumenting profiler. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1273 (default: 30) |
18548
e71c2ff93167
profiling: introduce limit configuration option
Mads Kiilerich <madski@unity3d.com>
parents:
18502
diff
changeset
|
1274 |
18502
68eecbaf1bd3
profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents:
18385
diff
changeset
|
1275 ``nested`` |
18642
a40d608e2a7b
profiling: replace '+' markup of nested lines with indentation
Mads Kiilerich <mads@kiilerich.com>
parents:
18636
diff
changeset
|
1276 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
|
1277 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
|
1278 Specific to the ``ls`` instrumenting profiler. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1279 (default: 5) |
18502
68eecbaf1bd3
profiling: add documentation of lsprof 'sort' and 'nested'
Mads Kiilerich <madski@unity3d.com>
parents:
18385
diff
changeset
|
1280 |
25520
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1281 ``progress`` |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1282 ------------ |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1283 |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1284 Mercurial commands can draw progress bars that are as informative as |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1285 possible. Some progress bars only offer indeterminate information, while others |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1286 have a definite end point. |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1287 |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1288 ``delay`` |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1289 Number of seconds (float) before showing the progress bar. (default: 3) |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1290 |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1291 ``changedelay`` |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1292 Minimum delay before showing a new topic. When set to less than 3 * refresh, |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1293 that value will be used instead. (default: 1) |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1294 |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1295 ``refresh`` |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1296 Time in seconds between refreshes of the progress bar. (default: 0.1) |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1297 |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1298 ``format`` |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1299 Format of the progress bar. |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1300 |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1301 Valid entries for the format field are ``topic``, ``bar``, ``number``, |
27665
72a25271e294
help: use backticks for progress.format keywords, correct letter case
Anton Shestakov <av6@dwimlabs.net>
parents:
27657
diff
changeset
|
1302 ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the |
72a25271e294
help: use backticks for progress.format keywords, correct letter case
Anton Shestakov <av6@dwimlabs.net>
parents:
27657
diff
changeset
|
1303 last 20 characters of the item, but this can be changed by adding either |
72a25271e294
help: use backticks for progress.format keywords, correct letter case
Anton Shestakov <av6@dwimlabs.net>
parents:
27657
diff
changeset
|
1304 ``-<num>`` which would take the last num characters, or ``+<num>`` for the |
72a25271e294
help: use backticks for progress.format keywords, correct letter case
Anton Shestakov <av6@dwimlabs.net>
parents:
27657
diff
changeset
|
1305 first num characters. |
25520
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1306 |
27665
72a25271e294
help: use backticks for progress.format keywords, correct letter case
Anton Shestakov <av6@dwimlabs.net>
parents:
27657
diff
changeset
|
1307 (default: topic bar number estimate) |
25520
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1308 |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1309 ``width`` |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1310 If set, the maximum width of the progress information (that is, min(width, |
26177 | 1311 term width) will be used). |
25520
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1312 |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1313 ``clear-complete`` |
26278 | 1314 Clear the progress bar after it's done. (default: True) |
25520
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1315 |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1316 ``disable`` |
26177 | 1317 If true, don't show a progress bar. |
25520
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1318 |
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1319 ``assume-tty`` |
26177 | 1320 If true, ALWAYS show a progress bar, unless disable is given. |
25520
c8fada8d9db9
progress: move config help into core config help
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
25430
diff
changeset
|
1321 |
14691
b1efd75cdafe
help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
14661
diff
changeset
|
1322 ``revsetalias`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1323 --------------- |
14691
b1efd75cdafe
help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
14661
diff
changeset
|
1324 |
b1efd75cdafe
help/config: mention [revsetalias] section
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
14661
diff
changeset
|
1325 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
|
1326 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1327 ``server`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1328 ---------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1329 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1330 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
|
1331 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1332 ``uncompressed`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1333 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
|
1334 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
|
1335 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
|
1336 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
|
1337 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
|
1338 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
|
1339 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
|
1340 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
|
1341 the write lock while determining what data to transfer. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1342 (default: True) |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1343 |
16361
6097ede2be4d
protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents:
16140
diff
changeset
|
1344 ``preferuncompressed`` |
6097ede2be4d
protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents:
16140
diff
changeset
|
1345 When set, clients will try to use the uncompressed streaming |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1346 protocol. (default: False) |
16361
6097ede2be4d
protocol: Add the stream-preferred capability
Benoit Allard <benoit@aeteurope.nl>
parents:
16140
diff
changeset
|
1347 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1348 ``validate`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1349 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
|
1350 checking that all new file revisions specified in manifests are |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1351 present. (default: False) |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1352 |
25691
5cda0ce05c42
wireproto: add config knob for http header length limit
Mike Edgar <adgar@google.com>
parents:
25649
diff
changeset
|
1353 ``maxhttpheaderlen`` |
5cda0ce05c42
wireproto: add config knob for http header length limit
Mike Edgar <adgar@google.com>
parents:
25649
diff
changeset
|
1354 Instruct HTTP clients not to send request headers longer than this |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1355 many bytes. (default: 1024) |
25691
5cda0ce05c42
wireproto: add config knob for http header length limit
Mike Edgar <adgar@google.com>
parents:
25649
diff
changeset
|
1356 |
27246
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1357 ``bundle1`` |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1358 Whether to allow clients to push and pull using the legacy bundle1 |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1359 exchange format. (default: True) |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1360 |
27633
37d7cf569cf3
wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27607
diff
changeset
|
1361 ``bundle1gd`` |
27683
76fc5ac23473
help: fix quoting for bundle1 options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27665
diff
changeset
|
1362 Like ``bundle1`` but only used if the repository is using the |
27633
37d7cf569cf3
wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27607
diff
changeset
|
1363 *generaldelta* storage format. (default: True) |
37d7cf569cf3
wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27607
diff
changeset
|
1364 |
27246
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1365 ``bundle1.push`` |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1366 Whether to allow clients to push using the legacy bundle1 exchange |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1367 format. (default: True) |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1368 |
27633
37d7cf569cf3
wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27607
diff
changeset
|
1369 ``bundle1gd.push`` |
27683
76fc5ac23473
help: fix quoting for bundle1 options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27665
diff
changeset
|
1370 Like ``bundle1.push`` but only used if the repository is using the |
27633
37d7cf569cf3
wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27607
diff
changeset
|
1371 *generaldelta* storage format. (default: True) |
37d7cf569cf3
wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27607
diff
changeset
|
1372 |
27246
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1373 ``bundle1.pull`` |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1374 Whether to allow clients to pull using the legacy bundle1 exchange |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1375 format. (default: True) |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1376 |
27633
37d7cf569cf3
wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27607
diff
changeset
|
1377 ``bundle1gd.pull`` |
27683
76fc5ac23473
help: fix quoting for bundle1 options
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27665
diff
changeset
|
1378 Like ``bundle1.pull`` but only used if the repository is using the |
27633
37d7cf569cf3
wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27607
diff
changeset
|
1379 *generaldelta* storage format. (default: True) |
37d7cf569cf3
wireproto: support disabling bundle1 only if repo is generaldelta
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27607
diff
changeset
|
1380 |
27246
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1381 Large repositories using the *generaldelta* storage format should |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1382 consider setting this option because converting *generaldelta* |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1383 repositories to the exchange format required by the bundle1 data |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1384 format can consume a lot of CPU. |
b288fb2724bf
wireproto: config options to disable bundle1
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27216
diff
changeset
|
1385 |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1386 ``smtp`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1387 -------- |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1388 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1389 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
|
1390 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1391 ``host`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1392 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
|
1393 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1394 ``port`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1395 Optional. Port to connect to on mail server. (default: 465 if |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1396 ``tls`` is smtps; 25 otherwise) |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1397 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1398 ``tls`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1399 Optional. Method to enable TLS when connecting to mail server: starttls, |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1400 smtps or none. (default: none) |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1401 |
18888
19d489404d79
smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
18734
diff
changeset
|
1402 ``verifycert`` |
19d489404d79
smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
18734
diff
changeset
|
1403 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
|
1404 ``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
|
1405 "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
|
1406 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
|
1407 ``[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
|
1408 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
|
1409 ``[hostfingerprints]`` and ``[web] cacerts``. --insecure for |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1410 :hg:`email` overwrites this as "loose". (default: strict) |
18888
19d489404d79
smtp: verify the certificate of the SMTP server for STARTTLS/SMTPS
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
18734
diff
changeset
|
1411 |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1412 ``username`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1413 Optional. User name for authenticating with the SMTP server. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1414 (default: None) |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1415 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1416 ``password`` |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1417 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
|
1418 specified, interactive sessions will prompt the user for a |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1419 password; non-interactive sessions will fail. (default: None) |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1420 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1421 ``local_hostname`` |
26180
b1caa076fc3b
help/config: change local_hostname help style
timeless@mozdev.org
parents:
26179
diff
changeset
|
1422 Optional. The hostname that the sender can use to identify |
16140
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1423 itself to the MTA. |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1424 |
dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
Michal Sznajder <michalsznajder@gmail.com>
parents:
16139
diff
changeset
|
1425 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1426 ``subpaths`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1427 ------------ |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1428 |
16549
517b25608ad6
help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents:
16513
diff
changeset
|
1429 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
|
1430 or becomes temporarily unavailable. This section lets you define |
517b25608ad6
help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents:
16513
diff
changeset
|
1431 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
|
1432 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1433 <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
|
1434 |
16549
517b25608ad6
help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents:
16513
diff
changeset
|
1435 where ``pattern`` is a regular expression matching a subrepository |
517b25608ad6
help/config: expand [subpaths] help
Martin Geisler <mg@aragost.com>
parents:
16513
diff
changeset
|
1436 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
|
1437 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
|
1438 ``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
|
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 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
|
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 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
|
1443 |
17251
98166640b356
help: fix some instances of 'the the'
Mads Kiilerich <mads@kiilerich.com>
parents:
17202
diff
changeset
|
1444 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
|
1445 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
|
1446 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
|
1447 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1448 ``trusted`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1449 ----------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1450 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1451 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
|
1452 ``.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
|
1453 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
|
1454 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
|
1455 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
|
1456 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
|
1457 section. |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1458 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1459 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
|
1460 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
|
1461 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
|
1462 *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
|
1463 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
|
1464 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1465 ``users`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1466 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
|
1467 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1468 ``groups`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1469 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
|
1470 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1471 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1472 ``ui`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1473 ------ |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1474 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1475 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
|
1476 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1477 ``archivemeta`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1478 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
|
1479 (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
|
1480 by the :hg:`archive` command or downloaded via hgweb. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1481 (default: True) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1482 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1483 ``askusername`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1484 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
|
1485 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
|
1486 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
|
1487 default ``USER@HOST`` is used instead. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1488 (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1489 |
27738
a0e783d26e81
exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27737
diff
changeset
|
1490 ``clonebundles`` |
a0e783d26e81
exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27737
diff
changeset
|
1491 Whether the "clone bundles" feature is enabled. |
a0e783d26e81
exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27737
diff
changeset
|
1492 |
a0e783d26e81
exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27737
diff
changeset
|
1493 When enabled, :hg:`clone` may download and apply a server-advertised |
a0e783d26e81
exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27737
diff
changeset
|
1494 bundle file from a URL instead of using the normal exchange mechanism. |
a0e783d26e81
exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27737
diff
changeset
|
1495 |
a0e783d26e81
exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27737
diff
changeset
|
1496 This can likely result in faster and more reliable clones. |
a0e783d26e81
exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27737
diff
changeset
|
1497 |
a0e783d26e81
exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27737
diff
changeset
|
1498 (default: True) |
a0e783d26e81
exchange: make clone bundles non-experimental and enabled by default
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27737
diff
changeset
|
1499 |
26623
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1500 ``clonebundlefallback`` |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1501 Whether failure to apply an advertised "clone bundle" from a server |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1502 should result in fallback to a regular clone. |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1503 |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1504 This is disabled by default because servers advertising "clone |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1505 bundles" often do so to reduce server load. If advertised bundles |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1506 start mass failing and clients automatically fall back to a regular |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1507 clone, this would add significant and unexpected load to the server |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1508 since the server is expecting clone operations to be offloaded to |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1509 pre-generated bundles. Failing fast (the default behavior) ensures |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1510 clients don't overwhelm the server when "clone bundle" application |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1511 fails. |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1512 |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1513 (default: False) |
5a95fe44121d
clonebundles: support for seeding clones from pre-generated bundles
Gregory Szorc <gregory.szorc@gmail.com>
parents:
26421
diff
changeset
|
1514 |
27737
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1515 ``clonebundleprefers`` |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1516 Defines preferences for which "clone bundles" to use. |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1517 |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1518 Servers advertising "clone bundles" may advertise multiple available |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1519 bundles. Each bundle may have different attributes, such as the bundle |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1520 type and compression format. This option is used to prefer a particular |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1521 bundle over another. |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1522 |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1523 The following keys are defined by Mercurial: |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1524 |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1525 BUNDLESPEC |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1526 A bundle type specifier. These are strings passed to :hg:`bundle -t`. |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1527 e.g. ``gzip-v2`` or ``bzip2-v1``. |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1528 |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1529 COMPRESSION |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1530 The compression format of the bundle. e.g. ``gzip`` and ``bzip2``. |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1531 |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1532 Server operators may define custom keys. |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1533 |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1534 Example values: ``COMPRESSION=bzip2``, |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1535 ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``. |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1536 |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1537 By default, the first bundle advertised by the server is used. |
482eb357fe98
exchange: make clonebundleprefers non-experimental
Gregory Szorc <gregory.szorc@gmail.com>
parents:
27683
diff
changeset
|
1538 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1539 ``commitsubrepos`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1540 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
|
1541 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
|
1542 changes, abort the commit. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1543 (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1544 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1545 ``debug`` |
26279 | 1546 Print debugging information. (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1547 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1548 ``editor`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1549 The editor to use during a commit. (default: ``$EDITOR`` or ``vi``) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1550 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1551 ``fallbackencoding`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1552 Encoding to try if it's not possible to decode the changelog using |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1553 UTF-8. (default: ISO-8859-1) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1554 |
27216
8117e2cd959e
graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents:
27093
diff
changeset
|
1555 ``graphnodetemplate`` |
8117e2cd959e
graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents:
27093
diff
changeset
|
1556 The template used to print changeset nodes in an ASCII revision graph. |
8117e2cd959e
graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents:
27093
diff
changeset
|
1557 (default: ``{graphnode}``) |
8117e2cd959e
graphlog: make node symbol templatable by ui.graphnodetemplate option
Yuya Nishihara <yuya@tcha.org>
parents:
27093
diff
changeset
|
1558 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1559 ``ignore`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1560 A file to read per-user ignore patterns from. This file should be |
23629
a04c7b74b3d5
ignore: resolve ignore files relative to repo root (issue4473) (BC)
Siddharth Agarwal <sid0@fb.com>
parents:
23297
diff
changeset
|
1561 in the same format as a repository-wide .hgignore file. Filenames |
a04c7b74b3d5
ignore: resolve ignore files relative to repo root (issue4473) (BC)
Siddharth Agarwal <sid0@fb.com>
parents:
23297
diff
changeset
|
1562 are relative to the repository root. This option supports hook syntax, |
a04c7b74b3d5
ignore: resolve ignore files relative to repo root (issue4473) (BC)
Siddharth Agarwal <sid0@fb.com>
parents:
23297
diff
changeset
|
1563 so if you want to specify multiple ignore files, you can do so by |
a04c7b74b3d5
ignore: resolve ignore files relative to repo root (issue4473) (BC)
Siddharth Agarwal <sid0@fb.com>
parents:
23297
diff
changeset
|
1564 setting something like ``ignore.other = ~/.hgignore2``. For details |
a04c7b74b3d5
ignore: resolve ignore files relative to repo root (issue4473) (BC)
Siddharth Agarwal <sid0@fb.com>
parents:
23297
diff
changeset
|
1565 of the ignore file 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
|
1566 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1567 ``interactive`` |
26279 | 1568 Allow to prompt the user. (default: True) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1569 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1570 ``logtemplate`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1571 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
|
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 ``merge`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1574 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
|
1575 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
|
1576 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
|
1577 |
21519
25d5a9ecbb85
merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents:
21403
diff
changeset
|
1578 ``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
|
1579 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
|
1580 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
|
1581 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
|
1582 One of ``basic`` or ``detailed``. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1583 (default: ``basic``) |
21519
25d5a9ecbb85
merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents:
21403
diff
changeset
|
1584 |
25d5a9ecbb85
merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents:
21403
diff
changeset
|
1585 ``mergemarkertemplate`` |
25d5a9ecbb85
merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents:
21403
diff
changeset
|
1586 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
|
1587 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
|
1588 format. |
26172 | 1589 |
21519
25d5a9ecbb85
merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents:
21403
diff
changeset
|
1590 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
|
1591 the first line of the commit description. |
26172 | 1592 |
24536
d09262d6ec23
filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents:
23629
diff
changeset
|
1593 If you use non-ASCII characters in names for tags, branches, bookmarks, |
d09262d6ec23
filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents:
23629
diff
changeset
|
1594 authors, and/or commit descriptions, you must pay attention to encodings of |
d09262d6ec23
filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents:
23629
diff
changeset
|
1595 managed files. At template expansion, non-ASCII characters use the encoding |
d09262d6ec23
filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents:
23629
diff
changeset
|
1596 specified by the ``--encoding`` global option, ``HGENCODING`` or other |
d09262d6ec23
filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents:
23629
diff
changeset
|
1597 environment variables that govern your locale. If the encoding of the merge |
d09262d6ec23
filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents:
23629
diff
changeset
|
1598 markers is different from the encoding of the merged files, |
d09262d6ec23
filemerge: clean up language in mergemarkertemplate help
Nathan Goldbaum <ngoldbau@ucsc.edu>
parents:
23629
diff
changeset
|
1599 serious problems may occur. |
21519
25d5a9ecbb85
merge: add conflict marker formatter (BC)
Durham Goode <durham@fb.com>
parents:
21403
diff
changeset
|
1600 |
26937
dda0aa3baedd
cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents:
26907
diff
changeset
|
1601 ``origbackuppath`` |
dda0aa3baedd
cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents:
26907
diff
changeset
|
1602 The path to a directory used to store generated .orig files. If the path is |
dda0aa3baedd
cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents:
26907
diff
changeset
|
1603 not a directory, one will be created. |
dda0aa3baedd
cmdutil: add origbackuppath helper
Christian Delahousse <cdelahousse@fb.com>
parents:
26907
diff
changeset
|
1604 |
25649
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1605 ``patch`` |
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1606 An optional external tool that ``hg import`` and some extensions |
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1607 will use for applying patches. By default Mercurial uses an |
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1608 internal patch utility. The external tool must work as the common |
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1609 Unix ``patch`` program. In particular, it must accept a ``-p`` |
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1610 argument to strip patch headers, a ``-d`` argument to specify the |
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1611 current directory, a file name to patch, and a patch file to take |
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1612 from stdin. |
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1613 |
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1614 It is possible to specify a patch tool together with extra |
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1615 arguments. For example, setting this option to ``patch --merge`` |
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1616 will use the ``patch`` program with its 2-way merge option. |
e90e031b3016
doc: document the ui.patch option
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
25631
diff
changeset
|
1617 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1618 ``portablefilenames`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1619 Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1620 (default: ``warn``) |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1621 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
|
1622 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
|
1623 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
|
1624 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
|
1625 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
|
1626 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
|
1627 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
|
1628 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
|
1629 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1630 ``quiet`` |
26279 | 1631 Reduce the amount of output printed. (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1632 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1633 ``remotecmd`` |
26278 | 1634 Remote command to use for clone/push/pull operations. (default: ``hg``) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1635 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1636 ``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
|
1637 Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a |
26279 | 1638 trusted user or group. (default: True) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1639 |
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 ``slash`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1641 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
|
1642 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
|
1643 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
|
1644 backslash character (``\``)). |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1645 (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1646 |
24663
7d01371e6358
commands: add ui.statuscopies config knob
Mathias De Maré <mathias.demare@gmail.com>
parents:
24542
diff
changeset
|
1647 ``statuscopies`` |
7d01371e6358
commands: add ui.statuscopies config knob
Mathias De Maré <mathias.demare@gmail.com>
parents:
24542
diff
changeset
|
1648 Display copies in the status command. |
7d01371e6358
commands: add ui.statuscopies config knob
Mathias De Maré <mathias.demare@gmail.com>
parents:
24542
diff
changeset
|
1649 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1650 ``ssh`` |
26278 | 1651 Command to use for SSH connections. (default: ``ssh``) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1652 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1653 ``strict`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1654 Require exact command names, instead of allowing unambiguous |
26279 | 1655 abbreviations. (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1656 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1657 ``style`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1658 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
|
1659 |
26263
bf2bfc6f45fb
traceback: allow providing a local support contact point
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
26225
diff
changeset
|
1660 ``supportcontact`` |
26313
e8afd380c576
help: copy-edit description of ui.supportcontact
Kevin Bullock <kbullock@ringworld.org>
parents:
26282
diff
changeset
|
1661 A URL where users should report a Mercurial traceback. Use this if you are a |
e8afd380c576
help: copy-edit description of ui.supportcontact
Kevin Bullock <kbullock@ringworld.org>
parents:
26282
diff
changeset
|
1662 large organisation with its own Mercurial deployment process and crash |
e8afd380c576
help: copy-edit description of ui.supportcontact
Kevin Bullock <kbullock@ringworld.org>
parents:
26282
diff
changeset
|
1663 reports should be addressed to your internal support. |
26263
bf2bfc6f45fb
traceback: allow providing a local support contact point
Pierre-Yves David <pierre-yves.david@fb.com>
parents:
26225
diff
changeset
|
1664 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1665 ``timeout`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1666 The timeout used when a lock is held (in seconds), a negative value |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1667 means no timeout. (default: 600) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1668 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1669 ``traceback`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1670 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
|
1671 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
|
1672 on all exceptions, even those recognized by Mercurial (such as |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1673 IOError or MemoryError). (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1674 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1675 ``username`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1676 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
|
1677 Typically a person's name and email address, e.g. ``Fred Widget |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1678 <fred@example.com>``. Environment variables in 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
|
1679 username are expanded. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1680 |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1681 (default: ``$EMAIL`` or ``username@hostname``. If the username in |
27552
20589d3bda6d
help: remove stray double spaces from config help
timeless <timeless@mozdev.org>
parents:
27551
diff
changeset
|
1682 hgrc is empty, e.g. if the system admin set ``username =`` in the |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1683 system hgrc, it has to be specified manually or in a different |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1684 hgrc file) |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1685 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1686 ``verbose`` |
26279 | 1687 Increase the amount of output printed. (default: False) |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1688 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1689 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1690 ``web`` |
17267
979b107eaea2
doc: unify section level between help topics
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
17251
diff
changeset
|
1691 ------- |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1692 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1693 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
|
1694 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
|
1695 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
|
1696 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
|
1697 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1698 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
|
1699 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
|
1700 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
|
1701 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
|
1702 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
|
1703 checks. |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1704 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1705 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
|
1706 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
|
1707 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
|
1708 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1709 $ 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
|
1710 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1711 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
|
1712 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
|
1713 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1714 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
|
1715 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1716 ``accesslog`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1717 Where to output the access log. (default: stdout) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1718 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1719 ``address`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1720 Interface address to bind to. (default: all) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1721 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1722 ``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
|
1723 List of archive format (bz2, gz, zip) allowed for downloading. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1724 (default: empty) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1725 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1726 ``allowbz2`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1727 (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
|
1728 revisions. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1729 (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1730 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1731 ``allowgz`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1732 (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
|
1733 revisions. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1734 (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1735 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1736 ``allowpull`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1737 Whether to allow pulling from the repository. (default: True) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1738 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1739 ``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
|
1740 Whether to allow pushing to the repository. If empty or not set, |
26181
c16f071f048e
help/config: reword allow_push to fix grammar
timeless@mozdev.org
parents:
26180
diff
changeset
|
1741 pushing is not allowed. If the special value ``*``, any remote |
c16f071f048e
help/config: reword allow_push to fix grammar
timeless@mozdev.org
parents:
26180
diff
changeset
|
1742 user can push, including unauthenticated users. Otherwise, the |
c16f071f048e
help/config: reword allow_push to fix grammar
timeless@mozdev.org
parents:
26180
diff
changeset
|
1743 remote user must have been authenticated, and the authenticated |
c16f071f048e
help/config: reword allow_push to fix grammar
timeless@mozdev.org
parents:
26180
diff
changeset
|
1744 user name must be present in this list. The contents of the |
c16f071f048e
help/config: reword allow_push to fix grammar
timeless@mozdev.org
parents:
26180
diff
changeset
|
1745 allow_push list are 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
|
1746 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1747 ``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
|
1748 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
|
1749 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
|
1750 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
|
1751 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
|
1752 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
|
1753 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
|
1754 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
|
1755 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
|
1756 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
|
1757 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1758 ``allowzip`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1759 (DEPRECATED) Whether to allow .zip downloading of repository |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1760 revisions. This feature creates temporary files. |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1761 (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1762 |
17933
8243dd66e0e3
webcommands: allow hgweb's archive to recurse into subrepos
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
17685
diff
changeset
|
1763 ``archivesubrepos`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1764 Whether to recurse into subrepositories when archiving. |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1765 (default: False) |
17933
8243dd66e0e3
webcommands: allow hgweb's archive to recurse into subrepos
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
17685
diff
changeset
|
1766 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1767 ``baseurl`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1768 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
|
1769 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
|
1770 URLs. Example: ``http://hgserver/repos/``. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1771 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1772 ``cacerts`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1773 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
|
1774 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
|
1775 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
|
1776 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
|
1777 with these certificates. |
7416ce2c7887
help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents:
16392
diff
changeset
|
1778 |
7416ce2c7887
help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents:
16392
diff
changeset
|
1779 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
|
1780 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
|
1781 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
|
1782 ``http://pypi.python.org``. |
7416ce2c7887
help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents:
16392
diff
changeset
|
1783 |
7416ce2c7887
help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents:
16392
diff
changeset
|
1784 To disable SSL verification temporarily, specify ``--insecure`` from |
7416ce2c7887
help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents:
16392
diff
changeset
|
1785 command line. |
7416ce2c7887
help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents:
16392
diff
changeset
|
1786 |
7416ce2c7887
help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents:
16392
diff
changeset
|
1787 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
|
1788 one. On most Linux systems this will be |
7416ce2c7887
help: fix indentation on cacert (issue3350)
Matt Mackall <mpm@selenic.com>
parents:
16392
diff
changeset
|
1789 ``/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
|
1790 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
|
1791 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1792 -----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
|
1793 ... (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
|
1794 -----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
|
1795 -----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
|
1796 ... (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
|
1797 -----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
|
1798 |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1799 ``cache`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1800 Whether to support caching in hgweb. (default: True) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1801 |
25853
81802d1355ac
hgweb: document web.certificates option
Matt Mackall <mpm@selenic.com>
parents:
25691
diff
changeset
|
1802 ``certificate`` |
81802d1355ac
hgweb: document web.certificates option
Matt Mackall <mpm@selenic.com>
parents:
25691
diff
changeset
|
1803 Certificate to use when running :hg:`serve`. |
81802d1355ac
hgweb: document web.certificates option
Matt Mackall <mpm@selenic.com>
parents:
25691
diff
changeset
|
1804 |
16570
63f10a163017
help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents:
16549
diff
changeset
|
1805 ``collapse`` |
63f10a163017
help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents:
16549
diff
changeset
|
1806 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
|
1807 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
|
1808 ``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
|
1809 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
|
1810 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
|
1811 collapses each collection of repositories found within a subdirectory |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1812 into a single entry for that subdirectory. (default: False) |
16570
63f10a163017
help: added description for the web.collapse setting
Paul Boddie <paul@boddie.org.uk>
parents:
16549
diff
changeset
|
1813 |
17316
8cf995a6dcb0
help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents:
17267
diff
changeset
|
1814 ``comparisoncontext`` |
8cf995a6dcb0
help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents:
17267
diff
changeset
|
1815 Number of lines of context to show in side-by-side file comparison. If |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1816 negative or the value ``full``, whole files are shown. (default: 5) |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1817 |
17316
8cf995a6dcb0
help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents:
17267
diff
changeset
|
1818 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
|
1819 ``comparison`` command, taking the same values. |
8cf995a6dcb0
help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents:
17267
diff
changeset
|
1820 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1821 ``contact`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1822 Name or email address of the person in charge of the repository. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1823 (default: 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
|
1824 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1825 ``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
|
1826 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
|
1827 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
|
1828 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
|
1829 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
|
1830 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
|
1831 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1832 ``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
|
1833 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
|
1834 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
|
1835 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
|
1836 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
|
1837 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
|
1838 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
|
1839 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
|
1840 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
|
1841 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
|
1842 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
|
1843 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
|
1844 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
|
1845 list. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1846 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1847 ``descend`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1848 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
|
1849 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
|
1850 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
|
1851 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1852 ``description`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1853 Textual description of the repository's purpose or contents. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1854 (default: "unknown") |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1855 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1856 ``encoding`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1857 Character encoding name. (default: the current locale charset) |
26177 | 1858 Example: "UTF-8". |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1859 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1860 ``errorlog`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1861 Where to output the error log. (default: stderr) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1862 |
17316
8cf995a6dcb0
help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents:
17267
diff
changeset
|
1863 ``guessmime`` |
8cf995a6dcb0
help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents:
17267
diff
changeset
|
1864 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
|
1865 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
|
1866 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
|
1867 allow cross-site scripting attacks when serving untrusted |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1868 repositories. (default: False) |
17202
1ae119269ddc
hgweb: side-by-side comparison functionality
wujek srujek
parents:
16585
diff
changeset
|
1869 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1870 ``hidden`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1871 Whether to hide the repository in the hgwebdir index. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1872 (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1873 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1874 ``ipv6`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1875 Whether to use IPv6. (default: False) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1876 |
14938
ec18cd254156
help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
14891
diff
changeset
|
1877 ``logoimg`` |
ec18cd254156
help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
14891
diff
changeset
|
1878 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
|
1879 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
|
1880 the logo image is "staticurl/logoimg". |
ec18cd254156
help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
14891
diff
changeset
|
1881 If unset, ``hglogo.png`` will be used. |
ec18cd254156
help: add "web/logoimg" setting description
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
14891
diff
changeset
|
1882 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1883 ``logourl`` |
26421
4b0fc75f9403
urls: bulk-change primary website URLs
Matt Mackall <mpm@selenic.com>
parents:
26365
diff
changeset
|
1884 Base URL to use for logos. If unset, ``https://mercurial-scm.org/`` |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1885 will be used. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1886 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1887 ``maxchanges`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1888 Maximum number of changes to list on the changelog. (default: 10) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1889 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1890 ``maxfiles`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1891 Maximum number of files to list per changeset. (default: 10) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1892 |
17317
0b8272274b56
help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents:
17316
diff
changeset
|
1893 ``maxshortchanges`` |
0b8272274b56
help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents:
17316
diff
changeset
|
1894 Maximum number of changes to list on the shortlog, graph or filelog |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1895 pages. (default: 60) |
17317
0b8272274b56
help/config.txt: document web.maxshortchanges
Patrick Mezard <patrick@mezard.eu>
parents:
17316
diff
changeset
|
1896 |
17316
8cf995a6dcb0
help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents:
17267
diff
changeset
|
1897 ``name`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1898 Repository name to use in the web interface. |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1899 (default: current working directory) |
17316
8cf995a6dcb0
help/config.txt: reorder [web] options
Patrick Mezard <patrick@mezard.eu>
parents:
17267
diff
changeset
|
1900 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1901 ``port`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1902 Port to listen on. (default: 8000) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1903 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1904 ``prefix`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1905 Prefix path to serve from. (default: '' (server root)) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1906 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1907 ``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
|
1908 Whether to require that inbound pushes be transported over SSL to |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1909 prevent password sniffing. (default: True) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1910 |
26072
06320fb11699
hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents:
25853
diff
changeset
|
1911 ``refreshinterval`` |
06320fb11699
hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents:
25853
diff
changeset
|
1912 How frequently directory listings re-scan the filesystem for new |
06320fb11699
hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents:
25853
diff
changeset
|
1913 repositories, in seconds. This is relevant when wildcards are used |
06320fb11699
hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents:
25853
diff
changeset
|
1914 to define paths. Depending on how much filesystem traversal is |
06320fb11699
hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents:
25853
diff
changeset
|
1915 required, refreshing may negatively impact performance. |
06320fb11699
hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents:
25853
diff
changeset
|
1916 |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1917 Values less than or equal to 0 always refresh. |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1918 (default: 20) |
26072
06320fb11699
hgweb: make refresh interval configurable
Gregory Szorc <gregory.szorc@gmail.com>
parents:
25853
diff
changeset
|
1919 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1920 ``staticurl`` |
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1921 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
|
1922 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
|
1923 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
|
1924 Example: ``http://hgserver/static/``. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1925 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1926 ``stripes`` |
17424
e7cfe3587ea4
fix trivial spelling errors
Mads Kiilerich <mads@kiilerich.com>
parents:
17317
diff
changeset
|
1927 How many lines a "zebra stripe" should span in multi-line output. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1928 Set to 0 to disable. (default: 1) |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1929 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1930 ``style`` |
22549
b1fc7ea5bb01
help: update help for hgweb template and style (issue4373)
Arun Chandrasekaran <visionofarun@gmail.com>
parents:
22252
diff
changeset
|
1931 Which template map style to use. The available options are the names of |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1932 subdirectories in the HTML templates path. (default: ``paper``) |
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1933 Example: ``monoblue``. |
14458
c62b3b74f1d2
help/config: separate terms with a blank line
Martin Geisler <mg@lazybytes.net>
parents:
14457
diff
changeset
|
1934 |
14456
ff4126ce9301
help: move part of hgrc.5 man page config help topic
Yun Lee <yun.lee.bj@gmail.com>
parents:
13955
diff
changeset
|
1935 ``templates`` |
22549
b1fc7ea5bb01
help: update help for hgweb template and style (issue4373)
Arun Chandrasekaran <visionofarun@gmail.com>
parents:
22252
diff
changeset
|
1936 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
|
1937 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
|
1938 |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1939 ``websub`` |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1940 ---------- |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1941 |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1942 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
|
1943 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
|
1944 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
|
1945 |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1946 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
|
1947 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
|
1948 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
|
1949 "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
|
1950 |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1951 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
|
1952 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
|
1953 HTML (see the examples below). |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1954 |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1955 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
|
1956 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
|
1957 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
|
1958 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
|
1959 |
18958
c3b920980f22
spelling: fix typos and spelling errors
Mads Kiilerich <madski@unity3d.com>
parents:
18888
diff
changeset
|
1960 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
|
1961 |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1962 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
|
1963 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
|
1964 |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1965 Examples:: |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1966 |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1967 [websub] |
52305554fd6e
hgweb: apply the websub filter to revision descriptions
Angel Ezquerra <angel.ezquerra@gmail.com>
parents:
18548
diff
changeset
|
1968 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
|
1969 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
|
1970 bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/ |
18652 | 1971 |
18636
dcb27c153a40
worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents:
18548
diff
changeset
|
1972 ``worker`` |
dcb27c153a40
worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents:
18548
diff
changeset
|
1973 ---------- |
dcb27c153a40
worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents:
18548
diff
changeset
|
1974 |
dcb27c153a40
worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents:
18548
diff
changeset
|
1975 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
|
1976 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
|
1977 helps performance. |
dcb27c153a40
worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents:
18548
diff
changeset
|
1978 |
dcb27c153a40
worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents:
18548
diff
changeset
|
1979 ``numcpus`` |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1980 Number of CPUs to use for parallel operations. A zero or |
18636
dcb27c153a40
worker: estimate whether it's worth running a task in parallel
Bryan O'Sullivan <bryano@fb.com>
parents:
18548
diff
changeset
|
1981 negative value is treated as ``use the default``. |
26182
6832ba528d1a
help/config: make defaults consistent
timeless@mozdev.org
parents:
26181
diff
changeset
|
1982 (default: 4 or the number of CPUs on the system, whichever is larger) |