Show More
@@ -1,3204 +1,3205 b'' | |||||
1 | The Mercurial system uses a set of configuration files to control |
|
1 | The Mercurial system uses a set of configuration files to control | |
2 | aspects of its behavior. |
|
2 | aspects of its behavior. | |
3 |
|
3 | |||
4 | Troubleshooting |
|
4 | Troubleshooting | |
5 | =============== |
|
5 | =============== | |
6 |
|
6 | |||
7 | If you're having problems with your configuration, |
|
7 | If you're having problems with your configuration, | |
8 | :hg:`config --source` can help you understand what is introducing |
|
8 | :hg:`config --source` can help you understand what is introducing | |
9 | a setting into your environment. |
|
9 | a setting into your environment. | |
10 |
|
10 | |||
11 | See :hg:`help config.syntax` and :hg:`help config.files` |
|
11 | See :hg:`help config.syntax` and :hg:`help config.files` | |
12 | for information about how and where to override things. |
|
12 | for information about how and where to override things. | |
13 |
|
13 | |||
14 | Structure |
|
14 | Structure | |
15 | ========= |
|
15 | ========= | |
16 |
|
16 | |||
17 | The configuration files use a simple ini-file format. A configuration |
|
17 | The configuration files use a simple ini-file format. A configuration | |
18 | file consists of sections, led by a ``[section]`` header and followed |
|
18 | file consists of sections, led by a ``[section]`` header and followed | |
19 | by ``name = value`` entries:: |
|
19 | by ``name = value`` entries:: | |
20 |
|
20 | |||
21 | [ui] |
|
21 | [ui] | |
22 | username = Firstname Lastname <firstname.lastname@example.net> |
|
22 | username = Firstname Lastname <firstname.lastname@example.net> | |
23 | verbose = True |
|
23 | verbose = True | |
24 |
|
24 | |||
25 | The above entries will be referred to as ``ui.username`` and |
|
25 | The above entries will be referred to as ``ui.username`` and | |
26 | ``ui.verbose``, respectively. See :hg:`help config.syntax`. |
|
26 | ``ui.verbose``, respectively. See :hg:`help config.syntax`. | |
27 |
|
27 | |||
28 | Files |
|
28 | Files | |
29 | ===== |
|
29 | ===== | |
30 |
|
30 | |||
31 | Mercurial reads configuration data from several files, if they exist. |
|
31 | Mercurial reads configuration data from several files, if they exist. | |
32 | These files do not exist by default and you will have to create the |
|
32 | These files do not exist by default and you will have to create the | |
33 | appropriate configuration files yourself: |
|
33 | appropriate configuration files yourself: | |
34 |
|
34 | |||
35 | Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file. |
|
35 | Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file. | |
36 |
|
36 | |||
37 | Global configuration like the username setting is typically put into: |
|
37 | Global configuration like the username setting is typically put into: | |
38 |
|
38 | |||
39 | .. container:: windows |
|
39 | .. container:: windows | |
40 |
|
40 | |||
41 | - ``%USERPROFILE%\mercurial.ini`` (on Windows) |
|
41 | - ``%USERPROFILE%\mercurial.ini`` (on Windows) | |
42 |
|
42 | |||
43 | .. container:: unix.plan9 |
|
43 | .. container:: unix.plan9 | |
44 |
|
44 | |||
45 | - ``$HOME/.hgrc`` (on Unix, Plan9) |
|
45 | - ``$HOME/.hgrc`` (on Unix, Plan9) | |
46 |
|
46 | |||
47 | The names of these files depend on the system on which Mercurial is |
|
47 | The names of these files depend on the system on which Mercurial is | |
48 | installed. ``*.rc`` files from a single directory are read in |
|
48 | installed. ``*.rc`` files from a single directory are read in | |
49 | alphabetical order, later ones overriding earlier ones. Where multiple |
|
49 | alphabetical order, later ones overriding earlier ones. Where multiple | |
50 | paths are given below, settings from earlier paths override later |
|
50 | paths are given below, settings from earlier paths override later | |
51 | ones. |
|
51 | ones. | |
52 |
|
52 | |||
53 | .. container:: verbose.unix |
|
53 | .. container:: verbose.unix | |
54 |
|
54 | |||
55 | On Unix, the following files are consulted: |
|
55 | On Unix, the following files are consulted: | |
56 |
|
56 | |||
57 | - ``<repo>/.hg/hgrc-not-shared`` (per-repository) |
|
57 | - ``<repo>/.hg/hgrc-not-shared`` (per-repository) | |
58 | - ``<repo>/.hg/hgrc`` (per-repository) |
|
58 | - ``<repo>/.hg/hgrc`` (per-repository) | |
59 | - ``$HOME/.hgrc`` (per-user) |
|
59 | - ``$HOME/.hgrc`` (per-user) | |
60 | - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user) |
|
60 | - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user) | |
61 | - ``<install-root>/etc/mercurial/hgrc`` (per-installation) |
|
61 | - ``<install-root>/etc/mercurial/hgrc`` (per-installation) | |
62 | - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation) |
|
62 | - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation) | |
63 | - ``/etc/mercurial/hgrc`` (per-system) |
|
63 | - ``/etc/mercurial/hgrc`` (per-system) | |
64 | - ``/etc/mercurial/hgrc.d/*.rc`` (per-system) |
|
64 | - ``/etc/mercurial/hgrc.d/*.rc`` (per-system) | |
65 | - ``<internal>/*.rc`` (defaults) |
|
65 | - ``<internal>/*.rc`` (defaults) | |
66 |
|
66 | |||
67 | .. container:: verbose.windows |
|
67 | .. container:: verbose.windows | |
68 |
|
68 | |||
69 | On Windows, the following files are consulted: |
|
69 | On Windows, the following files are consulted: | |
70 |
|
70 | |||
71 | - ``<repo>/.hg/hgrc-not-shared`` (per-repository) |
|
71 | - ``<repo>/.hg/hgrc-not-shared`` (per-repository) | |
72 | - ``<repo>/.hg/hgrc`` (per-repository) |
|
72 | - ``<repo>/.hg/hgrc`` (per-repository) | |
73 | - ``%USERPROFILE%\.hgrc`` (per-user) |
|
73 | - ``%USERPROFILE%\.hgrc`` (per-user) | |
74 | - ``%USERPROFILE%\Mercurial.ini`` (per-user) |
|
74 | - ``%USERPROFILE%\Mercurial.ini`` (per-user) | |
75 | - ``%HOME%\.hgrc`` (per-user) |
|
75 | - ``%HOME%\.hgrc`` (per-user) | |
76 | - ``%HOME%\Mercurial.ini`` (per-user) |
|
76 | - ``%HOME%\Mercurial.ini`` (per-user) | |
77 | - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-system) |
|
77 | - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-system) | |
78 | - ``<install-dir>\hgrc.d\*.rc`` (per-installation) |
|
78 | - ``<install-dir>\hgrc.d\*.rc`` (per-installation) | |
79 | - ``<install-dir>\Mercurial.ini`` (per-installation) |
|
79 | - ``<install-dir>\Mercurial.ini`` (per-installation) | |
80 | - ``%PROGRAMDATA%\Mercurial\hgrc`` (per-system) |
|
80 | - ``%PROGRAMDATA%\Mercurial\hgrc`` (per-system) | |
81 | - ``%PROGRAMDATA%\Mercurial\Mercurial.ini`` (per-system) |
|
81 | - ``%PROGRAMDATA%\Mercurial\Mercurial.ini`` (per-system) | |
82 | - ``%PROGRAMDATA%\Mercurial\hgrc.d\*.rc`` (per-system) |
|
82 | - ``%PROGRAMDATA%\Mercurial\hgrc.d\*.rc`` (per-system) | |
83 | - ``<internal>/*.rc`` (defaults) |
|
83 | - ``<internal>/*.rc`` (defaults) | |
84 |
|
84 | |||
85 | .. note:: |
|
85 | .. note:: | |
86 |
|
86 | |||
87 | The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial`` |
|
87 | The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial`` | |
88 | is used when running 32-bit Python on 64-bit Windows. |
|
88 | is used when running 32-bit Python on 64-bit Windows. | |
89 |
|
89 | |||
90 | .. container:: verbose.plan9 |
|
90 | .. container:: verbose.plan9 | |
91 |
|
91 | |||
92 | On Plan9, the following files are consulted: |
|
92 | On Plan9, the following files are consulted: | |
93 |
|
93 | |||
94 | - ``<repo>/.hg/hgrc-not-shared`` (per-repository) |
|
94 | - ``<repo>/.hg/hgrc-not-shared`` (per-repository) | |
95 | - ``<repo>/.hg/hgrc`` (per-repository) |
|
95 | - ``<repo>/.hg/hgrc`` (per-repository) | |
96 | - ``$home/lib/hgrc`` (per-user) |
|
96 | - ``$home/lib/hgrc`` (per-user) | |
97 | - ``<install-root>/lib/mercurial/hgrc`` (per-installation) |
|
97 | - ``<install-root>/lib/mercurial/hgrc`` (per-installation) | |
98 | - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation) |
|
98 | - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation) | |
99 | - ``/lib/mercurial/hgrc`` (per-system) |
|
99 | - ``/lib/mercurial/hgrc`` (per-system) | |
100 | - ``/lib/mercurial/hgrc.d/*.rc`` (per-system) |
|
100 | - ``/lib/mercurial/hgrc.d/*.rc`` (per-system) | |
101 | - ``<internal>/*.rc`` (defaults) |
|
101 | - ``<internal>/*.rc`` (defaults) | |
102 |
|
102 | |||
103 | Per-repository configuration options only apply in a |
|
103 | Per-repository configuration options only apply in a | |
104 | particular repository. This file is not version-controlled, and |
|
104 | particular repository. This file is not version-controlled, and | |
105 | will not get transferred during a "clone" operation. Options in |
|
105 | will not get transferred during a "clone" operation. Options in | |
106 | this file override options in all other configuration files. |
|
106 | this file override options in all other configuration files. | |
107 |
|
107 | |||
108 | .. container:: unix.plan9 |
|
108 | .. container:: unix.plan9 | |
109 |
|
109 | |||
110 | On Plan 9 and Unix, most of this file will be ignored if it doesn't |
|
110 | On Plan 9 and Unix, most of this file will be ignored if it doesn't | |
111 | belong to a trusted user or to a trusted group. See |
|
111 | belong to a trusted user or to a trusted group. See | |
112 | :hg:`help config.trusted` for more details. |
|
112 | :hg:`help config.trusted` for more details. | |
113 |
|
113 | |||
114 | Per-user configuration file(s) are for the user running Mercurial. Options |
|
114 | Per-user configuration file(s) are for the user running Mercurial. Options | |
115 | in these files apply to all Mercurial commands executed by this user in any |
|
115 | in these files apply to all Mercurial commands executed by this user in any | |
116 | directory. Options in these files override per-system and per-installation |
|
116 | directory. Options in these files override per-system and per-installation | |
117 | options. |
|
117 | options. | |
118 |
|
118 | |||
119 | Per-installation configuration files are searched for in the |
|
119 | Per-installation configuration files are searched for in the | |
120 | directory where Mercurial is installed. ``<install-root>`` is the |
|
120 | directory where Mercurial is installed. ``<install-root>`` is the | |
121 | parent directory of the **hg** executable (or symlink) being run. |
|
121 | parent directory of the **hg** executable (or symlink) being run. | |
122 |
|
122 | |||
123 | .. container:: unix.plan9 |
|
123 | .. container:: unix.plan9 | |
124 |
|
124 | |||
125 | For example, if installed in ``/shared/tools/bin/hg``, Mercurial |
|
125 | For example, if installed in ``/shared/tools/bin/hg``, Mercurial | |
126 | will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these |
|
126 | will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these | |
127 | files apply to all Mercurial commands executed by any user in any |
|
127 | files apply to all Mercurial commands executed by any user in any | |
128 | directory. |
|
128 | directory. | |
129 |
|
129 | |||
130 | Per-installation configuration files are for the system on |
|
130 | Per-installation configuration files are for the system on | |
131 | which Mercurial is running. Options in these files apply to all |
|
131 | which Mercurial is running. Options in these files apply to all | |
132 | Mercurial commands executed by any user in any directory. Registry |
|
132 | Mercurial commands executed by any user in any directory. Registry | |
133 | keys contain PATH-like strings, every part of which must reference |
|
133 | keys contain PATH-like strings, every part of which must reference | |
134 | a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will |
|
134 | a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will | |
135 | be read. Mercurial checks each of these locations in the specified |
|
135 | be read. Mercurial checks each of these locations in the specified | |
136 | order until one or more configuration files are detected. |
|
136 | order until one or more configuration files are detected. | |
137 |
|
137 | |||
138 | Per-system configuration files are for the system on which Mercurial |
|
138 | Per-system configuration files are for the system on which Mercurial | |
139 | is running. Options in these files apply to all Mercurial commands |
|
139 | is running. Options in these files apply to all Mercurial commands | |
140 | executed by any user in any directory. Options in these files |
|
140 | executed by any user in any directory. Options in these files | |
141 | override per-installation options. |
|
141 | override per-installation options. | |
142 |
|
142 | |||
143 | Mercurial comes with some default configuration. The default configuration |
|
143 | Mercurial comes with some default configuration. The default configuration | |
144 | files are installed with Mercurial and will be overwritten on upgrades. Default |
|
144 | files are installed with Mercurial and will be overwritten on upgrades. Default | |
145 | configuration files should never be edited by users or administrators but can |
|
145 | configuration files should never be edited by users or administrators but can | |
146 | be overridden in other configuration files. So far the directory only contains |
|
146 | be overridden in other configuration files. So far the directory only contains | |
147 | merge tool configuration but packagers can also put other default configuration |
|
147 | merge tool configuration but packagers can also put other default configuration | |
148 | there. |
|
148 | there. | |
149 |
|
149 | |||
150 | On versions 5.7 and later, if share-safe functionality is enabled, |
|
150 | On versions 5.7 and later, if share-safe functionality is enabled, | |
151 | shares will read config file of share source too. |
|
151 | shares will read config file of share source too. | |
152 | `<share-source/.hg/hgrc>` is read before reading `<repo/.hg/hgrc>`. |
|
152 | `<share-source/.hg/hgrc>` is read before reading `<repo/.hg/hgrc>`. | |
153 |
|
153 | |||
154 | For configs which should not be shared, `<repo/.hg/hgrc-not-shared>` |
|
154 | For configs which should not be shared, `<repo/.hg/hgrc-not-shared>` | |
155 | should be used. |
|
155 | should be used. | |
156 |
|
156 | |||
157 | Syntax |
|
157 | Syntax | |
158 | ====== |
|
158 | ====== | |
159 |
|
159 | |||
160 | A configuration file consists of sections, led by a ``[section]`` header |
|
160 | A configuration file consists of sections, led by a ``[section]`` header | |
161 | and followed by ``name = value`` entries (sometimes called |
|
161 | and followed by ``name = value`` entries (sometimes called | |
162 | ``configuration keys``):: |
|
162 | ``configuration keys``):: | |
163 |
|
163 | |||
164 | [spam] |
|
164 | [spam] | |
165 | eggs=ham |
|
165 | eggs=ham | |
166 | green= |
|
166 | green= | |
167 | eggs |
|
167 | eggs | |
168 |
|
168 | |||
169 | Each line contains one entry. If the lines that follow are indented, |
|
169 | Each line contains one entry. If the lines that follow are indented, | |
170 | they are treated as continuations of that entry. Leading whitespace is |
|
170 | they are treated as continuations of that entry. Leading whitespace is | |
171 | removed from values. Empty lines are skipped. Lines beginning with |
|
171 | removed from values. Empty lines are skipped. Lines beginning with | |
172 | ``#`` or ``;`` are ignored and may be used to provide comments. |
|
172 | ``#`` or ``;`` are ignored and may be used to provide comments. | |
173 |
|
173 | |||
174 | Configuration keys can be set multiple times, in which case Mercurial |
|
174 | Configuration keys can be set multiple times, in which case Mercurial | |
175 | will use the value that was configured last. As an example:: |
|
175 | will use the value that was configured last. As an example:: | |
176 |
|
176 | |||
177 | [spam] |
|
177 | [spam] | |
178 | eggs=large |
|
178 | eggs=large | |
179 | ham=serrano |
|
179 | ham=serrano | |
180 | eggs=small |
|
180 | eggs=small | |
181 |
|
181 | |||
182 | This would set the configuration key named ``eggs`` to ``small``. |
|
182 | This would set the configuration key named ``eggs`` to ``small``. | |
183 |
|
183 | |||
184 | It is also possible to define a section multiple times. A section can |
|
184 | It is also possible to define a section multiple times. A section can | |
185 | be redefined on the same and/or on different configuration files. For |
|
185 | be redefined on the same and/or on different configuration files. For | |
186 | example:: |
|
186 | example:: | |
187 |
|
187 | |||
188 | [foo] |
|
188 | [foo] | |
189 | eggs=large |
|
189 | eggs=large | |
190 | ham=serrano |
|
190 | ham=serrano | |
191 | eggs=small |
|
191 | eggs=small | |
192 |
|
192 | |||
193 | [bar] |
|
193 | [bar] | |
194 | eggs=ham |
|
194 | eggs=ham | |
195 | green= |
|
195 | green= | |
196 | eggs |
|
196 | eggs | |
197 |
|
197 | |||
198 | [foo] |
|
198 | [foo] | |
199 | ham=prosciutto |
|
199 | ham=prosciutto | |
200 | eggs=medium |
|
200 | eggs=medium | |
201 | bread=toasted |
|
201 | bread=toasted | |
202 |
|
202 | |||
203 | This would set the ``eggs``, ``ham``, and ``bread`` configuration keys |
|
203 | This would set the ``eggs``, ``ham``, and ``bread`` configuration keys | |
204 | of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``, |
|
204 | of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``, | |
205 | respectively. As you can see there only thing that matters is the last |
|
205 | respectively. As you can see there only thing that matters is the last | |
206 | value that was set for each of the configuration keys. |
|
206 | value that was set for each of the configuration keys. | |
207 |
|
207 | |||
208 | If a configuration key is set multiple times in different |
|
208 | If a configuration key is set multiple times in different | |
209 | configuration files the final value will depend on the order in which |
|
209 | configuration files the final value will depend on the order in which | |
210 | the different configuration files are read, with settings from earlier |
|
210 | the different configuration files are read, with settings from earlier | |
211 | paths overriding later ones as described on the ``Files`` section |
|
211 | paths overriding later ones as described on the ``Files`` section | |
212 | above. |
|
212 | above. | |
213 |
|
213 | |||
214 | A line of the form ``%include file`` will include ``file`` into the |
|
214 | A line of the form ``%include file`` will include ``file`` into the | |
215 | current configuration file. The inclusion is recursive, which means |
|
215 | current configuration file. The inclusion is recursive, which means | |
216 | that included files can include other files. Filenames are relative to |
|
216 | that included files can include other files. Filenames are relative to | |
217 | the configuration file in which the ``%include`` directive is found. |
|
217 | the configuration file in which the ``%include`` directive is found. | |
218 | Environment variables and ``~user`` constructs are expanded in |
|
218 | Environment variables and ``~user`` constructs are expanded in | |
219 | ``file``. This lets you do something like:: |
|
219 | ``file``. This lets you do something like:: | |
220 |
|
220 | |||
221 | %include ~/.hgrc.d/$HOST.rc |
|
221 | %include ~/.hgrc.d/$HOST.rc | |
222 |
|
222 | |||
223 | to include a different configuration file on each computer you use. |
|
223 | to include a different configuration file on each computer you use. | |
224 |
|
224 | |||
225 | A line with ``%unset name`` will remove ``name`` from the current |
|
225 | A line with ``%unset name`` will remove ``name`` from the current | |
226 | section, if it has been set previously. |
|
226 | section, if it has been set previously. | |
227 |
|
227 | |||
228 | The values are either free-form text strings, lists of text strings, |
|
228 | The values are either free-form text strings, lists of text strings, | |
229 | or Boolean values. Boolean values can be set to true using any of "1", |
|
229 | or Boolean values. Boolean values can be set to true using any of "1", | |
230 | "yes", "true", or "on" and to false using "0", "no", "false", or "off" |
|
230 | "yes", "true", or "on" and to false using "0", "no", "false", or "off" | |
231 | (all case insensitive). |
|
231 | (all case insensitive). | |
232 |
|
232 | |||
233 | List values are separated by whitespace or comma, except when values are |
|
233 | List values are separated by whitespace or comma, except when values are | |
234 | placed in double quotation marks:: |
|
234 | placed in double quotation marks:: | |
235 |
|
235 | |||
236 | allow_read = "John Doe, PhD", brian, betty |
|
236 | allow_read = "John Doe, PhD", brian, betty | |
237 |
|
237 | |||
238 | Quotation marks can be escaped by prefixing them with a backslash. Only |
|
238 | Quotation marks can be escaped by prefixing them with a backslash. Only | |
239 | quotation marks at the beginning of a word is counted as a quotation |
|
239 | quotation marks at the beginning of a word is counted as a quotation | |
240 | (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``). |
|
240 | (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``). | |
241 |
|
241 | |||
242 | Sections |
|
242 | Sections | |
243 | ======== |
|
243 | ======== | |
244 |
|
244 | |||
245 | This section describes the different sections that may appear in a |
|
245 | This section describes the different sections that may appear in a | |
246 | Mercurial configuration file, the purpose of each section, its possible |
|
246 | Mercurial configuration file, the purpose of each section, its possible | |
247 | keys, and their possible values. |
|
247 | keys, and their possible values. | |
248 |
|
248 | |||
249 | ``alias`` |
|
249 | ``alias`` | |
250 | --------- |
|
250 | --------- | |
251 |
|
251 | |||
252 | Defines command aliases. |
|
252 | Defines command aliases. | |
253 |
|
253 | |||
254 | Aliases allow you to define your own commands in terms of other |
|
254 | Aliases allow you to define your own commands in terms of other | |
255 | commands (or aliases), optionally including arguments. Positional |
|
255 | commands (or aliases), optionally including arguments. Positional | |
256 | arguments in the form of ``$1``, ``$2``, etc. in the alias definition |
|
256 | arguments in the form of ``$1``, ``$2``, etc. in the alias definition | |
257 | are expanded by Mercurial before execution. Positional arguments not |
|
257 | are expanded by Mercurial before execution. Positional arguments not | |
258 | already used by ``$N`` in the definition are put at the end of the |
|
258 | already used by ``$N`` in the definition are put at the end of the | |
259 | command to be executed. |
|
259 | command to be executed. | |
260 |
|
260 | |||
261 | Alias definitions consist of lines of the form:: |
|
261 | Alias definitions consist of lines of the form:: | |
262 |
|
262 | |||
263 | <alias> = <command> [<argument>]... |
|
263 | <alias> = <command> [<argument>]... | |
264 |
|
264 | |||
265 | For example, this definition:: |
|
265 | For example, this definition:: | |
266 |
|
266 | |||
267 | latest = log --limit 5 |
|
267 | latest = log --limit 5 | |
268 |
|
268 | |||
269 | creates a new command ``latest`` that shows only the five most recent |
|
269 | creates a new command ``latest`` that shows only the five most recent | |
270 | changesets. You can define subsequent aliases using earlier ones:: |
|
270 | changesets. You can define subsequent aliases using earlier ones:: | |
271 |
|
271 | |||
272 | stable5 = latest -b stable |
|
272 | stable5 = latest -b stable | |
273 |
|
273 | |||
274 | .. note:: |
|
274 | .. note:: | |
275 |
|
275 | |||
276 | It is possible to create aliases with the same names as |
|
276 | It is possible to create aliases with the same names as | |
277 | existing commands, which will then override the original |
|
277 | existing commands, which will then override the original | |
278 | definitions. This is almost always a bad idea! |
|
278 | definitions. This is almost always a bad idea! | |
279 |
|
279 | |||
280 | An alias can start with an exclamation point (``!``) to make it a |
|
280 | An alias can start with an exclamation point (``!``) to make it a | |
281 | shell alias. A shell alias is executed with the shell and will let you |
|
281 | shell alias. A shell alias is executed with the shell and will let you | |
282 | run arbitrary commands. As an example, :: |
|
282 | run arbitrary commands. As an example, :: | |
283 |
|
283 | |||
284 | echo = !echo $@ |
|
284 | echo = !echo $@ | |
285 |
|
285 | |||
286 | will let you do ``hg echo foo`` to have ``foo`` printed in your |
|
286 | will let you do ``hg echo foo`` to have ``foo`` printed in your | |
287 | terminal. A better example might be:: |
|
287 | terminal. A better example might be:: | |
288 |
|
288 | |||
289 | purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f |
|
289 | purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f | |
290 |
|
290 | |||
291 | which will make ``hg purge`` delete all unknown files in the |
|
291 | which will make ``hg purge`` delete all unknown files in the | |
292 | repository in the same manner as the purge extension. |
|
292 | repository in the same manner as the purge extension. | |
293 |
|
293 | |||
294 | Positional arguments like ``$1``, ``$2``, etc. in the alias definition |
|
294 | Positional arguments like ``$1``, ``$2``, etc. in the alias definition | |
295 | expand to the command arguments. Unmatched arguments are |
|
295 | expand to the command arguments. Unmatched arguments are | |
296 | removed. ``$0`` expands to the alias name and ``$@`` expands to all |
|
296 | removed. ``$0`` expands to the alias name and ``$@`` expands to all | |
297 | arguments separated by a space. ``"$@"`` (with quotes) expands to all |
|
297 | arguments separated by a space. ``"$@"`` (with quotes) expands to all | |
298 | arguments quoted individually and separated by a space. These expansions |
|
298 | arguments quoted individually and separated by a space. These expansions | |
299 | happen before the command is passed to the shell. |
|
299 | happen before the command is passed to the shell. | |
300 |
|
300 | |||
301 | Shell aliases are executed in an environment where ``$HG`` expands to |
|
301 | Shell aliases are executed in an environment where ``$HG`` expands to | |
302 | the path of the Mercurial that was used to execute the alias. This is |
|
302 | the path of the Mercurial that was used to execute the alias. This is | |
303 | useful when you want to call further Mercurial commands in a shell |
|
303 | useful when you want to call further Mercurial commands in a shell | |
304 | alias, as was done above for the purge alias. In addition, |
|
304 | alias, as was done above for the purge alias. In addition, | |
305 | ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg |
|
305 | ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg | |
306 | echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``. |
|
306 | echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``. | |
307 |
|
307 | |||
308 | .. note:: |
|
308 | .. note:: | |
309 |
|
309 | |||
310 | Some global configuration options such as ``-R`` are |
|
310 | Some global configuration options such as ``-R`` are | |
311 | processed before shell aliases and will thus not be passed to |
|
311 | processed before shell aliases and will thus not be passed to | |
312 | aliases. |
|
312 | aliases. | |
313 |
|
313 | |||
314 |
|
314 | |||
315 | ``annotate`` |
|
315 | ``annotate`` | |
316 | ------------ |
|
316 | ------------ | |
317 |
|
317 | |||
318 | Settings used when displaying file annotations. All values are |
|
318 | Settings used when displaying file annotations. All values are | |
319 | Booleans and default to False. See :hg:`help config.diff` for |
|
319 | Booleans and default to False. See :hg:`help config.diff` for | |
320 | related options for the diff command. |
|
320 | related options for the diff command. | |
321 |
|
321 | |||
322 | ``ignorews`` |
|
322 | ``ignorews`` | |
323 | Ignore white space when comparing lines. |
|
323 | Ignore white space when comparing lines. | |
324 |
|
324 | |||
325 | ``ignorewseol`` |
|
325 | ``ignorewseol`` | |
326 | Ignore white space at the end of a line when comparing lines. |
|
326 | Ignore white space at the end of a line when comparing lines. | |
327 |
|
327 | |||
328 | ``ignorewsamount`` |
|
328 | ``ignorewsamount`` | |
329 | Ignore changes in the amount of white space. |
|
329 | Ignore changes in the amount of white space. | |
330 |
|
330 | |||
331 | ``ignoreblanklines`` |
|
331 | ``ignoreblanklines`` | |
332 | Ignore changes whose lines are all blank. |
|
332 | Ignore changes whose lines are all blank. | |
333 |
|
333 | |||
334 |
|
334 | |||
335 | ``auth`` |
|
335 | ``auth`` | |
336 | -------- |
|
336 | -------- | |
337 |
|
337 | |||
338 | Authentication credentials and other authentication-like configuration |
|
338 | Authentication credentials and other authentication-like configuration | |
339 | for HTTP connections. This section allows you to store usernames and |
|
339 | for HTTP connections. This section allows you to store usernames and | |
340 | passwords for use when logging *into* HTTP servers. See |
|
340 | passwords for use when logging *into* HTTP servers. See | |
341 | :hg:`help config.web` if you want to configure *who* can login to |
|
341 | :hg:`help config.web` if you want to configure *who* can login to | |
342 | your HTTP server. |
|
342 | your HTTP server. | |
343 |
|
343 | |||
344 | The following options apply to all hosts. |
|
344 | The following options apply to all hosts. | |
345 |
|
345 | |||
346 | ``cookiefile`` |
|
346 | ``cookiefile`` | |
347 | Path to a file containing HTTP cookie lines. Cookies matching a |
|
347 | Path to a file containing HTTP cookie lines. Cookies matching a | |
348 | host will be sent automatically. |
|
348 | host will be sent automatically. | |
349 |
|
349 | |||
350 | The file format uses the Mozilla cookies.txt format, which defines cookies |
|
350 | The file format uses the Mozilla cookies.txt format, which defines cookies | |
351 | on their own lines. Each line contains 7 fields delimited by the tab |
|
351 | on their own lines. Each line contains 7 fields delimited by the tab | |
352 | character (domain, is_domain_cookie, path, is_secure, expires, name, |
|
352 | character (domain, is_domain_cookie, path, is_secure, expires, name, | |
353 | value). For more info, do an Internet search for "Netscape cookies.txt |
|
353 | value). For more info, do an Internet search for "Netscape cookies.txt | |
354 | format." |
|
354 | format." | |
355 |
|
355 | |||
356 | Note: the cookies parser does not handle port numbers on domains. You |
|
356 | Note: the cookies parser does not handle port numbers on domains. You | |
357 | will need to remove ports from the domain for the cookie to be recognized. |
|
357 | will need to remove ports from the domain for the cookie to be recognized. | |
358 | This could result in a cookie being disclosed to an unwanted server. |
|
358 | This could result in a cookie being disclosed to an unwanted server. | |
359 |
|
359 | |||
360 | The cookies file is read-only. |
|
360 | The cookies file is read-only. | |
361 |
|
361 | |||
362 | Other options in this section are grouped by name and have the following |
|
362 | Other options in this section are grouped by name and have the following | |
363 | format:: |
|
363 | format:: | |
364 |
|
364 | |||
365 | <name>.<argument> = <value> |
|
365 | <name>.<argument> = <value> | |
366 |
|
366 | |||
367 | where ``<name>`` is used to group arguments into authentication |
|
367 | where ``<name>`` is used to group arguments into authentication | |
368 | entries. Example:: |
|
368 | entries. Example:: | |
369 |
|
369 | |||
370 | foo.prefix = hg.intevation.de/mercurial |
|
370 | foo.prefix = hg.intevation.de/mercurial | |
371 | foo.username = foo |
|
371 | foo.username = foo | |
372 | foo.password = bar |
|
372 | foo.password = bar | |
373 | foo.schemes = http https |
|
373 | foo.schemes = http https | |
374 |
|
374 | |||
375 | bar.prefix = secure.example.org |
|
375 | bar.prefix = secure.example.org | |
376 | bar.key = path/to/file.key |
|
376 | bar.key = path/to/file.key | |
377 | bar.cert = path/to/file.cert |
|
377 | bar.cert = path/to/file.cert | |
378 | bar.schemes = https |
|
378 | bar.schemes = https | |
379 |
|
379 | |||
380 | Supported arguments: |
|
380 | Supported arguments: | |
381 |
|
381 | |||
382 | ``prefix`` |
|
382 | ``prefix`` | |
383 | Either ``*`` or a URI prefix with or without the scheme part. |
|
383 | Either ``*`` or a URI prefix with or without the scheme part. | |
384 | The authentication entry with the longest matching prefix is used |
|
384 | The authentication entry with the longest matching prefix is used | |
385 | (where ``*`` matches everything and counts as a match of length |
|
385 | (where ``*`` matches everything and counts as a match of length | |
386 | 1). If the prefix doesn't include a scheme, the match is performed |
|
386 | 1). If the prefix doesn't include a scheme, the match is performed | |
387 | against the URI with its scheme stripped as well, and the schemes |
|
387 | against the URI with its scheme stripped as well, and the schemes | |
388 | argument, q.v., is then subsequently consulted. |
|
388 | argument, q.v., is then subsequently consulted. | |
389 |
|
389 | |||
390 | ``username`` |
|
390 | ``username`` | |
391 | Optional. Username to authenticate with. If not given, and the |
|
391 | Optional. Username to authenticate with. If not given, and the | |
392 | remote site requires basic or digest authentication, the user will |
|
392 | remote site requires basic or digest authentication, the user will | |
393 | be prompted for it. Environment variables are expanded in the |
|
393 | be prompted for it. Environment variables are expanded in the | |
394 | username letting you do ``foo.username = $USER``. If the URI |
|
394 | username letting you do ``foo.username = $USER``. If the URI | |
395 | includes a username, only ``[auth]`` entries with a matching |
|
395 | includes a username, only ``[auth]`` entries with a matching | |
396 | username or without a username will be considered. |
|
396 | username or without a username will be considered. | |
397 |
|
397 | |||
398 | ``password`` |
|
398 | ``password`` | |
399 | Optional. Password to authenticate with. If not given, and the |
|
399 | Optional. Password to authenticate with. If not given, and the | |
400 | remote site requires basic or digest authentication, the user |
|
400 | remote site requires basic or digest authentication, the user | |
401 | will be prompted for it. |
|
401 | will be prompted for it. | |
402 |
|
402 | |||
403 | ``key`` |
|
403 | ``key`` | |
404 | Optional. PEM encoded client certificate key file. Environment |
|
404 | Optional. PEM encoded client certificate key file. Environment | |
405 | variables are expanded in the filename. |
|
405 | variables are expanded in the filename. | |
406 |
|
406 | |||
407 | ``cert`` |
|
407 | ``cert`` | |
408 | Optional. PEM encoded client certificate chain file. Environment |
|
408 | Optional. PEM encoded client certificate chain file. Environment | |
409 | variables are expanded in the filename. |
|
409 | variables are expanded in the filename. | |
410 |
|
410 | |||
411 | ``schemes`` |
|
411 | ``schemes`` | |
412 | Optional. Space separated list of URI schemes to use this |
|
412 | Optional. Space separated list of URI schemes to use this | |
413 | authentication entry with. Only used if the prefix doesn't include |
|
413 | authentication entry with. Only used if the prefix doesn't include | |
414 | a scheme. Supported schemes are http and https. They will match |
|
414 | a scheme. Supported schemes are http and https. They will match | |
415 | static-http and static-https respectively, as well. |
|
415 | static-http and static-https respectively, as well. | |
416 | (default: https) |
|
416 | (default: https) | |
417 |
|
417 | |||
418 | If no suitable authentication entry is found, the user is prompted |
|
418 | If no suitable authentication entry is found, the user is prompted | |
419 | for credentials as usual if required by the remote. |
|
419 | for credentials as usual if required by the remote. | |
420 |
|
420 | |||
421 | ``cmdserver`` |
|
421 | ``cmdserver`` | |
422 | ------------- |
|
422 | ------------- | |
423 |
|
423 | |||
424 | Controls command server settings. (ADVANCED) |
|
424 | Controls command server settings. (ADVANCED) | |
425 |
|
425 | |||
426 | ``message-encodings`` |
|
426 | ``message-encodings`` | |
427 | List of encodings for the ``m`` (message) channel. The first encoding |
|
427 | List of encodings for the ``m`` (message) channel. The first encoding | |
428 | supported by the server will be selected and advertised in the hello |
|
428 | supported by the server will be selected and advertised in the hello | |
429 | message. This is useful only when ``ui.message-output`` is set to |
|
429 | message. This is useful only when ``ui.message-output`` is set to | |
430 | ``channel``. Supported encodings are ``cbor``. |
|
430 | ``channel``. Supported encodings are ``cbor``. | |
431 |
|
431 | |||
432 | ``shutdown-on-interrupt`` |
|
432 | ``shutdown-on-interrupt`` | |
433 | If set to false, the server's main loop will continue running after |
|
433 | If set to false, the server's main loop will continue running after | |
434 | SIGINT received. ``runcommand`` requests can still be interrupted by |
|
434 | SIGINT received. ``runcommand`` requests can still be interrupted by | |
435 | SIGINT. Close the write end of the pipe to shut down the server |
|
435 | SIGINT. Close the write end of the pipe to shut down the server | |
436 | process gracefully. |
|
436 | process gracefully. | |
437 | (default: True) |
|
437 | (default: True) | |
438 |
|
438 | |||
439 | ``color`` |
|
439 | ``color`` | |
440 | --------- |
|
440 | --------- | |
441 |
|
441 | |||
442 | Configure the Mercurial color mode. For details about how to define your custom |
|
442 | Configure the Mercurial color mode. For details about how to define your custom | |
443 | effect and style see :hg:`help color`. |
|
443 | effect and style see :hg:`help color`. | |
444 |
|
444 | |||
445 | ``mode`` |
|
445 | ``mode`` | |
446 | String: control the method used to output color. One of ``auto``, ``ansi``, |
|
446 | String: control the method used to output color. One of ``auto``, ``ansi``, | |
447 | ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will |
|
447 | ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will | |
448 | use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a |
|
448 | use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a | |
449 | terminal. Any invalid value will disable color. |
|
449 | terminal. Any invalid value will disable color. | |
450 |
|
450 | |||
451 | ``pagermode`` |
|
451 | ``pagermode`` | |
452 | String: optional override of ``color.mode`` used with pager. |
|
452 | String: optional override of ``color.mode`` used with pager. | |
453 |
|
453 | |||
454 | On some systems, terminfo mode may cause problems when using |
|
454 | On some systems, terminfo mode may cause problems when using | |
455 | color with ``less -R`` as a pager program. less with the -R option |
|
455 | color with ``less -R`` as a pager program. less with the -R option | |
456 | will only display ECMA-48 color codes, and terminfo mode may sometimes |
|
456 | will only display ECMA-48 color codes, and terminfo mode may sometimes | |
457 | emit codes that less doesn't understand. You can work around this by |
|
457 | emit codes that less doesn't understand. You can work around this by | |
458 | either using ansi mode (or auto mode), or by using less -r (which will |
|
458 | either using ansi mode (or auto mode), or by using less -r (which will | |
459 | pass through all terminal control codes, not just color control |
|
459 | pass through all terminal control codes, not just color control | |
460 | codes). |
|
460 | codes). | |
461 |
|
461 | |||
462 | On some systems (such as MSYS in Windows), the terminal may support |
|
462 | On some systems (such as MSYS in Windows), the terminal may support | |
463 | a different color mode than the pager program. |
|
463 | a different color mode than the pager program. | |
464 |
|
464 | |||
465 | ``commands`` |
|
465 | ``commands`` | |
466 | ------------ |
|
466 | ------------ | |
467 |
|
467 | |||
468 | ``commit.post-status`` |
|
468 | ``commit.post-status`` | |
469 | Show status of files in the working directory after successful commit. |
|
469 | Show status of files in the working directory after successful commit. | |
470 | (default: False) |
|
470 | (default: False) | |
471 |
|
471 | |||
472 | ``merge.require-rev`` |
|
472 | ``merge.require-rev`` | |
473 | Require that the revision to merge the current commit with be specified on |
|
473 | Require that the revision to merge the current commit with be specified on | |
474 | the command line. If this is enabled and a revision is not specified, the |
|
474 | the command line. If this is enabled and a revision is not specified, the | |
475 | command aborts. |
|
475 | command aborts. | |
476 | (default: False) |
|
476 | (default: False) | |
477 |
|
477 | |||
478 | ``push.require-revs`` |
|
478 | ``push.require-revs`` | |
479 | Require revisions to push be specified using one or more mechanisms such as |
|
479 | Require revisions to push be specified using one or more mechanisms such as | |
480 | specifying them positionally on the command line, using ``-r``, ``-b``, |
|
480 | specifying them positionally on the command line, using ``-r``, ``-b``, | |
481 | and/or ``-B`` on the command line, or using ``paths.<path>:pushrev`` in the |
|
481 | and/or ``-B`` on the command line, or using ``paths.<path>:pushrev`` in the | |
482 | configuration. If this is enabled and revisions are not specified, the |
|
482 | configuration. If this is enabled and revisions are not specified, the | |
483 | command aborts. |
|
483 | command aborts. | |
484 | (default: False) |
|
484 | (default: False) | |
485 |
|
485 | |||
486 | ``resolve.confirm`` |
|
486 | ``resolve.confirm`` | |
487 | Confirm before performing action if no filename is passed. |
|
487 | Confirm before performing action if no filename is passed. | |
488 | (default: False) |
|
488 | (default: False) | |
489 |
|
489 | |||
490 | ``resolve.explicit-re-merge`` |
|
490 | ``resolve.explicit-re-merge`` | |
491 | Require uses of ``hg resolve`` to specify which action it should perform, |
|
491 | Require uses of ``hg resolve`` to specify which action it should perform, | |
492 | instead of re-merging files by default. |
|
492 | instead of re-merging files by default. | |
493 | (default: False) |
|
493 | (default: False) | |
494 |
|
494 | |||
495 | ``resolve.mark-check`` |
|
495 | ``resolve.mark-check`` | |
496 | Determines what level of checking :hg:`resolve --mark` will perform before |
|
496 | Determines what level of checking :hg:`resolve --mark` will perform before | |
497 | marking files as resolved. Valid values are ``none`, ``warn``, and |
|
497 | marking files as resolved. Valid values are ``none`, ``warn``, and | |
498 | ``abort``. ``warn`` will output a warning listing the file(s) that still |
|
498 | ``abort``. ``warn`` will output a warning listing the file(s) that still | |
499 | have conflict markers in them, but will still mark everything resolved. |
|
499 | have conflict markers in them, but will still mark everything resolved. | |
500 | ``abort`` will output the same warning but will not mark things as resolved. |
|
500 | ``abort`` will output the same warning but will not mark things as resolved. | |
501 | If --all is passed and this is set to ``abort``, only a warning will be |
|
501 | If --all is passed and this is set to ``abort``, only a warning will be | |
502 | shown (an error will not be raised). |
|
502 | shown (an error will not be raised). | |
503 | (default: ``none``) |
|
503 | (default: ``none``) | |
504 |
|
504 | |||
505 | ``status.relative`` |
|
505 | ``status.relative`` | |
506 | Make paths in :hg:`status` output relative to the current directory. |
|
506 | Make paths in :hg:`status` output relative to the current directory. | |
507 | (default: False) |
|
507 | (default: False) | |
508 |
|
508 | |||
509 | ``status.terse`` |
|
509 | ``status.terse`` | |
510 | Default value for the --terse flag, which condenses status output. |
|
510 | Default value for the --terse flag, which condenses status output. | |
511 | (default: empty) |
|
511 | (default: empty) | |
512 |
|
512 | |||
513 | ``update.check`` |
|
513 | ``update.check`` | |
514 | Determines what level of checking :hg:`update` will perform before moving |
|
514 | Determines what level of checking :hg:`update` will perform before moving | |
515 | to a destination revision. Valid values are ``abort``, ``none``, |
|
515 | to a destination revision. Valid values are ``abort``, ``none``, | |
516 | ``linear``, and ``noconflict``. |
|
516 | ``linear``, and ``noconflict``. | |
517 |
|
517 | |||
518 | - ``abort`` always fails if the working directory has uncommitted changes. |
|
518 | - ``abort`` always fails if the working directory has uncommitted changes. | |
519 |
|
519 | |||
520 | - ``none`` performs no checking, and may result in a merge with uncommitted changes. |
|
520 | - ``none`` performs no checking, and may result in a merge with uncommitted changes. | |
521 |
|
521 | |||
522 | - ``linear`` allows any update as long as it follows a straight line in the |
|
522 | - ``linear`` allows any update as long as it follows a straight line in the | |
523 | revision history, and may trigger a merge with uncommitted changes. |
|
523 | revision history, and may trigger a merge with uncommitted changes. | |
524 |
|
524 | |||
525 | - ``noconflict`` will allow any update which would not trigger a merge with |
|
525 | - ``noconflict`` will allow any update which would not trigger a merge with | |
526 | uncommitted changes, if any are present. |
|
526 | uncommitted changes, if any are present. | |
527 |
|
527 | |||
528 | (default: ``linear``) |
|
528 | (default: ``linear``) | |
529 |
|
529 | |||
530 | ``update.requiredest`` |
|
530 | ``update.requiredest`` | |
531 | Require that the user pass a destination when running :hg:`update`. |
|
531 | Require that the user pass a destination when running :hg:`update`. | |
532 | For example, :hg:`update .::` will be allowed, but a plain :hg:`update` |
|
532 | For example, :hg:`update .::` will be allowed, but a plain :hg:`update` | |
533 | will be disallowed. |
|
533 | will be disallowed. | |
534 | (default: False) |
|
534 | (default: False) | |
535 |
|
535 | |||
536 | ``committemplate`` |
|
536 | ``committemplate`` | |
537 | ------------------ |
|
537 | ------------------ | |
538 |
|
538 | |||
539 | ``changeset`` |
|
539 | ``changeset`` | |
540 | String: configuration in this section is used as the template to |
|
540 | String: configuration in this section is used as the template to | |
541 | customize the text shown in the editor when committing. |
|
541 | customize the text shown in the editor when committing. | |
542 |
|
542 | |||
543 | In addition to pre-defined template keywords, commit log specific one |
|
543 | In addition to pre-defined template keywords, commit log specific one | |
544 | below can be used for customization: |
|
544 | below can be used for customization: | |
545 |
|
545 | |||
546 | ``extramsg`` |
|
546 | ``extramsg`` | |
547 | String: Extra message (typically 'Leave message empty to abort |
|
547 | String: Extra message (typically 'Leave message empty to abort | |
548 | commit.'). This may be changed by some commands or extensions. |
|
548 | commit.'). This may be changed by some commands or extensions. | |
549 |
|
549 | |||
550 | For example, the template configuration below shows as same text as |
|
550 | For example, the template configuration below shows as same text as | |
551 | one shown by default:: |
|
551 | one shown by default:: | |
552 |
|
552 | |||
553 | [committemplate] |
|
553 | [committemplate] | |
554 | changeset = {desc}\n\n |
|
554 | changeset = {desc}\n\n | |
555 | HG: Enter commit message. Lines beginning with 'HG:' are removed. |
|
555 | HG: Enter commit message. Lines beginning with 'HG:' are removed. | |
556 | HG: {extramsg} |
|
556 | HG: {extramsg} | |
557 | HG: -- |
|
557 | HG: -- | |
558 | HG: user: {author}\n{ifeq(p2rev, "-1", "", |
|
558 | HG: user: {author}\n{ifeq(p2rev, "-1", "", | |
559 | "HG: branch merge\n") |
|
559 | "HG: branch merge\n") | |
560 | }HG: branch '{branch}'\n{if(activebookmark, |
|
560 | }HG: branch '{branch}'\n{if(activebookmark, | |
561 | "HG: bookmark '{activebookmark}'\n") }{subrepos % |
|
561 | "HG: bookmark '{activebookmark}'\n") }{subrepos % | |
562 | "HG: subrepo {subrepo}\n" }{file_adds % |
|
562 | "HG: subrepo {subrepo}\n" }{file_adds % | |
563 | "HG: added {file}\n" }{file_mods % |
|
563 | "HG: added {file}\n" }{file_mods % | |
564 | "HG: changed {file}\n" }{file_dels % |
|
564 | "HG: changed {file}\n" }{file_dels % | |
565 | "HG: removed {file}\n" }{if(files, "", |
|
565 | "HG: removed {file}\n" }{if(files, "", | |
566 | "HG: no files changed\n")} |
|
566 | "HG: no files changed\n")} | |
567 |
|
567 | |||
568 | ``diff()`` |
|
568 | ``diff()`` | |
569 | String: show the diff (see :hg:`help templates` for detail) |
|
569 | String: show the diff (see :hg:`help templates` for detail) | |
570 |
|
570 | |||
571 | Sometimes it is helpful to show the diff of the changeset in the editor without |
|
571 | Sometimes it is helpful to show the diff of the changeset in the editor without | |
572 | having to prefix 'HG: ' to each line so that highlighting works correctly. For |
|
572 | having to prefix 'HG: ' to each line so that highlighting works correctly. For | |
573 | this, Mercurial provides a special string which will ignore everything below |
|
573 | this, Mercurial provides a special string which will ignore everything below | |
574 | it:: |
|
574 | it:: | |
575 |
|
575 | |||
576 | HG: ------------------------ >8 ------------------------ |
|
576 | HG: ------------------------ >8 ------------------------ | |
577 |
|
577 | |||
578 | For example, the template configuration below will show the diff below the |
|
578 | For example, the template configuration below will show the diff below the | |
579 | extra message:: |
|
579 | extra message:: | |
580 |
|
580 | |||
581 | [committemplate] |
|
581 | [committemplate] | |
582 | changeset = {desc}\n\n |
|
582 | changeset = {desc}\n\n | |
583 | HG: Enter commit message. Lines beginning with 'HG:' are removed. |
|
583 | HG: Enter commit message. Lines beginning with 'HG:' are removed. | |
584 | HG: {extramsg} |
|
584 | HG: {extramsg} | |
585 | HG: ------------------------ >8 ------------------------ |
|
585 | HG: ------------------------ >8 ------------------------ | |
586 | HG: Do not touch the line above. |
|
586 | HG: Do not touch the line above. | |
587 | HG: Everything below will be removed. |
|
587 | HG: Everything below will be removed. | |
588 | {diff()} |
|
588 | {diff()} | |
589 |
|
589 | |||
590 | .. note:: |
|
590 | .. note:: | |
591 |
|
591 | |||
592 | For some problematic encodings (see :hg:`help win32mbcs` for |
|
592 | For some problematic encodings (see :hg:`help win32mbcs` for | |
593 | detail), this customization should be configured carefully, to |
|
593 | detail), this customization should be configured carefully, to | |
594 | avoid showing broken characters. |
|
594 | avoid showing broken characters. | |
595 |
|
595 | |||
596 | For example, if a multibyte character ending with backslash (0x5c) is |
|
596 | For example, if a multibyte character ending with backslash (0x5c) is | |
597 | followed by the ASCII character 'n' in the customized template, |
|
597 | followed by the ASCII character 'n' in the customized template, | |
598 | the sequence of backslash and 'n' is treated as line-feed unexpectedly |
|
598 | the sequence of backslash and 'n' is treated as line-feed unexpectedly | |
599 | (and the multibyte character is broken, too). |
|
599 | (and the multibyte character is broken, too). | |
600 |
|
600 | |||
601 | Customized template is used for commands below (``--edit`` may be |
|
601 | Customized template is used for commands below (``--edit`` may be | |
602 | required): |
|
602 | required): | |
603 |
|
603 | |||
604 | - :hg:`backout` |
|
604 | - :hg:`backout` | |
605 | - :hg:`commit` |
|
605 | - :hg:`commit` | |
606 | - :hg:`fetch` (for merge commit only) |
|
606 | - :hg:`fetch` (for merge commit only) | |
607 | - :hg:`graft` |
|
607 | - :hg:`graft` | |
608 | - :hg:`histedit` |
|
608 | - :hg:`histedit` | |
609 | - :hg:`import` |
|
609 | - :hg:`import` | |
610 | - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh` |
|
610 | - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh` | |
611 | - :hg:`rebase` |
|
611 | - :hg:`rebase` | |
612 | - :hg:`shelve` |
|
612 | - :hg:`shelve` | |
613 | - :hg:`sign` |
|
613 | - :hg:`sign` | |
614 | - :hg:`tag` |
|
614 | - :hg:`tag` | |
615 | - :hg:`transplant` |
|
615 | - :hg:`transplant` | |
616 |
|
616 | |||
617 | Configuring items below instead of ``changeset`` allows showing |
|
617 | Configuring items below instead of ``changeset`` allows showing | |
618 | customized message only for specific actions, or showing different |
|
618 | customized message only for specific actions, or showing different | |
619 | messages for each action. |
|
619 | messages for each action. | |
620 |
|
620 | |||
621 | - ``changeset.backout`` for :hg:`backout` |
|
621 | - ``changeset.backout`` for :hg:`backout` | |
622 | - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges |
|
622 | - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges | |
623 | - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other |
|
623 | - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other | |
624 | - ``changeset.commit.normal.merge`` for :hg:`commit` on merges |
|
624 | - ``changeset.commit.normal.merge`` for :hg:`commit` on merges | |
625 | - ``changeset.commit.normal.normal`` for :hg:`commit` on other |
|
625 | - ``changeset.commit.normal.normal`` for :hg:`commit` on other | |
626 | - ``changeset.fetch`` for :hg:`fetch` (impling merge commit) |
|
626 | - ``changeset.fetch`` for :hg:`fetch` (impling merge commit) | |
627 | - ``changeset.gpg.sign`` for :hg:`sign` |
|
627 | - ``changeset.gpg.sign`` for :hg:`sign` | |
628 | - ``changeset.graft`` for :hg:`graft` |
|
628 | - ``changeset.graft`` for :hg:`graft` | |
629 | - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit` |
|
629 | - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit` | |
630 | - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit` |
|
630 | - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit` | |
631 | - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit` |
|
631 | - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit` | |
632 | - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit` |
|
632 | - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit` | |
633 | - ``changeset.import.bypass`` for :hg:`import --bypass` |
|
633 | - ``changeset.import.bypass`` for :hg:`import --bypass` | |
634 | - ``changeset.import.normal.merge`` for :hg:`import` on merges |
|
634 | - ``changeset.import.normal.merge`` for :hg:`import` on merges | |
635 | - ``changeset.import.normal.normal`` for :hg:`import` on other |
|
635 | - ``changeset.import.normal.normal`` for :hg:`import` on other | |
636 | - ``changeset.mq.qnew`` for :hg:`qnew` |
|
636 | - ``changeset.mq.qnew`` for :hg:`qnew` | |
637 | - ``changeset.mq.qfold`` for :hg:`qfold` |
|
637 | - ``changeset.mq.qfold`` for :hg:`qfold` | |
638 | - ``changeset.mq.qrefresh`` for :hg:`qrefresh` |
|
638 | - ``changeset.mq.qrefresh`` for :hg:`qrefresh` | |
639 | - ``changeset.rebase.collapse`` for :hg:`rebase --collapse` |
|
639 | - ``changeset.rebase.collapse`` for :hg:`rebase --collapse` | |
640 | - ``changeset.rebase.merge`` for :hg:`rebase` on merges |
|
640 | - ``changeset.rebase.merge`` for :hg:`rebase` on merges | |
641 | - ``changeset.rebase.normal`` for :hg:`rebase` on other |
|
641 | - ``changeset.rebase.normal`` for :hg:`rebase` on other | |
642 | - ``changeset.shelve.shelve`` for :hg:`shelve` |
|
642 | - ``changeset.shelve.shelve`` for :hg:`shelve` | |
643 | - ``changeset.tag.add`` for :hg:`tag` without ``--remove`` |
|
643 | - ``changeset.tag.add`` for :hg:`tag` without ``--remove`` | |
644 | - ``changeset.tag.remove`` for :hg:`tag --remove` |
|
644 | - ``changeset.tag.remove`` for :hg:`tag --remove` | |
645 | - ``changeset.transplant.merge`` for :hg:`transplant` on merges |
|
645 | - ``changeset.transplant.merge`` for :hg:`transplant` on merges | |
646 | - ``changeset.transplant.normal`` for :hg:`transplant` on other |
|
646 | - ``changeset.transplant.normal`` for :hg:`transplant` on other | |
647 |
|
647 | |||
648 | These dot-separated lists of names are treated as hierarchical ones. |
|
648 | These dot-separated lists of names are treated as hierarchical ones. | |
649 | For example, ``changeset.tag.remove`` customizes the commit message |
|
649 | For example, ``changeset.tag.remove`` customizes the commit message | |
650 | only for :hg:`tag --remove`, but ``changeset.tag`` customizes the |
|
650 | only for :hg:`tag --remove`, but ``changeset.tag`` customizes the | |
651 | commit message for :hg:`tag` regardless of ``--remove`` option. |
|
651 | commit message for :hg:`tag` regardless of ``--remove`` option. | |
652 |
|
652 | |||
653 | When the external editor is invoked for a commit, the corresponding |
|
653 | When the external editor is invoked for a commit, the corresponding | |
654 | dot-separated list of names without the ``changeset.`` prefix |
|
654 | dot-separated list of names without the ``changeset.`` prefix | |
655 | (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment |
|
655 | (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment | |
656 | variable. |
|
656 | variable. | |
657 |
|
657 | |||
658 | In this section, items other than ``changeset`` can be referred from |
|
658 | In this section, items other than ``changeset`` can be referred from | |
659 | others. For example, the configuration to list committed files up |
|
659 | others. For example, the configuration to list committed files up | |
660 | below can be referred as ``{listupfiles}``:: |
|
660 | below can be referred as ``{listupfiles}``:: | |
661 |
|
661 | |||
662 | [committemplate] |
|
662 | [committemplate] | |
663 | listupfiles = {file_adds % |
|
663 | listupfiles = {file_adds % | |
664 | "HG: added {file}\n" }{file_mods % |
|
664 | "HG: added {file}\n" }{file_mods % | |
665 | "HG: changed {file}\n" }{file_dels % |
|
665 | "HG: changed {file}\n" }{file_dels % | |
666 | "HG: removed {file}\n" }{if(files, "", |
|
666 | "HG: removed {file}\n" }{if(files, "", | |
667 | "HG: no files changed\n")} |
|
667 | "HG: no files changed\n")} | |
668 |
|
668 | |||
669 | ``decode/encode`` |
|
669 | ``decode/encode`` | |
670 | ----------------- |
|
670 | ----------------- | |
671 |
|
671 | |||
672 | Filters for transforming files on checkout/checkin. This would |
|
672 | Filters for transforming files on checkout/checkin. This would | |
673 | typically be used for newline processing or other |
|
673 | typically be used for newline processing or other | |
674 | localization/canonicalization of files. |
|
674 | localization/canonicalization of files. | |
675 |
|
675 | |||
676 | Filters consist of a filter pattern followed by a filter command. |
|
676 | Filters consist of a filter pattern followed by a filter command. | |
677 | Filter patterns are globs by default, rooted at the repository root. |
|
677 | Filter patterns are globs by default, rooted at the repository root. | |
678 | For example, to match any file ending in ``.txt`` in the root |
|
678 | For example, to match any file ending in ``.txt`` in the root | |
679 | directory only, use the pattern ``*.txt``. To match any file ending |
|
679 | directory only, use the pattern ``*.txt``. To match any file ending | |
680 | in ``.c`` anywhere in the repository, use the pattern ``**.c``. |
|
680 | in ``.c`` anywhere in the repository, use the pattern ``**.c``. | |
681 | For each file only the first matching filter applies. |
|
681 | For each file only the first matching filter applies. | |
682 |
|
682 | |||
683 | The filter command can start with a specifier, either ``pipe:`` or |
|
683 | The filter command can start with a specifier, either ``pipe:`` or | |
684 | ``tempfile:``. If no specifier is given, ``pipe:`` is used by default. |
|
684 | ``tempfile:``. If no specifier is given, ``pipe:`` is used by default. | |
685 |
|
685 | |||
686 | A ``pipe:`` command must accept data on stdin and return the transformed |
|
686 | A ``pipe:`` command must accept data on stdin and return the transformed | |
687 | data on stdout. |
|
687 | data on stdout. | |
688 |
|
688 | |||
689 | Pipe example:: |
|
689 | Pipe example:: | |
690 |
|
690 | |||
691 | [encode] |
|
691 | [encode] | |
692 | # uncompress gzip files on checkin to improve delta compression |
|
692 | # uncompress gzip files on checkin to improve delta compression | |
693 | # note: not necessarily a good idea, just an example |
|
693 | # note: not necessarily a good idea, just an example | |
694 | *.gz = pipe: gunzip |
|
694 | *.gz = pipe: gunzip | |
695 |
|
695 | |||
696 | [decode] |
|
696 | [decode] | |
697 | # recompress gzip files when writing them to the working dir (we |
|
697 | # recompress gzip files when writing them to the working dir (we | |
698 | # can safely omit "pipe:", because it's the default) |
|
698 | # can safely omit "pipe:", because it's the default) | |
699 | *.gz = gzip |
|
699 | *.gz = gzip | |
700 |
|
700 | |||
701 | A ``tempfile:`` command is a template. The string ``INFILE`` is replaced |
|
701 | A ``tempfile:`` command is a template. The string ``INFILE`` is replaced | |
702 | with the name of a temporary file that contains the data to be |
|
702 | with the name of a temporary file that contains the data to be | |
703 | filtered by the command. The string ``OUTFILE`` is replaced with the name |
|
703 | filtered by the command. The string ``OUTFILE`` is replaced with the name | |
704 | of an empty temporary file, where the filtered data must be written by |
|
704 | of an empty temporary file, where the filtered data must be written by | |
705 | the command. |
|
705 | the command. | |
706 |
|
706 | |||
707 | .. container:: windows |
|
707 | .. container:: windows | |
708 |
|
708 | |||
709 | .. note:: |
|
709 | .. note:: | |
710 |
|
710 | |||
711 | The tempfile mechanism is recommended for Windows systems, |
|
711 | The tempfile mechanism is recommended for Windows systems, | |
712 | where the standard shell I/O redirection operators often have |
|
712 | where the standard shell I/O redirection operators often have | |
713 | strange effects and may corrupt the contents of your files. |
|
713 | strange effects and may corrupt the contents of your files. | |
714 |
|
714 | |||
715 | This filter mechanism is used internally by the ``eol`` extension to |
|
715 | This filter mechanism is used internally by the ``eol`` extension to | |
716 | translate line ending characters between Windows (CRLF) and Unix (LF) |
|
716 | translate line ending characters between Windows (CRLF) and Unix (LF) | |
717 | format. We suggest you use the ``eol`` extension for convenience. |
|
717 | format. We suggest you use the ``eol`` extension for convenience. | |
718 |
|
718 | |||
719 |
|
719 | |||
720 | ``defaults`` |
|
720 | ``defaults`` | |
721 | ------------ |
|
721 | ------------ | |
722 |
|
722 | |||
723 | (defaults are deprecated. Don't use them. Use aliases instead.) |
|
723 | (defaults are deprecated. Don't use them. Use aliases instead.) | |
724 |
|
724 | |||
725 | Use the ``[defaults]`` section to define command defaults, i.e. the |
|
725 | Use the ``[defaults]`` section to define command defaults, i.e. the | |
726 | default options/arguments to pass to the specified commands. |
|
726 | default options/arguments to pass to the specified commands. | |
727 |
|
727 | |||
728 | The following example makes :hg:`log` run in verbose mode, and |
|
728 | The following example makes :hg:`log` run in verbose mode, and | |
729 | :hg:`status` show only the modified files, by default:: |
|
729 | :hg:`status` show only the modified files, by default:: | |
730 |
|
730 | |||
731 | [defaults] |
|
731 | [defaults] | |
732 | log = -v |
|
732 | log = -v | |
733 | status = -m |
|
733 | status = -m | |
734 |
|
734 | |||
735 | The actual commands, instead of their aliases, must be used when |
|
735 | The actual commands, instead of their aliases, must be used when | |
736 | defining command defaults. The command defaults will also be applied |
|
736 | defining command defaults. The command defaults will also be applied | |
737 | to the aliases of the commands defined. |
|
737 | to the aliases of the commands defined. | |
738 |
|
738 | |||
739 |
|
739 | |||
740 | ``diff`` |
|
740 | ``diff`` | |
741 | -------- |
|
741 | -------- | |
742 |
|
742 | |||
743 | Settings used when displaying diffs. Everything except for ``unified`` |
|
743 | Settings used when displaying diffs. Everything except for ``unified`` | |
744 | is a Boolean and defaults to False. See :hg:`help config.annotate` |
|
744 | is a Boolean and defaults to False. See :hg:`help config.annotate` | |
745 | for related options for the annotate command. |
|
745 | for related options for the annotate command. | |
746 |
|
746 | |||
747 | ``git`` |
|
747 | ``git`` | |
748 | Use git extended diff format. |
|
748 | Use git extended diff format. | |
749 |
|
749 | |||
750 | ``nobinary`` |
|
750 | ``nobinary`` | |
751 | Omit git binary patches. |
|
751 | Omit git binary patches. | |
752 |
|
752 | |||
753 | ``nodates`` |
|
753 | ``nodates`` | |
754 | Don't include dates in diff headers. |
|
754 | Don't include dates in diff headers. | |
755 |
|
755 | |||
756 | ``noprefix`` |
|
756 | ``noprefix`` | |
757 | Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode. |
|
757 | Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode. | |
758 |
|
758 | |||
759 | ``showfunc`` |
|
759 | ``showfunc`` | |
760 | Show which function each change is in. |
|
760 | Show which function each change is in. | |
761 |
|
761 | |||
762 | ``ignorews`` |
|
762 | ``ignorews`` | |
763 | Ignore white space when comparing lines. |
|
763 | Ignore white space when comparing lines. | |
764 |
|
764 | |||
765 | ``ignorewsamount`` |
|
765 | ``ignorewsamount`` | |
766 | Ignore changes in the amount of white space. |
|
766 | Ignore changes in the amount of white space. | |
767 |
|
767 | |||
768 | ``ignoreblanklines`` |
|
768 | ``ignoreblanklines`` | |
769 | Ignore changes whose lines are all blank. |
|
769 | Ignore changes whose lines are all blank. | |
770 |
|
770 | |||
771 | ``unified`` |
|
771 | ``unified`` | |
772 | Number of lines of context to show. |
|
772 | Number of lines of context to show. | |
773 |
|
773 | |||
774 | ``word-diff`` |
|
774 | ``word-diff`` | |
775 | Highlight changed words. |
|
775 | Highlight changed words. | |
776 |
|
776 | |||
777 | ``email`` |
|
777 | ``email`` | |
778 | --------- |
|
778 | --------- | |
779 |
|
779 | |||
780 | Settings for extensions that send email messages. |
|
780 | Settings for extensions that send email messages. | |
781 |
|
781 | |||
782 | ``from`` |
|
782 | ``from`` | |
783 | Optional. Email address to use in "From" header and SMTP envelope |
|
783 | Optional. Email address to use in "From" header and SMTP envelope | |
784 | of outgoing messages. |
|
784 | of outgoing messages. | |
785 |
|
785 | |||
786 | ``to`` |
|
786 | ``to`` | |
787 | Optional. Comma-separated list of recipients' email addresses. |
|
787 | Optional. Comma-separated list of recipients' email addresses. | |
788 |
|
788 | |||
789 | ``cc`` |
|
789 | ``cc`` | |
790 | Optional. Comma-separated list of carbon copy recipients' |
|
790 | Optional. Comma-separated list of carbon copy recipients' | |
791 | email addresses. |
|
791 | email addresses. | |
792 |
|
792 | |||
793 | ``bcc`` |
|
793 | ``bcc`` | |
794 | Optional. Comma-separated list of blind carbon copy recipients' |
|
794 | Optional. Comma-separated list of blind carbon copy recipients' | |
795 | email addresses. |
|
795 | email addresses. | |
796 |
|
796 | |||
797 | ``method`` |
|
797 | ``method`` | |
798 | Optional. Method to use to send email messages. If value is ``smtp`` |
|
798 | Optional. Method to use to send email messages. If value is ``smtp`` | |
799 | (default), use SMTP (see the ``[smtp]`` section for configuration). |
|
799 | (default), use SMTP (see the ``[smtp]`` section for configuration). | |
800 | Otherwise, use as name of program to run that acts like sendmail |
|
800 | Otherwise, use as name of program to run that acts like sendmail | |
801 | (takes ``-f`` option for sender, list of recipients on command line, |
|
801 | (takes ``-f`` option for sender, list of recipients on command line, | |
802 | message on stdin). Normally, setting this to ``sendmail`` or |
|
802 | message on stdin). Normally, setting this to ``sendmail`` or | |
803 | ``/usr/sbin/sendmail`` is enough to use sendmail to send messages. |
|
803 | ``/usr/sbin/sendmail`` is enough to use sendmail to send messages. | |
804 |
|
804 | |||
805 | ``charsets`` |
|
805 | ``charsets`` | |
806 | Optional. Comma-separated list of character sets considered |
|
806 | Optional. Comma-separated list of character sets considered | |
807 | convenient for recipients. Addresses, headers, and parts not |
|
807 | convenient for recipients. Addresses, headers, and parts not | |
808 | containing patches of outgoing messages will be encoded in the |
|
808 | containing patches of outgoing messages will be encoded in the | |
809 | first character set to which conversion from local encoding |
|
809 | first character set to which conversion from local encoding | |
810 | (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct |
|
810 | (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct | |
811 | conversion fails, the text in question is sent as is. |
|
811 | conversion fails, the text in question is sent as is. | |
812 | (default: '') |
|
812 | (default: '') | |
813 |
|
813 | |||
814 | Order of outgoing email character sets: |
|
814 | Order of outgoing email character sets: | |
815 |
|
815 | |||
816 | 1. ``us-ascii``: always first, regardless of settings |
|
816 | 1. ``us-ascii``: always first, regardless of settings | |
817 | 2. ``email.charsets``: in order given by user |
|
817 | 2. ``email.charsets``: in order given by user | |
818 | 3. ``ui.fallbackencoding``: if not in email.charsets |
|
818 | 3. ``ui.fallbackencoding``: if not in email.charsets | |
819 | 4. ``$HGENCODING``: if not in email.charsets |
|
819 | 4. ``$HGENCODING``: if not in email.charsets | |
820 | 5. ``utf-8``: always last, regardless of settings |
|
820 | 5. ``utf-8``: always last, regardless of settings | |
821 |
|
821 | |||
822 | Email example:: |
|
822 | Email example:: | |
823 |
|
823 | |||
824 | [email] |
|
824 | [email] | |
825 | from = Joseph User <joe.user@example.com> |
|
825 | from = Joseph User <joe.user@example.com> | |
826 | method = /usr/sbin/sendmail |
|
826 | method = /usr/sbin/sendmail | |
827 | # charsets for western Europeans |
|
827 | # charsets for western Europeans | |
828 | # us-ascii, utf-8 omitted, as they are tried first and last |
|
828 | # us-ascii, utf-8 omitted, as they are tried first and last | |
829 | charsets = iso-8859-1, iso-8859-15, windows-1252 |
|
829 | charsets = iso-8859-1, iso-8859-15, windows-1252 | |
830 |
|
830 | |||
831 |
|
831 | |||
832 | ``extensions`` |
|
832 | ``extensions`` | |
833 | -------------- |
|
833 | -------------- | |
834 |
|
834 | |||
835 | Mercurial has an extension mechanism for adding new features. To |
|
835 | Mercurial has an extension mechanism for adding new features. To | |
836 | enable an extension, create an entry for it in this section. |
|
836 | enable an extension, create an entry for it in this section. | |
837 |
|
837 | |||
838 | If you know that the extension is already in Python's search path, |
|
838 | If you know that the extension is already in Python's search path, | |
839 | you can give the name of the module, followed by ``=``, with nothing |
|
839 | you can give the name of the module, followed by ``=``, with nothing | |
840 | after the ``=``. |
|
840 | after the ``=``. | |
841 |
|
841 | |||
842 | Otherwise, give a name that you choose, followed by ``=``, followed by |
|
842 | Otherwise, give a name that you choose, followed by ``=``, followed by | |
843 | the path to the ``.py`` file (including the file name extension) that |
|
843 | the path to the ``.py`` file (including the file name extension) that | |
844 | defines the extension. |
|
844 | defines the extension. | |
845 |
|
845 | |||
846 | To explicitly disable an extension that is enabled in an hgrc of |
|
846 | To explicitly disable an extension that is enabled in an hgrc of | |
847 | broader scope, prepend its path with ``!``, as in ``foo = !/ext/path`` |
|
847 | broader scope, prepend its path with ``!``, as in ``foo = !/ext/path`` | |
848 | or ``foo = !`` when path is not supplied. |
|
848 | or ``foo = !`` when path is not supplied. | |
849 |
|
849 | |||
850 | Example for ``~/.hgrc``:: |
|
850 | Example for ``~/.hgrc``:: | |
851 |
|
851 | |||
852 | [extensions] |
|
852 | [extensions] | |
853 | # (the churn extension will get loaded from Mercurial's path) |
|
853 | # (the churn extension will get loaded from Mercurial's path) | |
854 | churn = |
|
854 | churn = | |
855 | # (this extension will get loaded from the file specified) |
|
855 | # (this extension will get loaded from the file specified) | |
856 | myfeature = ~/.hgext/myfeature.py |
|
856 | myfeature = ~/.hgext/myfeature.py | |
857 |
|
857 | |||
858 | If an extension fails to load, a warning will be issued, and Mercurial will |
|
858 | If an extension fails to load, a warning will be issued, and Mercurial will | |
859 | proceed. To enforce that an extension must be loaded, one can set the `required` |
|
859 | proceed. To enforce that an extension must be loaded, one can set the `required` | |
860 | suboption in the config:: |
|
860 | suboption in the config:: | |
861 |
|
861 | |||
862 | [extensions] |
|
862 | [extensions] | |
863 | myfeature = ~/.hgext/myfeature.py |
|
863 | myfeature = ~/.hgext/myfeature.py | |
864 | myfeature:required = yes |
|
864 | myfeature:required = yes | |
865 |
|
865 | |||
866 | To debug extension loading issue, one can add `--traceback` to their mercurial |
|
866 | To debug extension loading issue, one can add `--traceback` to their mercurial | |
867 | invocation. |
|
867 | invocation. | |
868 |
|
868 | |||
869 | A default setting can we set using the special `*` extension key:: |
|
869 | A default setting can we set using the special `*` extension key:: | |
870 |
|
870 | |||
871 | [extensions] |
|
871 | [extensions] | |
872 | *:required = yes |
|
872 | *:required = yes | |
873 | myfeature = ~/.hgext/myfeature.py |
|
873 | myfeature = ~/.hgext/myfeature.py | |
874 | rebase= |
|
874 | rebase= | |
875 |
|
875 | |||
876 |
|
876 | |||
877 | ``format`` |
|
877 | ``format`` | |
878 | ---------- |
|
878 | ---------- | |
879 |
|
879 | |||
880 | Configuration that controls the repository format. Newer format options are more |
|
880 | Configuration that controls the repository format. Newer format options are more | |
881 | powerful, but incompatible with some older versions of Mercurial. Format options |
|
881 | powerful, but incompatible with some older versions of Mercurial. Format options | |
882 | are considered at repository initialization only. You need to make a new clone |
|
882 | are considered at repository initialization only. You need to make a new clone | |
883 | for config changes to be taken into account. |
|
883 | for config changes to be taken into account. | |
884 |
|
884 | |||
885 | For more details about repository format and version compatibility, see |
|
885 | For more details about repository format and version compatibility, see | |
886 | https://www.mercurial-scm.org/wiki/MissingRequirement |
|
886 | https://www.mercurial-scm.org/wiki/MissingRequirement | |
887 |
|
887 | |||
888 | ``usegeneraldelta`` |
|
888 | ``usegeneraldelta`` | |
889 | Enable or disable the "generaldelta" repository format which improves |
|
889 | Enable or disable the "generaldelta" repository format which improves | |
890 | repository compression by allowing "revlog" to store deltas against |
|
890 | repository compression by allowing "revlog" to store deltas against | |
891 | arbitrary revisions instead of the previously stored one. This provides |
|
891 | arbitrary revisions instead of the previously stored one. This provides | |
892 | significant improvement for repositories with branches. |
|
892 | significant improvement for repositories with branches. | |
893 |
|
893 | |||
894 | Repositories with this on-disk format require Mercurial version 1.9. |
|
894 | Repositories with this on-disk format require Mercurial version 1.9. | |
895 |
|
895 | |||
896 | Enabled by default. |
|
896 | Enabled by default. | |
897 |
|
897 | |||
898 | ``dotencode`` |
|
898 | ``dotencode`` | |
899 | Enable or disable the "dotencode" repository format which enhances |
|
899 | Enable or disable the "dotencode" repository format which enhances | |
900 | the "fncache" repository format (which has to be enabled to use |
|
900 | the "fncache" repository format (which has to be enabled to use | |
901 | dotencode) to avoid issues with filenames starting with "._" on |
|
901 | dotencode) to avoid issues with filenames starting with "._" on | |
902 | Mac OS X and spaces on Windows. |
|
902 | Mac OS X and spaces on Windows. | |
903 |
|
903 | |||
904 | Repositories with this on-disk format require Mercurial version 1.7. |
|
904 | Repositories with this on-disk format require Mercurial version 1.7. | |
905 |
|
905 | |||
906 | Enabled by default. |
|
906 | Enabled by default. | |
907 |
|
907 | |||
908 | ``usefncache`` |
|
908 | ``usefncache`` | |
909 | Enable or disable the "fncache" repository format which enhances |
|
909 | Enable or disable the "fncache" repository format which enhances | |
910 | the "store" repository format (which has to be enabled to use |
|
910 | the "store" repository format (which has to be enabled to use | |
911 | fncache) to allow longer filenames and avoids using Windows |
|
911 | fncache) to allow longer filenames and avoids using Windows | |
912 | reserved names, e.g. "nul". |
|
912 | reserved names, e.g. "nul". | |
913 |
|
913 | |||
914 | Repositories with this on-disk format require Mercurial version 1.1. |
|
914 | Repositories with this on-disk format require Mercurial version 1.1. | |
915 |
|
915 | |||
916 | Enabled by default. |
|
916 | Enabled by default. | |
917 |
|
917 | |||
918 | ``use-dirstate-v2`` |
|
918 | ``use-dirstate-v2`` | |
919 | Enable or disable the experimental "dirstate-v2" feature. The dirstate |
|
919 | Enable or disable the experimental "dirstate-v2" feature. The dirstate | |
920 | functionality is shared by all commands interacting with the working copy. |
|
920 | functionality is shared by all commands interacting with the working copy. | |
921 | The new version is more robust, faster and stores more information. |
|
921 | The new version is more robust, faster and stores more information. | |
922 |
|
922 | |||
923 | The performance-improving version of this feature is currently only |
|
923 | The performance-improving version of this feature is currently only | |
924 | implemented in Rust (see :hg:`help rust`), so people not using a version of |
|
924 | implemented in Rust (see :hg:`help rust`), so people not using a version of | |
925 | Mercurial compiled with the Rust parts might actually suffer some slowdown. |
|
925 | Mercurial compiled with the Rust parts might actually suffer some slowdown. | |
926 | For this reason, such versions will by default refuse to access repositories |
|
926 | For this reason, such versions will by default refuse to access repositories | |
927 | with "dirstate-v2" enabled. |
|
927 | with "dirstate-v2" enabled. | |
928 |
|
928 | |||
929 | This behavior can be adjusted via configuration: check |
|
929 | This behavior can be adjusted via configuration: check | |
930 | :hg:`help config.storage.dirstate-v2.slow-path` for details. |
|
930 | :hg:`help config.storage.dirstate-v2.slow-path` for details. | |
931 |
|
931 | |||
932 | Repositories with this on-disk format require Mercurial 6.0 or above. |
|
932 | Repositories with this on-disk format require Mercurial 6.0 or above. | |
933 |
|
933 | |||
934 | By default this format variant is disabled if the fast implementation is not |
|
934 | By default this format variant is disabled if the fast implementation is not | |
935 | available, and enabled by default if the fast implementation is available. |
|
935 | available, and enabled by default if the fast implementation is available. | |
936 |
|
936 | |||
937 | To accomodate installations of Mercurial without the fast implementation, |
|
937 | To accomodate installations of Mercurial without the fast implementation, | |
938 | you can downgrade your repository. To do so run the following command: |
|
938 | you can downgrade your repository. To do so run the following command: | |
939 |
|
939 | |||
940 | $ hg debugupgraderepo \ |
|
940 | $ hg debugupgraderepo \ | |
941 | --run \ |
|
941 | --run \ | |
942 | --config format.use-dirstate-v2=False \ |
|
942 | --config format.use-dirstate-v2=False \ | |
943 | --config storage.dirstate-v2.slow-path=allow |
|
943 | --config storage.dirstate-v2.slow-path=allow | |
944 |
|
944 | |||
945 | For a more comprehensive guide, see :hg:`help internals.dirstate-v2`. |
|
945 | For a more comprehensive guide, see :hg:`help internals.dirstate-v2`. | |
946 |
|
946 | |||
947 | ``use-dirstate-tracked-hint`` |
|
947 | ``use-dirstate-tracked-hint`` | |
948 | Enable or disable the writing of "tracked key" file alongside the dirstate. |
|
948 | Enable or disable the writing of "tracked key" file alongside the dirstate. | |
949 | (default to disabled) |
|
949 | (default to disabled) | |
950 |
|
950 | |||
951 | That "tracked-hint" can help external automations to detect changes to the |
|
951 | That "tracked-hint" can help external automations to detect changes to the | |
952 | set of tracked files. (i.e the result of `hg files` or `hg status -macd`) |
|
952 | set of tracked files. (i.e the result of `hg files` or `hg status -macd`) | |
953 |
|
953 | |||
954 | The tracked-hint is written in a new `.hg/dirstate-tracked-hint`. That file |
|
954 | The tracked-hint is written in a new `.hg/dirstate-tracked-hint`. That file | |
955 | contains two lines: |
|
955 | contains two lines: | |
956 | - the first line is the file version (currently: 1), |
|
956 | - the first line is the file version (currently: 1), | |
957 | - the second line contains the "tracked-hint". |
|
957 | - the second line contains the "tracked-hint". | |
958 | That file is written right after the dirstate is written. |
|
958 | That file is written right after the dirstate is written. | |
959 |
|
959 | |||
960 | The tracked-hint changes whenever the set of file tracked in the dirstate |
|
960 | The tracked-hint changes whenever the set of file tracked in the dirstate | |
961 | changes. The general idea is: |
|
961 | changes. The general idea is: | |
962 | - if the hint is identical, the set of tracked file SHOULD be identical, |
|
962 | - if the hint is identical, the set of tracked file SHOULD be identical, | |
963 | - if the hint is different, the set of tracked file MIGHT be different. |
|
963 | - if the hint is different, the set of tracked file MIGHT be different. | |
964 |
|
964 | |||
965 | The "hint is identical" case uses `SHOULD` as the dirstate and the hint file |
|
965 | The "hint is identical" case uses `SHOULD` as the dirstate and the hint file | |
966 | are two distinct files and therefore that cannot be read or written to in an |
|
966 | are two distinct files and therefore that cannot be read or written to in an | |
967 | atomic way. If the key is identical, nothing garantees that the dirstate is |
|
967 | atomic way. If the key is identical, nothing garantees that the dirstate is | |
968 | not updated right after the hint file. This is considered a negligible |
|
968 | not updated right after the hint file. This is considered a negligible | |
969 | limitation for the intended usecase. It is actually possible to prevent this |
|
969 | limitation for the intended usecase. It is actually possible to prevent this | |
970 | race by taking the repository lock during read operations. |
|
970 | race by taking the repository lock during read operations. | |
971 |
|
971 | |||
972 | They are two "ways" to use this feature: |
|
972 | They are two "ways" to use this feature: | |
973 |
|
973 | |||
974 | 1) monitoring changes to the `.hg/dirstate-tracked-hint`, if the file |
|
974 | 1) monitoring changes to the `.hg/dirstate-tracked-hint`, if the file | |
975 | changes, the tracked set might have changed. |
|
975 | changes, the tracked set might have changed. | |
976 |
|
976 | |||
977 | 2) storing the value and comparing it to a later value. |
|
977 | 2) storing the value and comparing it to a later value. | |
978 |
|
978 | |||
979 | ``use-persistent-nodemap`` |
|
979 | ``use-persistent-nodemap`` | |
980 | Enable or disable the "persistent-nodemap" feature which improves |
|
980 | Enable or disable the "persistent-nodemap" feature which improves | |
981 | performance if the Rust extensions are available. |
|
981 | performance if the Rust extensions are available. | |
982 |
|
982 | |||
983 | The "persistent-nodemap" persist the "node -> rev" on disk removing the |
|
983 | The "persistent-nodemap" persist the "node -> rev" on disk removing the | |
984 | need to dynamically build that mapping for each Mercurial invocation. This |
|
984 | need to dynamically build that mapping for each Mercurial invocation. This | |
985 | significantly reduces the startup cost of various local and server-side |
|
985 | significantly reduces the startup cost of various local and server-side | |
986 | operation for larger repositories. |
|
986 | operation for larger repositories. | |
987 |
|
987 | |||
988 | The performance-improving version of this feature is currently only |
|
988 | The performance-improving version of this feature is currently only | |
989 | implemented in Rust (see :hg:`help rust`), so people not using a version of |
|
989 | implemented in Rust (see :hg:`help rust`), so people not using a version of | |
990 | Mercurial compiled with the Rust parts might actually suffer some slowdown. |
|
990 | Mercurial compiled with the Rust parts might actually suffer some slowdown. | |
991 | For this reason, such versions will by default refuse to access repositories |
|
991 | For this reason, such versions will by default refuse to access repositories | |
992 | with "persistent-nodemap". |
|
992 | with "persistent-nodemap". | |
993 |
|
993 | |||
994 | This behavior can be adjusted via configuration: check |
|
994 | This behavior can be adjusted via configuration: check | |
995 | :hg:`help config.storage.revlog.persistent-nodemap.slow-path` for details. |
|
995 | :hg:`help config.storage.revlog.persistent-nodemap.slow-path` for details. | |
996 |
|
996 | |||
997 | Repositories with this on-disk format require Mercurial 5.4 or above. |
|
997 | Repositories with this on-disk format require Mercurial 5.4 or above. | |
998 |
|
998 | |||
999 | By default this format variant is disabled if the fast implementation is not |
|
999 | By default this format variant is disabled if the fast implementation is not | |
1000 | available, and enabled by default if the fast implementation is available. |
|
1000 | available, and enabled by default if the fast implementation is available. | |
1001 |
|
1001 | |||
1002 | To accomodate installations of Mercurial without the fast implementation, |
|
1002 | To accomodate installations of Mercurial without the fast implementation, | |
1003 | you can downgrade your repository. To do so run the following command: |
|
1003 | you can downgrade your repository. To do so run the following command: | |
1004 |
|
1004 | |||
1005 | $ hg debugupgraderepo \ |
|
1005 | $ hg debugupgraderepo \ | |
1006 | --run \ |
|
1006 | --run \ | |
1007 | --config format.use-persistent-nodemap=False \ |
|
1007 | --config format.use-persistent-nodemap=False \ | |
1008 | --config storage.revlog.persistent-nodemap.slow-path=allow |
|
1008 | --config storage.revlog.persistent-nodemap.slow-path=allow | |
1009 |
|
1009 | |||
1010 | ``use-share-safe`` |
|
1010 | ``use-share-safe`` | |
1011 | Enforce "safe" behaviors for all "shares" that access this repository. |
|
1011 | Enforce "safe" behaviors for all "shares" that access this repository. | |
1012 |
|
1012 | |||
1013 | With this feature, "shares" using this repository as a source will: |
|
1013 | With this feature, "shares" using this repository as a source will: | |
1014 |
|
1014 | |||
1015 | * read the source repository's configuration (`<source>/.hg/hgrc`). |
|
1015 | * read the source repository's configuration (`<source>/.hg/hgrc`). | |
1016 | * read and use the source repository's "requirements" |
|
1016 | * read and use the source repository's "requirements" | |
1017 | (except the working copy specific one). |
|
1017 | (except the working copy specific one). | |
1018 |
|
1018 | |||
1019 | Without this feature, "shares" using this repository as a source will: |
|
1019 | Without this feature, "shares" using this repository as a source will: | |
1020 |
|
1020 | |||
1021 | * keep tracking the repository "requirements" in the share only, ignoring |
|
1021 | * keep tracking the repository "requirements" in the share only, ignoring | |
1022 | the source "requirements", possibly diverging from them. |
|
1022 | the source "requirements", possibly diverging from them. | |
1023 | * ignore source repository config. This can create problems, like silently |
|
1023 | * ignore source repository config. This can create problems, like silently | |
1024 | ignoring important hooks. |
|
1024 | ignoring important hooks. | |
1025 |
|
1025 | |||
1026 | Beware that existing shares will not be upgraded/downgraded, and by |
|
1026 | Beware that existing shares will not be upgraded/downgraded, and by | |
1027 | default, Mercurial will refuse to interact with them until the mismatch |
|
1027 | default, Mercurial will refuse to interact with them until the mismatch | |
1028 | is resolved. See :hg:`help config.share.safe-mismatch.source-safe` and |
|
1028 | is resolved. See :hg:`help config.share.safe-mismatch.source-safe` and | |
1029 | :hg:`help config.share.safe-mismatch.source-not-safe` for details. |
|
1029 | :hg:`help config.share.safe-mismatch.source-not-safe` for details. | |
1030 |
|
1030 | |||
1031 | Introduced in Mercurial 5.7. |
|
1031 | Introduced in Mercurial 5.7. | |
1032 |
|
1032 | |||
1033 | Enabled by default in Mercurial 6.1. |
|
1033 | Enabled by default in Mercurial 6.1. | |
1034 |
|
1034 | |||
1035 | ``usestore`` |
|
1035 | ``usestore`` | |
1036 | Enable or disable the "store" repository format which improves |
|
1036 | Enable or disable the "store" repository format which improves | |
1037 | compatibility with systems that fold case or otherwise mangle |
|
1037 | compatibility with systems that fold case or otherwise mangle | |
1038 | filenames. Disabling this option will allow you to store longer filenames |
|
1038 | filenames. Disabling this option will allow you to store longer filenames | |
1039 | in some situations at the expense of compatibility. |
|
1039 | in some situations at the expense of compatibility. | |
1040 |
|
1040 | |||
1041 | Repositories with this on-disk format require Mercurial version 0.9.4. |
|
1041 | Repositories with this on-disk format require Mercurial version 0.9.4. | |
1042 |
|
1042 | |||
1043 | Enabled by default. |
|
1043 | Enabled by default. | |
1044 |
|
1044 | |||
1045 | ``sparse-revlog`` |
|
1045 | ``sparse-revlog`` | |
1046 | Enable or disable the ``sparse-revlog`` delta strategy. This format improves |
|
1046 | Enable or disable the ``sparse-revlog`` delta strategy. This format improves | |
1047 | delta re-use inside revlog. For very branchy repositories, it results in a |
|
1047 | delta re-use inside revlog. For very branchy repositories, it results in a | |
1048 | smaller store. For repositories with many revisions, it also helps |
|
1048 | smaller store. For repositories with many revisions, it also helps | |
1049 | performance (by using shortened delta chains.) |
|
1049 | performance (by using shortened delta chains.) | |
1050 |
|
1050 | |||
1051 | Repositories with this on-disk format require Mercurial version 4.7 |
|
1051 | Repositories with this on-disk format require Mercurial version 4.7 | |
1052 |
|
1052 | |||
1053 | Enabled by default. |
|
1053 | Enabled by default. | |
1054 |
|
1054 | |||
1055 | ``revlog-compression`` |
|
1055 | ``revlog-compression`` | |
1056 | Compression algorithm used by revlog. Supported values are `zlib` and |
|
1056 | Compression algorithm used by revlog. Supported values are `zlib` and | |
1057 | `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is |
|
1057 | `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is | |
1058 | a newer format that is usually a net win over `zlib`, operating faster at |
|
1058 | a newer format that is usually a net win over `zlib`, operating faster at | |
1059 | better compression rates. Use `zstd` to reduce CPU usage. Multiple values |
|
1059 | better compression rates. Use `zstd` to reduce CPU usage. Multiple values | |
1060 | can be specified, the first available one will be used. |
|
1060 | can be specified, the first available one will be used. | |
1061 |
|
1061 | |||
1062 | On some systems, the Mercurial installation may lack `zstd` support. |
|
1062 | On some systems, the Mercurial installation may lack `zstd` support. | |
1063 |
|
1063 | |||
1064 | Default is `zstd` if available, `zlib` otherwise. |
|
1064 | Default is `zstd` if available, `zlib` otherwise. | |
1065 |
|
1065 | |||
1066 | ``bookmarks-in-store`` |
|
1066 | ``bookmarks-in-store`` | |
1067 | Store bookmarks in .hg/store/. This means that bookmarks are shared when |
|
1067 | Store bookmarks in .hg/store/. This means that bookmarks are shared when | |
1068 | using `hg share` regardless of the `-B` option. |
|
1068 | using `hg share` regardless of the `-B` option. | |
1069 |
|
1069 | |||
1070 | Repositories with this on-disk format require Mercurial version 5.1. |
|
1070 | Repositories with this on-disk format require Mercurial version 5.1. | |
1071 |
|
1071 | |||
1072 | Disabled by default. |
|
1072 | Disabled by default. | |
1073 |
|
1073 | |||
1074 |
|
1074 | |||
1075 | ``graph`` |
|
1075 | ``graph`` | |
1076 | --------- |
|
1076 | --------- | |
1077 |
|
1077 | |||
1078 | Web graph view configuration. This section let you change graph |
|
1078 | Web graph view configuration. This section let you change graph | |
1079 | elements display properties by branches, for instance to make the |
|
1079 | elements display properties by branches, for instance to make the | |
1080 | ``default`` branch stand out. |
|
1080 | ``default`` branch stand out. | |
1081 |
|
1081 | |||
1082 | Each line has the following format:: |
|
1082 | Each line has the following format:: | |
1083 |
|
1083 | |||
1084 | <branch>.<argument> = <value> |
|
1084 | <branch>.<argument> = <value> | |
1085 |
|
1085 | |||
1086 | where ``<branch>`` is the name of the branch being |
|
1086 | where ``<branch>`` is the name of the branch being | |
1087 | customized. Example:: |
|
1087 | customized. Example:: | |
1088 |
|
1088 | |||
1089 | [graph] |
|
1089 | [graph] | |
1090 | # 2px width |
|
1090 | # 2px width | |
1091 | default.width = 2 |
|
1091 | default.width = 2 | |
1092 | # red color |
|
1092 | # red color | |
1093 | default.color = FF0000 |
|
1093 | default.color = FF0000 | |
1094 |
|
1094 | |||
1095 | Supported arguments: |
|
1095 | Supported arguments: | |
1096 |
|
1096 | |||
1097 | ``width`` |
|
1097 | ``width`` | |
1098 | Set branch edges width in pixels. |
|
1098 | Set branch edges width in pixels. | |
1099 |
|
1099 | |||
1100 | ``color`` |
|
1100 | ``color`` | |
1101 | Set branch edges color in hexadecimal RGB notation. |
|
1101 | Set branch edges color in hexadecimal RGB notation. | |
1102 |
|
1102 | |||
1103 | ``hooks`` |
|
1103 | ``hooks`` | |
1104 | --------- |
|
1104 | --------- | |
1105 |
|
1105 | |||
1106 | Commands or Python functions that get automatically executed by |
|
1106 | Commands or Python functions that get automatically executed by | |
1107 | various actions such as starting or finishing a commit. Multiple |
|
1107 | various actions such as starting or finishing a commit. Multiple | |
1108 | hooks can be run for the same action by appending a suffix to the |
|
1108 | hooks can be run for the same action by appending a suffix to the | |
1109 | action. Overriding a site-wide hook can be done by changing its |
|
1109 | action. Overriding a site-wide hook can be done by changing its | |
1110 | value or setting it to an empty string. Hooks can be prioritized |
|
1110 | value or setting it to an empty string. Hooks can be prioritized | |
1111 | by adding a prefix of ``priority.`` to the hook name on a new line |
|
1111 | by adding a prefix of ``priority.`` to the hook name on a new line | |
1112 | and setting the priority. The default priority is 0. |
|
1112 | and setting the priority. The default priority is 0. | |
1113 |
|
1113 | |||
1114 | Example ``.hg/hgrc``:: |
|
1114 | Example ``.hg/hgrc``:: | |
1115 |
|
1115 | |||
1116 | [hooks] |
|
1116 | [hooks] | |
1117 | # update working directory after adding changesets |
|
1117 | # update working directory after adding changesets | |
1118 | changegroup.update = hg update |
|
1118 | changegroup.update = hg update | |
1119 | # do not use the site-wide hook |
|
1119 | # do not use the site-wide hook | |
1120 | incoming = |
|
1120 | incoming = | |
1121 | incoming.email = /my/email/hook |
|
1121 | incoming.email = /my/email/hook | |
1122 | incoming.autobuild = /my/build/hook |
|
1122 | incoming.autobuild = /my/build/hook | |
1123 | # force autobuild hook to run before other incoming hooks |
|
1123 | # force autobuild hook to run before other incoming hooks | |
1124 | priority.incoming.autobuild = 1 |
|
1124 | priority.incoming.autobuild = 1 | |
1125 | ### control HGPLAIN setting when running autobuild hook |
|
1125 | ### control HGPLAIN setting when running autobuild hook | |
1126 | # HGPLAIN always set (default from Mercurial 5.7) |
|
1126 | # HGPLAIN always set (default from Mercurial 5.7) | |
1127 | incoming.autobuild:run-with-plain = yes |
|
1127 | incoming.autobuild:run-with-plain = yes | |
1128 | # HGPLAIN never set |
|
1128 | # HGPLAIN never set | |
1129 | incoming.autobuild:run-with-plain = no |
|
1129 | incoming.autobuild:run-with-plain = no | |
1130 | # HGPLAIN inherited from environment (default before Mercurial 5.7) |
|
1130 | # HGPLAIN inherited from environment (default before Mercurial 5.7) | |
1131 | incoming.autobuild:run-with-plain = auto |
|
1131 | incoming.autobuild:run-with-plain = auto | |
1132 |
|
1132 | |||
1133 | Most hooks are run with environment variables set that give useful |
|
1133 | Most hooks are run with environment variables set that give useful | |
1134 | additional information. For each hook below, the environment variables |
|
1134 | additional information. For each hook below, the environment variables | |
1135 | it is passed are listed with names in the form ``$HG_foo``. The |
|
1135 | it is passed are listed with names in the form ``$HG_foo``. The | |
1136 | ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks. |
|
1136 | ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks. | |
1137 | They contain the type of hook which triggered the run and the full name |
|
1137 | They contain the type of hook which triggered the run and the full name | |
1138 | of the hook in the config, respectively. In the example above, this will |
|
1138 | of the hook in the config, respectively. In the example above, this will | |
1139 | be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``. |
|
1139 | be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``. | |
1140 |
|
1140 | |||
1141 | .. container:: windows |
|
1141 | .. container:: windows | |
1142 |
|
1142 | |||
1143 | Some basic Unix syntax can be enabled for portability, including ``$VAR`` |
|
1143 | Some basic Unix syntax can be enabled for portability, including ``$VAR`` | |
1144 | and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will |
|
1144 | and ``${VAR}`` style variables. A ``~`` followed by ``\`` or ``/`` will | |
1145 | be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion |
|
1145 | be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion | |
1146 | on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back |
|
1146 | on Unix. To use a literal ``$`` or ``~``, it must be escaped with a back | |
1147 | slash or inside of a strong quote. Strong quotes will be replaced by |
|
1147 | slash or inside of a strong quote. Strong quotes will be replaced by | |
1148 | double quotes after processing. |
|
1148 | double quotes after processing. | |
1149 |
|
1149 | |||
1150 | This feature is enabled by adding a prefix of ``tonative.`` to the hook |
|
1150 | This feature is enabled by adding a prefix of ``tonative.`` to the hook | |
1151 | name on a new line, and setting it to ``True``. For example:: |
|
1151 | name on a new line, and setting it to ``True``. For example:: | |
1152 |
|
1152 | |||
1153 | [hooks] |
|
1153 | [hooks] | |
1154 | incoming.autobuild = /my/build/hook |
|
1154 | incoming.autobuild = /my/build/hook | |
1155 | # enable translation to cmd.exe syntax for autobuild hook |
|
1155 | # enable translation to cmd.exe syntax for autobuild hook | |
1156 | tonative.incoming.autobuild = True |
|
1156 | tonative.incoming.autobuild = True | |
1157 |
|
1157 | |||
1158 | ``changegroup`` |
|
1158 | ``changegroup`` | |
1159 | Run after a changegroup has been added via push, pull or unbundle. The ID of |
|
1159 | Run after a changegroup has been added via push, pull or unbundle. The ID of | |
1160 | the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``. |
|
1160 | the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``. | |
1161 | The URL from which changes came is in ``$HG_URL``. |
|
1161 | The URL from which changes came is in ``$HG_URL``. | |
1162 |
|
1162 | |||
1163 | ``commit`` |
|
1163 | ``commit`` | |
1164 | Run after a changeset has been created in the local repository. The ID |
|
1164 | Run after a changeset has been created in the local repository. The ID | |
1165 | of the newly created changeset is in ``$HG_NODE``. Parent changeset |
|
1165 | of the newly created changeset is in ``$HG_NODE``. Parent changeset | |
1166 | IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. |
|
1166 | IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. | |
1167 |
|
1167 | |||
1168 | ``incoming`` |
|
1168 | ``incoming`` | |
1169 | Run after a changeset has been pulled, pushed, or unbundled into |
|
1169 | Run after a changeset has been pulled, pushed, or unbundled into | |
1170 | the local repository. The ID of the newly arrived changeset is in |
|
1170 | the local repository. The ID of the newly arrived changeset is in | |
1171 | ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``. |
|
1171 | ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``. | |
1172 |
|
1172 | |||
1173 | ``outgoing`` |
|
1173 | ``outgoing`` | |
1174 | Run after sending changes from the local repository to another. The ID of |
|
1174 | Run after sending changes from the local repository to another. The ID of | |
1175 | first changeset sent is in ``$HG_NODE``. The source of operation is in |
|
1175 | first changeset sent is in ``$HG_NODE``. The source of operation is in | |
1176 | ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`. |
|
1176 | ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`. | |
1177 |
|
1177 | |||
1178 | ``post-<command>`` |
|
1178 | ``post-<command>`` | |
1179 | Run after successful invocations of the associated command. The |
|
1179 | Run after successful invocations of the associated command. The | |
1180 | contents of the command line are passed as ``$HG_ARGS`` and the result |
|
1180 | contents of the command line are passed as ``$HG_ARGS`` and the result | |
1181 | code in ``$HG_RESULT``. Parsed command line arguments are passed as |
|
1181 | code in ``$HG_RESULT``. Parsed command line arguments are passed as | |
1182 | ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of |
|
1182 | ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of | |
1183 | the python data internally passed to <command>. ``$HG_OPTS`` is a |
|
1183 | the python data internally passed to <command>. ``$HG_OPTS`` is a | |
1184 | dictionary of options (with unspecified options set to their defaults). |
|
1184 | dictionary of options (with unspecified options set to their defaults). | |
1185 | ``$HG_PATS`` is a list of arguments. Hook failure is ignored. |
|
1185 | ``$HG_PATS`` is a list of arguments. Hook failure is ignored. | |
1186 |
|
1186 | |||
1187 | ``fail-<command>`` |
|
1187 | ``fail-<command>`` | |
1188 | Run after a failed invocation of an associated command. The contents |
|
1188 | Run after a failed invocation of an associated command. The contents | |
1189 | of the command line are passed as ``$HG_ARGS``. Parsed command line |
|
1189 | of the command line are passed as ``$HG_ARGS``. Parsed command line | |
1190 | arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain |
|
1190 | arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain | |
1191 | string representations of the python data internally passed to |
|
1191 | string representations of the python data internally passed to | |
1192 | <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified |
|
1192 | <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified | |
1193 | options set to their defaults). ``$HG_PATS`` is a list of arguments. |
|
1193 | options set to their defaults). ``$HG_PATS`` is a list of arguments. | |
1194 | Hook failure is ignored. |
|
1194 | Hook failure is ignored. | |
1195 |
|
1195 | |||
1196 | ``pre-<command>`` |
|
1196 | ``pre-<command>`` | |
1197 | Run before executing the associated command. The contents of the |
|
1197 | Run before executing the associated command. The contents of the | |
1198 | command line are passed as ``$HG_ARGS``. Parsed command line arguments |
|
1198 | command line are passed as ``$HG_ARGS``. Parsed command line arguments | |
1199 | are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string |
|
1199 | are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string | |
1200 | representations of the data internally passed to <command>. ``$HG_OPTS`` |
|
1200 | representations of the data internally passed to <command>. ``$HG_OPTS`` | |
1201 | is a dictionary of options (with unspecified options set to their |
|
1201 | is a dictionary of options (with unspecified options set to their | |
1202 | defaults). ``$HG_PATS`` is a list of arguments. If the hook returns |
|
1202 | defaults). ``$HG_PATS`` is a list of arguments. If the hook returns | |
1203 | failure, the command doesn't execute and Mercurial returns the failure |
|
1203 | failure, the command doesn't execute and Mercurial returns the failure | |
1204 | code. |
|
1204 | code. | |
1205 |
|
1205 | |||
1206 | ``prechangegroup`` |
|
1206 | ``prechangegroup`` | |
1207 | Run before a changegroup is added via push, pull or unbundle. Exit |
|
1207 | Run before a changegroup is added via push, pull or unbundle. Exit | |
1208 | status 0 allows the changegroup to proceed. A non-zero status will |
|
1208 | status 0 allows the changegroup to proceed. A non-zero status will | |
1209 | cause the push, pull or unbundle to fail. The URL from which changes |
|
1209 | cause the push, pull or unbundle to fail. The URL from which changes | |
1210 | will come is in ``$HG_URL``. |
|
1210 | will come is in ``$HG_URL``. | |
1211 |
|
1211 | |||
1212 | ``precommit`` |
|
1212 | ``precommit`` | |
1213 | Run before starting a local commit. Exit status 0 allows the |
|
1213 | Run before starting a local commit. Exit status 0 allows the | |
1214 | commit to proceed. A non-zero status will cause the commit to fail. |
|
1214 | commit to proceed. A non-zero status will cause the commit to fail. | |
1215 | Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. |
|
1215 | Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. | |
1216 |
|
1216 | |||
1217 | ``prelistkeys`` |
|
1217 | ``prelistkeys`` | |
1218 | Run before listing pushkeys (like bookmarks) in the |
|
1218 | Run before listing pushkeys (like bookmarks) in the | |
1219 | repository. A non-zero status will cause failure. The key namespace is |
|
1219 | repository. A non-zero status will cause failure. The key namespace is | |
1220 | in ``$HG_NAMESPACE``. |
|
1220 | in ``$HG_NAMESPACE``. | |
1221 |
|
1221 | |||
1222 | ``preoutgoing`` |
|
1222 | ``preoutgoing`` | |
1223 | Run before collecting changes to send from the local repository to |
|
1223 | Run before collecting changes to send from the local repository to | |
1224 | another. A non-zero status will cause failure. This lets you prevent |
|
1224 | another. A non-zero status will cause failure. This lets you prevent | |
1225 | pull over HTTP or SSH. It can also prevent propagating commits (via |
|
1225 | pull over HTTP or SSH. It can also prevent propagating commits (via | |
1226 | local pull, push (outbound) or bundle commands), but not completely, |
|
1226 | local pull, push (outbound) or bundle commands), but not completely, | |
1227 | since you can just copy files instead. The source of operation is in |
|
1227 | since you can just copy files instead. The source of operation is in | |
1228 | ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote |
|
1228 | ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote | |
1229 | SSH or HTTP repository. If "push", "pull" or "bundle", the operation |
|
1229 | SSH or HTTP repository. If "push", "pull" or "bundle", the operation | |
1230 | is happening on behalf of a repository on same system. |
|
1230 | is happening on behalf of a repository on same system. | |
1231 |
|
1231 | |||
1232 | ``prepushkey`` |
|
1232 | ``prepushkey`` | |
1233 | Run before a pushkey (like a bookmark) is added to the |
|
1233 | Run before a pushkey (like a bookmark) is added to the | |
1234 | repository. A non-zero status will cause the key to be rejected. The |
|
1234 | repository. A non-zero status will cause the key to be rejected. The | |
1235 | key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``, |
|
1235 | key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``, | |
1236 | the old value (if any) is in ``$HG_OLD``, and the new value is in |
|
1236 | the old value (if any) is in ``$HG_OLD``, and the new value is in | |
1237 | ``$HG_NEW``. |
|
1237 | ``$HG_NEW``. | |
1238 |
|
1238 | |||
1239 | ``pretag`` |
|
1239 | ``pretag`` | |
1240 | Run before creating a tag. Exit status 0 allows the tag to be |
|
1240 | Run before creating a tag. Exit status 0 allows the tag to be | |
1241 | created. A non-zero status will cause the tag to fail. The ID of the |
|
1241 | created. A non-zero status will cause the tag to fail. The ID of the | |
1242 | changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The |
|
1242 | changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The | |
1243 | tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``. |
|
1243 | tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``. | |
1244 |
|
1244 | |||
1245 | ``pretxnopen`` |
|
1245 | ``pretxnopen`` | |
1246 | Run before any new repository transaction is open. The reason for the |
|
1246 | Run before any new repository transaction is open. The reason for the | |
1247 | transaction will be in ``$HG_TXNNAME``, and a unique identifier for the |
|
1247 | transaction will be in ``$HG_TXNNAME``, and a unique identifier for the | |
1248 | transaction will be in ``$HG_TXNID``. A non-zero status will prevent the |
|
1248 | transaction will be in ``$HG_TXNID``. A non-zero status will prevent the | |
1249 | transaction from being opened. |
|
1249 | transaction from being opened. | |
1250 |
|
1250 | |||
1251 | ``pretxnclose`` |
|
1251 | ``pretxnclose`` | |
1252 | Run right before the transaction is actually finalized. Any repository change |
|
1252 | Run right before the transaction is actually finalized. Any repository change | |
1253 | will be visible to the hook program. This lets you validate the transaction |
|
1253 | will be visible to the hook program. This lets you validate the transaction | |
1254 | content or change it. Exit status 0 allows the commit to proceed. A non-zero |
|
1254 | content or change it. Exit status 0 allows the commit to proceed. A non-zero | |
1255 | status will cause the transaction to be rolled back. The reason for the |
|
1255 | status will cause the transaction to be rolled back. The reason for the | |
1256 | transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for |
|
1256 | transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for | |
1257 | the transaction will be in ``$HG_TXNID``. The rest of the available data will |
|
1257 | the transaction will be in ``$HG_TXNID``. The rest of the available data will | |
1258 | vary according the transaction type. Changes unbundled to the repository will |
|
1258 | vary according the transaction type. Changes unbundled to the repository will | |
1259 | add ``$HG_URL`` and ``$HG_SOURCE``. New changesets will add ``$HG_NODE`` (the |
|
1259 | add ``$HG_URL`` and ``$HG_SOURCE``. New changesets will add ``$HG_NODE`` (the | |
1260 | ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last added |
|
1260 | ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last added | |
1261 | changeset). Bookmark and phase changes will set ``$HG_BOOKMARK_MOVED`` and |
|
1261 | changeset). Bookmark and phase changes will set ``$HG_BOOKMARK_MOVED`` and | |
1262 | ``$HG_PHASES_MOVED`` to ``1`` respectively. The number of new obsmarkers, if |
|
1262 | ``$HG_PHASES_MOVED`` to ``1`` respectively. The number of new obsmarkers, if | |
1263 | any, will be in ``$HG_NEW_OBSMARKERS``, etc. |
|
1263 | any, will be in ``$HG_NEW_OBSMARKERS``, etc. | |
1264 |
|
1264 | |||
1265 | ``pretxnclose-bookmark`` |
|
1265 | ``pretxnclose-bookmark`` | |
1266 | Run right before a bookmark change is actually finalized. Any repository |
|
1266 | Run right before a bookmark change is actually finalized. Any repository | |
1267 | change will be visible to the hook program. This lets you validate the |
|
1267 | change will be visible to the hook program. This lets you validate the | |
1268 | transaction content or change it. Exit status 0 allows the commit to |
|
1268 | transaction content or change it. Exit status 0 allows the commit to | |
1269 | proceed. A non-zero status will cause the transaction to be rolled back. |
|
1269 | proceed. A non-zero status will cause the transaction to be rolled back. | |
1270 | The name of the bookmark will be available in ``$HG_BOOKMARK``, the new |
|
1270 | The name of the bookmark will be available in ``$HG_BOOKMARK``, the new | |
1271 | bookmark location will be available in ``$HG_NODE`` while the previous |
|
1271 | bookmark location will be available in ``$HG_NODE`` while the previous | |
1272 | location will be available in ``$HG_OLDNODE``. In case of a bookmark |
|
1272 | location will be available in ``$HG_OLDNODE``. In case of a bookmark | |
1273 | creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE`` |
|
1273 | creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE`` | |
1274 | will be empty. |
|
1274 | will be empty. | |
1275 | In addition, the reason for the transaction opening will be in |
|
1275 | In addition, the reason for the transaction opening will be in | |
1276 | ``$HG_TXNNAME``, and a unique identifier for the transaction will be in |
|
1276 | ``$HG_TXNNAME``, and a unique identifier for the transaction will be in | |
1277 | ``$HG_TXNID``. |
|
1277 | ``$HG_TXNID``. | |
1278 |
|
1278 | |||
1279 | ``pretxnclose-phase`` |
|
1279 | ``pretxnclose-phase`` | |
1280 | Run right before a phase change is actually finalized. Any repository change |
|
1280 | Run right before a phase change is actually finalized. Any repository change | |
1281 | will be visible to the hook program. This lets you validate the transaction |
|
1281 | will be visible to the hook program. This lets you validate the transaction | |
1282 | content or change it. Exit status 0 allows the commit to proceed. A non-zero |
|
1282 | content or change it. Exit status 0 allows the commit to proceed. A non-zero | |
1283 | status will cause the transaction to be rolled back. The hook is called |
|
1283 | status will cause the transaction to be rolled back. The hook is called | |
1284 | multiple times, once for each revision affected by a phase change. |
|
1284 | multiple times, once for each revision affected by a phase change. | |
1285 | The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE`` |
|
1285 | The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE`` | |
1286 | while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE`` |
|
1286 | while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE`` | |
1287 | will be empty. In addition, the reason for the transaction opening will be in |
|
1287 | will be empty. In addition, the reason for the transaction opening will be in | |
1288 | ``$HG_TXNNAME``, and a unique identifier for the transaction will be in |
|
1288 | ``$HG_TXNNAME``, and a unique identifier for the transaction will be in | |
1289 | ``$HG_TXNID``. The hook is also run for newly added revisions. In this case |
|
1289 | ``$HG_TXNID``. The hook is also run for newly added revisions. In this case | |
1290 | the ``$HG_OLDPHASE`` entry will be empty. |
|
1290 | the ``$HG_OLDPHASE`` entry will be empty. | |
1291 |
|
1291 | |||
1292 | ``txnclose`` |
|
1292 | ``txnclose`` | |
1293 | Run after any repository transaction has been committed. At this |
|
1293 | Run after any repository transaction has been committed. At this | |
1294 | point, the transaction can no longer be rolled back. The hook will run |
|
1294 | point, the transaction can no longer be rolled back. The hook will run | |
1295 | after the lock is released. See :hg:`help config.hooks.pretxnclose` for |
|
1295 | after the lock is released. See :hg:`help config.hooks.pretxnclose` for | |
1296 | details about available variables. |
|
1296 | details about available variables. | |
1297 |
|
1297 | |||
1298 | ``txnclose-bookmark`` |
|
1298 | ``txnclose-bookmark`` | |
1299 | Run after any bookmark change has been committed. At this point, the |
|
1299 | Run after any bookmark change has been committed. At this point, the | |
1300 | transaction can no longer be rolled back. The hook will run after the lock |
|
1300 | transaction can no longer be rolled back. The hook will run after the lock | |
1301 | is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details |
|
1301 | is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details | |
1302 | about available variables. |
|
1302 | about available variables. | |
1303 |
|
1303 | |||
1304 | ``txnclose-phase`` |
|
1304 | ``txnclose-phase`` | |
1305 | Run after any phase change has been committed. At this point, the |
|
1305 | Run after any phase change has been committed. At this point, the | |
1306 | transaction can no longer be rolled back. The hook will run after the lock |
|
1306 | transaction can no longer be rolled back. The hook will run after the lock | |
1307 | is released. See :hg:`help config.hooks.pretxnclose-phase` for details about |
|
1307 | is released. See :hg:`help config.hooks.pretxnclose-phase` for details about | |
1308 | available variables. |
|
1308 | available variables. | |
1309 |
|
1309 | |||
1310 | ``txnabort`` |
|
1310 | ``txnabort`` | |
1311 | Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose` |
|
1311 | Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose` | |
1312 | for details about available variables. |
|
1312 | for details about available variables. | |
1313 |
|
1313 | |||
1314 | ``pretxnchangegroup`` |
|
1314 | ``pretxnchangegroup`` | |
1315 | Run after a changegroup has been added via push, pull or unbundle, but before |
|
1315 | Run after a changegroup has been added via push, pull or unbundle, but before | |
1316 | the transaction has been committed. The changegroup is visible to the hook |
|
1316 | the transaction has been committed. The changegroup is visible to the hook | |
1317 | program. This allows validation of incoming changes before accepting them. |
|
1317 | program. This allows validation of incoming changes before accepting them. | |
1318 | The ID of the first new changeset is in ``$HG_NODE`` and last is in |
|
1318 | The ID of the first new changeset is in ``$HG_NODE`` and last is in | |
1319 | ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero |
|
1319 | ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero | |
1320 | status will cause the transaction to be rolled back, and the push, pull or |
|
1320 | status will cause the transaction to be rolled back, and the push, pull or | |
1321 | unbundle will fail. The URL that was the source of changes is in ``$HG_URL``. |
|
1321 | unbundle will fail. The URL that was the source of changes is in ``$HG_URL``. | |
1322 |
|
1322 | |||
1323 | ``pretxncommit`` |
|
1323 | ``pretxncommit`` | |
1324 | Run after a changeset has been created, but before the transaction is |
|
1324 | Run after a changeset has been created, but before the transaction is | |
1325 | committed. The changeset is visible to the hook program. This allows |
|
1325 | committed. The changeset is visible to the hook program. This allows | |
1326 | validation of the commit message and changes. Exit status 0 allows the |
|
1326 | validation of the commit message and changes. Exit status 0 allows the | |
1327 | commit to proceed. A non-zero status will cause the transaction to |
|
1327 | commit to proceed. A non-zero status will cause the transaction to | |
1328 | be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent |
|
1328 | be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent | |
1329 | changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. |
|
1329 | changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. | |
1330 |
|
1330 | |||
1331 | ``preupdate`` |
|
1331 | ``preupdate`` | |
1332 | Run before updating the working directory. Exit status 0 allows |
|
1332 | Run before updating the working directory. Exit status 0 allows | |
1333 | the update to proceed. A non-zero status will prevent the update. |
|
1333 | the update to proceed. A non-zero status will prevent the update. | |
1334 | The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a |
|
1334 | The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a | |
1335 | merge, the ID of second new parent is in ``$HG_PARENT2``. |
|
1335 | merge, the ID of second new parent is in ``$HG_PARENT2``. | |
1336 |
|
1336 | |||
1337 | ``listkeys`` |
|
1337 | ``listkeys`` | |
1338 | Run after listing pushkeys (like bookmarks) in the repository. The |
|
1338 | Run after listing pushkeys (like bookmarks) in the repository. The | |
1339 | key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a |
|
1339 | key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a | |
1340 | dictionary containing the keys and values. |
|
1340 | dictionary containing the keys and values. | |
1341 |
|
1341 | |||
1342 | ``pushkey`` |
|
1342 | ``pushkey`` | |
1343 | Run after a pushkey (like a bookmark) is added to the |
|
1343 | Run after a pushkey (like a bookmark) is added to the | |
1344 | repository. The key namespace is in ``$HG_NAMESPACE``, the key is in |
|
1344 | repository. The key namespace is in ``$HG_NAMESPACE``, the key is in | |
1345 | ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new |
|
1345 | ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new | |
1346 | value is in ``$HG_NEW``. |
|
1346 | value is in ``$HG_NEW``. | |
1347 |
|
1347 | |||
1348 | ``tag`` |
|
1348 | ``tag`` | |
1349 | Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``. |
|
1349 | Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``. | |
1350 | The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in |
|
1350 | The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in | |
1351 | the repository if ``$HG_LOCAL=0``. |
|
1351 | the repository if ``$HG_LOCAL=0``. | |
1352 |
|
1352 | |||
1353 | ``update`` |
|
1353 | ``update`` | |
1354 | Run after updating the working directory. The changeset ID of first |
|
1354 | Run after updating the working directory. The changeset ID of first | |
1355 | new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new |
|
1355 | new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new | |
1356 | parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the |
|
1356 | parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the | |
1357 | update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``. |
|
1357 | update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``. | |
1358 |
|
1358 | |||
1359 | .. note:: |
|
1359 | .. note:: | |
1360 |
|
1360 | |||
1361 | It is generally better to use standard hooks rather than the |
|
1361 | It is generally better to use standard hooks rather than the | |
1362 | generic pre- and post- command hooks, as they are guaranteed to be |
|
1362 | generic pre- and post- command hooks, as they are guaranteed to be | |
1363 | called in the appropriate contexts for influencing transactions. |
|
1363 | called in the appropriate contexts for influencing transactions. | |
1364 | Also, hooks like "commit" will be called in all contexts that |
|
1364 | Also, hooks like "commit" will be called in all contexts that | |
1365 | generate a commit (e.g. tag) and not just the commit command. |
|
1365 | generate a commit (e.g. tag) and not just the commit command. | |
1366 |
|
1366 | |||
1367 | .. note:: |
|
1367 | .. note:: | |
1368 |
|
1368 | |||
1369 | Environment variables with empty values may not be passed to |
|
1369 | Environment variables with empty values may not be passed to | |
1370 | hooks on platforms such as Windows. As an example, ``$HG_PARENT2`` |
|
1370 | hooks on platforms such as Windows. As an example, ``$HG_PARENT2`` | |
1371 | will have an empty value under Unix-like platforms for non-merge |
|
1371 | will have an empty value under Unix-like platforms for non-merge | |
1372 | changesets, while it will not be available at all under Windows. |
|
1372 | changesets, while it will not be available at all under Windows. | |
1373 |
|
1373 | |||
1374 | The syntax for Python hooks is as follows:: |
|
1374 | The syntax for Python hooks is as follows:: | |
1375 |
|
1375 | |||
1376 | hookname = python:modulename.submodule.callable |
|
1376 | hookname = python:modulename.submodule.callable | |
1377 | hookname = python:/path/to/python/module.py:callable |
|
1377 | hookname = python:/path/to/python/module.py:callable | |
1378 |
|
1378 | |||
1379 | Python hooks are run within the Mercurial process. Each hook is |
|
1379 | Python hooks are run within the Mercurial process. Each hook is | |
1380 | called with at least three keyword arguments: a ui object (keyword |
|
1380 | called with at least three keyword arguments: a ui object (keyword | |
1381 | ``ui``), a repository object (keyword ``repo``), and a ``hooktype`` |
|
1381 | ``ui``), a repository object (keyword ``repo``), and a ``hooktype`` | |
1382 | keyword that tells what kind of hook is used. Arguments listed as |
|
1382 | keyword that tells what kind of hook is used. Arguments listed as | |
1383 | environment variables above are passed as keyword arguments, with no |
|
1383 | environment variables above are passed as keyword arguments, with no | |
1384 | ``HG_`` prefix, and names in lower case. |
|
1384 | ``HG_`` prefix, and names in lower case. | |
1385 |
|
1385 | |||
1386 | If a Python hook returns a "true" value or raises an exception, this |
|
1386 | If a Python hook returns a "true" value or raises an exception, this | |
1387 | is treated as a failure. |
|
1387 | is treated as a failure. | |
1388 |
|
1388 | |||
1389 |
|
1389 | |||
1390 | ``hostfingerprints`` |
|
1390 | ``hostfingerprints`` | |
1391 | -------------------- |
|
1391 | -------------------- | |
1392 |
|
1392 | |||
1393 | (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.) |
|
1393 | (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.) | |
1394 |
|
1394 | |||
1395 | Fingerprints of the certificates of known HTTPS servers. |
|
1395 | Fingerprints of the certificates of known HTTPS servers. | |
1396 |
|
1396 | |||
1397 | A HTTPS connection to a server with a fingerprint configured here will |
|
1397 | A HTTPS connection to a server with a fingerprint configured here will | |
1398 | only succeed if the servers certificate matches the fingerprint. |
|
1398 | only succeed if the servers certificate matches the fingerprint. | |
1399 | This is very similar to how ssh known hosts works. |
|
1399 | This is very similar to how ssh known hosts works. | |
1400 |
|
1400 | |||
1401 | The fingerprint is the SHA-1 hash value of the DER encoded certificate. |
|
1401 | The fingerprint is the SHA-1 hash value of the DER encoded certificate. | |
1402 | Multiple values can be specified (separated by spaces or commas). This can |
|
1402 | Multiple values can be specified (separated by spaces or commas). This can | |
1403 | be used to define both old and new fingerprints while a host transitions |
|
1403 | be used to define both old and new fingerprints while a host transitions | |
1404 | to a new certificate. |
|
1404 | to a new certificate. | |
1405 |
|
1405 | |||
1406 | The CA chain and web.cacerts is not used for servers with a fingerprint. |
|
1406 | The CA chain and web.cacerts is not used for servers with a fingerprint. | |
1407 |
|
1407 | |||
1408 | For example:: |
|
1408 | For example:: | |
1409 |
|
1409 | |||
1410 | [hostfingerprints] |
|
1410 | [hostfingerprints] | |
1411 | hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33 |
|
1411 | hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33 | |
1412 | hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33 |
|
1412 | hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33 | |
1413 |
|
1413 | |||
1414 | ``hostsecurity`` |
|
1414 | ``hostsecurity`` | |
1415 | ---------------- |
|
1415 | ---------------- | |
1416 |
|
1416 | |||
1417 | Used to specify global and per-host security settings for connecting to |
|
1417 | Used to specify global and per-host security settings for connecting to | |
1418 | other machines. |
|
1418 | other machines. | |
1419 |
|
1419 | |||
1420 | The following options control default behavior for all hosts. |
|
1420 | The following options control default behavior for all hosts. | |
1421 |
|
1421 | |||
1422 | ``ciphers`` |
|
1422 | ``ciphers`` | |
1423 | Defines the cryptographic ciphers to use for connections. |
|
1423 | Defines the cryptographic ciphers to use for connections. | |
1424 |
|
1424 | |||
1425 | Value must be a valid OpenSSL Cipher List Format as documented at |
|
1425 | Value must be a valid OpenSSL Cipher List Format as documented at | |
1426 | https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT. |
|
1426 | https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT. | |
1427 |
|
1427 | |||
1428 | This setting is for advanced users only. Setting to incorrect values |
|
1428 | This setting is for advanced users only. Setting to incorrect values | |
1429 | can significantly lower connection security or decrease performance. |
|
1429 | can significantly lower connection security or decrease performance. | |
1430 | You have been warned. |
|
1430 | You have been warned. | |
1431 |
|
1431 | |||
1432 | This option requires Python 2.7. |
|
1432 | This option requires Python 2.7. | |
1433 |
|
1433 | |||
1434 | ``minimumprotocol`` |
|
1434 | ``minimumprotocol`` | |
1435 | Defines the minimum channel encryption protocol to use. |
|
1435 | Defines the minimum channel encryption protocol to use. | |
1436 |
|
1436 | |||
1437 | By default, the highest version of TLS supported by both client and server |
|
1437 | By default, the highest version of TLS supported by both client and server | |
1438 | is used. |
|
1438 | is used. | |
1439 |
|
1439 | |||
1440 | Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``. |
|
1440 | Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``. | |
1441 |
|
1441 | |||
1442 | When running on an old Python version, only ``tls1.0`` is allowed since |
|
1442 | When running on an old Python version, only ``tls1.0`` is allowed since | |
1443 | old versions of Python only support up to TLS 1.0. |
|
1443 | old versions of Python only support up to TLS 1.0. | |
1444 |
|
1444 | |||
1445 | When running a Python that supports modern TLS versions, the default is |
|
1445 | When running a Python that supports modern TLS versions, the default is | |
1446 | ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this |
|
1446 | ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this | |
1447 | weakens security and should only be used as a feature of last resort if |
|
1447 | weakens security and should only be used as a feature of last resort if | |
1448 | a server does not support TLS 1.1+. |
|
1448 | a server does not support TLS 1.1+. | |
1449 |
|
1449 | |||
1450 | Options in the ``[hostsecurity]`` section can have the form |
|
1450 | Options in the ``[hostsecurity]`` section can have the form | |
1451 | ``hostname``:``setting``. This allows multiple settings to be defined on a |
|
1451 | ``hostname``:``setting``. This allows multiple settings to be defined on a | |
1452 | per-host basis. |
|
1452 | per-host basis. | |
1453 |
|
1453 | |||
1454 | The following per-host settings can be defined. |
|
1454 | The following per-host settings can be defined. | |
1455 |
|
1455 | |||
1456 | ``ciphers`` |
|
1456 | ``ciphers`` | |
1457 | This behaves like ``ciphers`` as described above except it only applies |
|
1457 | This behaves like ``ciphers`` as described above except it only applies | |
1458 | to the host on which it is defined. |
|
1458 | to the host on which it is defined. | |
1459 |
|
1459 | |||
1460 | ``fingerprints`` |
|
1460 | ``fingerprints`` | |
1461 | A list of hashes of the DER encoded peer/remote certificate. Values have |
|
1461 | A list of hashes of the DER encoded peer/remote certificate. Values have | |
1462 | the form ``algorithm``:``fingerprint``. e.g. |
|
1462 | the form ``algorithm``:``fingerprint``. e.g. | |
1463 | ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``. |
|
1463 | ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``. | |
1464 | In addition, colons (``:``) can appear in the fingerprint part. |
|
1464 | In addition, colons (``:``) can appear in the fingerprint part. | |
1465 |
|
1465 | |||
1466 | The following algorithms/prefixes are supported: ``sha1``, ``sha256``, |
|
1466 | The following algorithms/prefixes are supported: ``sha1``, ``sha256``, | |
1467 | ``sha512``. |
|
1467 | ``sha512``. | |
1468 |
|
1468 | |||
1469 | Use of ``sha256`` or ``sha512`` is preferred. |
|
1469 | Use of ``sha256`` or ``sha512`` is preferred. | |
1470 |
|
1470 | |||
1471 | If a fingerprint is specified, the CA chain is not validated for this |
|
1471 | If a fingerprint is specified, the CA chain is not validated for this | |
1472 | host and Mercurial will require the remote certificate to match one |
|
1472 | host and Mercurial will require the remote certificate to match one | |
1473 | of the fingerprints specified. This means if the server updates its |
|
1473 | of the fingerprints specified. This means if the server updates its | |
1474 | certificate, Mercurial will abort until a new fingerprint is defined. |
|
1474 | certificate, Mercurial will abort until a new fingerprint is defined. | |
1475 | This can provide stronger security than traditional CA-based validation |
|
1475 | This can provide stronger security than traditional CA-based validation | |
1476 | at the expense of convenience. |
|
1476 | at the expense of convenience. | |
1477 |
|
1477 | |||
1478 | This option takes precedence over ``verifycertsfile``. |
|
1478 | This option takes precedence over ``verifycertsfile``. | |
1479 |
|
1479 | |||
1480 | ``minimumprotocol`` |
|
1480 | ``minimumprotocol`` | |
1481 | This behaves like ``minimumprotocol`` as described above except it |
|
1481 | This behaves like ``minimumprotocol`` as described above except it | |
1482 | only applies to the host on which it is defined. |
|
1482 | only applies to the host on which it is defined. | |
1483 |
|
1483 | |||
1484 | ``verifycertsfile`` |
|
1484 | ``verifycertsfile`` | |
1485 | Path to file a containing a list of PEM encoded certificates used to |
|
1485 | Path to file a containing a list of PEM encoded certificates used to | |
1486 | verify the server certificate. Environment variables and ``~user`` |
|
1486 | verify the server certificate. Environment variables and ``~user`` | |
1487 | constructs are expanded in the filename. |
|
1487 | constructs are expanded in the filename. | |
1488 |
|
1488 | |||
1489 | The server certificate or the certificate's certificate authority (CA) |
|
1489 | The server certificate or the certificate's certificate authority (CA) | |
1490 | must match a certificate from this file or certificate verification |
|
1490 | must match a certificate from this file or certificate verification | |
1491 | will fail and connections to the server will be refused. |
|
1491 | will fail and connections to the server will be refused. | |
1492 |
|
1492 | |||
1493 | If defined, only certificates provided by this file will be used: |
|
1493 | If defined, only certificates provided by this file will be used: | |
1494 | ``web.cacerts`` and any system/default certificates will not be |
|
1494 | ``web.cacerts`` and any system/default certificates will not be | |
1495 | used. |
|
1495 | used. | |
1496 |
|
1496 | |||
1497 | This option has no effect if the per-host ``fingerprints`` option |
|
1497 | This option has no effect if the per-host ``fingerprints`` option | |
1498 | is set. |
|
1498 | is set. | |
1499 |
|
1499 | |||
1500 | The format of the file is as follows:: |
|
1500 | The format of the file is as follows:: | |
1501 |
|
1501 | |||
1502 | -----BEGIN CERTIFICATE----- |
|
1502 | -----BEGIN CERTIFICATE----- | |
1503 | ... (certificate in base64 PEM encoding) ... |
|
1503 | ... (certificate in base64 PEM encoding) ... | |
1504 | -----END CERTIFICATE----- |
|
1504 | -----END CERTIFICATE----- | |
1505 | -----BEGIN CERTIFICATE----- |
|
1505 | -----BEGIN CERTIFICATE----- | |
1506 | ... (certificate in base64 PEM encoding) ... |
|
1506 | ... (certificate in base64 PEM encoding) ... | |
1507 | -----END CERTIFICATE----- |
|
1507 | -----END CERTIFICATE----- | |
1508 |
|
1508 | |||
1509 | For example:: |
|
1509 | For example:: | |
1510 |
|
1510 | |||
1511 | [hostsecurity] |
|
1511 | [hostsecurity] | |
1512 | hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2 |
|
1512 | hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2 | |
1513 | hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33 |
|
1513 | hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33 | |
1514 | hg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2 |
|
1514 | hg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2 | |
1515 | foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem |
|
1515 | foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem | |
1516 |
|
1516 | |||
1517 | To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1 |
|
1517 | To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1 | |
1518 | when connecting to ``hg.example.com``:: |
|
1518 | when connecting to ``hg.example.com``:: | |
1519 |
|
1519 | |||
1520 | [hostsecurity] |
|
1520 | [hostsecurity] | |
1521 | minimumprotocol = tls1.2 |
|
1521 | minimumprotocol = tls1.2 | |
1522 | hg.example.com:minimumprotocol = tls1.1 |
|
1522 | hg.example.com:minimumprotocol = tls1.1 | |
1523 |
|
1523 | |||
1524 | ``http_proxy`` |
|
1524 | ``http_proxy`` | |
1525 | -------------- |
|
1525 | -------------- | |
1526 |
|
1526 | |||
1527 | Used to access web-based Mercurial repositories through a HTTP |
|
1527 | Used to access web-based Mercurial repositories through a HTTP | |
1528 | proxy. |
|
1528 | proxy. | |
1529 |
|
1529 | |||
1530 | ``host`` |
|
1530 | ``host`` | |
1531 | Host name and (optional) port of the proxy server, for example |
|
1531 | Host name and (optional) port of the proxy server, for example | |
1532 | "myproxy:8000". |
|
1532 | "myproxy:8000". | |
1533 |
|
1533 | |||
1534 | ``no`` |
|
1534 | ``no`` | |
1535 | Optional. Comma-separated list of host names that should bypass |
|
1535 | Optional. Comma-separated list of host names that should bypass | |
1536 | the proxy. |
|
1536 | the proxy. | |
1537 |
|
1537 | |||
1538 | ``passwd`` |
|
1538 | ``passwd`` | |
1539 | Optional. Password to authenticate with at the proxy server. |
|
1539 | Optional. Password to authenticate with at the proxy server. | |
1540 |
|
1540 | |||
1541 | ``user`` |
|
1541 | ``user`` | |
1542 | Optional. User name to authenticate with at the proxy server. |
|
1542 | Optional. User name to authenticate with at the proxy server. | |
1543 |
|
1543 | |||
1544 | ``always`` |
|
1544 | ``always`` | |
1545 | Optional. Always use the proxy, even for localhost and any entries |
|
1545 | Optional. Always use the proxy, even for localhost and any entries | |
1546 | in ``http_proxy.no``. (default: False) |
|
1546 | in ``http_proxy.no``. (default: False) | |
1547 |
|
1547 | |||
1548 | ``http`` |
|
1548 | ``http`` | |
1549 | ---------- |
|
1549 | ---------- | |
1550 |
|
1550 | |||
1551 | Used to configure access to Mercurial repositories via HTTP. |
|
1551 | Used to configure access to Mercurial repositories via HTTP. | |
1552 |
|
1552 | |||
1553 | ``timeout`` |
|
1553 | ``timeout`` | |
1554 | If set, blocking operations will timeout after that many seconds. |
|
1554 | If set, blocking operations will timeout after that many seconds. | |
1555 | (default: None) |
|
1555 | (default: None) | |
1556 |
|
1556 | |||
1557 | ``merge`` |
|
1557 | ``merge`` | |
1558 | --------- |
|
1558 | --------- | |
1559 |
|
1559 | |||
1560 | This section specifies behavior during merges and updates. |
|
1560 | This section specifies behavior during merges and updates. | |
1561 |
|
1561 | |||
1562 | ``checkignored`` |
|
1562 | ``checkignored`` | |
1563 | Controls behavior when an ignored file on disk has the same name as a tracked |
|
1563 | Controls behavior when an ignored file on disk has the same name as a tracked | |
1564 | file in the changeset being merged or updated to, and has different |
|
1564 | file in the changeset being merged or updated to, and has different | |
1565 | contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``, |
|
1565 | contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``, | |
1566 | abort on such files. With ``warn``, warn on such files and back them up as |
|
1566 | abort on such files. With ``warn``, warn on such files and back them up as | |
1567 | ``.orig``. With ``ignore``, don't print a warning and back them up as |
|
1567 | ``.orig``. With ``ignore``, don't print a warning and back them up as | |
1568 | ``.orig``. (default: ``abort``) |
|
1568 | ``.orig``. (default: ``abort``) | |
1569 |
|
1569 | |||
1570 | ``checkunknown`` |
|
1570 | ``checkunknown`` | |
1571 | Controls behavior when an unknown file that isn't ignored has the same name |
|
1571 | Controls behavior when an unknown file that isn't ignored has the same name | |
1572 | as a tracked file in the changeset being merged or updated to, and has |
|
1572 | as a tracked file in the changeset being merged or updated to, and has | |
1573 | different contents. Similar to ``merge.checkignored``, except for files that |
|
1573 | different contents. Similar to ``merge.checkignored``, except for files that | |
1574 | are not ignored. (default: ``abort``) |
|
1574 | are not ignored. (default: ``abort``) | |
1575 |
|
1575 | |||
1576 | ``on-failure`` |
|
1576 | ``on-failure`` | |
1577 | When set to ``continue`` (the default), the merge process attempts to |
|
1577 | When set to ``continue`` (the default), the merge process attempts to | |
1578 | merge all unresolved files using the merge chosen tool, regardless of |
|
1578 | merge all unresolved files using the merge chosen tool, regardless of | |
1579 | whether previous file merge attempts during the process succeeded or not. |
|
1579 | whether previous file merge attempts during the process succeeded or not. | |
1580 | Setting this to ``prompt`` will prompt after any merge failure continue |
|
1580 | Setting this to ``prompt`` will prompt after any merge failure continue | |
1581 | or halt the merge process. Setting this to ``halt`` will automatically |
|
1581 | or halt the merge process. Setting this to ``halt`` will automatically | |
1582 | halt the merge process on any merge tool failure. The merge process |
|
1582 | halt the merge process on any merge tool failure. The merge process | |
1583 | can be restarted by using the ``resolve`` command. When a merge is |
|
1583 | can be restarted by using the ``resolve`` command. When a merge is | |
1584 | halted, the repository is left in a normal ``unresolved`` merge state. |
|
1584 | halted, the repository is left in a normal ``unresolved`` merge state. | |
1585 | (default: ``continue``) |
|
1585 | (default: ``continue``) | |
1586 |
|
1586 | |||
1587 | ``strict-capability-check`` |
|
1587 | ``strict-capability-check`` | |
1588 | Whether capabilities of internal merge tools are checked strictly |
|
1588 | Whether capabilities of internal merge tools are checked strictly | |
1589 | or not, while examining rules to decide merge tool to be used. |
|
1589 | or not, while examining rules to decide merge tool to be used. | |
1590 | (default: False) |
|
1590 | (default: False) | |
1591 |
|
1591 | |||
1592 | ``merge-patterns`` |
|
1592 | ``merge-patterns`` | |
1593 | ------------------ |
|
1593 | ------------------ | |
1594 |
|
1594 | |||
1595 | This section specifies merge tools to associate with particular file |
|
1595 | This section specifies merge tools to associate with particular file | |
1596 | patterns. Tools matched here will take precedence over the default |
|
1596 | patterns. Tools matched here will take precedence over the default | |
1597 | merge tool. Patterns are globs by default, rooted at the repository |
|
1597 | merge tool. Patterns are globs by default, rooted at the repository | |
1598 | root. |
|
1598 | root. | |
1599 |
|
1599 | |||
1600 | Example:: |
|
1600 | Example:: | |
1601 |
|
1601 | |||
1602 | [merge-patterns] |
|
1602 | [merge-patterns] | |
1603 | **.c = kdiff3 |
|
1603 | **.c = kdiff3 | |
1604 | **.jpg = myimgmerge |
|
1604 | **.jpg = myimgmerge | |
1605 |
|
1605 | |||
1606 | ``merge-tools`` |
|
1606 | ``merge-tools`` | |
1607 | --------------- |
|
1607 | --------------- | |
1608 |
|
1608 | |||
1609 | This section configures external merge tools to use for file-level |
|
1609 | This section configures external merge tools to use for file-level | |
1610 | merges. This section has likely been preconfigured at install time. |
|
1610 | merges. This section has likely been preconfigured at install time. | |
1611 | Use :hg:`config merge-tools` to check the existing configuration. |
|
1611 | Use :hg:`config merge-tools` to check the existing configuration. | |
1612 | Also see :hg:`help merge-tools` for more details. |
|
1612 | Also see :hg:`help merge-tools` for more details. | |
1613 |
|
1613 | |||
1614 | Example ``~/.hgrc``:: |
|
1614 | Example ``~/.hgrc``:: | |
1615 |
|
1615 | |||
1616 | [merge-tools] |
|
1616 | [merge-tools] | |
1617 | # Override stock tool location |
|
1617 | # Override stock tool location | |
1618 | kdiff3.executable = ~/bin/kdiff3 |
|
1618 | kdiff3.executable = ~/bin/kdiff3 | |
1619 | # Specify command line |
|
1619 | # Specify command line | |
1620 | kdiff3.args = $base $local $other -o $output |
|
1620 | kdiff3.args = $base $local $other -o $output | |
1621 | # Give higher priority |
|
1621 | # Give higher priority | |
1622 | kdiff3.priority = 1 |
|
1622 | kdiff3.priority = 1 | |
1623 |
|
1623 | |||
1624 | # Changing the priority of preconfigured tool |
|
1624 | # Changing the priority of preconfigured tool | |
1625 | meld.priority = 0 |
|
1625 | meld.priority = 0 | |
1626 |
|
1626 | |||
1627 | # Disable a preconfigured tool |
|
1627 | # Disable a preconfigured tool | |
1628 | vimdiff.disabled = yes |
|
1628 | vimdiff.disabled = yes | |
1629 |
|
1629 | |||
1630 | # Define new tool |
|
1630 | # Define new tool | |
1631 | myHtmlTool.args = -m $local $other $base $output |
|
1631 | myHtmlTool.args = -m $local $other $base $output | |
1632 | myHtmlTool.regkey = Software\FooSoftware\HtmlMerge |
|
1632 | myHtmlTool.regkey = Software\FooSoftware\HtmlMerge | |
1633 | myHtmlTool.priority = 1 |
|
1633 | myHtmlTool.priority = 1 | |
1634 |
|
1634 | |||
1635 | Supported arguments: |
|
1635 | Supported arguments: | |
1636 |
|
1636 | |||
1637 | ``priority`` |
|
1637 | ``priority`` | |
1638 | The priority in which to evaluate this tool. |
|
1638 | The priority in which to evaluate this tool. | |
1639 | (default: 0) |
|
1639 | (default: 0) | |
1640 |
|
1640 | |||
1641 | ``executable`` |
|
1641 | ``executable`` | |
1642 | Either just the name of the executable or its pathname. |
|
1642 | Either just the name of the executable or its pathname. | |
1643 |
|
1643 | |||
1644 | .. container:: windows |
|
1644 | .. container:: windows | |
1645 |
|
1645 | |||
1646 | On Windows, the path can use environment variables with ${ProgramFiles} |
|
1646 | On Windows, the path can use environment variables with ${ProgramFiles} | |
1647 | syntax. |
|
1647 | syntax. | |
1648 |
|
1648 | |||
1649 | (default: the tool name) |
|
1649 | (default: the tool name) | |
1650 |
|
1650 | |||
1651 | ``args`` |
|
1651 | ``args`` | |
1652 | The arguments to pass to the tool executable. You can refer to the |
|
1652 | The arguments to pass to the tool executable. You can refer to the | |
1653 | files being merged as well as the output file through these |
|
1653 | files being merged as well as the output file through these | |
1654 | variables: ``$base``, ``$local``, ``$other``, ``$output``. |
|
1654 | variables: ``$base``, ``$local``, ``$other``, ``$output``. | |
1655 |
|
1655 | |||
1656 | The meaning of ``$local`` and ``$other`` can vary depending on which action is |
|
1656 | The meaning of ``$local`` and ``$other`` can vary depending on which action is | |
1657 | being performed. During an update or merge, ``$local`` represents the original |
|
1657 | being performed. During an update or merge, ``$local`` represents the original | |
1658 | state of the file, while ``$other`` represents the commit you are updating to or |
|
1658 | state of the file, while ``$other`` represents the commit you are updating to or | |
1659 | the commit you are merging with. During a rebase, ``$local`` represents the |
|
1659 | the commit you are merging with. During a rebase, ``$local`` represents the | |
1660 | destination of the rebase, and ``$other`` represents the commit being rebased. |
|
1660 | destination of the rebase, and ``$other`` represents the commit being rebased. | |
1661 |
|
1661 | |||
1662 | Some operations define custom labels to assist with identifying the revisions, |
|
1662 | Some operations define custom labels to assist with identifying the revisions, | |
1663 | accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom |
|
1663 | accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom | |
1664 | labels are not available, these will be ``local``, ``other``, and ``base``, |
|
1664 | labels are not available, these will be ``local``, ``other``, and ``base``, | |
1665 | respectively. |
|
1665 | respectively. | |
1666 | (default: ``$local $base $other``) |
|
1666 | (default: ``$local $base $other``) | |
1667 |
|
1667 | |||
1668 | ``premerge`` |
|
1668 | ``premerge`` | |
1669 | Attempt to run internal non-interactive 3-way merge tool before |
|
1669 | Attempt to run internal non-interactive 3-way merge tool before | |
1670 | launching external tool. Options are ``true``, ``false``, ``keep``, |
|
1670 | launching external tool. Options are ``true``, ``false``, ``keep``, | |
1671 | ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option |
|
1671 | ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option | |
1672 | will leave markers in the file if the premerge fails. The ``keep-merge3`` |
|
1672 | will leave markers in the file if the premerge fails. The ``keep-merge3`` | |
1673 | will do the same but include information about the base of the merge in the |
|
1673 | will do the same but include information about the base of the merge in the | |
1674 | marker (see internal :merge3 in :hg:`help merge-tools`). The |
|
1674 | marker (see internal :merge3 in :hg:`help merge-tools`). The | |
1675 | ``keep-mergediff`` option is similar but uses a different marker style |
|
1675 | ``keep-mergediff`` option is similar but uses a different marker style | |
1676 | (see internal :merge3 in :hg:`help merge-tools`). (default: True) |
|
1676 | (see internal :merge3 in :hg:`help merge-tools`). (default: True) | |
1677 |
|
1677 | |||
1678 | ``binary`` |
|
1678 | ``binary`` | |
1679 | This tool can merge binary files. (default: False, unless tool |
|
1679 | This tool can merge binary files. (default: False, unless tool | |
1680 | was selected by file pattern match) |
|
1680 | was selected by file pattern match) | |
1681 |
|
1681 | |||
1682 | ``symlink`` |
|
1682 | ``symlink`` | |
1683 | This tool can merge symlinks. (default: False) |
|
1683 | This tool can merge symlinks. (default: False) | |
1684 |
|
1684 | |||
1685 | ``check`` |
|
1685 | ``check`` | |
1686 | A list of merge success-checking options: |
|
1686 | A list of merge success-checking options: | |
1687 |
|
1687 | |||
1688 | ``changed`` |
|
1688 | ``changed`` | |
1689 | Ask whether merge was successful when the merged file shows no changes. |
|
1689 | Ask whether merge was successful when the merged file shows no changes. | |
1690 | ``conflicts`` |
|
1690 | ``conflicts`` | |
1691 | Check whether there are conflicts even though the tool reported success. |
|
1691 | Check whether there are conflicts even though the tool reported success. | |
1692 | ``prompt`` |
|
1692 | ``prompt`` | |
1693 | Always prompt for merge success, regardless of success reported by tool. |
|
1693 | Always prompt for merge success, regardless of success reported by tool. | |
1694 |
|
1694 | |||
1695 | ``fixeol`` |
|
1695 | ``fixeol`` | |
1696 | Attempt to fix up EOL changes caused by the merge tool. |
|
1696 | Attempt to fix up EOL changes caused by the merge tool. | |
1697 | (default: False) |
|
1697 | (default: False) | |
1698 |
|
1698 | |||
1699 | ``gui`` |
|
1699 | ``gui`` | |
1700 | This tool requires a graphical interface to run. (default: False) |
|
1700 | This tool requires a graphical interface to run. (default: False) | |
1701 |
|
1701 | |||
1702 | ``mergemarkers`` |
|
1702 | ``mergemarkers`` | |
1703 | Controls whether the labels passed via ``$labellocal``, ``$labelother``, and |
|
1703 | Controls whether the labels passed via ``$labellocal``, ``$labelother``, and | |
1704 | ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or |
|
1704 | ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or | |
1705 | ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict |
|
1705 | ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict | |
1706 | markers generated during premerge will be ``detailed`` if either this option or |
|
1706 | markers generated during premerge will be ``detailed`` if either this option or | |
1707 | the corresponding option in the ``[ui]`` section is ``detailed``. |
|
1707 | the corresponding option in the ``[ui]`` section is ``detailed``. | |
1708 | (default: ``basic``) |
|
1708 | (default: ``basic``) | |
1709 |
|
1709 | |||
1710 | ``mergemarkertemplate`` |
|
1710 | ``mergemarkertemplate`` | |
1711 | This setting can be used to override ``mergemarker`` from the |
|
1711 | This setting can be used to override ``mergemarker`` from the | |
1712 | ``[command-templates]`` section on a per-tool basis; this applies to the |
|
1712 | ``[command-templates]`` section on a per-tool basis; this applies to the | |
1713 | ``$label``-prefixed variables and to the conflict markers that are generated |
|
1713 | ``$label``-prefixed variables and to the conflict markers that are generated | |
1714 | if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable |
|
1714 | if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable | |
1715 | in ``[ui]`` for more information. |
|
1715 | in ``[ui]`` for more information. | |
1716 |
|
1716 | |||
1717 | .. container:: windows |
|
1717 | .. container:: windows | |
1718 |
|
1718 | |||
1719 | ``regkey`` |
|
1719 | ``regkey`` | |
1720 | Windows registry key which describes install location of this |
|
1720 | Windows registry key which describes install location of this | |
1721 | tool. Mercurial will search for this key first under |
|
1721 | tool. Mercurial will search for this key first under | |
1722 | ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``. |
|
1722 | ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``. | |
1723 | (default: None) |
|
1723 | (default: None) | |
1724 |
|
1724 | |||
1725 | ``regkeyalt`` |
|
1725 | ``regkeyalt`` | |
1726 | An alternate Windows registry key to try if the first key is not |
|
1726 | An alternate Windows registry key to try if the first key is not | |
1727 | found. The alternate key uses the same ``regname`` and ``regappend`` |
|
1727 | found. The alternate key uses the same ``regname`` and ``regappend`` | |
1728 | semantics of the primary key. The most common use for this key |
|
1728 | semantics of the primary key. The most common use for this key | |
1729 | is to search for 32bit applications on 64bit operating systems. |
|
1729 | is to search for 32bit applications on 64bit operating systems. | |
1730 | (default: None) |
|
1730 | (default: None) | |
1731 |
|
1731 | |||
1732 | ``regname`` |
|
1732 | ``regname`` | |
1733 | Name of value to read from specified registry key. |
|
1733 | Name of value to read from specified registry key. | |
1734 | (default: the unnamed (default) value) |
|
1734 | (default: the unnamed (default) value) | |
1735 |
|
1735 | |||
1736 | ``regappend`` |
|
1736 | ``regappend`` | |
1737 | String to append to the value read from the registry, typically |
|
1737 | String to append to the value read from the registry, typically | |
1738 | the executable name of the tool. |
|
1738 | the executable name of the tool. | |
1739 | (default: None) |
|
1739 | (default: None) | |
1740 |
|
1740 | |||
1741 | ``pager`` |
|
1741 | ``pager`` | |
1742 | --------- |
|
1742 | --------- | |
1743 |
|
1743 | |||
1744 | Setting used to control when to paginate and with what external tool. See |
|
1744 | Setting used to control when to paginate and with what external tool. See | |
1745 | :hg:`help pager` for details. |
|
1745 | :hg:`help pager` for details. | |
1746 |
|
1746 | |||
1747 | ``pager`` |
|
1747 | ``pager`` | |
1748 | Define the external tool used as pager. |
|
1748 | Define the external tool used as pager. | |
1749 |
|
1749 | |||
1750 | If no pager is set, Mercurial uses the environment variable $PAGER. |
|
1750 | If no pager is set, Mercurial uses the environment variable $PAGER. | |
1751 | If neither pager.pager, nor $PAGER is set, a default pager will be |
|
1751 | If neither pager.pager, nor $PAGER is set, a default pager will be | |
1752 | used, typically `less` on Unix and `more` on Windows. Example:: |
|
1752 | used, typically `less` on Unix and `more` on Windows. Example:: | |
1753 |
|
1753 | |||
1754 | [pager] |
|
1754 | [pager] | |
1755 | pager = less -FRX |
|
1755 | pager = less -FRX | |
1756 |
|
1756 | |||
1757 | ``ignore`` |
|
1757 | ``ignore`` | |
1758 | List of commands to disable the pager for. Example:: |
|
1758 | List of commands to disable the pager for. Example:: | |
1759 |
|
1759 | |||
1760 | [pager] |
|
1760 | [pager] | |
1761 | ignore = version, help, update |
|
1761 | ignore = version, help, update | |
1762 |
|
1762 | |||
1763 | ``patch`` |
|
1763 | ``patch`` | |
1764 | --------- |
|
1764 | --------- | |
1765 |
|
1765 | |||
1766 | Settings used when applying patches, for instance through the 'import' |
|
1766 | Settings used when applying patches, for instance through the 'import' | |
1767 | command or with Mercurial Queues extension. |
|
1767 | command or with Mercurial Queues extension. | |
1768 |
|
1768 | |||
1769 | ``eol`` |
|
1769 | ``eol`` | |
1770 | When set to 'strict' patch content and patched files end of lines |
|
1770 | When set to 'strict' patch content and patched files end of lines | |
1771 | are preserved. When set to ``lf`` or ``crlf``, both files end of |
|
1771 | are preserved. When set to ``lf`` or ``crlf``, both files end of | |
1772 | lines are ignored when patching and the result line endings are |
|
1772 | lines are ignored when patching and the result line endings are | |
1773 | normalized to either LF (Unix) or CRLF (Windows). When set to |
|
1773 | normalized to either LF (Unix) or CRLF (Windows). When set to | |
1774 | ``auto``, end of lines are again ignored while patching but line |
|
1774 | ``auto``, end of lines are again ignored while patching but line | |
1775 | endings in patched files are normalized to their original setting |
|
1775 | endings in patched files are normalized to their original setting | |
1776 | on a per-file basis. If target file does not exist or has no end |
|
1776 | on a per-file basis. If target file does not exist or has no end | |
1777 | of line, patch line endings are preserved. |
|
1777 | of line, patch line endings are preserved. | |
1778 | (default: strict) |
|
1778 | (default: strict) | |
1779 |
|
1779 | |||
1780 | ``fuzz`` |
|
1780 | ``fuzz`` | |
1781 | The number of lines of 'fuzz' to allow when applying patches. This |
|
1781 | The number of lines of 'fuzz' to allow when applying patches. This | |
1782 | controls how much context the patcher is allowed to ignore when |
|
1782 | controls how much context the patcher is allowed to ignore when | |
1783 | trying to apply a patch. |
|
1783 | trying to apply a patch. | |
1784 | (default: 2) |
|
1784 | (default: 2) | |
1785 |
|
1785 | |||
1786 | ``paths`` |
|
1786 | ``paths`` | |
1787 | --------- |
|
1787 | --------- | |
1788 |
|
1788 | |||
1789 | Assigns symbolic names and behavior to repositories. |
|
1789 | Assigns symbolic names and behavior to repositories. | |
1790 |
|
1790 | |||
1791 | Options are symbolic names defining the URL or directory that is the |
|
1791 | Options are symbolic names defining the URL or directory that is the | |
1792 | location of the repository. Example:: |
|
1792 | location of the repository. Example:: | |
1793 |
|
1793 | |||
1794 | [paths] |
|
1794 | [paths] | |
1795 | my_server = https://example.com/my_repo |
|
1795 | my_server = https://example.com/my_repo | |
1796 | local_path = /home/me/repo |
|
1796 | local_path = /home/me/repo | |
1797 |
|
1797 | |||
1798 | These symbolic names can be used from the command line. To pull |
|
1798 | These symbolic names can be used from the command line. To pull | |
1799 | from ``my_server``: :hg:`pull my_server`. To push to ``local_path``: |
|
1799 | from ``my_server``: :hg:`pull my_server`. To push to ``local_path``: | |
1800 | :hg:`push local_path`. You can check :hg:`help urls` for details about |
|
1800 | :hg:`push local_path`. You can check :hg:`help urls` for details about | |
1801 | valid URLs. |
|
1801 | valid URLs. | |
1802 |
|
1802 | |||
1803 | Options containing colons (``:``) denote sub-options that can influence |
|
1803 | Options containing colons (``:``) denote sub-options that can influence | |
1804 | behavior for that specific path. Example:: |
|
1804 | behavior for that specific path. Example:: | |
1805 |
|
1805 | |||
1806 | [paths] |
|
1806 | [paths] | |
1807 | my_server = https://example.com/my_path |
|
1807 | my_server = https://example.com/my_path | |
1808 | my_server:pushurl = ssh://example.com/my_path |
|
1808 | my_server:pushurl = ssh://example.com/my_path | |
1809 |
|
1809 | |||
1810 | Paths using the `path://otherpath` scheme will inherit the sub-options value from |
|
1810 | Paths using the `path://otherpath` scheme will inherit the sub-options value from | |
1811 | the path they point to. |
|
1811 | the path they point to. | |
1812 |
|
1812 | |||
1813 | The following sub-options can be defined: |
|
1813 | The following sub-options can be defined: | |
1814 |
|
1814 | |||
1815 | ``multi-urls`` |
|
1815 | ``multi-urls`` | |
1816 | A boolean option. When enabled the value of the `[paths]` entry will be |
|
1816 | A boolean option. When enabled the value of the `[paths]` entry will be | |
1817 | parsed as a list and the alias will resolve to multiple destination. If some |
|
1817 | parsed as a list and the alias will resolve to multiple destination. If some | |
1818 | of the list entry use the `path://` syntax, the suboption will be inherited |
|
1818 | of the list entry use the `path://` syntax, the suboption will be inherited | |
1819 | individually. |
|
1819 | individually. | |
1820 |
|
1820 | |||
1821 | ``pushurl`` |
|
1821 | ``pushurl`` | |
1822 | The URL to use for push operations. If not defined, the location |
|
1822 | The URL to use for push operations. If not defined, the location | |
1823 | defined by the path's main entry is used. |
|
1823 | defined by the path's main entry is used. | |
1824 |
|
1824 | |||
1825 | ``pushrev`` |
|
1825 | ``pushrev`` | |
1826 | A revset defining which revisions to push by default. |
|
1826 | A revset defining which revisions to push by default. | |
1827 |
|
1827 | |||
1828 | When :hg:`push` is executed without a ``-r`` argument, the revset |
|
1828 | When :hg:`push` is executed without a ``-r`` argument, the revset | |
1829 | defined by this sub-option is evaluated to determine what to push. |
|
1829 | defined by this sub-option is evaluated to determine what to push. | |
1830 |
|
1830 | |||
1831 | For example, a value of ``.`` will push the working directory's |
|
1831 | For example, a value of ``.`` will push the working directory's | |
1832 | revision by default. |
|
1832 | revision by default. | |
1833 |
|
1833 | |||
1834 | Revsets specifying bookmarks will not result in the bookmark being |
|
1834 | Revsets specifying bookmarks will not result in the bookmark being | |
1835 | pushed. |
|
1835 | pushed. | |
1836 |
|
1836 | |||
1837 | ``bookmarks.mode`` |
|
1837 | ``bookmarks.mode`` | |
1838 | How bookmark will be dealt during the exchange. It support the following value |
|
1838 | How bookmark will be dealt during the exchange. It support the following value | |
1839 |
|
1839 | |||
1840 | - ``default``: the default behavior, local and remote bookmarks are "merged" |
|
1840 | - ``default``: the default behavior, local and remote bookmarks are "merged" | |
1841 | on push/pull. |
|
1841 | on push/pull. | |
1842 |
|
1842 | |||
1843 | - ``mirror``: when pulling, replace local bookmarks by remote bookmarks. This |
|
1843 | - ``mirror``: when pulling, replace local bookmarks by remote bookmarks. This | |
1844 | is useful to replicate a repository, or as an optimization. |
|
1844 | is useful to replicate a repository, or as an optimization. | |
1845 |
|
1845 | |||
1846 | - ``ignore``: ignore bookmarks during exchange. |
|
1846 | - ``ignore``: ignore bookmarks during exchange. | |
1847 | (This currently only affect pulling) |
|
1847 | (This currently only affect pulling) | |
1848 |
|
1848 | |||
1849 | The following special named paths exist: |
|
1849 | The following special named paths exist: | |
1850 |
|
1850 | |||
1851 | ``default`` |
|
1851 | ``default`` | |
1852 | The URL or directory to use when no source or remote is specified. |
|
1852 | The URL or directory to use when no source or remote is specified. | |
1853 |
|
1853 | |||
1854 | :hg:`clone` will automatically define this path to the location the |
|
1854 | :hg:`clone` will automatically define this path to the location the | |
1855 | repository was cloned from. |
|
1855 | repository was cloned from. | |
1856 |
|
1856 | |||
1857 | ``default-push`` |
|
1857 | ``default-push`` | |
1858 | (deprecated) The URL or directory for the default :hg:`push` location. |
|
1858 | (deprecated) The URL or directory for the default :hg:`push` location. | |
1859 | ``default:pushurl`` should be used instead. |
|
1859 | ``default:pushurl`` should be used instead. | |
1860 |
|
1860 | |||
1861 | ``phases`` |
|
1861 | ``phases`` | |
1862 | ---------- |
|
1862 | ---------- | |
1863 |
|
1863 | |||
1864 | Specifies default handling of phases. See :hg:`help phases` for more |
|
1864 | Specifies default handling of phases. See :hg:`help phases` for more | |
1865 | information about working with phases. |
|
1865 | information about working with phases. | |
1866 |
|
1866 | |||
1867 | ``publish`` |
|
1867 | ``publish`` | |
1868 | Controls draft phase behavior when working as a server. When true, |
|
1868 | Controls draft phase behavior when working as a server. When true, | |
1869 | pushed changesets are set to public in both client and server and |
|
1869 | pushed changesets are set to public in both client and server and | |
1870 | pulled or cloned changesets are set to public in the client. |
|
1870 | pulled or cloned changesets are set to public in the client. | |
1871 | (default: True) |
|
1871 | (default: True) | |
1872 |
|
1872 | |||
1873 | ``new-commit`` |
|
1873 | ``new-commit`` | |
1874 | Phase of newly-created commits. |
|
1874 | Phase of newly-created commits. | |
1875 | (default: draft) |
|
1875 | (default: draft) | |
1876 |
|
1876 | |||
1877 | ``checksubrepos`` |
|
1877 | ``checksubrepos`` | |
1878 | Check the phase of the current revision of each subrepository. Allowed |
|
1878 | Check the phase of the current revision of each subrepository. Allowed | |
1879 | values are "ignore", "follow" and "abort". For settings other than |
|
1879 | values are "ignore", "follow" and "abort". For settings other than | |
1880 | "ignore", the phase of the current revision of each subrepository is |
|
1880 | "ignore", the phase of the current revision of each subrepository is | |
1881 | checked before committing the parent repository. If any of those phases is |
|
1881 | checked before committing the parent repository. If any of those phases is | |
1882 | greater than the phase of the parent repository (e.g. if a subrepo is in a |
|
1882 | greater than the phase of the parent repository (e.g. if a subrepo is in a | |
1883 | "secret" phase while the parent repo is in "draft" phase), the commit is |
|
1883 | "secret" phase while the parent repo is in "draft" phase), the commit is | |
1884 | either aborted (if checksubrepos is set to "abort") or the higher phase is |
|
1884 | either aborted (if checksubrepos is set to "abort") or the higher phase is | |
1885 | used for the parent repository commit (if set to "follow"). |
|
1885 | used for the parent repository commit (if set to "follow"). | |
1886 | (default: follow) |
|
1886 | (default: follow) | |
1887 |
|
1887 | |||
1888 |
|
1888 | |||
1889 | ``profiling`` |
|
1889 | ``profiling`` | |
1890 | ------------- |
|
1890 | ------------- | |
1891 |
|
1891 | |||
1892 | Specifies profiling type, format, and file output. Two profilers are |
|
1892 | Specifies profiling type, format, and file output. Two profilers are | |
1893 | supported: an instrumenting profiler (named ``ls``), and a sampling |
|
1893 | supported: an instrumenting profiler (named ``ls``), and a sampling | |
1894 | profiler (named ``stat``). |
|
1894 | profiler (named ``stat``). | |
1895 |
|
1895 | |||
1896 | In this section description, 'profiling data' stands for the raw data |
|
1896 | In this section description, 'profiling data' stands for the raw data | |
1897 | collected during profiling, while 'profiling report' stands for a |
|
1897 | collected during profiling, while 'profiling report' stands for a | |
1898 | statistical text report generated from the profiling data. |
|
1898 | statistical text report generated from the profiling data. | |
1899 |
|
1899 | |||
1900 | ``enabled`` |
|
1900 | ``enabled`` | |
1901 | Enable the profiler. |
|
1901 | Enable the profiler. | |
1902 | (default: false) |
|
1902 | (default: false) | |
1903 |
|
1903 | |||
1904 | This is equivalent to passing ``--profile`` on the command line. |
|
1904 | This is equivalent to passing ``--profile`` on the command line. | |
1905 |
|
1905 | |||
1906 | ``type`` |
|
1906 | ``type`` | |
1907 | The type of profiler to use. |
|
1907 | The type of profiler to use. | |
1908 | (default: stat) |
|
1908 | (default: stat) | |
1909 |
|
1909 | |||
1910 | ``ls`` |
|
1910 | ``ls`` | |
1911 | Use Python's built-in instrumenting profiler. This profiler |
|
1911 | Use Python's built-in instrumenting profiler. This profiler | |
1912 | works on all platforms, but each line number it reports is the |
|
1912 | works on all platforms, but each line number it reports is the | |
1913 | first line of a function. This restriction makes it difficult to |
|
1913 | first line of a function. This restriction makes it difficult to | |
1914 | identify the expensive parts of a non-trivial function. |
|
1914 | identify the expensive parts of a non-trivial function. | |
1915 | ``stat`` |
|
1915 | ``stat`` | |
1916 | Use a statistical profiler, statprof. This profiler is most |
|
1916 | Use a statistical profiler, statprof. This profiler is most | |
1917 | useful for profiling commands that run for longer than about 0.1 |
|
1917 | useful for profiling commands that run for longer than about 0.1 | |
1918 | seconds. |
|
1918 | seconds. | |
1919 |
|
1919 | |||
1920 | ``format`` |
|
1920 | ``format`` | |
1921 | Profiling format. Specific to the ``ls`` instrumenting profiler. |
|
1921 | Profiling format. Specific to the ``ls`` instrumenting profiler. | |
1922 | (default: text) |
|
1922 | (default: text) | |
1923 |
|
1923 | |||
1924 | ``text`` |
|
1924 | ``text`` | |
1925 | Generate a profiling report. When saving to a file, it should be |
|
1925 | Generate a profiling report. When saving to a file, it should be | |
1926 | noted that only the report is saved, and the profiling data is |
|
1926 | noted that only the report is saved, and the profiling data is | |
1927 | not kept. |
|
1927 | not kept. | |
1928 | ``kcachegrind`` |
|
1928 | ``kcachegrind`` | |
1929 | Format profiling data for kcachegrind use: when saving to a |
|
1929 | Format profiling data for kcachegrind use: when saving to a | |
1930 | file, the generated file can directly be loaded into |
|
1930 | file, the generated file can directly be loaded into | |
1931 | kcachegrind. |
|
1931 | kcachegrind. | |
1932 |
|
1932 | |||
1933 | ``statformat`` |
|
1933 | ``statformat`` | |
1934 | Profiling format for the ``stat`` profiler. |
|
1934 | Profiling format for the ``stat`` profiler. | |
1935 | (default: hotpath) |
|
1935 | (default: hotpath) | |
1936 |
|
1936 | |||
1937 | ``hotpath`` |
|
1937 | ``hotpath`` | |
1938 | Show a tree-based display containing the hot path of execution (where |
|
1938 | Show a tree-based display containing the hot path of execution (where | |
1939 | most time was spent). |
|
1939 | most time was spent). | |
1940 | ``bymethod`` |
|
1940 | ``bymethod`` | |
1941 | Show a table of methods ordered by how frequently they are active. |
|
1941 | Show a table of methods ordered by how frequently they are active. | |
1942 | ``byline`` |
|
1942 | ``byline`` | |
1943 | Show a table of lines in files ordered by how frequently they are active. |
|
1943 | Show a table of lines in files ordered by how frequently they are active. | |
1944 | ``json`` |
|
1944 | ``json`` | |
1945 | Render profiling data as JSON. |
|
1945 | Render profiling data as JSON. | |
1946 |
|
1946 | |||
1947 | ``freq`` |
|
1947 | ``freq`` | |
1948 | Sampling frequency. Specific to the ``stat`` sampling profiler. |
|
1948 | Sampling frequency. Specific to the ``stat`` sampling profiler. | |
1949 | (default: 1000) |
|
1949 | (default: 1000) | |
1950 |
|
1950 | |||
1951 | ``output`` |
|
1951 | ``output`` | |
1952 | File path where profiling data or report should be saved. If the |
|
1952 | File path where profiling data or report should be saved. If the | |
1953 | file exists, it is replaced. (default: None, data is printed on |
|
1953 | file exists, it is replaced. (default: None, data is printed on | |
1954 | stderr) |
|
1954 | stderr) | |
1955 |
|
1955 | |||
1956 | ``sort`` |
|
1956 | ``sort`` | |
1957 | Sort field. Specific to the ``ls`` instrumenting profiler. |
|
1957 | Sort field. Specific to the ``ls`` instrumenting profiler. | |
1958 | One of ``callcount``, ``reccallcount``, ``totaltime`` and |
|
1958 | One of ``callcount``, ``reccallcount``, ``totaltime`` and | |
1959 | ``inlinetime``. |
|
1959 | ``inlinetime``. | |
1960 | (default: inlinetime) |
|
1960 | (default: inlinetime) | |
1961 |
|
1961 | |||
1962 | ``time-track`` |
|
1962 | ``time-track`` | |
1963 | Control if the stat profiler track ``cpu`` or ``real`` time. |
|
1963 | Control if the stat profiler track ``cpu`` or ``real`` time. | |
1964 | (default: ``cpu`` on Windows, otherwise ``real``) |
|
1964 | (default: ``cpu`` on Windows, otherwise ``real``) | |
1965 |
|
1965 | |||
1966 | ``limit`` |
|
1966 | ``limit`` | |
1967 | Number of lines to show. Specific to the ``ls`` instrumenting profiler. |
|
1967 | Number of lines to show. Specific to the ``ls`` instrumenting profiler. | |
1968 | (default: 30) |
|
1968 | (default: 30) | |
1969 |
|
1969 | |||
1970 | ``nested`` |
|
1970 | ``nested`` | |
1971 | Show at most this number of lines of drill-down info after each main entry. |
|
1971 | Show at most this number of lines of drill-down info after each main entry. | |
1972 | This can help explain the difference between Total and Inline. |
|
1972 | This can help explain the difference between Total and Inline. | |
1973 | Specific to the ``ls`` instrumenting profiler. |
|
1973 | Specific to the ``ls`` instrumenting profiler. | |
1974 | (default: 0) |
|
1974 | (default: 0) | |
1975 |
|
1975 | |||
1976 | ``showmin`` |
|
1976 | ``showmin`` | |
1977 | Minimum fraction of samples an entry must have for it to be displayed. |
|
1977 | Minimum fraction of samples an entry must have for it to be displayed. | |
1978 | Can be specified as a float between ``0.0`` and ``1.0`` or can have a |
|
1978 | Can be specified as a float between ``0.0`` and ``1.0`` or can have a | |
1979 | ``%`` afterwards to allow values up to ``100``. e.g. ``5%``. |
|
1979 | ``%`` afterwards to allow values up to ``100``. e.g. ``5%``. | |
1980 |
|
1980 | |||
1981 | Only used by the ``stat`` profiler. |
|
1981 | Only used by the ``stat`` profiler. | |
1982 |
|
1982 | |||
1983 | For the ``hotpath`` format, default is ``0.05``. |
|
1983 | For the ``hotpath`` format, default is ``0.05``. | |
1984 | For the ``chrome`` format, default is ``0.005``. |
|
1984 | For the ``chrome`` format, default is ``0.005``. | |
1985 |
|
1985 | |||
1986 | The option is unused on other formats. |
|
1986 | The option is unused on other formats. | |
1987 |
|
1987 | |||
1988 | ``showmax`` |
|
1988 | ``showmax`` | |
1989 | Maximum fraction of samples an entry can have before it is ignored in |
|
1989 | Maximum fraction of samples an entry can have before it is ignored in | |
1990 | display. Values format is the same as ``showmin``. |
|
1990 | display. Values format is the same as ``showmin``. | |
1991 |
|
1991 | |||
1992 | Only used by the ``stat`` profiler. |
|
1992 | Only used by the ``stat`` profiler. | |
1993 |
|
1993 | |||
1994 | For the ``chrome`` format, default is ``0.999``. |
|
1994 | For the ``chrome`` format, default is ``0.999``. | |
1995 |
|
1995 | |||
1996 | The option is unused on other formats. |
|
1996 | The option is unused on other formats. | |
1997 |
|
1997 | |||
1998 | ``showtime`` |
|
1998 | ``showtime`` | |
1999 | Show time taken as absolute durations, in addition to percentages. |
|
1999 | Show time taken as absolute durations, in addition to percentages. | |
2000 | Only used by the ``hotpath`` format. |
|
2000 | Only used by the ``hotpath`` format. | |
2001 | (default: true) |
|
2001 | (default: true) | |
2002 |
|
2002 | |||
2003 | ``progress`` |
|
2003 | ``progress`` | |
2004 | ------------ |
|
2004 | ------------ | |
2005 |
|
2005 | |||
2006 | Mercurial commands can draw progress bars that are as informative as |
|
2006 | Mercurial commands can draw progress bars that are as informative as | |
2007 | possible. Some progress bars only offer indeterminate information, while others |
|
2007 | possible. Some progress bars only offer indeterminate information, while others | |
2008 | have a definite end point. |
|
2008 | have a definite end point. | |
2009 |
|
2009 | |||
2010 | ``debug`` |
|
2010 | ``debug`` | |
2011 | Whether to print debug info when updating the progress bar. (default: False) |
|
2011 | Whether to print debug info when updating the progress bar. (default: False) | |
2012 |
|
2012 | |||
2013 | ``delay`` |
|
2013 | ``delay`` | |
2014 | Number of seconds (float) before showing the progress bar. (default: 3) |
|
2014 | Number of seconds (float) before showing the progress bar. (default: 3) | |
2015 |
|
2015 | |||
2016 | ``changedelay`` |
|
2016 | ``changedelay`` | |
2017 | Minimum delay before showing a new topic. When set to less than 3 * refresh, |
|
2017 | Minimum delay before showing a new topic. When set to less than 3 * refresh, | |
2018 | that value will be used instead. (default: 1) |
|
2018 | that value will be used instead. (default: 1) | |
2019 |
|
2019 | |||
2020 | ``estimateinterval`` |
|
2020 | ``estimateinterval`` | |
2021 | Maximum sampling interval in seconds for speed and estimated time |
|
2021 | Maximum sampling interval in seconds for speed and estimated time | |
2022 | calculation. (default: 60) |
|
2022 | calculation. (default: 60) | |
2023 |
|
2023 | |||
2024 | ``refresh`` |
|
2024 | ``refresh`` | |
2025 | Time in seconds between refreshes of the progress bar. (default: 0.1) |
|
2025 | Time in seconds between refreshes of the progress bar. (default: 0.1) | |
2026 |
|
2026 | |||
2027 | ``format`` |
|
2027 | ``format`` | |
2028 | Format of the progress bar. |
|
2028 | Format of the progress bar. | |
2029 |
|
2029 | |||
2030 | Valid entries for the format field are ``topic``, ``bar``, ``number``, |
|
2030 | Valid entries for the format field are ``topic``, ``bar``, ``number``, | |
2031 | ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the |
|
2031 | ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the | |
2032 | last 20 characters of the item, but this can be changed by adding either |
|
2032 | last 20 characters of the item, but this can be changed by adding either | |
2033 | ``-<num>`` which would take the last num characters, or ``+<num>`` for the |
|
2033 | ``-<num>`` which would take the last num characters, or ``+<num>`` for the | |
2034 | first num characters. |
|
2034 | first num characters. | |
2035 |
|
2035 | |||
2036 | (default: topic bar number estimate) |
|
2036 | (default: topic bar number estimate) | |
2037 |
|
2037 | |||
2038 | ``width`` |
|
2038 | ``width`` | |
2039 | If set, the maximum width of the progress information (that is, min(width, |
|
2039 | If set, the maximum width of the progress information (that is, min(width, | |
2040 | term width) will be used). |
|
2040 | term width) will be used). | |
2041 |
|
2041 | |||
2042 | ``clear-complete`` |
|
2042 | ``clear-complete`` | |
2043 | Clear the progress bar after it's done. (default: True) |
|
2043 | Clear the progress bar after it's done. (default: True) | |
2044 |
|
2044 | |||
2045 | ``disable`` |
|
2045 | ``disable`` | |
2046 | If true, don't show a progress bar. |
|
2046 | If true, don't show a progress bar. | |
2047 |
|
2047 | |||
2048 | ``assume-tty`` |
|
2048 | ``assume-tty`` | |
2049 | If true, ALWAYS show a progress bar, unless disable is given. |
|
2049 | If true, ALWAYS show a progress bar, unless disable is given. | |
2050 |
|
2050 | |||
2051 | ``rebase`` |
|
2051 | ``rebase`` | |
2052 | ---------- |
|
2052 | ---------- | |
2053 |
|
2053 | |||
2054 | ``evolution.allowdivergence`` |
|
2054 | ``evolution.allowdivergence`` | |
2055 | Default to False, when True allow creating divergence when performing |
|
2055 | Default to False, when True allow creating divergence when performing | |
2056 | rebase of obsolete changesets. |
|
2056 | rebase of obsolete changesets. | |
2057 |
|
2057 | |||
2058 | ``revsetalias`` |
|
2058 | ``revsetalias`` | |
2059 | --------------- |
|
2059 | --------------- | |
2060 |
|
2060 | |||
2061 | Alias definitions for revsets. See :hg:`help revsets` for details. |
|
2061 | Alias definitions for revsets. See :hg:`help revsets` for details. | |
2062 |
|
2062 | |||
2063 | ``rewrite`` |
|
2063 | ``rewrite`` | |
2064 | ----------- |
|
2064 | ----------- | |
2065 |
|
2065 | |||
2066 | ``backup-bundle`` |
|
2066 | ``backup-bundle`` | |
2067 | Whether to save stripped changesets to a bundle file. (default: True) |
|
2067 | Whether to save stripped changesets to a bundle file. (default: True) | |
2068 |
|
2068 | |||
2069 | ``update-timestamp`` |
|
2069 | ``update-timestamp`` | |
2070 | If true, updates the date and time of the changeset to current. It is only |
|
2070 | If true, updates the date and time of the changeset to current. It is only | |
2071 | applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the |
|
2071 | applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the | |
2072 | current version. |
|
2072 | current version. | |
2073 |
|
2073 | |||
2074 | ``empty-successor`` |
|
2074 | ``empty-successor`` | |
2075 |
|
2075 | |||
2076 | Control what happens with empty successors that are the result of rewrite |
|
2076 | Control what happens with empty successors that are the result of rewrite | |
2077 | operations. If set to ``skip``, the successor is not created. If set to |
|
2077 | operations. If set to ``skip``, the successor is not created. If set to | |
2078 | ``keep``, the empty successor is created and kept. |
|
2078 | ``keep``, the empty successor is created and kept. | |
2079 |
|
2079 | |||
2080 | Currently, only the rebase and absorb commands consider this configuration. |
|
2080 | Currently, only the rebase and absorb commands consider this configuration. | |
2081 | (EXPERIMENTAL) |
|
2081 | (EXPERIMENTAL) | |
2082 |
|
2082 | |||
2083 | ``share`` |
|
2083 | ``share`` | |
2084 | --------- |
|
2084 | --------- | |
2085 |
|
2085 | |||
2086 | ``safe-mismatch.source-safe`` |
|
2086 | ``safe-mismatch.source-safe`` | |
2087 | Controls what happens when the shared repository does not use the |
|
2087 | Controls what happens when the shared repository does not use the | |
2088 | share-safe mechanism but its source repository does. |
|
2088 | share-safe mechanism but its source repository does. | |
2089 |
|
2089 | |||
2090 | Possible values are `abort` (default), `allow`, `upgrade-abort` and |
|
2090 | Possible values are `abort` (default), `allow`, `upgrade-abort` and | |
2091 | `upgrade-allow`. |
|
2091 | `upgrade-allow`. | |
2092 |
|
2092 | |||
2093 | ``abort`` |
|
2093 | ``abort`` | |
2094 | Disallows running any command and aborts |
|
2094 | Disallows running any command and aborts | |
2095 | ``allow`` |
|
2095 | ``allow`` | |
2096 | Respects the feature presence in the share source |
|
2096 | Respects the feature presence in the share source | |
2097 | ``upgrade-abort`` |
|
2097 | ``upgrade-abort`` | |
2098 | tries to upgrade the share to use share-safe; if it fails, aborts |
|
2098 | tries to upgrade the share to use share-safe; if it fails, aborts | |
2099 | ``upgrade-allow`` |
|
2099 | ``upgrade-allow`` | |
2100 | tries to upgrade the share; if it fails, continue by |
|
2100 | tries to upgrade the share; if it fails, continue by | |
2101 | respecting the share source setting |
|
2101 | respecting the share source setting | |
2102 |
|
2102 | |||
2103 | Check :hg:`help config.format.use-share-safe` for details about the |
|
2103 | Check :hg:`help config.format.use-share-safe` for details about the | |
2104 | share-safe feature. |
|
2104 | share-safe feature. | |
2105 |
|
2105 | |||
2106 | ``safe-mismatch.source-safe.warn`` |
|
2106 | ``safe-mismatch.source-safe.warn`` | |
2107 | Shows a warning on operations if the shared repository does not use |
|
2107 | Shows a warning on operations if the shared repository does not use | |
2108 | share-safe, but the source repository does. |
|
2108 | share-safe, but the source repository does. | |
2109 | (default: True) |
|
2109 | (default: True) | |
2110 |
|
2110 | |||
2111 | ``safe-mismatch.source-not-safe`` |
|
2111 | ``safe-mismatch.source-not-safe`` | |
2112 | Controls what happens when the shared repository uses the share-safe |
|
2112 | Controls what happens when the shared repository uses the share-safe | |
2113 | mechanism but its source does not. |
|
2113 | mechanism but its source does not. | |
2114 |
|
2114 | |||
2115 | Possible values are `abort` (default), `allow`, `downgrade-abort` and |
|
2115 | Possible values are `abort` (default), `allow`, `downgrade-abort` and | |
2116 | `downgrade-allow`. |
|
2116 | `downgrade-allow`. | |
2117 |
|
2117 | |||
2118 | ``abort`` |
|
2118 | ``abort`` | |
2119 | Disallows running any command and aborts |
|
2119 | Disallows running any command and aborts | |
2120 | ``allow`` |
|
2120 | ``allow`` | |
2121 | Respects the feature presence in the share source |
|
2121 | Respects the feature presence in the share source | |
2122 | ``downgrade-abort`` |
|
2122 | ``downgrade-abort`` | |
2123 | tries to downgrade the share to not use share-safe; if it fails, aborts |
|
2123 | tries to downgrade the share to not use share-safe; if it fails, aborts | |
2124 | ``downgrade-allow`` |
|
2124 | ``downgrade-allow`` | |
2125 | tries to downgrade the share to not use share-safe; |
|
2125 | tries to downgrade the share to not use share-safe; | |
2126 | if it fails, continue by respecting the shared source setting |
|
2126 | if it fails, continue by respecting the shared source setting | |
2127 |
|
2127 | |||
2128 | Check :hg:`help config.format.use-share-safe` for details about the |
|
2128 | Check :hg:`help config.format.use-share-safe` for details about the | |
2129 | share-safe feature. |
|
2129 | share-safe feature. | |
2130 |
|
2130 | |||
2131 | ``safe-mismatch.source-not-safe.warn`` |
|
2131 | ``safe-mismatch.source-not-safe.warn`` | |
2132 | Shows a warning on operations if the shared repository uses share-safe, |
|
2132 | Shows a warning on operations if the shared repository uses share-safe, | |
2133 | but the source repository does not. |
|
2133 | but the source repository does not. | |
2134 | (default: True) |
|
2134 | (default: True) | |
2135 |
|
2135 | |||
2136 | ``storage`` |
|
2136 | ``storage`` | |
2137 | ----------- |
|
2137 | ----------- | |
2138 |
|
2138 | |||
2139 | Control the strategy Mercurial uses internally to store history. Options in this |
|
2139 | Control the strategy Mercurial uses internally to store history. Options in this | |
2140 | category impact performance and repository size. |
|
2140 | category impact performance and repository size. | |
2141 |
|
2141 | |||
2142 | ``revlog.issue6528.fix-incoming`` |
|
2142 | ``revlog.issue6528.fix-incoming`` | |
2143 | Version 5.8 of Mercurial had a bug leading to altering the parent of file |
|
2143 | Version 5.8 of Mercurial had a bug leading to altering the parent of file | |
2144 | revision with copy information (or any other metadata) on exchange. This |
|
2144 | revision with copy information (or any other metadata) on exchange. This | |
2145 | leads to the copy metadata to be overlooked by various internal logic. The |
|
2145 | leads to the copy metadata to be overlooked by various internal logic. The | |
2146 | issue was fixed in Mercurial 5.8.1. |
|
2146 | issue was fixed in Mercurial 5.8.1. | |
2147 | (See https://bz.mercurial-scm.org/show_bug.cgi?id=6528 for details) |
|
2147 | (See https://bz.mercurial-scm.org/show_bug.cgi?id=6528 for details) | |
2148 |
|
2148 | |||
2149 | As a result Mercurial is now checking and fixing incoming file revisions to |
|
2149 | As a result Mercurial is now checking and fixing incoming file revisions to | |
2150 | make sure there parents are in the right order. This behavior can be |
|
2150 | make sure there parents are in the right order. This behavior can be | |
2151 | disabled by setting this option to `no`. This apply to revisions added |
|
2151 | disabled by setting this option to `no`. This apply to revisions added | |
2152 | through push, pull, clone and unbundle. |
|
2152 | through push, pull, clone and unbundle. | |
2153 |
|
2153 | |||
2154 | To fix affected revisions that already exist within the repository, one can |
|
2154 | To fix affected revisions that already exist within the repository, one can | |
2155 | use :hg:`debug-repair-issue-6528`. |
|
2155 | use :hg:`debug-repair-issue-6528`. | |
2156 |
|
2156 | |||
2157 | ``revlog.optimize-delta-parent-choice`` |
|
2157 | ``revlog.optimize-delta-parent-choice`` | |
2158 | When storing a merge revision, both parents will be equally considered as |
|
2158 | When storing a merge revision, both parents will be equally considered as | |
2159 | a possible delta base. This results in better delta selection and improved |
|
2159 | a possible delta base. This results in better delta selection and improved | |
2160 | revlog compression. This option is enabled by default. |
|
2160 | revlog compression. This option is enabled by default. | |
2161 |
|
2161 | |||
2162 | Turning this option off can result in large increase of repository size for |
|
2162 | Turning this option off can result in large increase of repository size for | |
2163 | repository with many merges. |
|
2163 | repository with many merges. | |
2164 |
|
2164 | |||
2165 | ``revlog.persistent-nodemap.mmap`` |
|
2165 | ``revlog.persistent-nodemap.mmap`` | |
2166 | Whether to use the Operating System "memory mapping" feature (when |
|
2166 | Whether to use the Operating System "memory mapping" feature (when | |
2167 | possible) to access the persistent nodemap data. This improve performance |
|
2167 | possible) to access the persistent nodemap data. This improve performance | |
2168 | and reduce memory pressure. |
|
2168 | and reduce memory pressure. | |
2169 |
|
2169 | |||
2170 | Default to True. |
|
2170 | Default to True. | |
2171 |
|
2171 | |||
2172 | For details on the "persistent-nodemap" feature, see: |
|
2172 | For details on the "persistent-nodemap" feature, see: | |
2173 | :hg:`help config.format.use-persistent-nodemap`. |
|
2173 | :hg:`help config.format.use-persistent-nodemap`. | |
2174 |
|
2174 | |||
2175 | ``revlog.persistent-nodemap.slow-path`` |
|
2175 | ``revlog.persistent-nodemap.slow-path`` | |
2176 | Control the behavior of Merucrial when using a repository with "persistent" |
|
2176 | Control the behavior of Merucrial when using a repository with "persistent" | |
2177 | nodemap with an installation of Mercurial without a fast implementation for |
|
2177 | nodemap with an installation of Mercurial without a fast implementation for | |
2178 | the feature: |
|
2178 | the feature: | |
2179 |
|
2179 | |||
2180 | ``allow``: Silently use the slower implementation to access the repository. |
|
2180 | ``allow``: Silently use the slower implementation to access the repository. | |
2181 | ``warn``: Warn, but use the slower implementation to access the repository. |
|
2181 | ``warn``: Warn, but use the slower implementation to access the repository. | |
2182 | ``abort``: Prevent access to such repositories. (This is the default) |
|
2182 | ``abort``: Prevent access to such repositories. (This is the default) | |
2183 |
|
2183 | |||
2184 | For details on the "persistent-nodemap" feature, see: |
|
2184 | For details on the "persistent-nodemap" feature, see: | |
2185 | :hg:`help config.format.use-persistent-nodemap`. |
|
2185 | :hg:`help config.format.use-persistent-nodemap`. | |
2186 |
|
2186 | |||
2187 | ``revlog.reuse-external-delta-parent`` |
|
2187 | ``revlog.reuse-external-delta-parent`` | |
2188 | Control the order in which delta parents are considered when adding new |
|
2188 | Control the order in which delta parents are considered when adding new | |
2189 | revisions from an external source. |
|
2189 | revisions from an external source. | |
2190 | (typically: apply bundle from `hg pull` or `hg push`). |
|
2190 | (typically: apply bundle from `hg pull` or `hg push`). | |
2191 |
|
2191 | |||
2192 | New revisions are usually provided as a delta against other revisions. By |
|
2192 | New revisions are usually provided as a delta against other revisions. By | |
2193 | default, Mercurial will try to reuse this delta first, therefore using the |
|
2193 | default, Mercurial will try to reuse this delta first, therefore using the | |
2194 | same "delta parent" as the source. Directly using delta's from the source |
|
2194 | same "delta parent" as the source. Directly using delta's from the source | |
2195 | reduces CPU usage and usually speeds up operation. However, in some case, |
|
2195 | reduces CPU usage and usually speeds up operation. However, in some case, | |
2196 | the source might have sub-optimal delta bases and forcing their reevaluation |
|
2196 | the source might have sub-optimal delta bases and forcing their reevaluation | |
2197 | is useful. For example, pushes from an old client could have sub-optimal |
|
2197 | is useful. For example, pushes from an old client could have sub-optimal | |
2198 | delta's parent that the server want to optimize. (lack of general delta, bad |
|
2198 | delta's parent that the server want to optimize. (lack of general delta, bad | |
2199 | parents, choice, lack of sparse-revlog, etc). |
|
2199 | parents, choice, lack of sparse-revlog, etc). | |
2200 |
|
2200 | |||
2201 | This option is enabled by default. Turning it off will ensure bad delta |
|
2201 | This option is enabled by default. Turning it off will ensure bad delta | |
2202 | parent choices from older client do not propagate to this repository, at |
|
2202 | parent choices from older client do not propagate to this repository, at | |
2203 | the cost of a small increase in CPU consumption. |
|
2203 | the cost of a small increase in CPU consumption. | |
2204 |
|
2204 | |||
2205 | Note: this option only control the order in which delta parents are |
|
2205 | Note: this option only control the order in which delta parents are | |
2206 | considered. Even when disabled, the existing delta from the source will be |
|
2206 | considered. Even when disabled, the existing delta from the source will be | |
2207 | reused if the same delta parent is selected. |
|
2207 | reused if the same delta parent is selected. | |
2208 |
|
2208 | |||
2209 | ``revlog.reuse-external-delta`` |
|
2209 | ``revlog.reuse-external-delta`` | |
2210 | Control the reuse of delta from external source. |
|
2210 | Control the reuse of delta from external source. | |
2211 | (typically: apply bundle from `hg pull` or `hg push`). |
|
2211 | (typically: apply bundle from `hg pull` or `hg push`). | |
2212 |
|
2212 | |||
2213 | New revisions are usually provided as a delta against another revision. By |
|
2213 | New revisions are usually provided as a delta against another revision. By | |
2214 | default, Mercurial will not recompute the same delta again, trusting |
|
2214 | default, Mercurial will not recompute the same delta again, trusting | |
2215 | externally provided deltas. There have been rare cases of small adjustment |
|
2215 | externally provided deltas. There have been rare cases of small adjustment | |
2216 | to the diffing algorithm in the past. So in some rare case, recomputing |
|
2216 | to the diffing algorithm in the past. So in some rare case, recomputing | |
2217 | delta provided by ancient clients can provides better results. Disabling |
|
2217 | delta provided by ancient clients can provides better results. Disabling | |
2218 | this option means going through a full delta recomputation for all incoming |
|
2218 | this option means going through a full delta recomputation for all incoming | |
2219 | revisions. It means a large increase in CPU usage and will slow operations |
|
2219 | revisions. It means a large increase in CPU usage and will slow operations | |
2220 | down. |
|
2220 | down. | |
2221 |
|
2221 | |||
2222 | This option is enabled by default. When disabled, it also disables the |
|
2222 | This option is enabled by default. When disabled, it also disables the | |
2223 | related ``storage.revlog.reuse-external-delta-parent`` option. |
|
2223 | related ``storage.revlog.reuse-external-delta-parent`` option. | |
2224 |
|
2224 | |||
2225 | ``revlog.zlib.level`` |
|
2225 | ``revlog.zlib.level`` | |
2226 | Zlib compression level used when storing data into the repository. Accepted |
|
2226 | Zlib compression level used when storing data into the repository. Accepted | |
2227 | Value range from 1 (lowest compression) to 9 (highest compression). Zlib |
|
2227 | Value range from 1 (lowest compression) to 9 (highest compression). Zlib | |
2228 | default value is 6. |
|
2228 | default value is 6. | |
2229 |
|
2229 | |||
2230 |
|
2230 | |||
2231 | ``revlog.zstd.level`` |
|
2231 | ``revlog.zstd.level`` | |
2232 | zstd compression level used when storing data into the repository. Accepted |
|
2232 | zstd compression level used when storing data into the repository. Accepted | |
2233 | Value range from 1 (lowest compression) to 22 (highest compression). |
|
2233 | Value range from 1 (lowest compression) to 22 (highest compression). | |
2234 | (default 3) |
|
2234 | (default 3) | |
2235 |
|
2235 | |||
2236 | ``server`` |
|
2236 | ``server`` | |
2237 | ---------- |
|
2237 | ---------- | |
2238 |
|
2238 | |||
2239 | Controls generic server settings. |
|
2239 | Controls generic server settings. | |
2240 |
|
2240 | |||
2241 | ``bookmarks-pushkey-compat`` |
|
2241 | ``bookmarks-pushkey-compat`` | |
2242 | Trigger pushkey hook when being pushed bookmark updates. This config exist |
|
2242 | Trigger pushkey hook when being pushed bookmark updates. This config exist | |
2243 | for compatibility purpose (default to True) |
|
2243 | for compatibility purpose (default to True) | |
2244 |
|
2244 | |||
2245 | If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark |
|
2245 | If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark | |
2246 | movement we recommend you migrate them to ``txnclose-bookmark`` and |
|
2246 | movement we recommend you migrate them to ``txnclose-bookmark`` and | |
2247 | ``pretxnclose-bookmark``. |
|
2247 | ``pretxnclose-bookmark``. | |
2248 |
|
2248 | |||
2249 | ``compressionengines`` |
|
2249 | ``compressionengines`` | |
2250 | List of compression engines and their relative priority to advertise |
|
2250 | List of compression engines and their relative priority to advertise | |
2251 | to clients. |
|
2251 | to clients. | |
2252 |
|
2252 | |||
2253 | The order of compression engines determines their priority, the first |
|
2253 | The order of compression engines determines their priority, the first | |
2254 | having the highest priority. If a compression engine is not listed |
|
2254 | having the highest priority. If a compression engine is not listed | |
2255 | here, it won't be advertised to clients. |
|
2255 | here, it won't be advertised to clients. | |
2256 |
|
2256 | |||
2257 | If not set (the default), built-in defaults are used. Run |
|
2257 | If not set (the default), built-in defaults are used. Run | |
2258 | :hg:`debuginstall` to list available compression engines and their |
|
2258 | :hg:`debuginstall` to list available compression engines and their | |
2259 | default wire protocol priority. |
|
2259 | default wire protocol priority. | |
2260 |
|
2260 | |||
2261 | Older Mercurial clients only support zlib compression and this setting |
|
2261 | Older Mercurial clients only support zlib compression and this setting | |
2262 | has no effect for legacy clients. |
|
2262 | has no effect for legacy clients. | |
2263 |
|
2263 | |||
2264 | ``uncompressed`` |
|
2264 | ``uncompressed`` | |
2265 | Whether to allow clients to clone a repository using the |
|
2265 | Whether to allow clients to clone a repository using the | |
2266 | uncompressed streaming protocol. This transfers about 40% more |
|
2266 | uncompressed streaming protocol. This transfers about 40% more | |
2267 | data than a regular clone, but uses less memory and CPU on both |
|
2267 | data than a regular clone, but uses less memory and CPU on both | |
2268 | server and client. Over a LAN (100 Mbps or better) or a very fast |
|
2268 | server and client. Over a LAN (100 Mbps or better) or a very fast | |
2269 | WAN, an uncompressed streaming clone is a lot faster (~10x) than a |
|
2269 | WAN, an uncompressed streaming clone is a lot faster (~10x) than a | |
2270 | regular clone. Over most WAN connections (anything slower than |
|
2270 | regular clone. Over most WAN connections (anything slower than | |
2271 | about 6 Mbps), uncompressed streaming is slower, because of the |
|
2271 | about 6 Mbps), uncompressed streaming is slower, because of the | |
2272 | extra data transfer overhead. This mode will also temporarily hold |
|
2272 | extra data transfer overhead. This mode will also temporarily hold | |
2273 | the write lock while determining what data to transfer. |
|
2273 | the write lock while determining what data to transfer. | |
2274 | (default: True) |
|
2274 | (default: True) | |
2275 |
|
2275 | |||
2276 | ``uncompressedallowsecret`` |
|
2276 | ``uncompressedallowsecret`` | |
2277 | Whether to allow stream clones when the repository contains secret |
|
2277 | Whether to allow stream clones when the repository contains secret | |
2278 | changesets. (default: False) |
|
2278 | changesets. (default: False) | |
2279 |
|
2279 | |||
2280 | ``preferuncompressed`` |
|
2280 | ``preferuncompressed`` | |
2281 | When set, clients will try to use the uncompressed streaming |
|
2281 | When set, clients will try to use the uncompressed streaming | |
2282 | protocol. (default: False) |
|
2282 | protocol. (default: False) | |
2283 |
|
2283 | |||
2284 | ``disablefullbundle`` |
|
2284 | ``disablefullbundle`` | |
2285 | When set, servers will refuse attempts to do pull-based clones. |
|
2285 | When set, servers will refuse attempts to do pull-based clones. | |
2286 | If this option is set, ``preferuncompressed`` and/or clone bundles |
|
2286 | If this option is set, ``preferuncompressed`` and/or clone bundles | |
2287 | are highly recommended. Partial clones will still be allowed. |
|
2287 | are highly recommended. Partial clones will still be allowed. | |
2288 | (default: False) |
|
2288 | (default: False) | |
2289 |
|
2289 | |||
2290 | ``streamunbundle`` |
|
2290 | ``streamunbundle`` | |
2291 | When set, servers will apply data sent from the client directly, |
|
2291 | When set, servers will apply data sent from the client directly, | |
2292 | otherwise it will be written to a temporary file first. This option |
|
2292 | otherwise it will be written to a temporary file first. This option | |
2293 | effectively prevents concurrent pushes. |
|
2293 | effectively prevents concurrent pushes. | |
2294 |
|
2294 | |||
2295 | ``pullbundle`` |
|
2295 | ``pullbundle`` | |
2296 | When set, the server will check pullbundles.manifest for bundles |
|
2296 | When set, the server will check pullbundles.manifest for bundles | |
2297 | covering the requested heads and common nodes. The first matching |
|
2297 | covering the requested heads and common nodes. The first matching | |
2298 | entry will be streamed to the client. |
|
2298 | entry will be streamed to the client. | |
2299 |
|
2299 | |||
2300 | For HTTP transport, the stream will still use zlib compression |
|
2300 | For HTTP transport, the stream will still use zlib compression | |
2301 | for older clients. |
|
2301 | for older clients. | |
2302 |
|
2302 | |||
2303 | ``concurrent-push-mode`` |
|
2303 | ``concurrent-push-mode`` | |
2304 | Level of allowed race condition between two pushing clients. |
|
2304 | Level of allowed race condition between two pushing clients. | |
2305 |
|
2305 | |||
2306 | - 'strict': push is abort if another client touched the repository |
|
2306 | - 'strict': push is abort if another client touched the repository | |
2307 | while the push was preparing. |
|
2307 | while the push was preparing. | |
2308 | - 'check-related': push is only aborted if it affects head that got also |
|
2308 | - 'check-related': push is only aborted if it affects head that got also | |
2309 | affected while the push was preparing. (default since 5.4) |
|
2309 | affected while the push was preparing. (default since 5.4) | |
2310 |
|
2310 | |||
2311 | 'check-related' only takes effect for compatible clients (version |
|
2311 | 'check-related' only takes effect for compatible clients (version | |
2312 | 4.3 and later). Older clients will use 'strict'. |
|
2312 | 4.3 and later). Older clients will use 'strict'. | |
2313 |
|
2313 | |||
2314 | ``validate`` |
|
2314 | ``validate`` | |
2315 | Whether to validate the completeness of pushed changesets by |
|
2315 | Whether to validate the completeness of pushed changesets by | |
2316 | checking that all new file revisions specified in manifests are |
|
2316 | checking that all new file revisions specified in manifests are | |
2317 | present. (default: False) |
|
2317 | present. (default: False) | |
2318 |
|
2318 | |||
2319 | ``maxhttpheaderlen`` |
|
2319 | ``maxhttpheaderlen`` | |
2320 | Instruct HTTP clients not to send request headers longer than this |
|
2320 | Instruct HTTP clients not to send request headers longer than this | |
2321 | many bytes. (default: 1024) |
|
2321 | many bytes. (default: 1024) | |
2322 |
|
2322 | |||
2323 | ``bundle1`` |
|
2323 | ``bundle1`` | |
2324 | Whether to allow clients to push and pull using the legacy bundle1 |
|
2324 | Whether to allow clients to push and pull using the legacy bundle1 | |
2325 | exchange format. (default: True) |
|
2325 | exchange format. (default: True) | |
2326 |
|
2326 | |||
2327 | ``bundle1gd`` |
|
2327 | ``bundle1gd`` | |
2328 | Like ``bundle1`` but only used if the repository is using the |
|
2328 | Like ``bundle1`` but only used if the repository is using the | |
2329 | *generaldelta* storage format. (default: True) |
|
2329 | *generaldelta* storage format. (default: True) | |
2330 |
|
2330 | |||
2331 | ``bundle1.push`` |
|
2331 | ``bundle1.push`` | |
2332 | Whether to allow clients to push using the legacy bundle1 exchange |
|
2332 | Whether to allow clients to push using the legacy bundle1 exchange | |
2333 | format. (default: True) |
|
2333 | format. (default: True) | |
2334 |
|
2334 | |||
2335 | ``bundle1gd.push`` |
|
2335 | ``bundle1gd.push`` | |
2336 | Like ``bundle1.push`` but only used if the repository is using the |
|
2336 | Like ``bundle1.push`` but only used if the repository is using the | |
2337 | *generaldelta* storage format. (default: True) |
|
2337 | *generaldelta* storage format. (default: True) | |
2338 |
|
2338 | |||
2339 | ``bundle1.pull`` |
|
2339 | ``bundle1.pull`` | |
2340 | Whether to allow clients to pull using the legacy bundle1 exchange |
|
2340 | Whether to allow clients to pull using the legacy bundle1 exchange | |
2341 | format. (default: True) |
|
2341 | format. (default: True) | |
2342 |
|
2342 | |||
2343 | ``bundle1gd.pull`` |
|
2343 | ``bundle1gd.pull`` | |
2344 | Like ``bundle1.pull`` but only used if the repository is using the |
|
2344 | Like ``bundle1.pull`` but only used if the repository is using the | |
2345 | *generaldelta* storage format. (default: True) |
|
2345 | *generaldelta* storage format. (default: True) | |
2346 |
|
2346 | |||
2347 | Large repositories using the *generaldelta* storage format should |
|
2347 | Large repositories using the *generaldelta* storage format should | |
2348 | consider setting this option because converting *generaldelta* |
|
2348 | consider setting this option because converting *generaldelta* | |
2349 | repositories to the exchange format required by the bundle1 data |
|
2349 | repositories to the exchange format required by the bundle1 data | |
2350 | format can consume a lot of CPU. |
|
2350 | format can consume a lot of CPU. | |
2351 |
|
2351 | |||
2352 | ``bundle2.stream`` |
|
2352 | ``bundle2.stream`` | |
2353 | Whether to allow clients to pull using the bundle2 streaming protocol. |
|
2353 | Whether to allow clients to pull using the bundle2 streaming protocol. | |
2354 | (default: True) |
|
2354 | (default: True) | |
2355 |
|
2355 | |||
2356 | ``zliblevel`` |
|
2356 | ``zliblevel`` | |
2357 | Integer between ``-1`` and ``9`` that controls the zlib compression level |
|
2357 | Integer between ``-1`` and ``9`` that controls the zlib compression level | |
2358 | for wire protocol commands that send zlib compressed output (notably the |
|
2358 | for wire protocol commands that send zlib compressed output (notably the | |
2359 | commands that send repository history data). |
|
2359 | commands that send repository history data). | |
2360 |
|
2360 | |||
2361 | The default (``-1``) uses the default zlib compression level, which is |
|
2361 | The default (``-1``) uses the default zlib compression level, which is | |
2362 | likely equivalent to ``6``. ``0`` means no compression. ``9`` means |
|
2362 | likely equivalent to ``6``. ``0`` means no compression. ``9`` means | |
2363 | maximum compression. |
|
2363 | maximum compression. | |
2364 |
|
2364 | |||
2365 | Setting this option allows server operators to make trade-offs between |
|
2365 | Setting this option allows server operators to make trade-offs between | |
2366 | bandwidth and CPU used. Lowering the compression lowers CPU utilization |
|
2366 | bandwidth and CPU used. Lowering the compression lowers CPU utilization | |
2367 | but sends more bytes to clients. |
|
2367 | but sends more bytes to clients. | |
2368 |
|
2368 | |||
2369 | This option only impacts the HTTP server. |
|
2369 | This option only impacts the HTTP server. | |
2370 |
|
2370 | |||
2371 | ``zstdlevel`` |
|
2371 | ``zstdlevel`` | |
2372 | Integer between ``1`` and ``22`` that controls the zstd compression level |
|
2372 | Integer between ``1`` and ``22`` that controls the zstd compression level | |
2373 | for wire protocol commands. ``1`` is the minimal amount of compression and |
|
2373 | for wire protocol commands. ``1`` is the minimal amount of compression and | |
2374 | ``22`` is the highest amount of compression. |
|
2374 | ``22`` is the highest amount of compression. | |
2375 |
|
2375 | |||
2376 | The default (``3``) should be significantly faster than zlib while likely |
|
2376 | The default (``3``) should be significantly faster than zlib while likely | |
2377 | delivering better compression ratios. |
|
2377 | delivering better compression ratios. | |
2378 |
|
2378 | |||
2379 | This option only impacts the HTTP server. |
|
2379 | This option only impacts the HTTP server. | |
2380 |
|
2380 | |||
2381 | See also ``server.zliblevel``. |
|
2381 | See also ``server.zliblevel``. | |
2382 |
|
2382 | |||
2383 | ``view`` |
|
2383 | ``view`` | |
2384 | Repository filter used when exchanging revisions with the peer. |
|
2384 | Repository filter used when exchanging revisions with the peer. | |
2385 |
|
2385 | |||
2386 | The default view (``served``) excludes secret and hidden changesets. |
|
2386 | The default view (``served``) excludes secret and hidden changesets. | |
2387 | Another useful value is ``immutable`` (no draft, secret or hidden |
|
2387 | Another useful value is ``immutable`` (no draft, secret or hidden | |
2388 | changesets). (EXPERIMENTAL) |
|
2388 | changesets). (EXPERIMENTAL) | |
2389 |
|
2389 | |||
2390 | ``smtp`` |
|
2390 | ``smtp`` | |
2391 | -------- |
|
2391 | -------- | |
2392 |
|
2392 | |||
2393 | Configuration for extensions that need to send email messages. |
|
2393 | Configuration for extensions that need to send email messages. | |
2394 |
|
2394 | |||
2395 | ``host`` |
|
2395 | ``host`` | |
2396 | Host name of mail server, e.g. "mail.example.com". |
|
2396 | Host name of mail server, e.g. "mail.example.com". | |
2397 |
|
2397 | |||
2398 | ``port`` |
|
2398 | ``port`` | |
2399 | Optional. Port to connect to on mail server. (default: 465 if |
|
2399 | Optional. Port to connect to on mail server. (default: 465 if | |
2400 | ``tls`` is smtps; 25 otherwise) |
|
2400 | ``tls`` is smtps; 25 otherwise) | |
2401 |
|
2401 | |||
2402 | ``tls`` |
|
2402 | ``tls`` | |
2403 | Optional. Method to enable TLS when connecting to mail server: starttls, |
|
2403 | Optional. Method to enable TLS when connecting to mail server: starttls, | |
2404 | smtps or none. (default: none) |
|
2404 | smtps or none. (default: none) | |
2405 |
|
2405 | |||
2406 | ``username`` |
|
2406 | ``username`` | |
2407 | Optional. User name for authenticating with the SMTP server. |
|
2407 | Optional. User name for authenticating with the SMTP server. | |
2408 | (default: None) |
|
2408 | (default: None) | |
2409 |
|
2409 | |||
2410 | ``password`` |
|
2410 | ``password`` | |
2411 | Optional. Password for authenticating with the SMTP server. If not |
|
2411 | Optional. Password for authenticating with the SMTP server. If not | |
2412 | specified, interactive sessions will prompt the user for a |
|
2412 | specified, interactive sessions will prompt the user for a | |
2413 | password; non-interactive sessions will fail. (default: None) |
|
2413 | password; non-interactive sessions will fail. (default: None) | |
2414 |
|
2414 | |||
2415 | ``local_hostname`` |
|
2415 | ``local_hostname`` | |
2416 | Optional. The hostname that the sender can use to identify |
|
2416 | Optional. The hostname that the sender can use to identify | |
2417 | itself to the MTA. |
|
2417 | itself to the MTA. | |
2418 |
|
2418 | |||
2419 |
|
2419 | |||
2420 | ``subpaths`` |
|
2420 | ``subpaths`` | |
2421 | ------------ |
|
2421 | ------------ | |
2422 |
|
2422 | |||
2423 | Subrepository source URLs can go stale if a remote server changes name |
|
2423 | Subrepository source URLs can go stale if a remote server changes name | |
2424 | or becomes temporarily unavailable. This section lets you define |
|
2424 | or becomes temporarily unavailable. This section lets you define | |
2425 | rewrite rules of the form:: |
|
2425 | rewrite rules of the form:: | |
2426 |
|
2426 | |||
2427 | <pattern> = <replacement> |
|
2427 | <pattern> = <replacement> | |
2428 |
|
2428 | |||
2429 | where ``pattern`` is a regular expression matching a subrepository |
|
2429 | where ``pattern`` is a regular expression matching a subrepository | |
2430 | source URL and ``replacement`` is the replacement string used to |
|
2430 | source URL and ``replacement`` is the replacement string used to | |
2431 | rewrite it. Groups can be matched in ``pattern`` and referenced in |
|
2431 | rewrite it. Groups can be matched in ``pattern`` and referenced in | |
2432 | ``replacements``. For instance:: |
|
2432 | ``replacements``. For instance:: | |
2433 |
|
2433 | |||
2434 | http://server/(.*)-hg/ = http://hg.server/\1/ |
|
2434 | http://server/(.*)-hg/ = http://hg.server/\1/ | |
2435 |
|
2435 | |||
2436 | rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``. |
|
2436 | rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``. | |
2437 |
|
2437 | |||
2438 | Relative subrepository paths are first made absolute, and the |
|
2438 | Relative subrepository paths are first made absolute, and the | |
2439 | rewrite rules are then applied on the full (absolute) path. If ``pattern`` |
|
2439 | rewrite rules are then applied on the full (absolute) path. If ``pattern`` | |
2440 | doesn't match the full path, an attempt is made to apply it on the |
|
2440 | doesn't match the full path, an attempt is made to apply it on the | |
2441 | relative path alone. The rules are applied in definition order. |
|
2441 | relative path alone. The rules are applied in definition order. | |
2442 |
|
2442 | |||
2443 | ``subrepos`` |
|
2443 | ``subrepos`` | |
2444 | ------------ |
|
2444 | ------------ | |
2445 |
|
2445 | |||
2446 | This section contains options that control the behavior of the |
|
2446 | This section contains options that control the behavior of the | |
2447 | subrepositories feature. See also :hg:`help subrepos`. |
|
2447 | subrepositories feature. See also :hg:`help subrepos`. | |
2448 |
|
2448 | |||
2449 | Security note: auditing in Mercurial is known to be insufficient to |
|
2449 | Security note: auditing in Mercurial is known to be insufficient to | |
2450 | prevent clone-time code execution with carefully constructed Git |
|
2450 | prevent clone-time code execution with carefully constructed Git | |
2451 | subrepos. It is unknown if a similar detect is present in Subversion |
|
2451 | subrepos. It is unknown if a similar detect is present in Subversion | |
2452 | subrepos. Both Git and Subversion subrepos are disabled by default |
|
2452 | subrepos. Both Git and Subversion subrepos are disabled by default | |
2453 | out of security concerns. These subrepo types can be enabled using |
|
2453 | out of security concerns. These subrepo types can be enabled using | |
2454 | the respective options below. |
|
2454 | the respective options below. | |
2455 |
|
2455 | |||
2456 | ``allowed`` |
|
2456 | ``allowed`` | |
2457 | Whether subrepositories are allowed in the working directory. |
|
2457 | Whether subrepositories are allowed in the working directory. | |
2458 |
|
2458 | |||
2459 | When false, commands involving subrepositories (like :hg:`update`) |
|
2459 | When false, commands involving subrepositories (like :hg:`update`) | |
2460 | will fail for all subrepository types. |
|
2460 | will fail for all subrepository types. | |
2461 | (default: true) |
|
2461 | (default: true) | |
2462 |
|
2462 | |||
2463 | ``hg:allowed`` |
|
2463 | ``hg:allowed`` | |
2464 | Whether Mercurial subrepositories are allowed in the working |
|
2464 | Whether Mercurial subrepositories are allowed in the working | |
2465 | directory. This option only has an effect if ``subrepos.allowed`` |
|
2465 | directory. This option only has an effect if ``subrepos.allowed`` | |
2466 | is true. |
|
2466 | is true. | |
2467 | (default: true) |
|
2467 | (default: true) | |
2468 |
|
2468 | |||
2469 | ``git:allowed`` |
|
2469 | ``git:allowed`` | |
2470 | Whether Git subrepositories are allowed in the working directory. |
|
2470 | Whether Git subrepositories are allowed in the working directory. | |
2471 | This option only has an effect if ``subrepos.allowed`` is true. |
|
2471 | This option only has an effect if ``subrepos.allowed`` is true. | |
2472 |
|
2472 | |||
2473 | See the security note above before enabling Git subrepos. |
|
2473 | See the security note above before enabling Git subrepos. | |
2474 | (default: false) |
|
2474 | (default: false) | |
2475 |
|
2475 | |||
2476 | ``svn:allowed`` |
|
2476 | ``svn:allowed`` | |
2477 | Whether Subversion subrepositories are allowed in the working |
|
2477 | Whether Subversion subrepositories are allowed in the working | |
2478 | directory. This option only has an effect if ``subrepos.allowed`` |
|
2478 | directory. This option only has an effect if ``subrepos.allowed`` | |
2479 | is true. |
|
2479 | is true. | |
2480 |
|
2480 | |||
2481 | See the security note above before enabling Subversion subrepos. |
|
2481 | See the security note above before enabling Subversion subrepos. | |
2482 | (default: false) |
|
2482 | (default: false) | |
2483 |
|
2483 | |||
2484 | ``templatealias`` |
|
2484 | ``templatealias`` | |
2485 | ----------------- |
|
2485 | ----------------- | |
2486 |
|
2486 | |||
2487 | Alias definitions for templates. See :hg:`help templates` for details. |
|
2487 | Alias definitions for templates. See :hg:`help templates` for details. | |
2488 |
|
2488 | |||
2489 | ``templates`` |
|
2489 | ``templates`` | |
2490 | ------------- |
|
2490 | ------------- | |
2491 |
|
2491 | |||
2492 | Use the ``[templates]`` section to define template strings. |
|
2492 | Use the ``[templates]`` section to define template strings. | |
2493 | See :hg:`help templates` for details. |
|
2493 | See :hg:`help templates` for details. | |
2494 |
|
2494 | |||
2495 | ``trusted`` |
|
2495 | ``trusted`` | |
2496 | ----------- |
|
2496 | ----------- | |
2497 |
|
2497 | |||
2498 | Mercurial will not use the settings in the |
|
2498 | Mercurial will not use the settings in the | |
2499 | ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted |
|
2499 | ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted | |
2500 | user or to a trusted group, as various hgrc features allow arbitrary |
|
2500 | user or to a trusted group, as various hgrc features allow arbitrary | |
2501 | commands to be run. This issue is often encountered when configuring |
|
2501 | commands to be run. This issue is often encountered when configuring | |
2502 | hooks or extensions for shared repositories or servers. However, |
|
2502 | hooks or extensions for shared repositories or servers. However, | |
2503 | the web interface will use some safe settings from the ``[web]`` |
|
2503 | the web interface will use some safe settings from the ``[web]`` | |
2504 | section. |
|
2504 | section. | |
2505 |
|
2505 | |||
2506 | This section specifies what users and groups are trusted. The |
|
2506 | This section specifies what users and groups are trusted. The | |
2507 | current user is always trusted. To trust everybody, list a user or a |
|
2507 | current user is always trusted. To trust everybody, list a user or a | |
2508 | group with name ``*``. These settings must be placed in an |
|
2508 | group with name ``*``. These settings must be placed in an | |
2509 | *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the |
|
2509 | *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the | |
2510 | user or service running Mercurial. |
|
2510 | user or service running Mercurial. | |
2511 |
|
2511 | |||
2512 | ``users`` |
|
2512 | ``users`` | |
2513 | Comma-separated list of trusted users. |
|
2513 | Comma-separated list of trusted users. | |
2514 |
|
2514 | |||
2515 | ``groups`` |
|
2515 | ``groups`` | |
2516 | Comma-separated list of trusted groups. |
|
2516 | Comma-separated list of trusted groups. | |
2517 |
|
2517 | |||
2518 |
|
2518 | |||
2519 | ``ui`` |
|
2519 | ``ui`` | |
2520 | ------ |
|
2520 | ------ | |
2521 |
|
2521 | |||
2522 | User interface controls. |
|
2522 | User interface controls. | |
2523 |
|
2523 | |||
2524 | ``archivemeta`` |
|
2524 | ``archivemeta`` | |
2525 | Whether to include the .hg_archival.txt file containing meta data |
|
2525 | Whether to include the .hg_archival.txt file containing meta data | |
2526 | (hashes for the repository base and for tip) in archives created |
|
2526 | (hashes for the repository base and for tip) in archives created | |
2527 | by the :hg:`archive` command or downloaded via hgweb. |
|
2527 | by the :hg:`archive` command or downloaded via hgweb. | |
2528 | (default: True) |
|
2528 | (default: True) | |
2529 |
|
2529 | |||
2530 | ``askusername`` |
|
2530 | ``askusername`` | |
2531 | Whether to prompt for a username when committing. If True, and |
|
2531 | Whether to prompt for a username when committing. If True, and | |
2532 | neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will |
|
2532 | neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will | |
2533 | be prompted to enter a username. If no username is entered, the |
|
2533 | be prompted to enter a username. If no username is entered, the | |
2534 | default ``USER@HOST`` is used instead. |
|
2534 | default ``USER@HOST`` is used instead. | |
2535 | (default: False) |
|
2535 | (default: False) | |
2536 |
|
2536 | |||
2537 | ``clonebundles`` |
|
2537 | ``clonebundles`` | |
2538 | Whether the "clone bundles" feature is enabled. |
|
2538 | Whether the "clone bundles" feature is enabled. | |
2539 |
|
2539 | |||
2540 | When enabled, :hg:`clone` may download and apply a server-advertised |
|
2540 | When enabled, :hg:`clone` may download and apply a server-advertised | |
2541 | bundle file from a URL instead of using the normal exchange mechanism. |
|
2541 | bundle file from a URL instead of using the normal exchange mechanism. | |
2542 |
|
2542 | |||
2543 | This can likely result in faster and more reliable clones. |
|
2543 | This can likely result in faster and more reliable clones. | |
2544 |
|
2544 | |||
2545 | (default: True) |
|
2545 | (default: True) | |
2546 |
|
2546 | |||
2547 | ``clonebundlefallback`` |
|
2547 | ``clonebundlefallback`` | |
2548 | Whether failure to apply an advertised "clone bundle" from a server |
|
2548 | Whether failure to apply an advertised "clone bundle" from a server | |
2549 | should result in fallback to a regular clone. |
|
2549 | should result in fallback to a regular clone. | |
2550 |
|
2550 | |||
2551 | This is disabled by default because servers advertising "clone |
|
2551 | This is disabled by default because servers advertising "clone | |
2552 | bundles" often do so to reduce server load. If advertised bundles |
|
2552 | bundles" often do so to reduce server load. If advertised bundles | |
2553 | start mass failing and clients automatically fall back to a regular |
|
2553 | start mass failing and clients automatically fall back to a regular | |
2554 | clone, this would add significant and unexpected load to the server |
|
2554 | clone, this would add significant and unexpected load to the server | |
2555 | since the server is expecting clone operations to be offloaded to |
|
2555 | since the server is expecting clone operations to be offloaded to | |
2556 | pre-generated bundles. Failing fast (the default behavior) ensures |
|
2556 | pre-generated bundles. Failing fast (the default behavior) ensures | |
2557 | clients don't overwhelm the server when "clone bundle" application |
|
2557 | clients don't overwhelm the server when "clone bundle" application | |
2558 | fails. |
|
2558 | fails. | |
2559 |
|
2559 | |||
2560 | (default: False) |
|
2560 | (default: False) | |
2561 |
|
2561 | |||
2562 | ``clonebundleprefers`` |
|
2562 | ``clonebundleprefers`` | |
2563 | Defines preferences for which "clone bundles" to use. |
|
2563 | Defines preferences for which "clone bundles" to use. | |
2564 |
|
2564 | |||
2565 | Servers advertising "clone bundles" may advertise multiple available |
|
2565 | Servers advertising "clone bundles" may advertise multiple available | |
2566 | bundles. Each bundle may have different attributes, such as the bundle |
|
2566 | bundles. Each bundle may have different attributes, such as the bundle | |
2567 | type and compression format. This option is used to prefer a particular |
|
2567 | type and compression format. This option is used to prefer a particular | |
2568 | bundle over another. |
|
2568 | bundle over another. | |
2569 |
|
2569 | |||
2570 | The following keys are defined by Mercurial: |
|
2570 | The following keys are defined by Mercurial: | |
2571 |
|
2571 | |||
2572 | BUNDLESPEC |
|
2572 | BUNDLESPEC | |
2573 | A bundle type specifier. These are strings passed to :hg:`bundle -t`. |
|
2573 | A bundle type specifier. These are strings passed to :hg:`bundle -t`. | |
2574 | e.g. ``gzip-v2`` or ``bzip2-v1``. |
|
2574 | e.g. ``gzip-v2`` or ``bzip2-v1``. | |
2575 |
|
2575 | |||
2576 | COMPRESSION |
|
2576 | COMPRESSION | |
2577 | The compression format of the bundle. e.g. ``gzip`` and ``bzip2``. |
|
2577 | The compression format of the bundle. e.g. ``gzip`` and ``bzip2``. | |
2578 |
|
2578 | |||
2579 | Server operators may define custom keys. |
|
2579 | Server operators may define custom keys. | |
2580 |
|
2580 | |||
2581 | Example values: ``COMPRESSION=bzip2``, |
|
2581 | Example values: ``COMPRESSION=bzip2``, | |
2582 | ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``. |
|
2582 | ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``. | |
2583 |
|
2583 | |||
2584 | By default, the first bundle advertised by the server is used. |
|
2584 | By default, the first bundle advertised by the server is used. | |
2585 |
|
2585 | |||
2586 | ``color`` |
|
2586 | ``color`` | |
2587 | When to colorize output. Possible value are Boolean ("yes" or "no"), or |
|
2587 | When to colorize output. Possible value are Boolean ("yes" or "no"), or | |
2588 | "debug", or "always". (default: "yes"). "yes" will use color whenever it |
|
2588 | "debug", or "always". (default: "yes"). "yes" will use color whenever it | |
2589 | seems possible. See :hg:`help color` for details. |
|
2589 | seems possible. See :hg:`help color` for details. | |
2590 |
|
2590 | |||
2591 | ``commitsubrepos`` |
|
2591 | ``commitsubrepos`` | |
2592 | Whether to commit modified subrepositories when committing the |
|
2592 | Whether to commit modified subrepositories when committing the | |
2593 | parent repository. If False and one subrepository has uncommitted |
|
2593 | parent repository. If False and one subrepository has uncommitted | |
2594 | changes, abort the commit. |
|
2594 | changes, abort the commit. | |
2595 | (default: False) |
|
2595 | (default: False) | |
2596 |
|
2596 | |||
2597 | ``debug`` |
|
2597 | ``debug`` | |
2598 | Print debugging information. (default: False) |
|
2598 | Print debugging information. (default: False) | |
2599 |
|
2599 | |||
2600 | ``editor`` |
|
2600 | ``editor`` | |
2601 | The editor to use during a commit. (default: ``$EDITOR`` or ``vi``) |
|
2601 | The editor to use during a commit. (default: ``$EDITOR`` or ``vi``) | |
2602 |
|
2602 | |||
2603 | ``fallbackencoding`` |
|
2603 | ``fallbackencoding`` | |
2604 | Encoding to try if it's not possible to decode the changelog using |
|
2604 | Encoding to try if it's not possible to decode the changelog using | |
2605 | UTF-8. (default: ISO-8859-1) |
|
2605 | UTF-8. (default: ISO-8859-1) | |
2606 |
|
2606 | |||
2607 | ``graphnodetemplate`` |
|
2607 | ``graphnodetemplate`` | |
2608 | (DEPRECATED) Use ``command-templates.graphnode`` instead. |
|
2608 | (DEPRECATED) Use ``command-templates.graphnode`` instead. | |
2609 |
|
2609 | |||
2610 | ``ignore`` |
|
2610 | ``ignore`` | |
2611 | A file to read per-user ignore patterns from. This file should be |
|
2611 | A file to read per-user ignore patterns from. This file should be | |
2612 | in the same format as a repository-wide .hgignore file. Filenames |
|
2612 | in the same format as a repository-wide .hgignore file. Filenames | |
2613 | are relative to the repository root. This option supports hook syntax, |
|
2613 | are relative to the repository root. This option supports hook syntax, | |
2614 | so if you want to specify multiple ignore files, you can do so by |
|
2614 | so if you want to specify multiple ignore files, you can do so by | |
2615 | setting something like ``ignore.other = ~/.hgignore2``. For details |
|
2615 | setting something like ``ignore.other = ~/.hgignore2``. For details | |
2616 | of the ignore file format, see the ``hgignore(5)`` man page. |
|
2616 | of the ignore file format, see the ``hgignore(5)`` man page. | |
2617 |
|
2617 | |||
2618 | ``interactive`` |
|
2618 | ``interactive`` | |
2619 | Allow to prompt the user. (default: True) |
|
2619 | Allow to prompt the user. (default: True) | |
2620 |
|
2620 | |||
2621 | ``interface`` |
|
2621 | ``interface`` | |
2622 | Select the default interface for interactive features (default: text). |
|
2622 | Select the default interface for interactive features (default: text). | |
2623 | Possible values are 'text' and 'curses'. |
|
2623 | Possible values are 'text' and 'curses'. | |
2624 |
|
2624 | |||
2625 | ``interface.chunkselector`` |
|
2625 | ``interface.chunkselector`` | |
2626 | Select the interface for change recording (e.g. :hg:`commit -i`). |
|
2626 | Select the interface for change recording (e.g. :hg:`commit -i`). | |
2627 | Possible values are 'text' and 'curses'. |
|
2627 | Possible values are 'text' and 'curses'. | |
2628 | This config overrides the interface specified by ui.interface. |
|
2628 | This config overrides the interface specified by ui.interface. | |
2629 |
|
2629 | |||
2630 | ``large-file-limit`` |
|
2630 | ``large-file-limit`` | |
2631 | Largest file size that gives no memory use warning. |
|
2631 | Largest file size that gives no memory use warning. | |
2632 | Possible values are integers or 0 to disable the check. |
|
2632 | Possible values are integers or 0 to disable the check. | |
2633 | (default: 10000000) |
|
2633 | Value is expressed in bytes by default, one can use standard units for | |
|
2634 | convenience (e.g. 10MB, 0.1GB, etc) (default: 10000000) | |||
2634 |
|
2635 | |||
2635 | ``logtemplate`` |
|
2636 | ``logtemplate`` | |
2636 | (DEPRECATED) Use ``command-templates.log`` instead. |
|
2637 | (DEPRECATED) Use ``command-templates.log`` instead. | |
2637 |
|
2638 | |||
2638 | ``merge`` |
|
2639 | ``merge`` | |
2639 | The conflict resolution program to use during a manual merge. |
|
2640 | The conflict resolution program to use during a manual merge. | |
2640 | For more information on merge tools see :hg:`help merge-tools`. |
|
2641 | For more information on merge tools see :hg:`help merge-tools`. | |
2641 | For configuring merge tools see the ``[merge-tools]`` section. |
|
2642 | For configuring merge tools see the ``[merge-tools]`` section. | |
2642 |
|
2643 | |||
2643 | ``mergemarkers`` |
|
2644 | ``mergemarkers`` | |
2644 | Sets the merge conflict marker label styling. The ``detailed`` style |
|
2645 | Sets the merge conflict marker label styling. The ``detailed`` style | |
2645 | uses the ``command-templates.mergemarker`` setting to style the labels. |
|
2646 | uses the ``command-templates.mergemarker`` setting to style the labels. | |
2646 | The ``basic`` style just uses 'local' and 'other' as the marker label. |
|
2647 | The ``basic`` style just uses 'local' and 'other' as the marker label. | |
2647 | One of ``basic`` or ``detailed``. |
|
2648 | One of ``basic`` or ``detailed``. | |
2648 | (default: ``basic``) |
|
2649 | (default: ``basic``) | |
2649 |
|
2650 | |||
2650 | ``mergemarkertemplate`` |
|
2651 | ``mergemarkertemplate`` | |
2651 | (DEPRECATED) Use ``command-templates.mergemarker`` instead. |
|
2652 | (DEPRECATED) Use ``command-templates.mergemarker`` instead. | |
2652 |
|
2653 | |||
2653 | ``message-output`` |
|
2654 | ``message-output`` | |
2654 | Where to write status and error messages. (default: ``stdio``) |
|
2655 | Where to write status and error messages. (default: ``stdio``) | |
2655 |
|
2656 | |||
2656 | ``channel`` |
|
2657 | ``channel`` | |
2657 | Use separate channel for structured output. (Command-server only) |
|
2658 | Use separate channel for structured output. (Command-server only) | |
2658 | ``stderr`` |
|
2659 | ``stderr`` | |
2659 | Everything to stderr. |
|
2660 | Everything to stderr. | |
2660 | ``stdio`` |
|
2661 | ``stdio`` | |
2661 | Status to stdout, and error to stderr. |
|
2662 | Status to stdout, and error to stderr. | |
2662 |
|
2663 | |||
2663 | ``origbackuppath`` |
|
2664 | ``origbackuppath`` | |
2664 | The path to a directory used to store generated .orig files. If the path is |
|
2665 | The path to a directory used to store generated .orig files. If the path is | |
2665 | not a directory, one will be created. If set, files stored in this |
|
2666 | not a directory, one will be created. If set, files stored in this | |
2666 | directory have the same name as the original file and do not have a .orig |
|
2667 | directory have the same name as the original file and do not have a .orig | |
2667 | suffix. |
|
2668 | suffix. | |
2668 |
|
2669 | |||
2669 | ``paginate`` |
|
2670 | ``paginate`` | |
2670 | Control the pagination of command output (default: True). See :hg:`help pager` |
|
2671 | Control the pagination of command output (default: True). See :hg:`help pager` | |
2671 | for details. |
|
2672 | for details. | |
2672 |
|
2673 | |||
2673 | ``patch`` |
|
2674 | ``patch`` | |
2674 | An optional external tool that ``hg import`` and some extensions |
|
2675 | An optional external tool that ``hg import`` and some extensions | |
2675 | will use for applying patches. By default Mercurial uses an |
|
2676 | will use for applying patches. By default Mercurial uses an | |
2676 | internal patch utility. The external tool must work as the common |
|
2677 | internal patch utility. The external tool must work as the common | |
2677 | Unix ``patch`` program. In particular, it must accept a ``-p`` |
|
2678 | Unix ``patch`` program. In particular, it must accept a ``-p`` | |
2678 | argument to strip patch headers, a ``-d`` argument to specify the |
|
2679 | argument to strip patch headers, a ``-d`` argument to specify the | |
2679 | current directory, a file name to patch, and a patch file to take |
|
2680 | current directory, a file name to patch, and a patch file to take | |
2680 | from stdin. |
|
2681 | from stdin. | |
2681 |
|
2682 | |||
2682 | It is possible to specify a patch tool together with extra |
|
2683 | It is possible to specify a patch tool together with extra | |
2683 | arguments. For example, setting this option to ``patch --merge`` |
|
2684 | arguments. For example, setting this option to ``patch --merge`` | |
2684 | will use the ``patch`` program with its 2-way merge option. |
|
2685 | will use the ``patch`` program with its 2-way merge option. | |
2685 |
|
2686 | |||
2686 | ``portablefilenames`` |
|
2687 | ``portablefilenames`` | |
2687 | Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``. |
|
2688 | Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``. | |
2688 | (default: ``warn``) |
|
2689 | (default: ``warn``) | |
2689 |
|
2690 | |||
2690 | ``warn`` |
|
2691 | ``warn`` | |
2691 | Print a warning message on POSIX platforms, if a file with a non-portable |
|
2692 | Print a warning message on POSIX platforms, if a file with a non-portable | |
2692 | filename is added (e.g. a file with a name that can't be created on |
|
2693 | filename is added (e.g. a file with a name that can't be created on | |
2693 | Windows because it contains reserved parts like ``AUX``, reserved |
|
2694 | Windows because it contains reserved parts like ``AUX``, reserved | |
2694 | characters like ``:``, or would cause a case collision with an existing |
|
2695 | characters like ``:``, or would cause a case collision with an existing | |
2695 | file). |
|
2696 | file). | |
2696 |
|
2697 | |||
2697 | ``ignore`` |
|
2698 | ``ignore`` | |
2698 | Don't print a warning. |
|
2699 | Don't print a warning. | |
2699 |
|
2700 | |||
2700 | ``abort`` |
|
2701 | ``abort`` | |
2701 | The command is aborted. |
|
2702 | The command is aborted. | |
2702 |
|
2703 | |||
2703 | ``true`` |
|
2704 | ``true`` | |
2704 | Alias for ``warn``. |
|
2705 | Alias for ``warn``. | |
2705 |
|
2706 | |||
2706 | ``false`` |
|
2707 | ``false`` | |
2707 | Alias for ``ignore``. |
|
2708 | Alias for ``ignore``. | |
2708 |
|
2709 | |||
2709 | .. container:: windows |
|
2710 | .. container:: windows | |
2710 |
|
2711 | |||
2711 | On Windows, this configuration option is ignored and the command aborted. |
|
2712 | On Windows, this configuration option is ignored and the command aborted. | |
2712 |
|
2713 | |||
2713 | ``pre-merge-tool-output-template`` |
|
2714 | ``pre-merge-tool-output-template`` | |
2714 | (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead. |
|
2715 | (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead. | |
2715 |
|
2716 | |||
2716 | ``quiet`` |
|
2717 | ``quiet`` | |
2717 | Reduce the amount of output printed. |
|
2718 | Reduce the amount of output printed. | |
2718 | (default: False) |
|
2719 | (default: False) | |
2719 |
|
2720 | |||
2720 | ``relative-paths`` |
|
2721 | ``relative-paths`` | |
2721 | Prefer relative paths in the UI. |
|
2722 | Prefer relative paths in the UI. | |
2722 |
|
2723 | |||
2723 | ``remotecmd`` |
|
2724 | ``remotecmd`` | |
2724 | Remote command to use for clone/push/pull operations. |
|
2725 | Remote command to use for clone/push/pull operations. | |
2725 | (default: ``hg``) |
|
2726 | (default: ``hg``) | |
2726 |
|
2727 | |||
2727 | ``report_untrusted`` |
|
2728 | ``report_untrusted`` | |
2728 | Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a |
|
2729 | Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a | |
2729 | trusted user or group. |
|
2730 | trusted user or group. | |
2730 | (default: True) |
|
2731 | (default: True) | |
2731 |
|
2732 | |||
2732 | ``slash`` |
|
2733 | ``slash`` | |
2733 | (Deprecated. Use ``slashpath`` template filter instead.) |
|
2734 | (Deprecated. Use ``slashpath`` template filter instead.) | |
2734 |
|
2735 | |||
2735 | Display paths using a slash (``/``) as the path separator. This |
|
2736 | Display paths using a slash (``/``) as the path separator. This | |
2736 | only makes a difference on systems where the default path |
|
2737 | only makes a difference on systems where the default path | |
2737 | separator is not the slash character (e.g. Windows uses the |
|
2738 | separator is not the slash character (e.g. Windows uses the | |
2738 | backslash character (``\``)). |
|
2739 | backslash character (``\``)). | |
2739 | (default: False) |
|
2740 | (default: False) | |
2740 |
|
2741 | |||
2741 | ``statuscopies`` |
|
2742 | ``statuscopies`` | |
2742 | Display copies in the status command. |
|
2743 | Display copies in the status command. | |
2743 |
|
2744 | |||
2744 | ``ssh`` |
|
2745 | ``ssh`` | |
2745 | Command to use for SSH connections. (default: ``ssh``) |
|
2746 | Command to use for SSH connections. (default: ``ssh``) | |
2746 |
|
2747 | |||
2747 | ``ssherrorhint`` |
|
2748 | ``ssherrorhint`` | |
2748 | A hint shown to the user in the case of SSH error (e.g. |
|
2749 | A hint shown to the user in the case of SSH error (e.g. | |
2749 | ``Please see http://company/internalwiki/ssh.html``) |
|
2750 | ``Please see http://company/internalwiki/ssh.html``) | |
2750 |
|
2751 | |||
2751 | ``strict`` |
|
2752 | ``strict`` | |
2752 | Require exact command names, instead of allowing unambiguous |
|
2753 | Require exact command names, instead of allowing unambiguous | |
2753 | abbreviations. (default: False) |
|
2754 | abbreviations. (default: False) | |
2754 |
|
2755 | |||
2755 | ``style`` |
|
2756 | ``style`` | |
2756 | Name of style to use for command output. |
|
2757 | Name of style to use for command output. | |
2757 |
|
2758 | |||
2758 | ``supportcontact`` |
|
2759 | ``supportcontact`` | |
2759 | A URL where users should report a Mercurial traceback. Use this if you are a |
|
2760 | A URL where users should report a Mercurial traceback. Use this if you are a | |
2760 | large organisation with its own Mercurial deployment process and crash |
|
2761 | large organisation with its own Mercurial deployment process and crash | |
2761 | reports should be addressed to your internal support. |
|
2762 | reports should be addressed to your internal support. | |
2762 |
|
2763 | |||
2763 | ``textwidth`` |
|
2764 | ``textwidth`` | |
2764 | Maximum width of help text. A longer line generated by ``hg help`` or |
|
2765 | Maximum width of help text. A longer line generated by ``hg help`` or | |
2765 | ``hg subcommand --help`` will be broken after white space to get this |
|
2766 | ``hg subcommand --help`` will be broken after white space to get this | |
2766 | width or the terminal width, whichever comes first. |
|
2767 | width or the terminal width, whichever comes first. | |
2767 | A non-positive value will disable this and the terminal width will be |
|
2768 | A non-positive value will disable this and the terminal width will be | |
2768 | used. (default: 78) |
|
2769 | used. (default: 78) | |
2769 |
|
2770 | |||
2770 | ``timeout`` |
|
2771 | ``timeout`` | |
2771 | The timeout used when a lock is held (in seconds), a negative value |
|
2772 | The timeout used when a lock is held (in seconds), a negative value | |
2772 | means no timeout. (default: 600) |
|
2773 | means no timeout. (default: 600) | |
2773 |
|
2774 | |||
2774 | ``timeout.warn`` |
|
2775 | ``timeout.warn`` | |
2775 | Time (in seconds) before a warning is printed about held lock. A negative |
|
2776 | Time (in seconds) before a warning is printed about held lock. A negative | |
2776 | value means no warning. (default: 0) |
|
2777 | value means no warning. (default: 0) | |
2777 |
|
2778 | |||
2778 | ``traceback`` |
|
2779 | ``traceback`` | |
2779 | Mercurial always prints a traceback when an unknown exception |
|
2780 | Mercurial always prints a traceback when an unknown exception | |
2780 | occurs. Setting this to True will make Mercurial print a traceback |
|
2781 | occurs. Setting this to True will make Mercurial print a traceback | |
2781 | on all exceptions, even those recognized by Mercurial (such as |
|
2782 | on all exceptions, even those recognized by Mercurial (such as | |
2782 | IOError or MemoryError). (default: False) |
|
2783 | IOError or MemoryError). (default: False) | |
2783 |
|
2784 | |||
2784 | ``tweakdefaults`` |
|
2785 | ``tweakdefaults`` | |
2785 |
|
2786 | |||
2786 | By default Mercurial's behavior changes very little from release |
|
2787 | By default Mercurial's behavior changes very little from release | |
2787 | to release, but over time the recommended config settings |
|
2788 | to release, but over time the recommended config settings | |
2788 | shift. Enable this config to opt in to get automatic tweaks to |
|
2789 | shift. Enable this config to opt in to get automatic tweaks to | |
2789 | Mercurial's behavior over time. This config setting will have no |
|
2790 | Mercurial's behavior over time. This config setting will have no | |
2790 | effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does |
|
2791 | effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does | |
2791 | not include ``tweakdefaults``. (default: False) |
|
2792 | not include ``tweakdefaults``. (default: False) | |
2792 |
|
2793 | |||
2793 | It currently means:: |
|
2794 | It currently means:: | |
2794 |
|
2795 | |||
2795 | .. tweakdefaultsmarker |
|
2796 | .. tweakdefaultsmarker | |
2796 |
|
2797 | |||
2797 | ``username`` |
|
2798 | ``username`` | |
2798 | The committer of a changeset created when running "commit". |
|
2799 | The committer of a changeset created when running "commit". | |
2799 | Typically a person's name and email address, e.g. ``Fred Widget |
|
2800 | Typically a person's name and email address, e.g. ``Fred Widget | |
2800 | <fred@example.com>``. Environment variables in the |
|
2801 | <fred@example.com>``. Environment variables in the | |
2801 | username are expanded. |
|
2802 | username are expanded. | |
2802 |
|
2803 | |||
2803 | (default: ``$EMAIL`` or ``username@hostname``. If the username in |
|
2804 | (default: ``$EMAIL`` or ``username@hostname``. If the username in | |
2804 | hgrc is empty, e.g. if the system admin set ``username =`` in the |
|
2805 | hgrc is empty, e.g. if the system admin set ``username =`` in the | |
2805 | system hgrc, it has to be specified manually or in a different |
|
2806 | system hgrc, it has to be specified manually or in a different | |
2806 | hgrc file) |
|
2807 | hgrc file) | |
2807 |
|
2808 | |||
2808 | ``verbose`` |
|
2809 | ``verbose`` | |
2809 | Increase the amount of output printed. (default: False) |
|
2810 | Increase the amount of output printed. (default: False) | |
2810 |
|
2811 | |||
2811 |
|
2812 | |||
2812 | ``command-templates`` |
|
2813 | ``command-templates`` | |
2813 | --------------------- |
|
2814 | --------------------- | |
2814 |
|
2815 | |||
2815 | Templates used for customizing the output of commands. |
|
2816 | Templates used for customizing the output of commands. | |
2816 |
|
2817 | |||
2817 | ``graphnode`` |
|
2818 | ``graphnode`` | |
2818 | The template used to print changeset nodes in an ASCII revision graph. |
|
2819 | The template used to print changeset nodes in an ASCII revision graph. | |
2819 | (default: ``{graphnode}``) |
|
2820 | (default: ``{graphnode}``) | |
2820 |
|
2821 | |||
2821 | ``log`` |
|
2822 | ``log`` | |
2822 | Template string for commands that print changesets. |
|
2823 | Template string for commands that print changesets. | |
2823 |
|
2824 | |||
2824 | ``mergemarker`` |
|
2825 | ``mergemarker`` | |
2825 | The template used to print the commit description next to each conflict |
|
2826 | The template used to print the commit description next to each conflict | |
2826 | marker during merge conflicts. See :hg:`help templates` for the template |
|
2827 | marker during merge conflicts. See :hg:`help templates` for the template | |
2827 | format. |
|
2828 | format. | |
2828 |
|
2829 | |||
2829 | Defaults to showing the hash, tags, branches, bookmarks, author, and |
|
2830 | Defaults to showing the hash, tags, branches, bookmarks, author, and | |
2830 | the first line of the commit description. |
|
2831 | the first line of the commit description. | |
2831 |
|
2832 | |||
2832 | If you use non-ASCII characters in names for tags, branches, bookmarks, |
|
2833 | If you use non-ASCII characters in names for tags, branches, bookmarks, | |
2833 | authors, and/or commit descriptions, you must pay attention to encodings of |
|
2834 | authors, and/or commit descriptions, you must pay attention to encodings of | |
2834 | managed files. At template expansion, non-ASCII characters use the encoding |
|
2835 | managed files. At template expansion, non-ASCII characters use the encoding | |
2835 | specified by the ``--encoding`` global option, ``HGENCODING`` or other |
|
2836 | specified by the ``--encoding`` global option, ``HGENCODING`` or other | |
2836 | environment variables that govern your locale. If the encoding of the merge |
|
2837 | environment variables that govern your locale. If the encoding of the merge | |
2837 | markers is different from the encoding of the merged files, |
|
2838 | markers is different from the encoding of the merged files, | |
2838 | serious problems may occur. |
|
2839 | serious problems may occur. | |
2839 |
|
2840 | |||
2840 | Can be overridden per-merge-tool, see the ``[merge-tools]`` section. |
|
2841 | Can be overridden per-merge-tool, see the ``[merge-tools]`` section. | |
2841 |
|
2842 | |||
2842 | ``oneline-summary`` |
|
2843 | ``oneline-summary`` | |
2843 | A template used by `hg rebase` and other commands for showing a one-line |
|
2844 | A template used by `hg rebase` and other commands for showing a one-line | |
2844 | summary of a commit. If the template configured here is longer than one |
|
2845 | summary of a commit. If the template configured here is longer than one | |
2845 | line, then only the first line is used. |
|
2846 | line, then only the first line is used. | |
2846 |
|
2847 | |||
2847 | The template can be overridden per command by defining a template in |
|
2848 | The template can be overridden per command by defining a template in | |
2848 | `oneline-summary.<command>`, where `<command>` can be e.g. "rebase". |
|
2849 | `oneline-summary.<command>`, where `<command>` can be e.g. "rebase". | |
2849 |
|
2850 | |||
2850 | ``pre-merge-tool-output`` |
|
2851 | ``pre-merge-tool-output`` | |
2851 | A template that is printed before executing an external merge tool. This can |
|
2852 | A template that is printed before executing an external merge tool. This can | |
2852 | be used to print out additional context that might be useful to have during |
|
2853 | be used to print out additional context that might be useful to have during | |
2853 | the conflict resolution, such as the description of the various commits |
|
2854 | the conflict resolution, such as the description of the various commits | |
2854 | involved or bookmarks/tags. |
|
2855 | involved or bookmarks/tags. | |
2855 |
|
2856 | |||
2856 | Additional information is available in the ``local`, ``base``, and ``other`` |
|
2857 | Additional information is available in the ``local`, ``base``, and ``other`` | |
2857 | dicts. For example: ``{local.label}``, ``{base.name}``, or |
|
2858 | dicts. For example: ``{local.label}``, ``{base.name}``, or | |
2858 | ``{other.islink}``. |
|
2859 | ``{other.islink}``. | |
2859 |
|
2860 | |||
2860 |
|
2861 | |||
2861 | ``web`` |
|
2862 | ``web`` | |
2862 | ------- |
|
2863 | ------- | |
2863 |
|
2864 | |||
2864 | Web interface configuration. The settings in this section apply to |
|
2865 | Web interface configuration. The settings in this section apply to | |
2865 | both the builtin webserver (started by :hg:`serve`) and the script you |
|
2866 | both the builtin webserver (started by :hg:`serve`) and the script you | |
2866 | run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI |
|
2867 | run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI | |
2867 | and WSGI). |
|
2868 | and WSGI). | |
2868 |
|
2869 | |||
2869 | The Mercurial webserver does no authentication (it does not prompt for |
|
2870 | The Mercurial webserver does no authentication (it does not prompt for | |
2870 | usernames and passwords to validate *who* users are), but it does do |
|
2871 | usernames and passwords to validate *who* users are), but it does do | |
2871 | authorization (it grants or denies access for *authenticated users* |
|
2872 | authorization (it grants or denies access for *authenticated users* | |
2872 | based on settings in this section). You must either configure your |
|
2873 | based on settings in this section). You must either configure your | |
2873 | webserver to do authentication for you, or disable the authorization |
|
2874 | webserver to do authentication for you, or disable the authorization | |
2874 | checks. |
|
2875 | checks. | |
2875 |
|
2876 | |||
2876 | For a quick setup in a trusted environment, e.g., a private LAN, where |
|
2877 | For a quick setup in a trusted environment, e.g., a private LAN, where | |
2877 | you want it to accept pushes from anybody, you can use the following |
|
2878 | you want it to accept pushes from anybody, you can use the following | |
2878 | command line:: |
|
2879 | command line:: | |
2879 |
|
2880 | |||
2880 | $ hg --config web.allow-push=* --config web.push_ssl=False serve |
|
2881 | $ hg --config web.allow-push=* --config web.push_ssl=False serve | |
2881 |
|
2882 | |||
2882 | Note that this will allow anybody to push anything to the server and |
|
2883 | Note that this will allow anybody to push anything to the server and | |
2883 | that this should not be used for public servers. |
|
2884 | that this should not be used for public servers. | |
2884 |
|
2885 | |||
2885 | The full set of options is: |
|
2886 | The full set of options is: | |
2886 |
|
2887 | |||
2887 | ``accesslog`` |
|
2888 | ``accesslog`` | |
2888 | Where to output the access log. (default: stdout) |
|
2889 | Where to output the access log. (default: stdout) | |
2889 |
|
2890 | |||
2890 | ``address`` |
|
2891 | ``address`` | |
2891 | Interface address to bind to. (default: all) |
|
2892 | Interface address to bind to. (default: all) | |
2892 |
|
2893 | |||
2893 | ``allow-archive`` |
|
2894 | ``allow-archive`` | |
2894 | List of archive format (bz2, gz, zip) allowed for downloading. |
|
2895 | List of archive format (bz2, gz, zip) allowed for downloading. | |
2895 | (default: empty) |
|
2896 | (default: empty) | |
2896 |
|
2897 | |||
2897 | ``allowbz2`` |
|
2898 | ``allowbz2`` | |
2898 | (DEPRECATED) Whether to allow .tar.bz2 downloading of repository |
|
2899 | (DEPRECATED) Whether to allow .tar.bz2 downloading of repository | |
2899 | revisions. |
|
2900 | revisions. | |
2900 | (default: False) |
|
2901 | (default: False) | |
2901 |
|
2902 | |||
2902 | ``allowgz`` |
|
2903 | ``allowgz`` | |
2903 | (DEPRECATED) Whether to allow .tar.gz downloading of repository |
|
2904 | (DEPRECATED) Whether to allow .tar.gz downloading of repository | |
2904 | revisions. |
|
2905 | revisions. | |
2905 | (default: False) |
|
2906 | (default: False) | |
2906 |
|
2907 | |||
2907 | ``allow-pull`` |
|
2908 | ``allow-pull`` | |
2908 | Whether to allow pulling from the repository. (default: True) |
|
2909 | Whether to allow pulling from the repository. (default: True) | |
2909 |
|
2910 | |||
2910 | ``allow-push`` |
|
2911 | ``allow-push`` | |
2911 | Whether to allow pushing to the repository. If empty or not set, |
|
2912 | Whether to allow pushing to the repository. If empty or not set, | |
2912 | pushing is not allowed. If the special value ``*``, any remote |
|
2913 | pushing is not allowed. If the special value ``*``, any remote | |
2913 | user can push, including unauthenticated users. Otherwise, the |
|
2914 | user can push, including unauthenticated users. Otherwise, the | |
2914 | remote user must have been authenticated, and the authenticated |
|
2915 | remote user must have been authenticated, and the authenticated | |
2915 | user name must be present in this list. The contents of the |
|
2916 | user name must be present in this list. The contents of the | |
2916 | allow-push list are examined after the deny_push list. |
|
2917 | allow-push list are examined after the deny_push list. | |
2917 |
|
2918 | |||
2918 | ``allow_read`` |
|
2919 | ``allow_read`` | |
2919 | If the user has not already been denied repository access due to |
|
2920 | If the user has not already been denied repository access due to | |
2920 | the contents of deny_read, this list determines whether to grant |
|
2921 | the contents of deny_read, this list determines whether to grant | |
2921 | repository access to the user. If this list is not empty, and the |
|
2922 | repository access to the user. If this list is not empty, and the | |
2922 | user is unauthenticated or not present in the list, then access is |
|
2923 | user is unauthenticated or not present in the list, then access is | |
2923 | denied for the user. If the list is empty or not set, then access |
|
2924 | denied for the user. If the list is empty or not set, then access | |
2924 | is permitted to all users by default. Setting allow_read to the |
|
2925 | is permitted to all users by default. Setting allow_read to the | |
2925 | special value ``*`` is equivalent to it not being set (i.e. access |
|
2926 | special value ``*`` is equivalent to it not being set (i.e. access | |
2926 | is permitted to all users). The contents of the allow_read list are |
|
2927 | is permitted to all users). The contents of the allow_read list are | |
2927 | examined after the deny_read list. |
|
2928 | examined after the deny_read list. | |
2928 |
|
2929 | |||
2929 | ``allowzip`` |
|
2930 | ``allowzip`` | |
2930 | (DEPRECATED) Whether to allow .zip downloading of repository |
|
2931 | (DEPRECATED) Whether to allow .zip downloading of repository | |
2931 | revisions. This feature creates temporary files. |
|
2932 | revisions. This feature creates temporary files. | |
2932 | (default: False) |
|
2933 | (default: False) | |
2933 |
|
2934 | |||
2934 | ``archivesubrepos`` |
|
2935 | ``archivesubrepos`` | |
2935 | Whether to recurse into subrepositories when archiving. |
|
2936 | Whether to recurse into subrepositories when archiving. | |
2936 | (default: False) |
|
2937 | (default: False) | |
2937 |
|
2938 | |||
2938 | ``baseurl`` |
|
2939 | ``baseurl`` | |
2939 | Base URL to use when publishing URLs in other locations, so |
|
2940 | Base URL to use when publishing URLs in other locations, so | |
2940 | third-party tools like email notification hooks can construct |
|
2941 | third-party tools like email notification hooks can construct | |
2941 | URLs. Example: ``http://hgserver/repos/``. |
|
2942 | URLs. Example: ``http://hgserver/repos/``. | |
2942 |
|
2943 | |||
2943 | ``cacerts`` |
|
2944 | ``cacerts`` | |
2944 | Path to file containing a list of PEM encoded certificate |
|
2945 | Path to file containing a list of PEM encoded certificate | |
2945 | authority certificates. Environment variables and ``~user`` |
|
2946 | authority certificates. Environment variables and ``~user`` | |
2946 | constructs are expanded in the filename. If specified on the |
|
2947 | constructs are expanded in the filename. If specified on the | |
2947 | client, then it will verify the identity of remote HTTPS servers |
|
2948 | client, then it will verify the identity of remote HTTPS servers | |
2948 | with these certificates. |
|
2949 | with these certificates. | |
2949 |
|
2950 | |||
2950 | To disable SSL verification temporarily, specify ``--insecure`` from |
|
2951 | To disable SSL verification temporarily, specify ``--insecure`` from | |
2951 | command line. |
|
2952 | command line. | |
2952 |
|
2953 | |||
2953 | You can use OpenSSL's CA certificate file if your platform has |
|
2954 | You can use OpenSSL's CA certificate file if your platform has | |
2954 | one. On most Linux systems this will be |
|
2955 | one. On most Linux systems this will be | |
2955 | ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to |
|
2956 | ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to | |
2956 | generate this file manually. The form must be as follows:: |
|
2957 | generate this file manually. The form must be as follows:: | |
2957 |
|
2958 | |||
2958 | -----BEGIN CERTIFICATE----- |
|
2959 | -----BEGIN CERTIFICATE----- | |
2959 | ... (certificate in base64 PEM encoding) ... |
|
2960 | ... (certificate in base64 PEM encoding) ... | |
2960 | -----END CERTIFICATE----- |
|
2961 | -----END CERTIFICATE----- | |
2961 | -----BEGIN CERTIFICATE----- |
|
2962 | -----BEGIN CERTIFICATE----- | |
2962 | ... (certificate in base64 PEM encoding) ... |
|
2963 | ... (certificate in base64 PEM encoding) ... | |
2963 | -----END CERTIFICATE----- |
|
2964 | -----END CERTIFICATE----- | |
2964 |
|
2965 | |||
2965 | ``cache`` |
|
2966 | ``cache`` | |
2966 | Whether to support caching in hgweb. (default: True) |
|
2967 | Whether to support caching in hgweb. (default: True) | |
2967 |
|
2968 | |||
2968 | ``certificate`` |
|
2969 | ``certificate`` | |
2969 | Certificate to use when running :hg:`serve`. |
|
2970 | Certificate to use when running :hg:`serve`. | |
2970 |
|
2971 | |||
2971 | ``collapse`` |
|
2972 | ``collapse`` | |
2972 | With ``descend`` enabled, repositories in subdirectories are shown at |
|
2973 | With ``descend`` enabled, repositories in subdirectories are shown at | |
2973 | a single level alongside repositories in the current path. With |
|
2974 | a single level alongside repositories in the current path. With | |
2974 | ``collapse`` also enabled, repositories residing at a deeper level than |
|
2975 | ``collapse`` also enabled, repositories residing at a deeper level than | |
2975 | the current path are grouped behind navigable directory entries that |
|
2976 | the current path are grouped behind navigable directory entries that | |
2976 | lead to the locations of these repositories. In effect, this setting |
|
2977 | lead to the locations of these repositories. In effect, this setting | |
2977 | collapses each collection of repositories found within a subdirectory |
|
2978 | collapses each collection of repositories found within a subdirectory | |
2978 | into a single entry for that subdirectory. (default: False) |
|
2979 | into a single entry for that subdirectory. (default: False) | |
2979 |
|
2980 | |||
2980 | ``comparisoncontext`` |
|
2981 | ``comparisoncontext`` | |
2981 | Number of lines of context to show in side-by-side file comparison. If |
|
2982 | Number of lines of context to show in side-by-side file comparison. If | |
2982 | negative or the value ``full``, whole files are shown. (default: 5) |
|
2983 | negative or the value ``full``, whole files are shown. (default: 5) | |
2983 |
|
2984 | |||
2984 | This setting can be overridden by a ``context`` request parameter to the |
|
2985 | This setting can be overridden by a ``context`` request parameter to the | |
2985 | ``comparison`` command, taking the same values. |
|
2986 | ``comparison`` command, taking the same values. | |
2986 |
|
2987 | |||
2987 | ``contact`` |
|
2988 | ``contact`` | |
2988 | Name or email address of the person in charge of the repository. |
|
2989 | Name or email address of the person in charge of the repository. | |
2989 | (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty) |
|
2990 | (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty) | |
2990 |
|
2991 | |||
2991 | ``csp`` |
|
2992 | ``csp`` | |
2992 | Send a ``Content-Security-Policy`` HTTP header with this value. |
|
2993 | Send a ``Content-Security-Policy`` HTTP header with this value. | |
2993 |
|
2994 | |||
2994 | The value may contain a special string ``%nonce%``, which will be replaced |
|
2995 | The value may contain a special string ``%nonce%``, which will be replaced | |
2995 | by a randomly-generated one-time use value. If the value contains |
|
2996 | by a randomly-generated one-time use value. If the value contains | |
2996 | ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the |
|
2997 | ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the | |
2997 | one-time property of the nonce. This nonce will also be inserted into |
|
2998 | one-time property of the nonce. This nonce will also be inserted into | |
2998 | ``<script>`` elements containing inline JavaScript. |
|
2999 | ``<script>`` elements containing inline JavaScript. | |
2999 |
|
3000 | |||
3000 | Note: lots of HTML content sent by the server is derived from repository |
|
3001 | Note: lots of HTML content sent by the server is derived from repository | |
3001 | data. Please consider the potential for malicious repository data to |
|
3002 | data. Please consider the potential for malicious repository data to | |
3002 | "inject" itself into generated HTML content as part of your security |
|
3003 | "inject" itself into generated HTML content as part of your security | |
3003 | threat model. |
|
3004 | threat model. | |
3004 |
|
3005 | |||
3005 | ``deny_push`` |
|
3006 | ``deny_push`` | |
3006 | Whether to deny pushing to the repository. If empty or not set, |
|
3007 | Whether to deny pushing to the repository. If empty or not set, | |
3007 | push is not denied. If the special value ``*``, all remote users are |
|
3008 | push is not denied. If the special value ``*``, all remote users are | |
3008 | denied push. Otherwise, unauthenticated users are all denied, and |
|
3009 | denied push. Otherwise, unauthenticated users are all denied, and | |
3009 | any authenticated user name present in this list is also denied. The |
|
3010 | any authenticated user name present in this list is also denied. The | |
3010 | contents of the deny_push list are examined before the allow-push list. |
|
3011 | contents of the deny_push list are examined before the allow-push list. | |
3011 |
|
3012 | |||
3012 | ``deny_read`` |
|
3013 | ``deny_read`` | |
3013 | Whether to deny reading/viewing of the repository. If this list is |
|
3014 | Whether to deny reading/viewing of the repository. If this list is | |
3014 | not empty, unauthenticated users are all denied, and any |
|
3015 | not empty, unauthenticated users are all denied, and any | |
3015 | authenticated user name present in this list is also denied access to |
|
3016 | authenticated user name present in this list is also denied access to | |
3016 | the repository. If set to the special value ``*``, all remote users |
|
3017 | the repository. If set to the special value ``*``, all remote users | |
3017 | are denied access (rarely needed ;). If deny_read is empty or not set, |
|
3018 | are denied access (rarely needed ;). If deny_read is empty or not set, | |
3018 | the determination of repository access depends on the presence and |
|
3019 | the determination of repository access depends on the presence and | |
3019 | content of the allow_read list (see description). If both |
|
3020 | content of the allow_read list (see description). If both | |
3020 | deny_read and allow_read are empty or not set, then access is |
|
3021 | deny_read and allow_read are empty or not set, then access is | |
3021 | permitted to all users by default. If the repository is being |
|
3022 | permitted to all users by default. If the repository is being | |
3022 | served via hgwebdir, denied users will not be able to see it in |
|
3023 | served via hgwebdir, denied users will not be able to see it in | |
3023 | the list of repositories. The contents of the deny_read list have |
|
3024 | the list of repositories. The contents of the deny_read list have | |
3024 | priority over (are examined before) the contents of the allow_read |
|
3025 | priority over (are examined before) the contents of the allow_read | |
3025 | list. |
|
3026 | list. | |
3026 |
|
3027 | |||
3027 | ``descend`` |
|
3028 | ``descend`` | |
3028 | hgwebdir indexes will not descend into subdirectories. Only repositories |
|
3029 | hgwebdir indexes will not descend into subdirectories. Only repositories | |
3029 | directly in the current path will be shown (other repositories are still |
|
3030 | directly in the current path will be shown (other repositories are still | |
3030 | available from the index corresponding to their containing path). |
|
3031 | available from the index corresponding to their containing path). | |
3031 |
|
3032 | |||
3032 | ``description`` |
|
3033 | ``description`` | |
3033 | Textual description of the repository's purpose or contents. |
|
3034 | Textual description of the repository's purpose or contents. | |
3034 | (default: "unknown") |
|
3035 | (default: "unknown") | |
3035 |
|
3036 | |||
3036 | ``encoding`` |
|
3037 | ``encoding`` | |
3037 | Character encoding name. (default: the current locale charset) |
|
3038 | Character encoding name. (default: the current locale charset) | |
3038 | Example: "UTF-8". |
|
3039 | Example: "UTF-8". | |
3039 |
|
3040 | |||
3040 | ``errorlog`` |
|
3041 | ``errorlog`` | |
3041 | Where to output the error log. (default: stderr) |
|
3042 | Where to output the error log. (default: stderr) | |
3042 |
|
3043 | |||
3043 | ``guessmime`` |
|
3044 | ``guessmime`` | |
3044 | Control MIME types for raw download of file content. |
|
3045 | Control MIME types for raw download of file content. | |
3045 | Set to True to let hgweb guess the content type from the file |
|
3046 | Set to True to let hgweb guess the content type from the file | |
3046 | extension. This will serve HTML files as ``text/html`` and might |
|
3047 | extension. This will serve HTML files as ``text/html`` and might | |
3047 | allow cross-site scripting attacks when serving untrusted |
|
3048 | allow cross-site scripting attacks when serving untrusted | |
3048 | repositories. (default: False) |
|
3049 | repositories. (default: False) | |
3049 |
|
3050 | |||
3050 | ``hidden`` |
|
3051 | ``hidden`` | |
3051 | Whether to hide the repository in the hgwebdir index. |
|
3052 | Whether to hide the repository in the hgwebdir index. | |
3052 | (default: False) |
|
3053 | (default: False) | |
3053 |
|
3054 | |||
3054 | ``ipv6`` |
|
3055 | ``ipv6`` | |
3055 | Whether to use IPv6. (default: False) |
|
3056 | Whether to use IPv6. (default: False) | |
3056 |
|
3057 | |||
3057 | ``labels`` |
|
3058 | ``labels`` | |
3058 | List of string *labels* associated with the repository. |
|
3059 | List of string *labels* associated with the repository. | |
3059 |
|
3060 | |||
3060 | Labels are exposed as a template keyword and can be used to customize |
|
3061 | Labels are exposed as a template keyword and can be used to customize | |
3061 | output. e.g. the ``index`` template can group or filter repositories |
|
3062 | output. e.g. the ``index`` template can group or filter repositories | |
3062 | by labels and the ``summary`` template can display additional content |
|
3063 | by labels and the ``summary`` template can display additional content | |
3063 | if a specific label is present. |
|
3064 | if a specific label is present. | |
3064 |
|
3065 | |||
3065 | ``logoimg`` |
|
3066 | ``logoimg`` | |
3066 | File name of the logo image that some templates display on each page. |
|
3067 | File name of the logo image that some templates display on each page. | |
3067 | The file name is relative to ``staticurl``. That is, the full path to |
|
3068 | The file name is relative to ``staticurl``. That is, the full path to | |
3068 | the logo image is "staticurl/logoimg". |
|
3069 | the logo image is "staticurl/logoimg". | |
3069 | If unset, ``hglogo.png`` will be used. |
|
3070 | If unset, ``hglogo.png`` will be used. | |
3070 |
|
3071 | |||
3071 | ``logourl`` |
|
3072 | ``logourl`` | |
3072 | Base URL to use for logos. If unset, ``https://mercurial-scm.org/`` |
|
3073 | Base URL to use for logos. If unset, ``https://mercurial-scm.org/`` | |
3073 | will be used. |
|
3074 | will be used. | |
3074 |
|
3075 | |||
3075 | ``maxchanges`` |
|
3076 | ``maxchanges`` | |
3076 | Maximum number of changes to list on the changelog. (default: 10) |
|
3077 | Maximum number of changes to list on the changelog. (default: 10) | |
3077 |
|
3078 | |||
3078 | ``maxfiles`` |
|
3079 | ``maxfiles`` | |
3079 | Maximum number of files to list per changeset. (default: 10) |
|
3080 | Maximum number of files to list per changeset. (default: 10) | |
3080 |
|
3081 | |||
3081 | ``maxshortchanges`` |
|
3082 | ``maxshortchanges`` | |
3082 | Maximum number of changes to list on the shortlog, graph or filelog |
|
3083 | Maximum number of changes to list on the shortlog, graph or filelog | |
3083 | pages. (default: 60) |
|
3084 | pages. (default: 60) | |
3084 |
|
3085 | |||
3085 | ``name`` |
|
3086 | ``name`` | |
3086 | Repository name to use in the web interface. |
|
3087 | Repository name to use in the web interface. | |
3087 | (default: current working directory) |
|
3088 | (default: current working directory) | |
3088 |
|
3089 | |||
3089 | ``port`` |
|
3090 | ``port`` | |
3090 | Port to listen on. (default: 8000) |
|
3091 | Port to listen on. (default: 8000) | |
3091 |
|
3092 | |||
3092 | ``prefix`` |
|
3093 | ``prefix`` | |
3093 | Prefix path to serve from. (default: '' (server root)) |
|
3094 | Prefix path to serve from. (default: '' (server root)) | |
3094 |
|
3095 | |||
3095 | ``push_ssl`` |
|
3096 | ``push_ssl`` | |
3096 | Whether to require that inbound pushes be transported over SSL to |
|
3097 | Whether to require that inbound pushes be transported over SSL to | |
3097 | prevent password sniffing. (default: True) |
|
3098 | prevent password sniffing. (default: True) | |
3098 |
|
3099 | |||
3099 | ``refreshinterval`` |
|
3100 | ``refreshinterval`` | |
3100 | How frequently directory listings re-scan the filesystem for new |
|
3101 | How frequently directory listings re-scan the filesystem for new | |
3101 | repositories, in seconds. This is relevant when wildcards are used |
|
3102 | repositories, in seconds. This is relevant when wildcards are used | |
3102 | to define paths. Depending on how much filesystem traversal is |
|
3103 | to define paths. Depending on how much filesystem traversal is | |
3103 | required, refreshing may negatively impact performance. |
|
3104 | required, refreshing may negatively impact performance. | |
3104 |
|
3105 | |||
3105 | Values less than or equal to 0 always refresh. |
|
3106 | Values less than or equal to 0 always refresh. | |
3106 | (default: 20) |
|
3107 | (default: 20) | |
3107 |
|
3108 | |||
3108 | ``server-header`` |
|
3109 | ``server-header`` | |
3109 | Value for HTTP ``Server`` response header. |
|
3110 | Value for HTTP ``Server`` response header. | |
3110 |
|
3111 | |||
3111 | ``static`` |
|
3112 | ``static`` | |
3112 | Directory where static files are served from. |
|
3113 | Directory where static files are served from. | |
3113 |
|
3114 | |||
3114 | ``staticurl`` |
|
3115 | ``staticurl`` | |
3115 | Base URL to use for static files. If unset, static files (e.g. the |
|
3116 | Base URL to use for static files. If unset, static files (e.g. the | |
3116 | hgicon.png favicon) will be served by the CGI script itself. Use |
|
3117 | hgicon.png favicon) will be served by the CGI script itself. Use | |
3117 | this setting to serve them directly with the HTTP server. |
|
3118 | this setting to serve them directly with the HTTP server. | |
3118 | Example: ``http://hgserver/static/``. |
|
3119 | Example: ``http://hgserver/static/``. | |
3119 |
|
3120 | |||
3120 | ``stripes`` |
|
3121 | ``stripes`` | |
3121 | How many lines a "zebra stripe" should span in multi-line output. |
|
3122 | How many lines a "zebra stripe" should span in multi-line output. | |
3122 | Set to 0 to disable. (default: 1) |
|
3123 | Set to 0 to disable. (default: 1) | |
3123 |
|
3124 | |||
3124 | ``style`` |
|
3125 | ``style`` | |
3125 | Which template map style to use. The available options are the names of |
|
3126 | Which template map style to use. The available options are the names of | |
3126 | subdirectories in the HTML templates path. (default: ``paper``) |
|
3127 | subdirectories in the HTML templates path. (default: ``paper``) | |
3127 | Example: ``monoblue``. |
|
3128 | Example: ``monoblue``. | |
3128 |
|
3129 | |||
3129 | ``templates`` |
|
3130 | ``templates`` | |
3130 | Where to find the HTML templates. The default path to the HTML templates |
|
3131 | Where to find the HTML templates. The default path to the HTML templates | |
3131 | can be obtained from ``hg debuginstall``. |
|
3132 | can be obtained from ``hg debuginstall``. | |
3132 |
|
3133 | |||
3133 | ``websub`` |
|
3134 | ``websub`` | |
3134 | ---------- |
|
3135 | ---------- | |
3135 |
|
3136 | |||
3136 | Web substitution filter definition. You can use this section to |
|
3137 | Web substitution filter definition. You can use this section to | |
3137 | define a set of regular expression substitution patterns which |
|
3138 | define a set of regular expression substitution patterns which | |
3138 | let you automatically modify the hgweb server output. |
|
3139 | let you automatically modify the hgweb server output. | |
3139 |
|
3140 | |||
3140 | The default hgweb templates only apply these substitution patterns |
|
3141 | The default hgweb templates only apply these substitution patterns | |
3141 | on the revision description fields. You can apply them anywhere |
|
3142 | on the revision description fields. You can apply them anywhere | |
3142 | you want when you create your own templates by adding calls to the |
|
3143 | you want when you create your own templates by adding calls to the | |
3143 | "websub" filter (usually after calling the "escape" filter). |
|
3144 | "websub" filter (usually after calling the "escape" filter). | |
3144 |
|
3145 | |||
3145 | This can be used, for example, to convert issue references to links |
|
3146 | This can be used, for example, to convert issue references to links | |
3146 | to your issue tracker, or to convert "markdown-like" syntax into |
|
3147 | to your issue tracker, or to convert "markdown-like" syntax into | |
3147 | HTML (see the examples below). |
|
3148 | HTML (see the examples below). | |
3148 |
|
3149 | |||
3149 | Each entry in this section names a substitution filter. |
|
3150 | Each entry in this section names a substitution filter. | |
3150 | The value of each entry defines the substitution expression itself. |
|
3151 | The value of each entry defines the substitution expression itself. | |
3151 | The websub expressions follow the old interhg extension syntax, |
|
3152 | The websub expressions follow the old interhg extension syntax, | |
3152 | which in turn imitates the Unix sed replacement syntax:: |
|
3153 | which in turn imitates the Unix sed replacement syntax:: | |
3153 |
|
3154 | |||
3154 | patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i] |
|
3155 | patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i] | |
3155 |
|
3156 | |||
3156 | You can use any separator other than "/". The final "i" is optional |
|
3157 | You can use any separator other than "/". The final "i" is optional | |
3157 | and indicates that the search must be case insensitive. |
|
3158 | and indicates that the search must be case insensitive. | |
3158 |
|
3159 | |||
3159 | Examples:: |
|
3160 | Examples:: | |
3160 |
|
3161 | |||
3161 | [websub] |
|
3162 | [websub] | |
3162 | issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i |
|
3163 | issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i | |
3163 | italic = s/\b_(\S+)_\b/<i>\1<\/i>/ |
|
3164 | italic = s/\b_(\S+)_\b/<i>\1<\/i>/ | |
3164 | bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/ |
|
3165 | bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/ | |
3165 |
|
3166 | |||
3166 | ``worker`` |
|
3167 | ``worker`` | |
3167 | ---------- |
|
3168 | ---------- | |
3168 |
|
3169 | |||
3169 | Parallel master/worker configuration. We currently perform working |
|
3170 | Parallel master/worker configuration. We currently perform working | |
3170 | directory updates in parallel on Unix-like systems, which greatly |
|
3171 | directory updates in parallel on Unix-like systems, which greatly | |
3171 | helps performance. |
|
3172 | helps performance. | |
3172 |
|
3173 | |||
3173 | ``enabled`` |
|
3174 | ``enabled`` | |
3174 | Whether to enable workers code to be used. |
|
3175 | Whether to enable workers code to be used. | |
3175 | (default: true) |
|
3176 | (default: true) | |
3176 |
|
3177 | |||
3177 | ``numcpus`` |
|
3178 | ``numcpus`` | |
3178 | Number of CPUs to use for parallel operations. A zero or |
|
3179 | Number of CPUs to use for parallel operations. A zero or | |
3179 | negative value is treated as ``use the default``. |
|
3180 | negative value is treated as ``use the default``. | |
3180 | (default: 4 or the number of CPUs on the system, whichever is larger) |
|
3181 | (default: 4 or the number of CPUs on the system, whichever is larger) | |
3181 |
|
3182 | |||
3182 | ``backgroundclose`` |
|
3183 | ``backgroundclose`` | |
3183 | Whether to enable closing file handles on background threads during certain |
|
3184 | Whether to enable closing file handles on background threads during certain | |
3184 | operations. Some platforms aren't very efficient at closing file |
|
3185 | operations. Some platforms aren't very efficient at closing file | |
3185 | handles that have been written or appended to. By performing file closing |
|
3186 | handles that have been written or appended to. By performing file closing | |
3186 | on background threads, file write rate can increase substantially. |
|
3187 | on background threads, file write rate can increase substantially. | |
3187 | (default: true on Windows, false elsewhere) |
|
3188 | (default: true on Windows, false elsewhere) | |
3188 |
|
3189 | |||
3189 | ``backgroundcloseminfilecount`` |
|
3190 | ``backgroundcloseminfilecount`` | |
3190 | Minimum number of files required to trigger background file closing. |
|
3191 | Minimum number of files required to trigger background file closing. | |
3191 | Operations not writing this many files won't start background close |
|
3192 | Operations not writing this many files won't start background close | |
3192 | threads. |
|
3193 | threads. | |
3193 | (default: 2048) |
|
3194 | (default: 2048) | |
3194 |
|
3195 | |||
3195 | ``backgroundclosemaxqueue`` |
|
3196 | ``backgroundclosemaxqueue`` | |
3196 | The maximum number of opened file handles waiting to be closed in the |
|
3197 | The maximum number of opened file handles waiting to be closed in the | |
3197 | background. This option only has an effect if ``backgroundclose`` is |
|
3198 | background. This option only has an effect if ``backgroundclose`` is | |
3198 | enabled. |
|
3199 | enabled. | |
3199 | (default: 384) |
|
3200 | (default: 384) | |
3200 |
|
3201 | |||
3201 | ``backgroundclosethreadcount`` |
|
3202 | ``backgroundclosethreadcount`` | |
3202 | Number of threads to process background file closes. Only relevant if |
|
3203 | Number of threads to process background file closes. Only relevant if | |
3203 | ``backgroundclose`` is enabled. |
|
3204 | ``backgroundclose`` is enabled. | |
3204 | (default: 4) |
|
3205 | (default: 4) |
General Comments 0
You need to be logged in to leave comments.
Login now