Show More
@@ -1,2418 +1,2422 b'' | |||
|
1 | 1 | The Mercurial system uses a set of configuration files to control |
|
2 | 2 | aspects of its behavior. |
|
3 | 3 | |
|
4 | 4 | Troubleshooting |
|
5 | 5 | =============== |
|
6 | 6 | |
|
7 | 7 | If you're having problems with your configuration, |
|
8 | 8 | :hg:`config --debug` can help you understand what is introducing |
|
9 | 9 | a setting into your environment. |
|
10 | 10 | |
|
11 | 11 | See :hg:`help config.syntax` and :hg:`help config.files` |
|
12 | 12 | for information about how and where to override things. |
|
13 | 13 | |
|
14 | 14 | Structure |
|
15 | 15 | ========= |
|
16 | 16 | |
|
17 | 17 | The configuration files use a simple ini-file format. A configuration |
|
18 | 18 | file consists of sections, led by a ``[section]`` header and followed |
|
19 | 19 | by ``name = value`` entries:: |
|
20 | 20 | |
|
21 | 21 | [ui] |
|
22 | 22 | username = Firstname Lastname <firstname.lastname@example.net> |
|
23 | 23 | verbose = True |
|
24 | 24 | |
|
25 | 25 | The above entries will be referred to as ``ui.username`` and |
|
26 | 26 | ``ui.verbose``, respectively. See :hg:`help config.syntax`. |
|
27 | 27 | |
|
28 | 28 | Files |
|
29 | 29 | ===== |
|
30 | 30 | |
|
31 | 31 | Mercurial reads configuration data from several files, if they exist. |
|
32 | 32 | These files do not exist by default and you will have to create the |
|
33 | 33 | appropriate configuration files yourself: |
|
34 | 34 | |
|
35 | 35 | Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file. |
|
36 | 36 | |
|
37 | 37 | Global configuration like the username setting is typically put into: |
|
38 | 38 | |
|
39 | 39 | .. container:: windows |
|
40 | 40 | |
|
41 | 41 | - ``%USERPROFILE%\mercurial.ini`` (on Windows) |
|
42 | 42 | |
|
43 | 43 | .. container:: unix.plan9 |
|
44 | 44 | |
|
45 | 45 | - ``$HOME/.hgrc`` (on Unix, Plan9) |
|
46 | 46 | |
|
47 | 47 | The names of these files depend on the system on which Mercurial is |
|
48 | 48 | installed. ``*.rc`` files from a single directory are read in |
|
49 | 49 | alphabetical order, later ones overriding earlier ones. Where multiple |
|
50 | 50 | paths are given below, settings from earlier paths override later |
|
51 | 51 | ones. |
|
52 | 52 | |
|
53 | 53 | .. container:: verbose.unix |
|
54 | 54 | |
|
55 | 55 | On Unix, the following files are consulted: |
|
56 | 56 | |
|
57 | 57 | - ``<repo>/.hg/hgrc`` (per-repository) |
|
58 | 58 | - ``$HOME/.hgrc`` (per-user) |
|
59 | 59 | - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user) |
|
60 | 60 | - ``<install-root>/etc/mercurial/hgrc`` (per-installation) |
|
61 | 61 | - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation) |
|
62 | 62 | - ``/etc/mercurial/hgrc`` (per-system) |
|
63 | 63 | - ``/etc/mercurial/hgrc.d/*.rc`` (per-system) |
|
64 | 64 | - ``<internal>/default.d/*.rc`` (defaults) |
|
65 | 65 | |
|
66 | 66 | .. container:: verbose.windows |
|
67 | 67 | |
|
68 | 68 | On Windows, the following files are consulted: |
|
69 | 69 | |
|
70 | 70 | - ``<repo>/.hg/hgrc`` (per-repository) |
|
71 | 71 | - ``%USERPROFILE%\.hgrc`` (per-user) |
|
72 | 72 | - ``%USERPROFILE%\Mercurial.ini`` (per-user) |
|
73 | 73 | - ``%HOME%\.hgrc`` (per-user) |
|
74 | 74 | - ``%HOME%\Mercurial.ini`` (per-user) |
|
75 | 75 | - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation) |
|
76 | 76 | - ``<install-dir>\hgrc.d\*.rc`` (per-installation) |
|
77 | 77 | - ``<install-dir>\Mercurial.ini`` (per-installation) |
|
78 | 78 | - ``<internal>/default.d/*.rc`` (defaults) |
|
79 | 79 | |
|
80 | 80 | .. note:: |
|
81 | 81 | |
|
82 | 82 | The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial`` |
|
83 | 83 | is used when running 32-bit Python on 64-bit Windows. |
|
84 | 84 | |
|
85 | 85 | .. container:: windows |
|
86 | 86 | |
|
87 | 87 | On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. |
|
88 | 88 | |
|
89 | 89 | .. container:: verbose.plan9 |
|
90 | 90 | |
|
91 | 91 | On Plan9, the following files are consulted: |
|
92 | 92 | |
|
93 | 93 | - ``<repo>/.hg/hgrc`` (per-repository) |
|
94 | 94 | - ``$home/lib/hgrc`` (per-user) |
|
95 | 95 | - ``<install-root>/lib/mercurial/hgrc`` (per-installation) |
|
96 | 96 | - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation) |
|
97 | 97 | - ``/lib/mercurial/hgrc`` (per-system) |
|
98 | 98 | - ``/lib/mercurial/hgrc.d/*.rc`` (per-system) |
|
99 | 99 | - ``<internal>/default.d/*.rc`` (defaults) |
|
100 | 100 | |
|
101 | 101 | Per-repository configuration options only apply in a |
|
102 | 102 | particular repository. This file is not version-controlled, and |
|
103 | 103 | will not get transferred during a "clone" operation. Options in |
|
104 | 104 | this file override options in all other configuration files. |
|
105 | 105 | |
|
106 | 106 | .. container:: unix.plan9 |
|
107 | 107 | |
|
108 | 108 | On Plan 9 and Unix, most of this file will be ignored if it doesn't |
|
109 | 109 | belong to a trusted user or to a trusted group. See |
|
110 | 110 | :hg:`help config.trusted` for more details. |
|
111 | 111 | |
|
112 | 112 | Per-user configuration file(s) are for the user running Mercurial. Options |
|
113 | 113 | in these files apply to all Mercurial commands executed by this user in any |
|
114 | 114 | directory. Options in these files override per-system and per-installation |
|
115 | 115 | options. |
|
116 | 116 | |
|
117 | 117 | Per-installation configuration files are searched for in the |
|
118 | 118 | directory where Mercurial is installed. ``<install-root>`` is the |
|
119 | 119 | parent directory of the **hg** executable (or symlink) being run. |
|
120 | 120 | |
|
121 | 121 | .. container:: unix.plan9 |
|
122 | 122 | |
|
123 | 123 | For example, if installed in ``/shared/tools/bin/hg``, Mercurial |
|
124 | 124 | will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these |
|
125 | 125 | files apply to all Mercurial commands executed by any user in any |
|
126 | 126 | directory. |
|
127 | 127 | |
|
128 | 128 | Per-installation configuration files are for the system on |
|
129 | 129 | which Mercurial is running. Options in these files apply to all |
|
130 | 130 | Mercurial commands executed by any user in any directory. Registry |
|
131 | 131 | keys contain PATH-like strings, every part of which must reference |
|
132 | 132 | a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will |
|
133 | 133 | be read. Mercurial checks each of these locations in the specified |
|
134 | 134 | order until one or more configuration files are detected. |
|
135 | 135 | |
|
136 | 136 | Per-system configuration files are for the system on which Mercurial |
|
137 | 137 | is running. Options in these files apply to all Mercurial commands |
|
138 | 138 | executed by any user in any directory. Options in these files |
|
139 | 139 | override per-installation options. |
|
140 | 140 | |
|
141 | 141 | Mercurial comes with some default configuration. The default configuration |
|
142 | 142 | files are installed with Mercurial and will be overwritten on upgrades. Default |
|
143 | 143 | configuration files should never be edited by users or administrators but can |
|
144 | 144 | be overridden in other configuration files. So far the directory only contains |
|
145 | 145 | merge tool configuration but packagers can also put other default configuration |
|
146 | 146 | there. |
|
147 | 147 | |
|
148 | 148 | Syntax |
|
149 | 149 | ====== |
|
150 | 150 | |
|
151 | 151 | A configuration file consists of sections, led by a ``[section]`` header |
|
152 | 152 | and followed by ``name = value`` entries (sometimes called |
|
153 | 153 | ``configuration keys``):: |
|
154 | 154 | |
|
155 | 155 | [spam] |
|
156 | 156 | eggs=ham |
|
157 | 157 | green= |
|
158 | 158 | eggs |
|
159 | 159 | |
|
160 | 160 | Each line contains one entry. If the lines that follow are indented, |
|
161 | 161 | they are treated as continuations of that entry. Leading whitespace is |
|
162 | 162 | removed from values. Empty lines are skipped. Lines beginning with |
|
163 | 163 | ``#`` or ``;`` are ignored and may be used to provide comments. |
|
164 | 164 | |
|
165 | 165 | Configuration keys can be set multiple times, in which case Mercurial |
|
166 | 166 | will use the value that was configured last. As an example:: |
|
167 | 167 | |
|
168 | 168 | [spam] |
|
169 | 169 | eggs=large |
|
170 | 170 | ham=serrano |
|
171 | 171 | eggs=small |
|
172 | 172 | |
|
173 | 173 | This would set the configuration key named ``eggs`` to ``small``. |
|
174 | 174 | |
|
175 | 175 | It is also possible to define a section multiple times. A section can |
|
176 | 176 | be redefined on the same and/or on different configuration files. For |
|
177 | 177 | example:: |
|
178 | 178 | |
|
179 | 179 | [foo] |
|
180 | 180 | eggs=large |
|
181 | 181 | ham=serrano |
|
182 | 182 | eggs=small |
|
183 | 183 | |
|
184 | 184 | [bar] |
|
185 | 185 | eggs=ham |
|
186 | 186 | green= |
|
187 | 187 | eggs |
|
188 | 188 | |
|
189 | 189 | [foo] |
|
190 | 190 | ham=prosciutto |
|
191 | 191 | eggs=medium |
|
192 | 192 | bread=toasted |
|
193 | 193 | |
|
194 | 194 | This would set the ``eggs``, ``ham``, and ``bread`` configuration keys |
|
195 | 195 | of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``, |
|
196 | 196 | respectively. As you can see there only thing that matters is the last |
|
197 | 197 | value that was set for each of the configuration keys. |
|
198 | 198 | |
|
199 | 199 | If a configuration key is set multiple times in different |
|
200 | 200 | configuration files the final value will depend on the order in which |
|
201 | 201 | the different configuration files are read, with settings from earlier |
|
202 | 202 | paths overriding later ones as described on the ``Files`` section |
|
203 | 203 | above. |
|
204 | 204 | |
|
205 | 205 | A line of the form ``%include file`` will include ``file`` into the |
|
206 | 206 | current configuration file. The inclusion is recursive, which means |
|
207 | 207 | that included files can include other files. Filenames are relative to |
|
208 | 208 | the configuration file in which the ``%include`` directive is found. |
|
209 | 209 | Environment variables and ``~user`` constructs are expanded in |
|
210 | 210 | ``file``. This lets you do something like:: |
|
211 | 211 | |
|
212 | 212 | %include ~/.hgrc.d/$HOST.rc |
|
213 | 213 | |
|
214 | 214 | to include a different configuration file on each computer you use. |
|
215 | 215 | |
|
216 | 216 | A line with ``%unset name`` will remove ``name`` from the current |
|
217 | 217 | section, if it has been set previously. |
|
218 | 218 | |
|
219 | 219 | The values are either free-form text strings, lists of text strings, |
|
220 | 220 | or Boolean values. Boolean values can be set to true using any of "1", |
|
221 | 221 | "yes", "true", or "on" and to false using "0", "no", "false", or "off" |
|
222 | 222 | (all case insensitive). |
|
223 | 223 | |
|
224 | 224 | List values are separated by whitespace or comma, except when values are |
|
225 | 225 | placed in double quotation marks:: |
|
226 | 226 | |
|
227 | 227 | allow_read = "John Doe, PhD", brian, betty |
|
228 | 228 | |
|
229 | 229 | Quotation marks can be escaped by prefixing them with a backslash. Only |
|
230 | 230 | quotation marks at the beginning of a word is counted as a quotation |
|
231 | 231 | (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``). |
|
232 | 232 | |
|
233 | 233 | Sections |
|
234 | 234 | ======== |
|
235 | 235 | |
|
236 | 236 | This section describes the different sections that may appear in a |
|
237 | 237 | Mercurial configuration file, the purpose of each section, its possible |
|
238 | 238 | keys, and their possible values. |
|
239 | 239 | |
|
240 | 240 | ``alias`` |
|
241 | 241 | --------- |
|
242 | 242 | |
|
243 | 243 | Defines command aliases. |
|
244 | 244 | |
|
245 | 245 | Aliases allow you to define your own commands in terms of other |
|
246 | 246 | commands (or aliases), optionally including arguments. Positional |
|
247 | 247 | arguments in the form of ``$1``, ``$2``, etc. in the alias definition |
|
248 | 248 | are expanded by Mercurial before execution. Positional arguments not |
|
249 | 249 | already used by ``$N`` in the definition are put at the end of the |
|
250 | 250 | command to be executed. |
|
251 | 251 | |
|
252 | 252 | Alias definitions consist of lines of the form:: |
|
253 | 253 | |
|
254 | 254 | <alias> = <command> [<argument>]... |
|
255 | 255 | |
|
256 | 256 | For example, this definition:: |
|
257 | 257 | |
|
258 | 258 | latest = log --limit 5 |
|
259 | 259 | |
|
260 | 260 | creates a new command ``latest`` that shows only the five most recent |
|
261 | 261 | changesets. You can define subsequent aliases using earlier ones:: |
|
262 | 262 | |
|
263 | 263 | stable5 = latest -b stable |
|
264 | 264 | |
|
265 | 265 | .. note:: |
|
266 | 266 | |
|
267 | 267 | It is possible to create aliases with the same names as |
|
268 | 268 | existing commands, which will then override the original |
|
269 | 269 | definitions. This is almost always a bad idea! |
|
270 | 270 | |
|
271 | 271 | An alias can start with an exclamation point (``!``) to make it a |
|
272 | 272 | shell alias. A shell alias is executed with the shell and will let you |
|
273 | 273 | run arbitrary commands. As an example, :: |
|
274 | 274 | |
|
275 | 275 | echo = !echo $@ |
|
276 | 276 | |
|
277 | 277 | will let you do ``hg echo foo`` to have ``foo`` printed in your |
|
278 | 278 | terminal. A better example might be:: |
|
279 | 279 | |
|
280 | 280 | purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f |
|
281 | 281 | |
|
282 | 282 | which will make ``hg purge`` delete all unknown files in the |
|
283 | 283 | repository in the same manner as the purge extension. |
|
284 | 284 | |
|
285 | 285 | Positional arguments like ``$1``, ``$2``, etc. in the alias definition |
|
286 | 286 | expand to the command arguments. Unmatched arguments are |
|
287 | 287 | removed. ``$0`` expands to the alias name and ``$@`` expands to all |
|
288 | 288 | arguments separated by a space. ``"$@"`` (with quotes) expands to all |
|
289 | 289 | arguments quoted individually and separated by a space. These expansions |
|
290 | 290 | happen before the command is passed to the shell. |
|
291 | 291 | |
|
292 | 292 | Shell aliases are executed in an environment where ``$HG`` expands to |
|
293 | 293 | the path of the Mercurial that was used to execute the alias. This is |
|
294 | 294 | useful when you want to call further Mercurial commands in a shell |
|
295 | 295 | alias, as was done above for the purge alias. In addition, |
|
296 | 296 | ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg |
|
297 | 297 | echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``. |
|
298 | 298 | |
|
299 | 299 | .. note:: |
|
300 | 300 | |
|
301 | 301 | Some global configuration options such as ``-R`` are |
|
302 | 302 | processed before shell aliases and will thus not be passed to |
|
303 | 303 | aliases. |
|
304 | 304 | |
|
305 | 305 | |
|
306 | 306 | ``annotate`` |
|
307 | 307 | ------------ |
|
308 | 308 | |
|
309 | 309 | Settings used when displaying file annotations. All values are |
|
310 | 310 | Booleans and default to False. See :hg:`help config.diff` for |
|
311 | 311 | related options for the diff command. |
|
312 | 312 | |
|
313 | 313 | ``ignorews`` |
|
314 | 314 | Ignore white space when comparing lines. |
|
315 | 315 | |
|
316 | 316 | ``ignorewsamount`` |
|
317 | 317 | Ignore changes in the amount of white space. |
|
318 | 318 | |
|
319 | 319 | ``ignoreblanklines`` |
|
320 | 320 | Ignore changes whose lines are all blank. |
|
321 | 321 | |
|
322 | 322 | |
|
323 | 323 | ``auth`` |
|
324 | 324 | -------- |
|
325 | 325 | |
|
326 | 326 | Authentication credentials and other authentication-like configuration |
|
327 | 327 | for HTTP connections. This section allows you to store usernames and |
|
328 | 328 | passwords for use when logging *into* HTTP servers. See |
|
329 | 329 | :hg:`help config.web` if you want to configure *who* can login to |
|
330 | 330 | your HTTP server. |
|
331 | 331 | |
|
332 | 332 | The following options apply to all hosts. |
|
333 | 333 | |
|
334 | 334 | ``cookiefile`` |
|
335 | 335 | Path to a file containing HTTP cookie lines. Cookies matching a |
|
336 | 336 | host will be sent automatically. |
|
337 | 337 | |
|
338 | 338 | The file format uses the Mozilla cookies.txt format, which defines cookies |
|
339 | 339 | on their own lines. Each line contains 7 fields delimited by the tab |
|
340 | 340 | character (domain, is_domain_cookie, path, is_secure, expires, name, |
|
341 | 341 | value). For more info, do an Internet search for "Netscape cookies.txt |
|
342 | 342 | format." |
|
343 | 343 | |
|
344 | 344 | Note: the cookies parser does not handle port numbers on domains. You |
|
345 | 345 | will need to remove ports from the domain for the cookie to be recognized. |
|
346 | 346 | This could result in a cookie being disclosed to an unwanted server. |
|
347 | 347 | |
|
348 | 348 | The cookies file is read-only. |
|
349 | 349 | |
|
350 | 350 | Other options in this section are grouped by name and have the following |
|
351 | 351 | format:: |
|
352 | 352 | |
|
353 | 353 | <name>.<argument> = <value> |
|
354 | 354 | |
|
355 | 355 | where ``<name>`` is used to group arguments into authentication |
|
356 | 356 | entries. Example:: |
|
357 | 357 | |
|
358 | 358 | foo.prefix = hg.intevation.de/mercurial |
|
359 | 359 | foo.username = foo |
|
360 | 360 | foo.password = bar |
|
361 | 361 | foo.schemes = http https |
|
362 | 362 | |
|
363 | 363 | bar.prefix = secure.example.org |
|
364 | 364 | bar.key = path/to/file.key |
|
365 | 365 | bar.cert = path/to/file.cert |
|
366 | 366 | bar.schemes = https |
|
367 | 367 | |
|
368 | 368 | Supported arguments: |
|
369 | 369 | |
|
370 | 370 | ``prefix`` |
|
371 | 371 | Either ``*`` or a URI prefix with or without the scheme part. |
|
372 | 372 | The authentication entry with the longest matching prefix is used |
|
373 | 373 | (where ``*`` matches everything and counts as a match of length |
|
374 | 374 | 1). If the prefix doesn't include a scheme, the match is performed |
|
375 | 375 | against the URI with its scheme stripped as well, and the schemes |
|
376 | 376 | argument, q.v., is then subsequently consulted. |
|
377 | 377 | |
|
378 | 378 | ``username`` |
|
379 | 379 | Optional. Username to authenticate with. If not given, and the |
|
380 | 380 | remote site requires basic or digest authentication, the user will |
|
381 | 381 | be prompted for it. Environment variables are expanded in the |
|
382 | 382 | username letting you do ``foo.username = $USER``. If the URI |
|
383 | 383 | includes a username, only ``[auth]`` entries with a matching |
|
384 | 384 | username or without a username will be considered. |
|
385 | 385 | |
|
386 | 386 | ``password`` |
|
387 | 387 | Optional. Password to authenticate with. If not given, and the |
|
388 | 388 | remote site requires basic or digest authentication, the user |
|
389 | 389 | will be prompted for it. |
|
390 | 390 | |
|
391 | 391 | ``key`` |
|
392 | 392 | Optional. PEM encoded client certificate key file. Environment |
|
393 | 393 | variables are expanded in the filename. |
|
394 | 394 | |
|
395 | 395 | ``cert`` |
|
396 | 396 | Optional. PEM encoded client certificate chain file. Environment |
|
397 | 397 | variables are expanded in the filename. |
|
398 | 398 | |
|
399 | 399 | ``schemes`` |
|
400 | 400 | Optional. Space separated list of URI schemes to use this |
|
401 | 401 | authentication entry with. Only used if the prefix doesn't include |
|
402 | 402 | a scheme. Supported schemes are http and https. They will match |
|
403 | 403 | static-http and static-https respectively, as well. |
|
404 | 404 | (default: https) |
|
405 | 405 | |
|
406 | 406 | If no suitable authentication entry is found, the user is prompted |
|
407 | 407 | for credentials as usual if required by the remote. |
|
408 | 408 | |
|
409 | 409 | ``color`` |
|
410 | 410 | --------- |
|
411 | 411 | |
|
412 | 412 | Configure the Mercurial color mode. For details about how to define your custom |
|
413 | 413 | effect and style see :hg:`help color`. |
|
414 | 414 | |
|
415 | 415 | ``mode`` |
|
416 | 416 | String: control the method used to output color. One of ``auto``, ``ansi``, |
|
417 | 417 | ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will |
|
418 | 418 | use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a |
|
419 | 419 | terminal. Any invalid value will disable color. |
|
420 | 420 | |
|
421 | 421 | ``pagermode`` |
|
422 | 422 | String: optional override of ``color.mode`` used with pager. |
|
423 | 423 | |
|
424 | 424 | On some systems, terminfo mode may cause problems when using |
|
425 | 425 | color with ``less -R`` as a pager program. less with the -R option |
|
426 | 426 | will only display ECMA-48 color codes, and terminfo mode may sometimes |
|
427 | 427 | emit codes that less doesn't understand. You can work around this by |
|
428 | 428 | either using ansi mode (or auto mode), or by using less -r (which will |
|
429 | 429 | pass through all terminal control codes, not just color control |
|
430 | 430 | codes). |
|
431 | 431 | |
|
432 | 432 | On some systems (such as MSYS in Windows), the terminal may support |
|
433 | 433 | a different color mode than the pager program. |
|
434 | 434 | |
|
435 | 435 | ``commands`` |
|
436 | 436 | ------------ |
|
437 | 437 | |
|
438 | 438 | ``status.relative`` |
|
439 | 439 | Make paths in :hg:`status` output relative to the current directory. |
|
440 | 440 | (default: False) |
|
441 | 441 | |
|
442 | 442 | ``update.requiredest`` |
|
443 | 443 | Require that the user pass a destination when running :hg:`update`. |
|
444 | 444 | For example, :hg:`update .::` will be allowed, but a plain :hg:`update` |
|
445 | 445 | will be disallowed. |
|
446 | 446 | (default: False) |
|
447 | 447 | |
|
448 | 448 | ``committemplate`` |
|
449 | 449 | ------------------ |
|
450 | 450 | |
|
451 | 451 | ``changeset`` |
|
452 | 452 | String: configuration in this section is used as the template to |
|
453 | 453 | customize the text shown in the editor when committing. |
|
454 | 454 | |
|
455 | 455 | In addition to pre-defined template keywords, commit log specific one |
|
456 | 456 | below can be used for customization: |
|
457 | 457 | |
|
458 | 458 | ``extramsg`` |
|
459 | 459 | String: Extra message (typically 'Leave message empty to abort |
|
460 | 460 | commit.'). This may be changed by some commands or extensions. |
|
461 | 461 | |
|
462 | 462 | For example, the template configuration below shows as same text as |
|
463 | 463 | one shown by default:: |
|
464 | 464 | |
|
465 | 465 | [committemplate] |
|
466 | 466 | changeset = {desc}\n\n |
|
467 | 467 | HG: Enter commit message. Lines beginning with 'HG:' are removed. |
|
468 | 468 | HG: {extramsg} |
|
469 | 469 | HG: -- |
|
470 | 470 | HG: user: {author}\n{ifeq(p2rev, "-1", "", |
|
471 | 471 | "HG: branch merge\n") |
|
472 | 472 | }HG: branch '{branch}'\n{if(activebookmark, |
|
473 | 473 | "HG: bookmark '{activebookmark}'\n") }{subrepos % |
|
474 | 474 | "HG: subrepo {subrepo}\n" }{file_adds % |
|
475 | 475 | "HG: added {file}\n" }{file_mods % |
|
476 | 476 | "HG: changed {file}\n" }{file_dels % |
|
477 | 477 | "HG: removed {file}\n" }{if(files, "", |
|
478 | 478 | "HG: no files changed\n")} |
|
479 | 479 | |
|
480 | 480 | ``diff()`` |
|
481 | 481 | String: show the diff (see :hg:`help templates` for detail) |
|
482 | 482 | |
|
483 | 483 | Sometimes it is helpful to show the diff of the changeset in the editor without |
|
484 | 484 | having to prefix 'HG: ' to each line so that highlighting works correctly. For |
|
485 | 485 | this, Mercurial provides a special string which will ignore everything below |
|
486 | 486 | it:: |
|
487 | 487 | |
|
488 | 488 | HG: ------------------------ >8 ------------------------ |
|
489 | 489 | |
|
490 | 490 | For example, the template configuration below will show the diff below the |
|
491 | 491 | extra message:: |
|
492 | 492 | |
|
493 | 493 | [committemplate] |
|
494 | 494 | changeset = {desc}\n\n |
|
495 | 495 | HG: Enter commit message. Lines beginning with 'HG:' are removed. |
|
496 | 496 | HG: {extramsg} |
|
497 | 497 | HG: ------------------------ >8 ------------------------ |
|
498 | 498 | HG: Do not touch the line above. |
|
499 | 499 | HG: Everything below will be removed. |
|
500 | 500 | {diff()} |
|
501 | 501 | |
|
502 | 502 | .. note:: |
|
503 | 503 | |
|
504 | 504 | For some problematic encodings (see :hg:`help win32mbcs` for |
|
505 | 505 | detail), this customization should be configured carefully, to |
|
506 | 506 | avoid showing broken characters. |
|
507 | 507 | |
|
508 | 508 | For example, if a multibyte character ending with backslash (0x5c) is |
|
509 | 509 | followed by the ASCII character 'n' in the customized template, |
|
510 | 510 | the sequence of backslash and 'n' is treated as line-feed unexpectedly |
|
511 | 511 | (and the multibyte character is broken, too). |
|
512 | 512 | |
|
513 | 513 | Customized template is used for commands below (``--edit`` may be |
|
514 | 514 | required): |
|
515 | 515 | |
|
516 | 516 | - :hg:`backout` |
|
517 | 517 | - :hg:`commit` |
|
518 | 518 | - :hg:`fetch` (for merge commit only) |
|
519 | 519 | - :hg:`graft` |
|
520 | 520 | - :hg:`histedit` |
|
521 | 521 | - :hg:`import` |
|
522 | 522 | - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh` |
|
523 | 523 | - :hg:`rebase` |
|
524 | 524 | - :hg:`shelve` |
|
525 | 525 | - :hg:`sign` |
|
526 | 526 | - :hg:`tag` |
|
527 | 527 | - :hg:`transplant` |
|
528 | 528 | |
|
529 | 529 | Configuring items below instead of ``changeset`` allows showing |
|
530 | 530 | customized message only for specific actions, or showing different |
|
531 | 531 | messages for each action. |
|
532 | 532 | |
|
533 | 533 | - ``changeset.backout`` for :hg:`backout` |
|
534 | 534 | - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges |
|
535 | 535 | - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other |
|
536 | 536 | - ``changeset.commit.normal.merge`` for :hg:`commit` on merges |
|
537 | 537 | - ``changeset.commit.normal.normal`` for :hg:`commit` on other |
|
538 | 538 | - ``changeset.fetch`` for :hg:`fetch` (impling merge commit) |
|
539 | 539 | - ``changeset.gpg.sign`` for :hg:`sign` |
|
540 | 540 | - ``changeset.graft`` for :hg:`graft` |
|
541 | 541 | - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit` |
|
542 | 542 | - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit` |
|
543 | 543 | - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit` |
|
544 | 544 | - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit` |
|
545 | 545 | - ``changeset.import.bypass`` for :hg:`import --bypass` |
|
546 | 546 | - ``changeset.import.normal.merge`` for :hg:`import` on merges |
|
547 | 547 | - ``changeset.import.normal.normal`` for :hg:`import` on other |
|
548 | 548 | - ``changeset.mq.qnew`` for :hg:`qnew` |
|
549 | 549 | - ``changeset.mq.qfold`` for :hg:`qfold` |
|
550 | 550 | - ``changeset.mq.qrefresh`` for :hg:`qrefresh` |
|
551 | 551 | - ``changeset.rebase.collapse`` for :hg:`rebase --collapse` |
|
552 | 552 | - ``changeset.rebase.merge`` for :hg:`rebase` on merges |
|
553 | 553 | - ``changeset.rebase.normal`` for :hg:`rebase` on other |
|
554 | 554 | - ``changeset.shelve.shelve`` for :hg:`shelve` |
|
555 | 555 | - ``changeset.tag.add`` for :hg:`tag` without ``--remove`` |
|
556 | 556 | - ``changeset.tag.remove`` for :hg:`tag --remove` |
|
557 | 557 | - ``changeset.transplant.merge`` for :hg:`transplant` on merges |
|
558 | 558 | - ``changeset.transplant.normal`` for :hg:`transplant` on other |
|
559 | 559 | |
|
560 | 560 | These dot-separated lists of names are treated as hierarchical ones. |
|
561 | 561 | For example, ``changeset.tag.remove`` customizes the commit message |
|
562 | 562 | only for :hg:`tag --remove`, but ``changeset.tag`` customizes the |
|
563 | 563 | commit message for :hg:`tag` regardless of ``--remove`` option. |
|
564 | 564 | |
|
565 | 565 | When the external editor is invoked for a commit, the corresponding |
|
566 | 566 | dot-separated list of names without the ``changeset.`` prefix |
|
567 | 567 | (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment |
|
568 | 568 | variable. |
|
569 | 569 | |
|
570 | 570 | In this section, items other than ``changeset`` can be referred from |
|
571 | 571 | others. For example, the configuration to list committed files up |
|
572 | 572 | below can be referred as ``{listupfiles}``:: |
|
573 | 573 | |
|
574 | 574 | [committemplate] |
|
575 | 575 | listupfiles = {file_adds % |
|
576 | 576 | "HG: added {file}\n" }{file_mods % |
|
577 | 577 | "HG: changed {file}\n" }{file_dels % |
|
578 | 578 | "HG: removed {file}\n" }{if(files, "", |
|
579 | 579 | "HG: no files changed\n")} |
|
580 | 580 | |
|
581 | 581 | ``decode/encode`` |
|
582 | 582 | ----------------- |
|
583 | 583 | |
|
584 | 584 | Filters for transforming files on checkout/checkin. This would |
|
585 | 585 | typically be used for newline processing or other |
|
586 | 586 | localization/canonicalization of files. |
|
587 | 587 | |
|
588 | 588 | Filters consist of a filter pattern followed by a filter command. |
|
589 | 589 | Filter patterns are globs by default, rooted at the repository root. |
|
590 | 590 | For example, to match any file ending in ``.txt`` in the root |
|
591 | 591 | directory only, use the pattern ``*.txt``. To match any file ending |
|
592 | 592 | in ``.c`` anywhere in the repository, use the pattern ``**.c``. |
|
593 | 593 | For each file only the first matching filter applies. |
|
594 | 594 | |
|
595 | 595 | The filter command can start with a specifier, either ``pipe:`` or |
|
596 | 596 | ``tempfile:``. If no specifier is given, ``pipe:`` is used by default. |
|
597 | 597 | |
|
598 | 598 | A ``pipe:`` command must accept data on stdin and return the transformed |
|
599 | 599 | data on stdout. |
|
600 | 600 | |
|
601 | 601 | Pipe example:: |
|
602 | 602 | |
|
603 | 603 | [encode] |
|
604 | 604 | # uncompress gzip files on checkin to improve delta compression |
|
605 | 605 | # note: not necessarily a good idea, just an example |
|
606 | 606 | *.gz = pipe: gunzip |
|
607 | 607 | |
|
608 | 608 | [decode] |
|
609 | 609 | # recompress gzip files when writing them to the working dir (we |
|
610 | 610 | # can safely omit "pipe:", because it's the default) |
|
611 | 611 | *.gz = gzip |
|
612 | 612 | |
|
613 | 613 | A ``tempfile:`` command is a template. The string ``INFILE`` is replaced |
|
614 | 614 | with the name of a temporary file that contains the data to be |
|
615 | 615 | filtered by the command. The string ``OUTFILE`` is replaced with the name |
|
616 | 616 | of an empty temporary file, where the filtered data must be written by |
|
617 | 617 | the command. |
|
618 | 618 | |
|
619 | 619 | .. container:: windows |
|
620 | 620 | |
|
621 | 621 | .. note:: |
|
622 | 622 | |
|
623 | 623 | The tempfile mechanism is recommended for Windows systems, |
|
624 | 624 | where the standard shell I/O redirection operators often have |
|
625 | 625 | strange effects and may corrupt the contents of your files. |
|
626 | 626 | |
|
627 | 627 | This filter mechanism is used internally by the ``eol`` extension to |
|
628 | 628 | translate line ending characters between Windows (CRLF) and Unix (LF) |
|
629 | 629 | format. We suggest you use the ``eol`` extension for convenience. |
|
630 | 630 | |
|
631 | 631 | |
|
632 | 632 | ``defaults`` |
|
633 | 633 | ------------ |
|
634 | 634 | |
|
635 | 635 | (defaults are deprecated. Don't use them. Use aliases instead.) |
|
636 | 636 | |
|
637 | 637 | Use the ``[defaults]`` section to define command defaults, i.e. the |
|
638 | 638 | default options/arguments to pass to the specified commands. |
|
639 | 639 | |
|
640 | 640 | The following example makes :hg:`log` run in verbose mode, and |
|
641 | 641 | :hg:`status` show only the modified files, by default:: |
|
642 | 642 | |
|
643 | 643 | [defaults] |
|
644 | 644 | log = -v |
|
645 | 645 | status = -m |
|
646 | 646 | |
|
647 | 647 | The actual commands, instead of their aliases, must be used when |
|
648 | 648 | defining command defaults. The command defaults will also be applied |
|
649 | 649 | to the aliases of the commands defined. |
|
650 | 650 | |
|
651 | 651 | |
|
652 | 652 | ``diff`` |
|
653 | 653 | -------- |
|
654 | 654 | |
|
655 | 655 | Settings used when displaying diffs. Everything except for ``unified`` |
|
656 | 656 | is a Boolean and defaults to False. See :hg:`help config.annotate` |
|
657 | 657 | for related options for the annotate command. |
|
658 | 658 | |
|
659 | 659 | ``git`` |
|
660 | 660 | Use git extended diff format. |
|
661 | 661 | |
|
662 | 662 | ``nobinary`` |
|
663 | 663 | Omit git binary patches. |
|
664 | 664 | |
|
665 | 665 | ``nodates`` |
|
666 | 666 | Don't include dates in diff headers. |
|
667 | 667 | |
|
668 | 668 | ``noprefix`` |
|
669 | 669 | Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode. |
|
670 | 670 | |
|
671 | 671 | ``showfunc`` |
|
672 | 672 | Show which function each change is in. |
|
673 | 673 | |
|
674 | 674 | ``ignorews`` |
|
675 | 675 | Ignore white space when comparing lines. |
|
676 | 676 | |
|
677 | 677 | ``ignorewsamount`` |
|
678 | 678 | Ignore changes in the amount of white space. |
|
679 | 679 | |
|
680 | 680 | ``ignoreblanklines`` |
|
681 | 681 | Ignore changes whose lines are all blank. |
|
682 | 682 | |
|
683 | 683 | ``unified`` |
|
684 | 684 | Number of lines of context to show. |
|
685 | 685 | |
|
686 | 686 | ``email`` |
|
687 | 687 | --------- |
|
688 | 688 | |
|
689 | 689 | Settings for extensions that send email messages. |
|
690 | 690 | |
|
691 | 691 | ``from`` |
|
692 | 692 | Optional. Email address to use in "From" header and SMTP envelope |
|
693 | 693 | of outgoing messages. |
|
694 | 694 | |
|
695 | 695 | ``to`` |
|
696 | 696 | Optional. Comma-separated list of recipients' email addresses. |
|
697 | 697 | |
|
698 | 698 | ``cc`` |
|
699 | 699 | Optional. Comma-separated list of carbon copy recipients' |
|
700 | 700 | email addresses. |
|
701 | 701 | |
|
702 | 702 | ``bcc`` |
|
703 | 703 | Optional. Comma-separated list of blind carbon copy recipients' |
|
704 | 704 | email addresses. |
|
705 | 705 | |
|
706 | 706 | ``method`` |
|
707 | 707 | Optional. Method to use to send email messages. If value is ``smtp`` |
|
708 | 708 | (default), use SMTP (see the ``[smtp]`` section for configuration). |
|
709 | 709 | Otherwise, use as name of program to run that acts like sendmail |
|
710 | 710 | (takes ``-f`` option for sender, list of recipients on command line, |
|
711 | 711 | message on stdin). Normally, setting this to ``sendmail`` or |
|
712 | 712 | ``/usr/sbin/sendmail`` is enough to use sendmail to send messages. |
|
713 | 713 | |
|
714 | 714 | ``charsets`` |
|
715 | 715 | Optional. Comma-separated list of character sets considered |
|
716 | 716 | convenient for recipients. Addresses, headers, and parts not |
|
717 | 717 | containing patches of outgoing messages will be encoded in the |
|
718 | 718 | first character set to which conversion from local encoding |
|
719 | 719 | (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct |
|
720 | 720 | conversion fails, the text in question is sent as is. |
|
721 | 721 | (default: '') |
|
722 | 722 | |
|
723 | 723 | Order of outgoing email character sets: |
|
724 | 724 | |
|
725 | 725 | 1. ``us-ascii``: always first, regardless of settings |
|
726 | 726 | 2. ``email.charsets``: in order given by user |
|
727 | 727 | 3. ``ui.fallbackencoding``: if not in email.charsets |
|
728 | 728 | 4. ``$HGENCODING``: if not in email.charsets |
|
729 | 729 | 5. ``utf-8``: always last, regardless of settings |
|
730 | 730 | |
|
731 | 731 | Email example:: |
|
732 | 732 | |
|
733 | 733 | [email] |
|
734 | 734 | from = Joseph User <joe.user@example.com> |
|
735 | 735 | method = /usr/sbin/sendmail |
|
736 | 736 | # charsets for western Europeans |
|
737 | 737 | # us-ascii, utf-8 omitted, as they are tried first and last |
|
738 | 738 | charsets = iso-8859-1, iso-8859-15, windows-1252 |
|
739 | 739 | |
|
740 | 740 | |
|
741 | 741 | ``extensions`` |
|
742 | 742 | -------------- |
|
743 | 743 | |
|
744 | 744 | Mercurial has an extension mechanism for adding new features. To |
|
745 | 745 | enable an extension, create an entry for it in this section. |
|
746 | 746 | |
|
747 | 747 | If you know that the extension is already in Python's search path, |
|
748 | 748 | you can give the name of the module, followed by ``=``, with nothing |
|
749 | 749 | after the ``=``. |
|
750 | 750 | |
|
751 | 751 | Otherwise, give a name that you choose, followed by ``=``, followed by |
|
752 | 752 | the path to the ``.py`` file (including the file name extension) that |
|
753 | 753 | defines the extension. |
|
754 | 754 | |
|
755 | 755 | To explicitly disable an extension that is enabled in an hgrc of |
|
756 | 756 | broader scope, prepend its path with ``!``, as in ``foo = !/ext/path`` |
|
757 | 757 | or ``foo = !`` when path is not supplied. |
|
758 | 758 | |
|
759 | 759 | Example for ``~/.hgrc``:: |
|
760 | 760 | |
|
761 | 761 | [extensions] |
|
762 | 762 | # (the churn extension will get loaded from Mercurial's path) |
|
763 | 763 | churn = |
|
764 | 764 | # (this extension will get loaded from the file specified) |
|
765 | 765 | myfeature = ~/.hgext/myfeature.py |
|
766 | 766 | |
|
767 | 767 | |
|
768 | 768 | ``format`` |
|
769 | 769 | ---------- |
|
770 | 770 | |
|
771 | 771 | ``usegeneraldelta`` |
|
772 | 772 | Enable or disable the "generaldelta" repository format which improves |
|
773 | 773 | repository compression by allowing "revlog" to store delta against arbitrary |
|
774 | 774 | revision instead of the previous stored one. This provides significant |
|
775 | 775 | improvement for repositories with branches. |
|
776 | 776 | |
|
777 | 777 | Repositories with this on-disk format require Mercurial version 1.9. |
|
778 | 778 | |
|
779 | 779 | Enabled by default. |
|
780 | 780 | |
|
781 | 781 | ``dotencode`` |
|
782 | 782 | Enable or disable the "dotencode" repository format which enhances |
|
783 | 783 | the "fncache" repository format (which has to be enabled to use |
|
784 | 784 | dotencode) to avoid issues with filenames starting with ._ on |
|
785 | 785 | Mac OS X and spaces on Windows. |
|
786 | 786 | |
|
787 | 787 | Repositories with this on-disk format require Mercurial version 1.7. |
|
788 | 788 | |
|
789 | 789 | Enabled by default. |
|
790 | 790 | |
|
791 | 791 | ``usefncache`` |
|
792 | 792 | Enable or disable the "fncache" repository format which enhances |
|
793 | 793 | the "store" repository format (which has to be enabled to use |
|
794 | 794 | fncache) to allow longer filenames and avoids using Windows |
|
795 | 795 | reserved names, e.g. "nul". |
|
796 | 796 | |
|
797 | 797 | Repositories with this on-disk format require Mercurial version 1.1. |
|
798 | 798 | |
|
799 | 799 | Enabled by default. |
|
800 | 800 | |
|
801 | 801 | ``usestore`` |
|
802 | 802 | Enable or disable the "store" repository format which improves |
|
803 | 803 | compatibility with systems that fold case or otherwise mangle |
|
804 | 804 | filenames. Disabling this option will allow you to store longer filenames |
|
805 | 805 | in some situations at the expense of compatibility. |
|
806 | 806 | |
|
807 | 807 | Repositories with this on-disk format require Mercurial version 0.9.4. |
|
808 | 808 | |
|
809 | 809 | Enabled by default. |
|
810 | 810 | |
|
811 | 811 | ``graph`` |
|
812 | 812 | --------- |
|
813 | 813 | |
|
814 | 814 | Web graph view configuration. This section let you change graph |
|
815 | 815 | elements display properties by branches, for instance to make the |
|
816 | 816 | ``default`` branch stand out. |
|
817 | 817 | |
|
818 | 818 | Each line has the following format:: |
|
819 | 819 | |
|
820 | 820 | <branch>.<argument> = <value> |
|
821 | 821 | |
|
822 | 822 | where ``<branch>`` is the name of the branch being |
|
823 | 823 | customized. Example:: |
|
824 | 824 | |
|
825 | 825 | [graph] |
|
826 | 826 | # 2px width |
|
827 | 827 | default.width = 2 |
|
828 | 828 | # red color |
|
829 | 829 | default.color = FF0000 |
|
830 | 830 | |
|
831 | 831 | Supported arguments: |
|
832 | 832 | |
|
833 | 833 | ``width`` |
|
834 | 834 | Set branch edges width in pixels. |
|
835 | 835 | |
|
836 | 836 | ``color`` |
|
837 | 837 | Set branch edges color in hexadecimal RGB notation. |
|
838 | 838 | |
|
839 | 839 | ``hooks`` |
|
840 | 840 | --------- |
|
841 | 841 | |
|
842 | 842 | Commands or Python functions that get automatically executed by |
|
843 | 843 | various actions such as starting or finishing a commit. Multiple |
|
844 | 844 | hooks can be run for the same action by appending a suffix to the |
|
845 | 845 | action. Overriding a site-wide hook can be done by changing its |
|
846 | 846 | value or setting it to an empty string. Hooks can be prioritized |
|
847 | 847 | by adding a prefix of ``priority.`` to the hook name on a new line |
|
848 | 848 | and setting the priority. The default priority is 0. |
|
849 | 849 | |
|
850 | 850 | Example ``.hg/hgrc``:: |
|
851 | 851 | |
|
852 | 852 | [hooks] |
|
853 | 853 | # update working directory after adding changesets |
|
854 | 854 | changegroup.update = hg update |
|
855 | 855 | # do not use the site-wide hook |
|
856 | 856 | incoming = |
|
857 | 857 | incoming.email = /my/email/hook |
|
858 | 858 | incoming.autobuild = /my/build/hook |
|
859 | 859 | # force autobuild hook to run before other incoming hooks |
|
860 | 860 | priority.incoming.autobuild = 1 |
|
861 | 861 | |
|
862 | 862 | Most hooks are run with environment variables set that give useful |
|
863 | 863 | additional information. For each hook below, the environment variables |
|
864 | 864 | it is passed are listed with names of the form ``$HG_foo``. The |
|
865 | 865 | ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks. |
|
866 | 866 | their respectively contains the type of hook which triggered the run and |
|
867 | 867 | the full name of the hooks in the config. In the example about this will |
|
868 | 868 | be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``. |
|
869 | 869 | |
|
870 | 870 | ``changegroup`` |
|
871 | 871 | Run after a changegroup has been added via push, pull or unbundle. ID of the |
|
872 | 872 | first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL |
|
873 | 873 | from which changes came is in ``$HG_URL``. |
|
874 | 874 | |
|
875 | 875 | ``commit`` |
|
876 | 876 | Run after a changeset has been created in the local repository. ID |
|
877 | 877 | of the newly created changeset is in ``$HG_NODE``. Parent changeset |
|
878 | 878 | IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. |
|
879 | 879 | |
|
880 | 880 | ``incoming`` |
|
881 | 881 | Run after a changeset has been pulled, pushed, or unbundled into |
|
882 | 882 | the local repository. The ID of the newly arrived changeset is in |
|
883 | 883 | ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``. |
|
884 | 884 | |
|
885 | 885 | ``outgoing`` |
|
886 | 886 | Run after sending changes from local repository to another. ID of |
|
887 | 887 | first changeset sent is in ``$HG_NODE``. Source of operation is in |
|
888 | 888 | ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook. |
|
889 | 889 | |
|
890 | 890 | ``post-<command>`` |
|
891 | 891 | Run after successful invocations of the associated command. The |
|
892 | 892 | contents of the command line are passed as ``$HG_ARGS`` and the result |
|
893 | 893 | code in ``$HG_RESULT``. Parsed command line arguments are passed as |
|
894 | 894 | ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of |
|
895 | 895 | the python data internally passed to <command>. ``$HG_OPTS`` is a |
|
896 | 896 | dictionary of options (with unspecified options set to their defaults). |
|
897 | 897 | ``$HG_PATS`` is a list of arguments. Hook failure is ignored. |
|
898 | 898 | |
|
899 | 899 | ``fail-<command>`` |
|
900 | 900 | Run after a failed invocation of an associated command. The contents |
|
901 | 901 | of the command line are passed as ``$HG_ARGS``. Parsed command line |
|
902 | 902 | arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain |
|
903 | 903 | string representations of the python data internally passed to |
|
904 | 904 | <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified |
|
905 | 905 | options set to their defaults). ``$HG_PATS`` is a list of arguments. |
|
906 | 906 | Hook failure is ignored. |
|
907 | 907 | |
|
908 | 908 | ``pre-<command>`` |
|
909 | 909 | Run before executing the associated command. The contents of the |
|
910 | 910 | command line are passed as ``$HG_ARGS``. Parsed command line arguments |
|
911 | 911 | are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string |
|
912 | 912 | representations of the data internally passed to <command>. ``$HG_OPTS`` |
|
913 | 913 | is a dictionary of options (with unspecified options set to their |
|
914 | 914 | defaults). ``$HG_PATS`` is a list of arguments. If the hook returns |
|
915 | 915 | failure, the command doesn't execute and Mercurial returns the failure |
|
916 | 916 | code. |
|
917 | 917 | |
|
918 | 918 | ``prechangegroup`` |
|
919 | 919 | Run before a changegroup is added via push, pull or unbundle. Exit |
|
920 | 920 | status 0 allows the changegroup to proceed. Non-zero status will |
|
921 | 921 | cause the push, pull or unbundle to fail. URL from which changes |
|
922 | 922 | will come is in ``$HG_URL``. |
|
923 | 923 | |
|
924 | 924 | ``precommit`` |
|
925 | 925 | Run before starting a local commit. Exit status 0 allows the |
|
926 | 926 | commit to proceed. Non-zero status will cause the commit to fail. |
|
927 | 927 | Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. |
|
928 | 928 | |
|
929 | 929 | ``prelistkeys`` |
|
930 | 930 | Run before listing pushkeys (like bookmarks) in the |
|
931 | 931 | repository. Non-zero status will cause failure. The key namespace is |
|
932 | 932 | in ``$HG_NAMESPACE``. |
|
933 | 933 | |
|
934 | 934 | ``preoutgoing`` |
|
935 | 935 | Run before collecting changes to send from the local repository to |
|
936 | 936 | another. Non-zero status will cause failure. This lets you prevent |
|
937 | 937 | pull over HTTP or SSH. Also prevents against local pull, push |
|
938 | 938 | (outbound) or bundle commands, but not effective, since you can |
|
939 | 939 | just copy files instead then. Source of operation is in |
|
940 | 940 | ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote |
|
941 | 941 | SSH or HTTP repository. If "push", "pull" or "bundle", operation |
|
942 | 942 | is happening on behalf of repository on same system. |
|
943 | 943 | |
|
944 | 944 | ``prepushkey`` |
|
945 | 945 | Run before a pushkey (like a bookmark) is added to the |
|
946 | 946 | repository. Non-zero status will cause the key to be rejected. The |
|
947 | 947 | key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``, |
|
948 | 948 | the old value (if any) is in ``$HG_OLD``, and the new value is in |
|
949 | 949 | ``$HG_NEW``. |
|
950 | 950 | |
|
951 | 951 | ``pretag`` |
|
952 | 952 | Run before creating a tag. Exit status 0 allows the tag to be |
|
953 | 953 | created. Non-zero status will cause the tag to fail. ID of |
|
954 | 954 | changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is |
|
955 | 955 | local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``. |
|
956 | 956 | |
|
957 | 957 | ``pretxnopen`` |
|
958 | 958 | Run before any new repository transaction is open. The reason for the |
|
959 | 959 | transaction will be in ``$HG_TXNNAME`` and a unique identifier for the |
|
960 | 960 | transaction will be in ``HG_TXNID``. A non-zero status will prevent the |
|
961 | 961 | transaction from being opened. |
|
962 | 962 | |
|
963 | 963 | ``pretxnclose`` |
|
964 | 964 | Run right before the transaction is actually finalized. Any repository change |
|
965 | 965 | will be visible to the hook program. This lets you validate the transaction |
|
966 | 966 | content or change it. Exit status 0 allows the commit to proceed. Non-zero |
|
967 | 967 | status will cause the transaction to be rolled back. The reason for the |
|
968 | 968 | transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for |
|
969 | 969 | the transaction will be in ``HG_TXNID``. The rest of the available data will |
|
970 | 970 | vary according the transaction type. New changesets will add ``$HG_NODE`` (id |
|
971 | 971 | of the first added changeset), ``$HG_NODE_LAST`` (id of the last added |
|
972 | 972 | changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases |
|
973 | 973 | changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc. |
|
974 | 974 | |
|
975 | 975 | ``txnclose`` |
|
976 | 976 | Run after any repository transaction has been committed. At this |
|
977 | 977 | point, the transaction can no longer be rolled back. The hook will run |
|
978 | 978 | after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for |
|
979 | 979 | details about available variables. |
|
980 | 980 | |
|
981 | 981 | ``txnabort`` |
|
982 | 982 | Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose` |
|
983 | 983 | docs for details about available variables. |
|
984 | 984 | |
|
985 | 985 | ``pretxnchangegroup`` |
|
986 | 986 | Run after a changegroup has been added via push, pull or unbundle, but before |
|
987 | 987 | the transaction has been committed. Changegroup is visible to hook program. |
|
988 | 988 | This lets you validate incoming changes before accepting them. Passed the ID |
|
989 | 989 | of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. |
|
990 | 990 | Exit status 0 allows the transaction to commit. Non-zero status will cause |
|
991 | 991 | the transaction to be rolled back and the push, pull or unbundle will fail. |
|
992 | 992 | URL that was source of changes is in ``$HG_URL``. |
|
993 | 993 | |
|
994 | 994 | ``pretxncommit`` |
|
995 | 995 | Run after a changeset has been created but the transaction not yet |
|
996 | 996 | committed. Changeset is visible to hook program. This lets you |
|
997 | 997 | validate commit message and changes. Exit status 0 allows the |
|
998 | 998 | commit to proceed. Non-zero status will cause the transaction to |
|
999 | 999 | be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset |
|
1000 | 1000 | IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. |
|
1001 | 1001 | |
|
1002 | 1002 | ``preupdate`` |
|
1003 | 1003 | Run before updating the working directory. Exit status 0 allows |
|
1004 | 1004 | the update to proceed. Non-zero status will prevent the update. |
|
1005 | 1005 | Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID |
|
1006 | 1006 | of second new parent is in ``$HG_PARENT2``. |
|
1007 | 1007 | |
|
1008 | 1008 | ``listkeys`` |
|
1009 | 1009 | Run after listing pushkeys (like bookmarks) in the repository. The |
|
1010 | 1010 | key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a |
|
1011 | 1011 | dictionary containing the keys and values. |
|
1012 | 1012 | |
|
1013 | 1013 | ``pushkey`` |
|
1014 | 1014 | Run after a pushkey (like a bookmark) is added to the |
|
1015 | 1015 | repository. The key namespace is in ``$HG_NAMESPACE``, the key is in |
|
1016 | 1016 | ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new |
|
1017 | 1017 | value is in ``$HG_NEW``. |
|
1018 | 1018 | |
|
1019 | 1019 | ``tag`` |
|
1020 | 1020 | Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``. |
|
1021 | 1021 | Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in |
|
1022 | 1022 | repository if ``$HG_LOCAL=0``. |
|
1023 | 1023 | |
|
1024 | 1024 | ``update`` |
|
1025 | 1025 | Run after updating the working directory. Changeset ID of first |
|
1026 | 1026 | new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is |
|
1027 | 1027 | in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the |
|
1028 | 1028 | update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``. |
|
1029 | 1029 | |
|
1030 | 1030 | .. note:: |
|
1031 | 1031 | |
|
1032 | 1032 | It is generally better to use standard hooks rather than the |
|
1033 | 1033 | generic pre- and post- command hooks as they are guaranteed to be |
|
1034 | 1034 | called in the appropriate contexts for influencing transactions. |
|
1035 | 1035 | Also, hooks like "commit" will be called in all contexts that |
|
1036 | 1036 | generate a commit (e.g. tag) and not just the commit command. |
|
1037 | 1037 | |
|
1038 | 1038 | .. note:: |
|
1039 | 1039 | |
|
1040 | 1040 | Environment variables with empty values may not be passed to |
|
1041 | 1041 | hooks on platforms such as Windows. As an example, ``$HG_PARENT2`` |
|
1042 | 1042 | will have an empty value under Unix-like platforms for non-merge |
|
1043 | 1043 | changesets, while it will not be available at all under Windows. |
|
1044 | 1044 | |
|
1045 | 1045 | The syntax for Python hooks is as follows:: |
|
1046 | 1046 | |
|
1047 | 1047 | hookname = python:modulename.submodule.callable |
|
1048 | 1048 | hookname = python:/path/to/python/module.py:callable |
|
1049 | 1049 | |
|
1050 | 1050 | Python hooks are run within the Mercurial process. Each hook is |
|
1051 | 1051 | called with at least three keyword arguments: a ui object (keyword |
|
1052 | 1052 | ``ui``), a repository object (keyword ``repo``), and a ``hooktype`` |
|
1053 | 1053 | keyword that tells what kind of hook is used. Arguments listed as |
|
1054 | 1054 | environment variables above are passed as keyword arguments, with no |
|
1055 | 1055 | ``HG_`` prefix, and names in lower case. |
|
1056 | 1056 | |
|
1057 | 1057 | If a Python hook returns a "true" value or raises an exception, this |
|
1058 | 1058 | is treated as a failure. |
|
1059 | 1059 | |
|
1060 | 1060 | |
|
1061 | 1061 | ``hostfingerprints`` |
|
1062 | 1062 | -------------------- |
|
1063 | 1063 | |
|
1064 | 1064 | (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.) |
|
1065 | 1065 | |
|
1066 | 1066 | Fingerprints of the certificates of known HTTPS servers. |
|
1067 | 1067 | |
|
1068 | 1068 | A HTTPS connection to a server with a fingerprint configured here will |
|
1069 | 1069 | only succeed if the servers certificate matches the fingerprint. |
|
1070 | 1070 | This is very similar to how ssh known hosts works. |
|
1071 | 1071 | |
|
1072 | 1072 | The fingerprint is the SHA-1 hash value of the DER encoded certificate. |
|
1073 | 1073 | Multiple values can be specified (separated by spaces or commas). This can |
|
1074 | 1074 | be used to define both old and new fingerprints while a host transitions |
|
1075 | 1075 | to a new certificate. |
|
1076 | 1076 | |
|
1077 | 1077 | The CA chain and web.cacerts is not used for servers with a fingerprint. |
|
1078 | 1078 | |
|
1079 | 1079 | For example:: |
|
1080 | 1080 | |
|
1081 | 1081 | [hostfingerprints] |
|
1082 | 1082 | hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33 |
|
1083 | 1083 | hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33 |
|
1084 | 1084 | |
|
1085 | 1085 | ``hostsecurity`` |
|
1086 | 1086 | ---------------- |
|
1087 | 1087 | |
|
1088 | 1088 | Used to specify global and per-host security settings for connecting to |
|
1089 | 1089 | other machines. |
|
1090 | 1090 | |
|
1091 | 1091 | The following options control default behavior for all hosts. |
|
1092 | 1092 | |
|
1093 | 1093 | ``ciphers`` |
|
1094 | 1094 | Defines the cryptographic ciphers to use for connections. |
|
1095 | 1095 | |
|
1096 | 1096 | Value must be a valid OpenSSL Cipher List Format as documented at |
|
1097 | 1097 | https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT. |
|
1098 | 1098 | |
|
1099 | 1099 | This setting is for advanced users only. Setting to incorrect values |
|
1100 | 1100 | can significantly lower connection security or decrease performance. |
|
1101 | 1101 | You have been warned. |
|
1102 | 1102 | |
|
1103 | 1103 | This option requires Python 2.7. |
|
1104 | 1104 | |
|
1105 | 1105 | ``minimumprotocol`` |
|
1106 | 1106 | Defines the minimum channel encryption protocol to use. |
|
1107 | 1107 | |
|
1108 | 1108 | By default, the highest version of TLS supported by both client and server |
|
1109 | 1109 | is used. |
|
1110 | 1110 | |
|
1111 | 1111 | Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``. |
|
1112 | 1112 | |
|
1113 | 1113 | When running on an old Python version, only ``tls1.0`` is allowed since |
|
1114 | 1114 | old versions of Python only support up to TLS 1.0. |
|
1115 | 1115 | |
|
1116 | 1116 | When running a Python that supports modern TLS versions, the default is |
|
1117 | 1117 | ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this |
|
1118 | 1118 | weakens security and should only be used as a feature of last resort if |
|
1119 | 1119 | a server does not support TLS 1.1+. |
|
1120 | 1120 | |
|
1121 | 1121 | Options in the ``[hostsecurity]`` section can have the form |
|
1122 | 1122 | ``hostname``:``setting``. This allows multiple settings to be defined on a |
|
1123 | 1123 | per-host basis. |
|
1124 | 1124 | |
|
1125 | 1125 | The following per-host settings can be defined. |
|
1126 | 1126 | |
|
1127 | 1127 | ``ciphers`` |
|
1128 | 1128 | This behaves like ``ciphers`` as described above except it only applies |
|
1129 | 1129 | to the host on which it is defined. |
|
1130 | 1130 | |
|
1131 | 1131 | ``fingerprints`` |
|
1132 | 1132 | A list of hashes of the DER encoded peer/remote certificate. Values have |
|
1133 | 1133 | the form ``algorithm``:``fingerprint``. e.g. |
|
1134 | 1134 | ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``. |
|
1135 | 1135 | In addition, colons (``:``) can appear in the fingerprint part. |
|
1136 | 1136 | |
|
1137 | 1137 | The following algorithms/prefixes are supported: ``sha1``, ``sha256``, |
|
1138 | 1138 | ``sha512``. |
|
1139 | 1139 | |
|
1140 | 1140 | Use of ``sha256`` or ``sha512`` is preferred. |
|
1141 | 1141 | |
|
1142 | 1142 | If a fingerprint is specified, the CA chain is not validated for this |
|
1143 | 1143 | host and Mercurial will require the remote certificate to match one |
|
1144 | 1144 | of the fingerprints specified. This means if the server updates its |
|
1145 | 1145 | certificate, Mercurial will abort until a new fingerprint is defined. |
|
1146 | 1146 | This can provide stronger security than traditional CA-based validation |
|
1147 | 1147 | at the expense of convenience. |
|
1148 | 1148 | |
|
1149 | 1149 | This option takes precedence over ``verifycertsfile``. |
|
1150 | 1150 | |
|
1151 | 1151 | ``minimumprotocol`` |
|
1152 | 1152 | This behaves like ``minimumprotocol`` as described above except it |
|
1153 | 1153 | only applies to the host on which it is defined. |
|
1154 | 1154 | |
|
1155 | 1155 | ``verifycertsfile`` |
|
1156 | 1156 | Path to file a containing a list of PEM encoded certificates used to |
|
1157 | 1157 | verify the server certificate. Environment variables and ``~user`` |
|
1158 | 1158 | constructs are expanded in the filename. |
|
1159 | 1159 | |
|
1160 | 1160 | The server certificate or the certificate's certificate authority (CA) |
|
1161 | 1161 | must match a certificate from this file or certificate verification |
|
1162 | 1162 | will fail and connections to the server will be refused. |
|
1163 | 1163 | |
|
1164 | 1164 | If defined, only certificates provided by this file will be used: |
|
1165 | 1165 | ``web.cacerts`` and any system/default certificates will not be |
|
1166 | 1166 | used. |
|
1167 | 1167 | |
|
1168 | 1168 | This option has no effect if the per-host ``fingerprints`` option |
|
1169 | 1169 | is set. |
|
1170 | 1170 | |
|
1171 | 1171 | The format of the file is as follows:: |
|
1172 | 1172 | |
|
1173 | 1173 | -----BEGIN CERTIFICATE----- |
|
1174 | 1174 | ... (certificate in base64 PEM encoding) ... |
|
1175 | 1175 | -----END CERTIFICATE----- |
|
1176 | 1176 | -----BEGIN CERTIFICATE----- |
|
1177 | 1177 | ... (certificate in base64 PEM encoding) ... |
|
1178 | 1178 | -----END CERTIFICATE----- |
|
1179 | 1179 | |
|
1180 | 1180 | For example:: |
|
1181 | 1181 | |
|
1182 | 1182 | [hostsecurity] |
|
1183 | 1183 | hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2 |
|
1184 | 1184 | 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 |
|
1185 | 1185 | 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 |
|
1186 | 1186 | foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem |
|
1187 | 1187 | |
|
1188 | 1188 | To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1 |
|
1189 | 1189 | when connecting to ``hg.example.com``:: |
|
1190 | 1190 | |
|
1191 | 1191 | [hostsecurity] |
|
1192 | 1192 | minimumprotocol = tls1.2 |
|
1193 | 1193 | hg.example.com:minimumprotocol = tls1.1 |
|
1194 | 1194 | |
|
1195 | 1195 | ``http_proxy`` |
|
1196 | 1196 | -------------- |
|
1197 | 1197 | |
|
1198 | 1198 | Used to access web-based Mercurial repositories through a HTTP |
|
1199 | 1199 | proxy. |
|
1200 | 1200 | |
|
1201 | 1201 | ``host`` |
|
1202 | 1202 | Host name and (optional) port of the proxy server, for example |
|
1203 | 1203 | "myproxy:8000". |
|
1204 | 1204 | |
|
1205 | 1205 | ``no`` |
|
1206 | 1206 | Optional. Comma-separated list of host names that should bypass |
|
1207 | 1207 | the proxy. |
|
1208 | 1208 | |
|
1209 | 1209 | ``passwd`` |
|
1210 | 1210 | Optional. Password to authenticate with at the proxy server. |
|
1211 | 1211 | |
|
1212 | 1212 | ``user`` |
|
1213 | 1213 | Optional. User name to authenticate with at the proxy server. |
|
1214 | 1214 | |
|
1215 | 1215 | ``always`` |
|
1216 | 1216 | Optional. Always use the proxy, even for localhost and any entries |
|
1217 | 1217 | in ``http_proxy.no``. (default: False) |
|
1218 | 1218 | |
|
1219 | 1219 | ``merge`` |
|
1220 | 1220 | --------- |
|
1221 | 1221 | |
|
1222 | 1222 | This section specifies behavior during merges and updates. |
|
1223 | 1223 | |
|
1224 | 1224 | ``checkignored`` |
|
1225 | 1225 | Controls behavior when an ignored file on disk has the same name as a tracked |
|
1226 | 1226 | file in the changeset being merged or updated to, and has different |
|
1227 | 1227 | contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``, |
|
1228 | 1228 | abort on such files. With ``warn``, warn on such files and back them up as |
|
1229 | 1229 | ``.orig``. With ``ignore``, don't print a warning and back them up as |
|
1230 | 1230 | ``.orig``. (default: ``abort``) |
|
1231 | 1231 | |
|
1232 | 1232 | ``checkunknown`` |
|
1233 | 1233 | Controls behavior when an unknown file that isn't ignored has the same name |
|
1234 | 1234 | as a tracked file in the changeset being merged or updated to, and has |
|
1235 | 1235 | different contents. Similar to ``merge.checkignored``, except for files that |
|
1236 | 1236 | are not ignored. (default: ``abort``) |
|
1237 | 1237 | |
|
1238 | 1238 | ``merge-patterns`` |
|
1239 | 1239 | ------------------ |
|
1240 | 1240 | |
|
1241 | 1241 | This section specifies merge tools to associate with particular file |
|
1242 | 1242 | patterns. Tools matched here will take precedence over the default |
|
1243 | 1243 | merge tool. Patterns are globs by default, rooted at the repository |
|
1244 | 1244 | root. |
|
1245 | 1245 | |
|
1246 | 1246 | Example:: |
|
1247 | 1247 | |
|
1248 | 1248 | [merge-patterns] |
|
1249 | 1249 | **.c = kdiff3 |
|
1250 | 1250 | **.jpg = myimgmerge |
|
1251 | 1251 | |
|
1252 | 1252 | ``merge-tools`` |
|
1253 | 1253 | --------------- |
|
1254 | 1254 | |
|
1255 | 1255 | This section configures external merge tools to use for file-level |
|
1256 | 1256 | merges. This section has likely been preconfigured at install time. |
|
1257 | 1257 | Use :hg:`config merge-tools` to check the existing configuration. |
|
1258 | 1258 | Also see :hg:`help merge-tools` for more details. |
|
1259 | 1259 | |
|
1260 | 1260 | Example ``~/.hgrc``:: |
|
1261 | 1261 | |
|
1262 | 1262 | [merge-tools] |
|
1263 | 1263 | # Override stock tool location |
|
1264 | 1264 | kdiff3.executable = ~/bin/kdiff3 |
|
1265 | 1265 | # Specify command line |
|
1266 | 1266 | kdiff3.args = $base $local $other -o $output |
|
1267 | 1267 | # Give higher priority |
|
1268 | 1268 | kdiff3.priority = 1 |
|
1269 | 1269 | |
|
1270 | 1270 | # Changing the priority of preconfigured tool |
|
1271 | 1271 | meld.priority = 0 |
|
1272 | 1272 | |
|
1273 | 1273 | # Disable a preconfigured tool |
|
1274 | 1274 | vimdiff.disabled = yes |
|
1275 | 1275 | |
|
1276 | 1276 | # Define new tool |
|
1277 | 1277 | myHtmlTool.args = -m $local $other $base $output |
|
1278 | 1278 | myHtmlTool.regkey = Software\FooSoftware\HtmlMerge |
|
1279 | 1279 | myHtmlTool.priority = 1 |
|
1280 | 1280 | |
|
1281 | 1281 | Supported arguments: |
|
1282 | 1282 | |
|
1283 | 1283 | ``priority`` |
|
1284 | 1284 | The priority in which to evaluate this tool. |
|
1285 | 1285 | (default: 0) |
|
1286 | 1286 | |
|
1287 | 1287 | ``executable`` |
|
1288 | 1288 | Either just the name of the executable or its pathname. |
|
1289 | 1289 | |
|
1290 | 1290 | .. container:: windows |
|
1291 | 1291 | |
|
1292 | 1292 | On Windows, the path can use environment variables with ${ProgramFiles} |
|
1293 | 1293 | syntax. |
|
1294 | 1294 | |
|
1295 | 1295 | (default: the tool name) |
|
1296 | 1296 | |
|
1297 | 1297 | ``args`` |
|
1298 | 1298 | The arguments to pass to the tool executable. You can refer to the |
|
1299 | 1299 | files being merged as well as the output file through these |
|
1300 | 1300 | variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning |
|
1301 | 1301 | of ``$local`` and ``$other`` can vary depending on which action is being |
|
1302 | 1302 | performed. During and update or merge, ``$local`` represents the original |
|
1303 | 1303 | state of the file, while ``$other`` represents the commit you are updating |
|
1304 | 1304 | to or the commit you are merging with. During a rebase ``$local`` |
|
1305 | 1305 | represents the destination of the rebase, and ``$other`` represents the |
|
1306 | 1306 | commit being rebased. |
|
1307 | 1307 | (default: ``$local $base $other``) |
|
1308 | 1308 | |
|
1309 | 1309 | ``premerge`` |
|
1310 | 1310 | Attempt to run internal non-interactive 3-way merge tool before |
|
1311 | 1311 | launching external tool. Options are ``true``, ``false``, ``keep`` or |
|
1312 | 1312 | ``keep-merge3``. The ``keep`` option will leave markers in the file if the |
|
1313 | 1313 | premerge fails. The ``keep-merge3`` will do the same but include information |
|
1314 | 1314 | about the base of the merge in the marker (see internal :merge3 in |
|
1315 | 1315 | :hg:`help merge-tools`). |
|
1316 | 1316 | (default: True) |
|
1317 | 1317 | |
|
1318 | 1318 | ``binary`` |
|
1319 | 1319 | This tool can merge binary files. (default: False, unless tool |
|
1320 | 1320 | was selected by file pattern match) |
|
1321 | 1321 | |
|
1322 | 1322 | ``symlink`` |
|
1323 | 1323 | This tool can merge symlinks. (default: False) |
|
1324 | 1324 | |
|
1325 | 1325 | ``check`` |
|
1326 | 1326 | A list of merge success-checking options: |
|
1327 | 1327 | |
|
1328 | 1328 | ``changed`` |
|
1329 | 1329 | Ask whether merge was successful when the merged file shows no changes. |
|
1330 | 1330 | ``conflicts`` |
|
1331 | 1331 | Check whether there are conflicts even though the tool reported success. |
|
1332 | 1332 | ``prompt`` |
|
1333 | 1333 | Always prompt for merge success, regardless of success reported by tool. |
|
1334 | 1334 | |
|
1335 | 1335 | ``fixeol`` |
|
1336 | 1336 | Attempt to fix up EOL changes caused by the merge tool. |
|
1337 | 1337 | (default: False) |
|
1338 | 1338 | |
|
1339 | 1339 | ``gui`` |
|
1340 | 1340 | This tool requires a graphical interface to run. (default: False) |
|
1341 | 1341 | |
|
1342 | 1342 | .. container:: windows |
|
1343 | 1343 | |
|
1344 | 1344 | ``regkey`` |
|
1345 | 1345 | Windows registry key which describes install location of this |
|
1346 | 1346 | tool. Mercurial will search for this key first under |
|
1347 | 1347 | ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``. |
|
1348 | 1348 | (default: None) |
|
1349 | 1349 | |
|
1350 | 1350 | ``regkeyalt`` |
|
1351 | 1351 | An alternate Windows registry key to try if the first key is not |
|
1352 | 1352 | found. The alternate key uses the same ``regname`` and ``regappend`` |
|
1353 | 1353 | semantics of the primary key. The most common use for this key |
|
1354 | 1354 | is to search for 32bit applications on 64bit operating systems. |
|
1355 | 1355 | (default: None) |
|
1356 | 1356 | |
|
1357 | 1357 | ``regname`` |
|
1358 | 1358 | Name of value to read from specified registry key. |
|
1359 | 1359 | (default: the unnamed (default) value) |
|
1360 | 1360 | |
|
1361 | 1361 | ``regappend`` |
|
1362 | 1362 | String to append to the value read from the registry, typically |
|
1363 | 1363 | the executable name of the tool. |
|
1364 | 1364 | (default: None) |
|
1365 | 1365 | |
|
1366 | 1366 | ``pager`` |
|
1367 | 1367 | --------- |
|
1368 | 1368 | |
|
1369 | 1369 | Setting used to control when to paginate and with what external tool. See |
|
1370 | 1370 | :hg:`help pager` for details. |
|
1371 | 1371 | |
|
1372 | 1372 | ``pager`` |
|
1373 | 1373 | Define the external tool used as pager. |
|
1374 | 1374 | |
|
1375 | 1375 | If no pager is set, Mercurial uses the environment variable $PAGER. |
|
1376 | 1376 | If neither pager.pager, nor $PAGER is set, a default pager will be |
|
1377 | 1377 | used, typically `less` on Unix and `more` on Windows. Example:: |
|
1378 | 1378 | |
|
1379 | 1379 | [pager] |
|
1380 | 1380 | pager = less -FRX |
|
1381 | 1381 | |
|
1382 | 1382 | ``ignore`` |
|
1383 | 1383 | List of commands to disable the pager for. Example:: |
|
1384 | 1384 | |
|
1385 | 1385 | [pager] |
|
1386 | 1386 | ignore = version, help, update |
|
1387 | 1387 | |
|
1388 | 1388 | ``patch`` |
|
1389 | 1389 | --------- |
|
1390 | 1390 | |
|
1391 | 1391 | Settings used when applying patches, for instance through the 'import' |
|
1392 | 1392 | command or with Mercurial Queues extension. |
|
1393 | 1393 | |
|
1394 | 1394 | ``eol`` |
|
1395 | 1395 | When set to 'strict' patch content and patched files end of lines |
|
1396 | 1396 | are preserved. When set to ``lf`` or ``crlf``, both files end of |
|
1397 | 1397 | lines are ignored when patching and the result line endings are |
|
1398 | 1398 | normalized to either LF (Unix) or CRLF (Windows). When set to |
|
1399 | 1399 | ``auto``, end of lines are again ignored while patching but line |
|
1400 | 1400 | endings in patched files are normalized to their original setting |
|
1401 | 1401 | on a per-file basis. If target file does not exist or has no end |
|
1402 | 1402 | of line, patch line endings are preserved. |
|
1403 | 1403 | (default: strict) |
|
1404 | 1404 | |
|
1405 | 1405 | ``fuzz`` |
|
1406 | 1406 | The number of lines of 'fuzz' to allow when applying patches. This |
|
1407 | 1407 | controls how much context the patcher is allowed to ignore when |
|
1408 | 1408 | trying to apply a patch. |
|
1409 | 1409 | (default: 2) |
|
1410 | 1410 | |
|
1411 | 1411 | ``paths`` |
|
1412 | 1412 | --------- |
|
1413 | 1413 | |
|
1414 | 1414 | Assigns symbolic names and behavior to repositories. |
|
1415 | 1415 | |
|
1416 | 1416 | Options are symbolic names defining the URL or directory that is the |
|
1417 | 1417 | location of the repository. Example:: |
|
1418 | 1418 | |
|
1419 | 1419 | [paths] |
|
1420 | 1420 | my_server = https://example.com/my_repo |
|
1421 | 1421 | local_path = /home/me/repo |
|
1422 | 1422 | |
|
1423 | 1423 | These symbolic names can be used from the command line. To pull |
|
1424 | 1424 | from ``my_server``: :hg:`pull my_server`. To push to ``local_path``: |
|
1425 | 1425 | :hg:`push local_path`. |
|
1426 | 1426 | |
|
1427 | 1427 | Options containing colons (``:``) denote sub-options that can influence |
|
1428 | 1428 | behavior for that specific path. Example:: |
|
1429 | 1429 | |
|
1430 | 1430 | [paths] |
|
1431 | 1431 | my_server = https://example.com/my_path |
|
1432 | 1432 | my_server:pushurl = ssh://example.com/my_path |
|
1433 | 1433 | |
|
1434 | 1434 | The following sub-options can be defined: |
|
1435 | 1435 | |
|
1436 | 1436 | ``pushurl`` |
|
1437 | 1437 | The URL to use for push operations. If not defined, the location |
|
1438 | 1438 | defined by the path's main entry is used. |
|
1439 | 1439 | |
|
1440 | 1440 | ``pushrev`` |
|
1441 | 1441 | A revset defining which revisions to push by default. |
|
1442 | 1442 | |
|
1443 | 1443 | When :hg:`push` is executed without a ``-r`` argument, the revset |
|
1444 | 1444 | defined by this sub-option is evaluated to determine what to push. |
|
1445 | 1445 | |
|
1446 | 1446 | For example, a value of ``.`` will push the working directory's |
|
1447 | 1447 | revision by default. |
|
1448 | 1448 | |
|
1449 | 1449 | Revsets specifying bookmarks will not result in the bookmark being |
|
1450 | 1450 | pushed. |
|
1451 | 1451 | |
|
1452 | 1452 | The following special named paths exist: |
|
1453 | 1453 | |
|
1454 | 1454 | ``default`` |
|
1455 | 1455 | The URL or directory to use when no source or remote is specified. |
|
1456 | 1456 | |
|
1457 | 1457 | :hg:`clone` will automatically define this path to the location the |
|
1458 | 1458 | repository was cloned from. |
|
1459 | 1459 | |
|
1460 | 1460 | ``default-push`` |
|
1461 | 1461 | (deprecated) The URL or directory for the default :hg:`push` location. |
|
1462 | 1462 | ``default:pushurl`` should be used instead. |
|
1463 | 1463 | |
|
1464 | 1464 | ``phases`` |
|
1465 | 1465 | ---------- |
|
1466 | 1466 | |
|
1467 | 1467 | Specifies default handling of phases. See :hg:`help phases` for more |
|
1468 | 1468 | information about working with phases. |
|
1469 | 1469 | |
|
1470 | 1470 | ``publish`` |
|
1471 | 1471 | Controls draft phase behavior when working as a server. When true, |
|
1472 | 1472 | pushed changesets are set to public in both client and server and |
|
1473 | 1473 | pulled or cloned changesets are set to public in the client. |
|
1474 | 1474 | (default: True) |
|
1475 | 1475 | |
|
1476 | 1476 | ``new-commit`` |
|
1477 | 1477 | Phase of newly-created commits. |
|
1478 | 1478 | (default: draft) |
|
1479 | 1479 | |
|
1480 | 1480 | ``checksubrepos`` |
|
1481 | 1481 | Check the phase of the current revision of each subrepository. Allowed |
|
1482 | 1482 | values are "ignore", "follow" and "abort". For settings other than |
|
1483 | 1483 | "ignore", the phase of the current revision of each subrepository is |
|
1484 | 1484 | checked before committing the parent repository. If any of those phases is |
|
1485 | 1485 | greater than the phase of the parent repository (e.g. if a subrepo is in a |
|
1486 | 1486 | "secret" phase while the parent repo is in "draft" phase), the commit is |
|
1487 | 1487 | either aborted (if checksubrepos is set to "abort") or the higher phase is |
|
1488 | 1488 | used for the parent repository commit (if set to "follow"). |
|
1489 | 1489 | (default: follow) |
|
1490 | 1490 | |
|
1491 | 1491 | |
|
1492 | 1492 | ``profiling`` |
|
1493 | 1493 | ------------- |
|
1494 | 1494 | |
|
1495 | 1495 | Specifies profiling type, format, and file output. Two profilers are |
|
1496 | 1496 | supported: an instrumenting profiler (named ``ls``), and a sampling |
|
1497 | 1497 | profiler (named ``stat``). |
|
1498 | 1498 | |
|
1499 | 1499 | In this section description, 'profiling data' stands for the raw data |
|
1500 | 1500 | collected during profiling, while 'profiling report' stands for a |
|
1501 | 1501 | statistical text report generated from the profiling data. The |
|
1502 | 1502 | profiling is done using lsprof. |
|
1503 | 1503 | |
|
1504 | 1504 | ``enabled`` |
|
1505 | 1505 | Enable the profiler. |
|
1506 | 1506 | (default: false) |
|
1507 | 1507 | |
|
1508 | 1508 | This is equivalent to passing ``--profile`` on the command line. |
|
1509 | 1509 | |
|
1510 | 1510 | ``type`` |
|
1511 | 1511 | The type of profiler to use. |
|
1512 | 1512 | (default: stat) |
|
1513 | 1513 | |
|
1514 | 1514 | ``ls`` |
|
1515 | 1515 | Use Python's built-in instrumenting profiler. This profiler |
|
1516 | 1516 | works on all platforms, but each line number it reports is the |
|
1517 | 1517 | first line of a function. This restriction makes it difficult to |
|
1518 | 1518 | identify the expensive parts of a non-trivial function. |
|
1519 | 1519 | ``stat`` |
|
1520 | 1520 | Use a statistical profiler, statprof. This profiler is most |
|
1521 | 1521 | useful for profiling commands that run for longer than about 0.1 |
|
1522 | 1522 | seconds. |
|
1523 | 1523 | |
|
1524 | 1524 | ``format`` |
|
1525 | 1525 | Profiling format. Specific to the ``ls`` instrumenting profiler. |
|
1526 | 1526 | (default: text) |
|
1527 | 1527 | |
|
1528 | 1528 | ``text`` |
|
1529 | 1529 | Generate a profiling report. When saving to a file, it should be |
|
1530 | 1530 | noted that only the report is saved, and the profiling data is |
|
1531 | 1531 | not kept. |
|
1532 | 1532 | ``kcachegrind`` |
|
1533 | 1533 | Format profiling data for kcachegrind use: when saving to a |
|
1534 | 1534 | file, the generated file can directly be loaded into |
|
1535 | 1535 | kcachegrind. |
|
1536 | 1536 | |
|
1537 | 1537 | ``statformat`` |
|
1538 | 1538 | Profiling format for the ``stat`` profiler. |
|
1539 | 1539 | (default: hotpath) |
|
1540 | 1540 | |
|
1541 | 1541 | ``hotpath`` |
|
1542 | 1542 | Show a tree-based display containing the hot path of execution (where |
|
1543 | 1543 | most time was spent). |
|
1544 | 1544 | ``bymethod`` |
|
1545 | 1545 | Show a table of methods ordered by how frequently they are active. |
|
1546 | 1546 | ``byline`` |
|
1547 | 1547 | Show a table of lines in files ordered by how frequently they are active. |
|
1548 | 1548 | ``json`` |
|
1549 | 1549 | Render profiling data as JSON. |
|
1550 | 1550 | |
|
1551 | 1551 | ``frequency`` |
|
1552 | 1552 | Sampling frequency. Specific to the ``stat`` sampling profiler. |
|
1553 | 1553 | (default: 1000) |
|
1554 | 1554 | |
|
1555 | 1555 | ``output`` |
|
1556 | 1556 | File path where profiling data or report should be saved. If the |
|
1557 | 1557 | file exists, it is replaced. (default: None, data is printed on |
|
1558 | 1558 | stderr) |
|
1559 | 1559 | |
|
1560 | 1560 | ``sort`` |
|
1561 | 1561 | Sort field. Specific to the ``ls`` instrumenting profiler. |
|
1562 | 1562 | One of ``callcount``, ``reccallcount``, ``totaltime`` and |
|
1563 | 1563 | ``inlinetime``. |
|
1564 | 1564 | (default: inlinetime) |
|
1565 | 1565 | |
|
1566 | 1566 | ``limit`` |
|
1567 | 1567 | Number of lines to show. Specific to the ``ls`` instrumenting profiler. |
|
1568 | 1568 | (default: 30) |
|
1569 | 1569 | |
|
1570 | 1570 | ``nested`` |
|
1571 | 1571 | Show at most this number of lines of drill-down info after each main entry. |
|
1572 | 1572 | This can help explain the difference between Total and Inline. |
|
1573 | 1573 | Specific to the ``ls`` instrumenting profiler. |
|
1574 | 1574 | (default: 5) |
|
1575 | 1575 | |
|
1576 | 1576 | ``progress`` |
|
1577 | 1577 | ------------ |
|
1578 | 1578 | |
|
1579 | 1579 | Mercurial commands can draw progress bars that are as informative as |
|
1580 | 1580 | possible. Some progress bars only offer indeterminate information, while others |
|
1581 | 1581 | have a definite end point. |
|
1582 | 1582 | |
|
1583 | 1583 | ``delay`` |
|
1584 | 1584 | Number of seconds (float) before showing the progress bar. (default: 3) |
|
1585 | 1585 | |
|
1586 | 1586 | ``changedelay`` |
|
1587 | 1587 | Minimum delay before showing a new topic. When set to less than 3 * refresh, |
|
1588 | 1588 | that value will be used instead. (default: 1) |
|
1589 | 1589 | |
|
1590 | 1590 | ``refresh`` |
|
1591 | 1591 | Time in seconds between refreshes of the progress bar. (default: 0.1) |
|
1592 | 1592 | |
|
1593 | 1593 | ``format`` |
|
1594 | 1594 | Format of the progress bar. |
|
1595 | 1595 | |
|
1596 | 1596 | Valid entries for the format field are ``topic``, ``bar``, ``number``, |
|
1597 | 1597 | ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the |
|
1598 | 1598 | last 20 characters of the item, but this can be changed by adding either |
|
1599 | 1599 | ``-<num>`` which would take the last num characters, or ``+<num>`` for the |
|
1600 | 1600 | first num characters. |
|
1601 | 1601 | |
|
1602 | 1602 | (default: topic bar number estimate) |
|
1603 | 1603 | |
|
1604 | 1604 | ``width`` |
|
1605 | 1605 | If set, the maximum width of the progress information (that is, min(width, |
|
1606 | 1606 | term width) will be used). |
|
1607 | 1607 | |
|
1608 | 1608 | ``clear-complete`` |
|
1609 | 1609 | Clear the progress bar after it's done. (default: True) |
|
1610 | 1610 | |
|
1611 | 1611 | ``disable`` |
|
1612 | 1612 | If true, don't show a progress bar. |
|
1613 | 1613 | |
|
1614 | 1614 | ``assume-tty`` |
|
1615 | 1615 | If true, ALWAYS show a progress bar, unless disable is given. |
|
1616 | 1616 | |
|
1617 | 1617 | ``rebase`` |
|
1618 | 1618 | ---------- |
|
1619 | 1619 | |
|
1620 | 1620 | ``allowdivergence`` |
|
1621 | 1621 | Default to False, when True allow creating divergence when performing |
|
1622 | 1622 | rebase of obsolete changesets. |
|
1623 | 1623 | |
|
1624 | 1624 | ``revsetalias`` |
|
1625 | 1625 | --------------- |
|
1626 | 1626 | |
|
1627 | 1627 | Alias definitions for revsets. See :hg:`help revsets` for details. |
|
1628 | 1628 | |
|
1629 | 1629 | ``server`` |
|
1630 | 1630 | ---------- |
|
1631 | 1631 | |
|
1632 | 1632 | Controls generic server settings. |
|
1633 | 1633 | |
|
1634 | 1634 | ``compressionengines`` |
|
1635 | 1635 | List of compression engines and their relative priority to advertise |
|
1636 | 1636 | to clients. |
|
1637 | 1637 | |
|
1638 | 1638 | The order of compression engines determines their priority, the first |
|
1639 | 1639 | having the highest priority. If a compression engine is not listed |
|
1640 | 1640 | here, it won't be advertised to clients. |
|
1641 | 1641 | |
|
1642 | 1642 | If not set (the default), built-in defaults are used. Run |
|
1643 | 1643 | :hg:`debuginstall` to list available compression engines and their |
|
1644 | 1644 | default wire protocol priority. |
|
1645 | 1645 | |
|
1646 | 1646 | Older Mercurial clients only support zlib compression and this setting |
|
1647 | 1647 | has no effect for legacy clients. |
|
1648 | 1648 | |
|
1649 | 1649 | ``uncompressed`` |
|
1650 | 1650 | Whether to allow clients to clone a repository using the |
|
1651 | 1651 | uncompressed streaming protocol. This transfers about 40% more |
|
1652 | 1652 | data than a regular clone, but uses less memory and CPU on both |
|
1653 | 1653 | server and client. Over a LAN (100 Mbps or better) or a very fast |
|
1654 | 1654 | WAN, an uncompressed streaming clone is a lot faster (~10x) than a |
|
1655 | 1655 | regular clone. Over most WAN connections (anything slower than |
|
1656 | 1656 | about 6 Mbps), uncompressed streaming is slower, because of the |
|
1657 | 1657 | extra data transfer overhead. This mode will also temporarily hold |
|
1658 | 1658 | the write lock while determining what data to transfer. |
|
1659 | 1659 | (default: True) |
|
1660 | 1660 | |
|
1661 | ``uncompressedallowsecret`` | |
|
1662 | Whether to allow stream clones when the repository contains secret | |
|
1663 | changesets. (default: False) | |
|
1664 | ||
|
1661 | 1665 | ``preferuncompressed`` |
|
1662 | 1666 | When set, clients will try to use the uncompressed streaming |
|
1663 | 1667 | protocol. (default: False) |
|
1664 | 1668 | |
|
1665 | 1669 | ``disablefullbundle`` |
|
1666 | 1670 | When set, servers will refuse attempts to do pull-based clones. |
|
1667 | 1671 | If this option is set, ``preferuncompressed`` and/or clone bundles |
|
1668 | 1672 | are highly recommended. Partial clones will still be allowed. |
|
1669 | 1673 | (default: False) |
|
1670 | 1674 | |
|
1671 | 1675 | ``validate`` |
|
1672 | 1676 | Whether to validate the completeness of pushed changesets by |
|
1673 | 1677 | checking that all new file revisions specified in manifests are |
|
1674 | 1678 | present. (default: False) |
|
1675 | 1679 | |
|
1676 | 1680 | ``maxhttpheaderlen`` |
|
1677 | 1681 | Instruct HTTP clients not to send request headers longer than this |
|
1678 | 1682 | many bytes. (default: 1024) |
|
1679 | 1683 | |
|
1680 | 1684 | ``bundle1`` |
|
1681 | 1685 | Whether to allow clients to push and pull using the legacy bundle1 |
|
1682 | 1686 | exchange format. (default: True) |
|
1683 | 1687 | |
|
1684 | 1688 | ``bundle1gd`` |
|
1685 | 1689 | Like ``bundle1`` but only used if the repository is using the |
|
1686 | 1690 | *generaldelta* storage format. (default: True) |
|
1687 | 1691 | |
|
1688 | 1692 | ``bundle1.push`` |
|
1689 | 1693 | Whether to allow clients to push using the legacy bundle1 exchange |
|
1690 | 1694 | format. (default: True) |
|
1691 | 1695 | |
|
1692 | 1696 | ``bundle1gd.push`` |
|
1693 | 1697 | Like ``bundle1.push`` but only used if the repository is using the |
|
1694 | 1698 | *generaldelta* storage format. (default: True) |
|
1695 | 1699 | |
|
1696 | 1700 | ``bundle1.pull`` |
|
1697 | 1701 | Whether to allow clients to pull using the legacy bundle1 exchange |
|
1698 | 1702 | format. (default: True) |
|
1699 | 1703 | |
|
1700 | 1704 | ``bundle1gd.pull`` |
|
1701 | 1705 | Like ``bundle1.pull`` but only used if the repository is using the |
|
1702 | 1706 | *generaldelta* storage format. (default: True) |
|
1703 | 1707 | |
|
1704 | 1708 | Large repositories using the *generaldelta* storage format should |
|
1705 | 1709 | consider setting this option because converting *generaldelta* |
|
1706 | 1710 | repositories to the exchange format required by the bundle1 data |
|
1707 | 1711 | format can consume a lot of CPU. |
|
1708 | 1712 | |
|
1709 | 1713 | ``zliblevel`` |
|
1710 | 1714 | Integer between ``-1`` and ``9`` that controls the zlib compression level |
|
1711 | 1715 | for wire protocol commands that send zlib compressed output (notably the |
|
1712 | 1716 | commands that send repository history data). |
|
1713 | 1717 | |
|
1714 | 1718 | The default (``-1``) uses the default zlib compression level, which is |
|
1715 | 1719 | likely equivalent to ``6``. ``0`` means no compression. ``9`` means |
|
1716 | 1720 | maximum compression. |
|
1717 | 1721 | |
|
1718 | 1722 | Setting this option allows server operators to make trade-offs between |
|
1719 | 1723 | bandwidth and CPU used. Lowering the compression lowers CPU utilization |
|
1720 | 1724 | but sends more bytes to clients. |
|
1721 | 1725 | |
|
1722 | 1726 | This option only impacts the HTTP server. |
|
1723 | 1727 | |
|
1724 | 1728 | ``zstdlevel`` |
|
1725 | 1729 | Integer between ``1`` and ``22`` that controls the zstd compression level |
|
1726 | 1730 | for wire protocol commands. ``1`` is the minimal amount of compression and |
|
1727 | 1731 | ``22`` is the highest amount of compression. |
|
1728 | 1732 | |
|
1729 | 1733 | The default (``3``) should be significantly faster than zlib while likely |
|
1730 | 1734 | delivering better compression ratios. |
|
1731 | 1735 | |
|
1732 | 1736 | This option only impacts the HTTP server. |
|
1733 | 1737 | |
|
1734 | 1738 | See also ``server.zliblevel``. |
|
1735 | 1739 | |
|
1736 | 1740 | ``smtp`` |
|
1737 | 1741 | -------- |
|
1738 | 1742 | |
|
1739 | 1743 | Configuration for extensions that need to send email messages. |
|
1740 | 1744 | |
|
1741 | 1745 | ``host`` |
|
1742 | 1746 | Host name of mail server, e.g. "mail.example.com". |
|
1743 | 1747 | |
|
1744 | 1748 | ``port`` |
|
1745 | 1749 | Optional. Port to connect to on mail server. (default: 465 if |
|
1746 | 1750 | ``tls`` is smtps; 25 otherwise) |
|
1747 | 1751 | |
|
1748 | 1752 | ``tls`` |
|
1749 | 1753 | Optional. Method to enable TLS when connecting to mail server: starttls, |
|
1750 | 1754 | smtps or none. (default: none) |
|
1751 | 1755 | |
|
1752 | 1756 | ``username`` |
|
1753 | 1757 | Optional. User name for authenticating with the SMTP server. |
|
1754 | 1758 | (default: None) |
|
1755 | 1759 | |
|
1756 | 1760 | ``password`` |
|
1757 | 1761 | Optional. Password for authenticating with the SMTP server. If not |
|
1758 | 1762 | specified, interactive sessions will prompt the user for a |
|
1759 | 1763 | password; non-interactive sessions will fail. (default: None) |
|
1760 | 1764 | |
|
1761 | 1765 | ``local_hostname`` |
|
1762 | 1766 | Optional. The hostname that the sender can use to identify |
|
1763 | 1767 | itself to the MTA. |
|
1764 | 1768 | |
|
1765 | 1769 | |
|
1766 | 1770 | ``subpaths`` |
|
1767 | 1771 | ------------ |
|
1768 | 1772 | |
|
1769 | 1773 | Subrepository source URLs can go stale if a remote server changes name |
|
1770 | 1774 | or becomes temporarily unavailable. This section lets you define |
|
1771 | 1775 | rewrite rules of the form:: |
|
1772 | 1776 | |
|
1773 | 1777 | <pattern> = <replacement> |
|
1774 | 1778 | |
|
1775 | 1779 | where ``pattern`` is a regular expression matching a subrepository |
|
1776 | 1780 | source URL and ``replacement`` is the replacement string used to |
|
1777 | 1781 | rewrite it. Groups can be matched in ``pattern`` and referenced in |
|
1778 | 1782 | ``replacements``. For instance:: |
|
1779 | 1783 | |
|
1780 | 1784 | http://server/(.*)-hg/ = http://hg.server/\1/ |
|
1781 | 1785 | |
|
1782 | 1786 | rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``. |
|
1783 | 1787 | |
|
1784 | 1788 | Relative subrepository paths are first made absolute, and the |
|
1785 | 1789 | rewrite rules are then applied on the full (absolute) path. If ``pattern`` |
|
1786 | 1790 | doesn't match the full path, an attempt is made to apply it on the |
|
1787 | 1791 | relative path alone. The rules are applied in definition order. |
|
1788 | 1792 | |
|
1789 | 1793 | ``templatealias`` |
|
1790 | 1794 | ----------------- |
|
1791 | 1795 | |
|
1792 | 1796 | Alias definitions for templates. See :hg:`help templates` for details. |
|
1793 | 1797 | |
|
1794 | 1798 | ``templates`` |
|
1795 | 1799 | ------------- |
|
1796 | 1800 | |
|
1797 | 1801 | Use the ``[templates]`` section to define template strings. |
|
1798 | 1802 | See :hg:`help templates` for details. |
|
1799 | 1803 | |
|
1800 | 1804 | ``trusted`` |
|
1801 | 1805 | ----------- |
|
1802 | 1806 | |
|
1803 | 1807 | Mercurial will not use the settings in the |
|
1804 | 1808 | ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted |
|
1805 | 1809 | user or to a trusted group, as various hgrc features allow arbitrary |
|
1806 | 1810 | commands to be run. This issue is often encountered when configuring |
|
1807 | 1811 | hooks or extensions for shared repositories or servers. However, |
|
1808 | 1812 | the web interface will use some safe settings from the ``[web]`` |
|
1809 | 1813 | section. |
|
1810 | 1814 | |
|
1811 | 1815 | This section specifies what users and groups are trusted. The |
|
1812 | 1816 | current user is always trusted. To trust everybody, list a user or a |
|
1813 | 1817 | group with name ``*``. These settings must be placed in an |
|
1814 | 1818 | *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the |
|
1815 | 1819 | user or service running Mercurial. |
|
1816 | 1820 | |
|
1817 | 1821 | ``users`` |
|
1818 | 1822 | Comma-separated list of trusted users. |
|
1819 | 1823 | |
|
1820 | 1824 | ``groups`` |
|
1821 | 1825 | Comma-separated list of trusted groups. |
|
1822 | 1826 | |
|
1823 | 1827 | |
|
1824 | 1828 | ``ui`` |
|
1825 | 1829 | ------ |
|
1826 | 1830 | |
|
1827 | 1831 | User interface controls. |
|
1828 | 1832 | |
|
1829 | 1833 | ``archivemeta`` |
|
1830 | 1834 | Whether to include the .hg_archival.txt file containing meta data |
|
1831 | 1835 | (hashes for the repository base and for tip) in archives created |
|
1832 | 1836 | by the :hg:`archive` command or downloaded via hgweb. |
|
1833 | 1837 | (default: True) |
|
1834 | 1838 | |
|
1835 | 1839 | ``askusername`` |
|
1836 | 1840 | Whether to prompt for a username when committing. If True, and |
|
1837 | 1841 | neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will |
|
1838 | 1842 | be prompted to enter a username. If no username is entered, the |
|
1839 | 1843 | default ``USER@HOST`` is used instead. |
|
1840 | 1844 | (default: False) |
|
1841 | 1845 | |
|
1842 | 1846 | ``clonebundles`` |
|
1843 | 1847 | Whether the "clone bundles" feature is enabled. |
|
1844 | 1848 | |
|
1845 | 1849 | When enabled, :hg:`clone` may download and apply a server-advertised |
|
1846 | 1850 | bundle file from a URL instead of using the normal exchange mechanism. |
|
1847 | 1851 | |
|
1848 | 1852 | This can likely result in faster and more reliable clones. |
|
1849 | 1853 | |
|
1850 | 1854 | (default: True) |
|
1851 | 1855 | |
|
1852 | 1856 | ``clonebundlefallback`` |
|
1853 | 1857 | Whether failure to apply an advertised "clone bundle" from a server |
|
1854 | 1858 | should result in fallback to a regular clone. |
|
1855 | 1859 | |
|
1856 | 1860 | This is disabled by default because servers advertising "clone |
|
1857 | 1861 | bundles" often do so to reduce server load. If advertised bundles |
|
1858 | 1862 | start mass failing and clients automatically fall back to a regular |
|
1859 | 1863 | clone, this would add significant and unexpected load to the server |
|
1860 | 1864 | since the server is expecting clone operations to be offloaded to |
|
1861 | 1865 | pre-generated bundles. Failing fast (the default behavior) ensures |
|
1862 | 1866 | clients don't overwhelm the server when "clone bundle" application |
|
1863 | 1867 | fails. |
|
1864 | 1868 | |
|
1865 | 1869 | (default: False) |
|
1866 | 1870 | |
|
1867 | 1871 | ``clonebundleprefers`` |
|
1868 | 1872 | Defines preferences for which "clone bundles" to use. |
|
1869 | 1873 | |
|
1870 | 1874 | Servers advertising "clone bundles" may advertise multiple available |
|
1871 | 1875 | bundles. Each bundle may have different attributes, such as the bundle |
|
1872 | 1876 | type and compression format. This option is used to prefer a particular |
|
1873 | 1877 | bundle over another. |
|
1874 | 1878 | |
|
1875 | 1879 | The following keys are defined by Mercurial: |
|
1876 | 1880 | |
|
1877 | 1881 | BUNDLESPEC |
|
1878 | 1882 | A bundle type specifier. These are strings passed to :hg:`bundle -t`. |
|
1879 | 1883 | e.g. ``gzip-v2`` or ``bzip2-v1``. |
|
1880 | 1884 | |
|
1881 | 1885 | COMPRESSION |
|
1882 | 1886 | The compression format of the bundle. e.g. ``gzip`` and ``bzip2``. |
|
1883 | 1887 | |
|
1884 | 1888 | Server operators may define custom keys. |
|
1885 | 1889 | |
|
1886 | 1890 | Example values: ``COMPRESSION=bzip2``, |
|
1887 | 1891 | ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``. |
|
1888 | 1892 | |
|
1889 | 1893 | By default, the first bundle advertised by the server is used. |
|
1890 | 1894 | |
|
1891 | 1895 | ``color`` |
|
1892 | 1896 | When to colorize output. Possible value are Boolean ("yes" or "no"), or |
|
1893 | 1897 | "debug", or "always". (default: "yes"). "yes" will use color whenever it |
|
1894 | 1898 | seems possible. See :hg:`help color` for details. |
|
1895 | 1899 | |
|
1896 | 1900 | ``commitsubrepos`` |
|
1897 | 1901 | Whether to commit modified subrepositories when committing the |
|
1898 | 1902 | parent repository. If False and one subrepository has uncommitted |
|
1899 | 1903 | changes, abort the commit. |
|
1900 | 1904 | (default: False) |
|
1901 | 1905 | |
|
1902 | 1906 | ``debug`` |
|
1903 | 1907 | Print debugging information. (default: False) |
|
1904 | 1908 | |
|
1905 | 1909 | ``editor`` |
|
1906 | 1910 | The editor to use during a commit. (default: ``$EDITOR`` or ``vi``) |
|
1907 | 1911 | |
|
1908 | 1912 | ``fallbackencoding`` |
|
1909 | 1913 | Encoding to try if it's not possible to decode the changelog using |
|
1910 | 1914 | UTF-8. (default: ISO-8859-1) |
|
1911 | 1915 | |
|
1912 | 1916 | ``graphnodetemplate`` |
|
1913 | 1917 | The template used to print changeset nodes in an ASCII revision graph. |
|
1914 | 1918 | (default: ``{graphnode}``) |
|
1915 | 1919 | |
|
1916 | 1920 | ``ignore`` |
|
1917 | 1921 | A file to read per-user ignore patterns from. This file should be |
|
1918 | 1922 | in the same format as a repository-wide .hgignore file. Filenames |
|
1919 | 1923 | are relative to the repository root. This option supports hook syntax, |
|
1920 | 1924 | so if you want to specify multiple ignore files, you can do so by |
|
1921 | 1925 | setting something like ``ignore.other = ~/.hgignore2``. For details |
|
1922 | 1926 | of the ignore file format, see the ``hgignore(5)`` man page. |
|
1923 | 1927 | |
|
1924 | 1928 | ``interactive`` |
|
1925 | 1929 | Allow to prompt the user. (default: True) |
|
1926 | 1930 | |
|
1927 | 1931 | ``interface`` |
|
1928 | 1932 | Select the default interface for interactive features (default: text). |
|
1929 | 1933 | Possible values are 'text' and 'curses'. |
|
1930 | 1934 | |
|
1931 | 1935 | ``interface.chunkselector`` |
|
1932 | 1936 | Select the interface for change recording (e.g. :hg:`commit -i`). |
|
1933 | 1937 | Possible values are 'text' and 'curses'. |
|
1934 | 1938 | This config overrides the interface specified by ui.interface. |
|
1935 | 1939 | |
|
1936 | 1940 | ``logtemplate`` |
|
1937 | 1941 | Template string for commands that print changesets. |
|
1938 | 1942 | |
|
1939 | 1943 | ``merge`` |
|
1940 | 1944 | The conflict resolution program to use during a manual merge. |
|
1941 | 1945 | For more information on merge tools see :hg:`help merge-tools`. |
|
1942 | 1946 | For configuring merge tools see the ``[merge-tools]`` section. |
|
1943 | 1947 | |
|
1944 | 1948 | ``mergemarkers`` |
|
1945 | 1949 | Sets the merge conflict marker label styling. The ``detailed`` |
|
1946 | 1950 | style uses the ``mergemarkertemplate`` setting to style the labels. |
|
1947 | 1951 | The ``basic`` style just uses 'local' and 'other' as the marker label. |
|
1948 | 1952 | One of ``basic`` or ``detailed``. |
|
1949 | 1953 | (default: ``basic``) |
|
1950 | 1954 | |
|
1951 | 1955 | ``mergemarkertemplate`` |
|
1952 | 1956 | The template used to print the commit description next to each conflict |
|
1953 | 1957 | marker during merge conflicts. See :hg:`help templates` for the template |
|
1954 | 1958 | format. |
|
1955 | 1959 | |
|
1956 | 1960 | Defaults to showing the hash, tags, branches, bookmarks, author, and |
|
1957 | 1961 | the first line of the commit description. |
|
1958 | 1962 | |
|
1959 | 1963 | If you use non-ASCII characters in names for tags, branches, bookmarks, |
|
1960 | 1964 | authors, and/or commit descriptions, you must pay attention to encodings of |
|
1961 | 1965 | managed files. At template expansion, non-ASCII characters use the encoding |
|
1962 | 1966 | specified by the ``--encoding`` global option, ``HGENCODING`` or other |
|
1963 | 1967 | environment variables that govern your locale. If the encoding of the merge |
|
1964 | 1968 | markers is different from the encoding of the merged files, |
|
1965 | 1969 | serious problems may occur. |
|
1966 | 1970 | |
|
1967 | 1971 | ``origbackuppath`` |
|
1968 | 1972 | The path to a directory used to store generated .orig files. If the path is |
|
1969 | 1973 | not a directory, one will be created. |
|
1970 | 1974 | |
|
1971 | 1975 | ``paginate`` |
|
1972 | 1976 | Control the pagination of command output (default: True). See :hg:`help pager` |
|
1973 | 1977 | for details. |
|
1974 | 1978 | |
|
1975 | 1979 | ``patch`` |
|
1976 | 1980 | An optional external tool that ``hg import`` and some extensions |
|
1977 | 1981 | will use for applying patches. By default Mercurial uses an |
|
1978 | 1982 | internal patch utility. The external tool must work as the common |
|
1979 | 1983 | Unix ``patch`` program. In particular, it must accept a ``-p`` |
|
1980 | 1984 | argument to strip patch headers, a ``-d`` argument to specify the |
|
1981 | 1985 | current directory, a file name to patch, and a patch file to take |
|
1982 | 1986 | from stdin. |
|
1983 | 1987 | |
|
1984 | 1988 | It is possible to specify a patch tool together with extra |
|
1985 | 1989 | arguments. For example, setting this option to ``patch --merge`` |
|
1986 | 1990 | will use the ``patch`` program with its 2-way merge option. |
|
1987 | 1991 | |
|
1988 | 1992 | ``portablefilenames`` |
|
1989 | 1993 | Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``. |
|
1990 | 1994 | (default: ``warn``) |
|
1991 | 1995 | |
|
1992 | 1996 | ``warn`` |
|
1993 | 1997 | Print a warning message on POSIX platforms, if a file with a non-portable |
|
1994 | 1998 | filename is added (e.g. a file with a name that can't be created on |
|
1995 | 1999 | Windows because it contains reserved parts like ``AUX``, reserved |
|
1996 | 2000 | characters like ``:``, or would cause a case collision with an existing |
|
1997 | 2001 | file). |
|
1998 | 2002 | |
|
1999 | 2003 | ``ignore`` |
|
2000 | 2004 | Don't print a warning. |
|
2001 | 2005 | |
|
2002 | 2006 | ``abort`` |
|
2003 | 2007 | The command is aborted. |
|
2004 | 2008 | |
|
2005 | 2009 | ``true`` |
|
2006 | 2010 | Alias for ``warn``. |
|
2007 | 2011 | |
|
2008 | 2012 | ``false`` |
|
2009 | 2013 | Alias for ``ignore``. |
|
2010 | 2014 | |
|
2011 | 2015 | .. container:: windows |
|
2012 | 2016 | |
|
2013 | 2017 | On Windows, this configuration option is ignored and the command aborted. |
|
2014 | 2018 | |
|
2015 | 2019 | ``quiet`` |
|
2016 | 2020 | Reduce the amount of output printed. |
|
2017 | 2021 | (default: False) |
|
2018 | 2022 | |
|
2019 | 2023 | ``remotecmd`` |
|
2020 | 2024 | Remote command to use for clone/push/pull operations. |
|
2021 | 2025 | (default: ``hg``) |
|
2022 | 2026 | |
|
2023 | 2027 | ``report_untrusted`` |
|
2024 | 2028 | Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a |
|
2025 | 2029 | trusted user or group. |
|
2026 | 2030 | (default: True) |
|
2027 | 2031 | |
|
2028 | 2032 | ``slash`` |
|
2029 | 2033 | Display paths using a slash (``/``) as the path separator. This |
|
2030 | 2034 | only makes a difference on systems where the default path |
|
2031 | 2035 | separator is not the slash character (e.g. Windows uses the |
|
2032 | 2036 | backslash character (``\``)). |
|
2033 | 2037 | (default: False) |
|
2034 | 2038 | |
|
2035 | 2039 | ``statuscopies`` |
|
2036 | 2040 | Display copies in the status command. |
|
2037 | 2041 | |
|
2038 | 2042 | ``ssh`` |
|
2039 | 2043 | Command to use for SSH connections. (default: ``ssh``) |
|
2040 | 2044 | |
|
2041 | 2045 | ``strict`` |
|
2042 | 2046 | Require exact command names, instead of allowing unambiguous |
|
2043 | 2047 | abbreviations. (default: False) |
|
2044 | 2048 | |
|
2045 | 2049 | ``style`` |
|
2046 | 2050 | Name of style to use for command output. |
|
2047 | 2051 | |
|
2048 | 2052 | ``supportcontact`` |
|
2049 | 2053 | A URL where users should report a Mercurial traceback. Use this if you are a |
|
2050 | 2054 | large organisation with its own Mercurial deployment process and crash |
|
2051 | 2055 | reports should be addressed to your internal support. |
|
2052 | 2056 | |
|
2053 | 2057 | ``textwidth`` |
|
2054 | 2058 | Maximum width of help text. A longer line generated by ``hg help`` or |
|
2055 | 2059 | ``hg subcommand --help`` will be broken after white space to get this |
|
2056 | 2060 | width or the terminal width, whichever comes first. |
|
2057 | 2061 | A non-positive value will disable this and the terminal width will be |
|
2058 | 2062 | used. (default: 78) |
|
2059 | 2063 | |
|
2060 | 2064 | ``timeout`` |
|
2061 | 2065 | The timeout used when a lock is held (in seconds), a negative value |
|
2062 | 2066 | means no timeout. (default: 600) |
|
2063 | 2067 | |
|
2064 | 2068 | ``traceback`` |
|
2065 | 2069 | Mercurial always prints a traceback when an unknown exception |
|
2066 | 2070 | occurs. Setting this to True will make Mercurial print a traceback |
|
2067 | 2071 | on all exceptions, even those recognized by Mercurial (such as |
|
2068 | 2072 | IOError or MemoryError). (default: False) |
|
2069 | 2073 | |
|
2070 | 2074 | ``username`` |
|
2071 | 2075 | The committer of a changeset created when running "commit". |
|
2072 | 2076 | Typically a person's name and email address, e.g. ``Fred Widget |
|
2073 | 2077 | <fred@example.com>``. Environment variables in the |
|
2074 | 2078 | username are expanded. |
|
2075 | 2079 | |
|
2076 | 2080 | (default: ``$EMAIL`` or ``username@hostname``. If the username in |
|
2077 | 2081 | hgrc is empty, e.g. if the system admin set ``username =`` in the |
|
2078 | 2082 | system hgrc, it has to be specified manually or in a different |
|
2079 | 2083 | hgrc file) |
|
2080 | 2084 | |
|
2081 | 2085 | ``verbose`` |
|
2082 | 2086 | Increase the amount of output printed. (default: False) |
|
2083 | 2087 | |
|
2084 | 2088 | |
|
2085 | 2089 | ``web`` |
|
2086 | 2090 | ------- |
|
2087 | 2091 | |
|
2088 | 2092 | Web interface configuration. The settings in this section apply to |
|
2089 | 2093 | both the builtin webserver (started by :hg:`serve`) and the script you |
|
2090 | 2094 | run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI |
|
2091 | 2095 | and WSGI). |
|
2092 | 2096 | |
|
2093 | 2097 | The Mercurial webserver does no authentication (it does not prompt for |
|
2094 | 2098 | usernames and passwords to validate *who* users are), but it does do |
|
2095 | 2099 | authorization (it grants or denies access for *authenticated users* |
|
2096 | 2100 | based on settings in this section). You must either configure your |
|
2097 | 2101 | webserver to do authentication for you, or disable the authorization |
|
2098 | 2102 | checks. |
|
2099 | 2103 | |
|
2100 | 2104 | For a quick setup in a trusted environment, e.g., a private LAN, where |
|
2101 | 2105 | you want it to accept pushes from anybody, you can use the following |
|
2102 | 2106 | command line:: |
|
2103 | 2107 | |
|
2104 | 2108 | $ hg --config web.allow_push=* --config web.push_ssl=False serve |
|
2105 | 2109 | |
|
2106 | 2110 | Note that this will allow anybody to push anything to the server and |
|
2107 | 2111 | that this should not be used for public servers. |
|
2108 | 2112 | |
|
2109 | 2113 | The full set of options is: |
|
2110 | 2114 | |
|
2111 | 2115 | ``accesslog`` |
|
2112 | 2116 | Where to output the access log. (default: stdout) |
|
2113 | 2117 | |
|
2114 | 2118 | ``address`` |
|
2115 | 2119 | Interface address to bind to. (default: all) |
|
2116 | 2120 | |
|
2117 | 2121 | ``allow_archive`` |
|
2118 | 2122 | List of archive format (bz2, gz, zip) allowed for downloading. |
|
2119 | 2123 | (default: empty) |
|
2120 | 2124 | |
|
2121 | 2125 | ``allowbz2`` |
|
2122 | 2126 | (DEPRECATED) Whether to allow .tar.bz2 downloading of repository |
|
2123 | 2127 | revisions. |
|
2124 | 2128 | (default: False) |
|
2125 | 2129 | |
|
2126 | 2130 | ``allowgz`` |
|
2127 | 2131 | (DEPRECATED) Whether to allow .tar.gz downloading of repository |
|
2128 | 2132 | revisions. |
|
2129 | 2133 | (default: False) |
|
2130 | 2134 | |
|
2131 | 2135 | ``allowpull`` |
|
2132 | 2136 | Whether to allow pulling from the repository. (default: True) |
|
2133 | 2137 | |
|
2134 | 2138 | ``allow_push`` |
|
2135 | 2139 | Whether to allow pushing to the repository. If empty or not set, |
|
2136 | 2140 | pushing is not allowed. If the special value ``*``, any remote |
|
2137 | 2141 | user can push, including unauthenticated users. Otherwise, the |
|
2138 | 2142 | remote user must have been authenticated, and the authenticated |
|
2139 | 2143 | user name must be present in this list. The contents of the |
|
2140 | 2144 | allow_push list are examined after the deny_push list. |
|
2141 | 2145 | |
|
2142 | 2146 | ``allow_read`` |
|
2143 | 2147 | If the user has not already been denied repository access due to |
|
2144 | 2148 | the contents of deny_read, this list determines whether to grant |
|
2145 | 2149 | repository access to the user. If this list is not empty, and the |
|
2146 | 2150 | user is unauthenticated or not present in the list, then access is |
|
2147 | 2151 | denied for the user. If the list is empty or not set, then access |
|
2148 | 2152 | is permitted to all users by default. Setting allow_read to the |
|
2149 | 2153 | special value ``*`` is equivalent to it not being set (i.e. access |
|
2150 | 2154 | is permitted to all users). The contents of the allow_read list are |
|
2151 | 2155 | examined after the deny_read list. |
|
2152 | 2156 | |
|
2153 | 2157 | ``allowzip`` |
|
2154 | 2158 | (DEPRECATED) Whether to allow .zip downloading of repository |
|
2155 | 2159 | revisions. This feature creates temporary files. |
|
2156 | 2160 | (default: False) |
|
2157 | 2161 | |
|
2158 | 2162 | ``archivesubrepos`` |
|
2159 | 2163 | Whether to recurse into subrepositories when archiving. |
|
2160 | 2164 | (default: False) |
|
2161 | 2165 | |
|
2162 | 2166 | ``baseurl`` |
|
2163 | 2167 | Base URL to use when publishing URLs in other locations, so |
|
2164 | 2168 | third-party tools like email notification hooks can construct |
|
2165 | 2169 | URLs. Example: ``http://hgserver/repos/``. |
|
2166 | 2170 | |
|
2167 | 2171 | ``cacerts`` |
|
2168 | 2172 | Path to file containing a list of PEM encoded certificate |
|
2169 | 2173 | authority certificates. Environment variables and ``~user`` |
|
2170 | 2174 | constructs are expanded in the filename. If specified on the |
|
2171 | 2175 | client, then it will verify the identity of remote HTTPS servers |
|
2172 | 2176 | with these certificates. |
|
2173 | 2177 | |
|
2174 | 2178 | To disable SSL verification temporarily, specify ``--insecure`` from |
|
2175 | 2179 | command line. |
|
2176 | 2180 | |
|
2177 | 2181 | You can use OpenSSL's CA certificate file if your platform has |
|
2178 | 2182 | one. On most Linux systems this will be |
|
2179 | 2183 | ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to |
|
2180 | 2184 | generate this file manually. The form must be as follows:: |
|
2181 | 2185 | |
|
2182 | 2186 | -----BEGIN CERTIFICATE----- |
|
2183 | 2187 | ... (certificate in base64 PEM encoding) ... |
|
2184 | 2188 | -----END CERTIFICATE----- |
|
2185 | 2189 | -----BEGIN CERTIFICATE----- |
|
2186 | 2190 | ... (certificate in base64 PEM encoding) ... |
|
2187 | 2191 | -----END CERTIFICATE----- |
|
2188 | 2192 | |
|
2189 | 2193 | ``cache`` |
|
2190 | 2194 | Whether to support caching in hgweb. (default: True) |
|
2191 | 2195 | |
|
2192 | 2196 | ``certificate`` |
|
2193 | 2197 | Certificate to use when running :hg:`serve`. |
|
2194 | 2198 | |
|
2195 | 2199 | ``collapse`` |
|
2196 | 2200 | With ``descend`` enabled, repositories in subdirectories are shown at |
|
2197 | 2201 | a single level alongside repositories in the current path. With |
|
2198 | 2202 | ``collapse`` also enabled, repositories residing at a deeper level than |
|
2199 | 2203 | the current path are grouped behind navigable directory entries that |
|
2200 | 2204 | lead to the locations of these repositories. In effect, this setting |
|
2201 | 2205 | collapses each collection of repositories found within a subdirectory |
|
2202 | 2206 | into a single entry for that subdirectory. (default: False) |
|
2203 | 2207 | |
|
2204 | 2208 | ``comparisoncontext`` |
|
2205 | 2209 | Number of lines of context to show in side-by-side file comparison. If |
|
2206 | 2210 | negative or the value ``full``, whole files are shown. (default: 5) |
|
2207 | 2211 | |
|
2208 | 2212 | This setting can be overridden by a ``context`` request parameter to the |
|
2209 | 2213 | ``comparison`` command, taking the same values. |
|
2210 | 2214 | |
|
2211 | 2215 | ``contact`` |
|
2212 | 2216 | Name or email address of the person in charge of the repository. |
|
2213 | 2217 | (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty) |
|
2214 | 2218 | |
|
2215 | 2219 | ``csp`` |
|
2216 | 2220 | Send a ``Content-Security-Policy`` HTTP header with this value. |
|
2217 | 2221 | |
|
2218 | 2222 | The value may contain a special string ``%nonce%``, which will be replaced |
|
2219 | 2223 | by a randomly-generated one-time use value. If the value contains |
|
2220 | 2224 | ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the |
|
2221 | 2225 | one-time property of the nonce. This nonce will also be inserted into |
|
2222 | 2226 | ``<script>`` elements containing inline JavaScript. |
|
2223 | 2227 | |
|
2224 | 2228 | Note: lots of HTML content sent by the server is derived from repository |
|
2225 | 2229 | data. Please consider the potential for malicious repository data to |
|
2226 | 2230 | "inject" itself into generated HTML content as part of your security |
|
2227 | 2231 | threat model. |
|
2228 | 2232 | |
|
2229 | 2233 | ``deny_push`` |
|
2230 | 2234 | Whether to deny pushing to the repository. If empty or not set, |
|
2231 | 2235 | push is not denied. If the special value ``*``, all remote users are |
|
2232 | 2236 | denied push. Otherwise, unauthenticated users are all denied, and |
|
2233 | 2237 | any authenticated user name present in this list is also denied. The |
|
2234 | 2238 | contents of the deny_push list are examined before the allow_push list. |
|
2235 | 2239 | |
|
2236 | 2240 | ``deny_read`` |
|
2237 | 2241 | Whether to deny reading/viewing of the repository. If this list is |
|
2238 | 2242 | not empty, unauthenticated users are all denied, and any |
|
2239 | 2243 | authenticated user name present in this list is also denied access to |
|
2240 | 2244 | the repository. If set to the special value ``*``, all remote users |
|
2241 | 2245 | are denied access (rarely needed ;). If deny_read is empty or not set, |
|
2242 | 2246 | the determination of repository access depends on the presence and |
|
2243 | 2247 | content of the allow_read list (see description). If both |
|
2244 | 2248 | deny_read and allow_read are empty or not set, then access is |
|
2245 | 2249 | permitted to all users by default. If the repository is being |
|
2246 | 2250 | served via hgwebdir, denied users will not be able to see it in |
|
2247 | 2251 | the list of repositories. The contents of the deny_read list have |
|
2248 | 2252 | priority over (are examined before) the contents of the allow_read |
|
2249 | 2253 | list. |
|
2250 | 2254 | |
|
2251 | 2255 | ``descend`` |
|
2252 | 2256 | hgwebdir indexes will not descend into subdirectories. Only repositories |
|
2253 | 2257 | directly in the current path will be shown (other repositories are still |
|
2254 | 2258 | available from the index corresponding to their containing path). |
|
2255 | 2259 | |
|
2256 | 2260 | ``description`` |
|
2257 | 2261 | Textual description of the repository's purpose or contents. |
|
2258 | 2262 | (default: "unknown") |
|
2259 | 2263 | |
|
2260 | 2264 | ``encoding`` |
|
2261 | 2265 | Character encoding name. (default: the current locale charset) |
|
2262 | 2266 | Example: "UTF-8". |
|
2263 | 2267 | |
|
2264 | 2268 | ``errorlog`` |
|
2265 | 2269 | Where to output the error log. (default: stderr) |
|
2266 | 2270 | |
|
2267 | 2271 | ``guessmime`` |
|
2268 | 2272 | Control MIME types for raw download of file content. |
|
2269 | 2273 | Set to True to let hgweb guess the content type from the file |
|
2270 | 2274 | extension. This will serve HTML files as ``text/html`` and might |
|
2271 | 2275 | allow cross-site scripting attacks when serving untrusted |
|
2272 | 2276 | repositories. (default: False) |
|
2273 | 2277 | |
|
2274 | 2278 | ``hidden`` |
|
2275 | 2279 | Whether to hide the repository in the hgwebdir index. |
|
2276 | 2280 | (default: False) |
|
2277 | 2281 | |
|
2278 | 2282 | ``ipv6`` |
|
2279 | 2283 | Whether to use IPv6. (default: False) |
|
2280 | 2284 | |
|
2281 | 2285 | ``labels`` |
|
2282 | 2286 | List of string *labels* associated with the repository. |
|
2283 | 2287 | |
|
2284 | 2288 | Labels are exposed as a template keyword and can be used to customize |
|
2285 | 2289 | output. e.g. the ``index`` template can group or filter repositories |
|
2286 | 2290 | by labels and the ``summary`` template can display additional content |
|
2287 | 2291 | if a specific label is present. |
|
2288 | 2292 | |
|
2289 | 2293 | ``logoimg`` |
|
2290 | 2294 | File name of the logo image that some templates display on each page. |
|
2291 | 2295 | The file name is relative to ``staticurl``. That is, the full path to |
|
2292 | 2296 | the logo image is "staticurl/logoimg". |
|
2293 | 2297 | If unset, ``hglogo.png`` will be used. |
|
2294 | 2298 | |
|
2295 | 2299 | ``logourl`` |
|
2296 | 2300 | Base URL to use for logos. If unset, ``https://mercurial-scm.org/`` |
|
2297 | 2301 | will be used. |
|
2298 | 2302 | |
|
2299 | 2303 | ``maxchanges`` |
|
2300 | 2304 | Maximum number of changes to list on the changelog. (default: 10) |
|
2301 | 2305 | |
|
2302 | 2306 | ``maxfiles`` |
|
2303 | 2307 | Maximum number of files to list per changeset. (default: 10) |
|
2304 | 2308 | |
|
2305 | 2309 | ``maxshortchanges`` |
|
2306 | 2310 | Maximum number of changes to list on the shortlog, graph or filelog |
|
2307 | 2311 | pages. (default: 60) |
|
2308 | 2312 | |
|
2309 | 2313 | ``name`` |
|
2310 | 2314 | Repository name to use in the web interface. |
|
2311 | 2315 | (default: current working directory) |
|
2312 | 2316 | |
|
2313 | 2317 | ``port`` |
|
2314 | 2318 | Port to listen on. (default: 8000) |
|
2315 | 2319 | |
|
2316 | 2320 | ``prefix`` |
|
2317 | 2321 | Prefix path to serve from. (default: '' (server root)) |
|
2318 | 2322 | |
|
2319 | 2323 | ``push_ssl`` |
|
2320 | 2324 | Whether to require that inbound pushes be transported over SSL to |
|
2321 | 2325 | prevent password sniffing. (default: True) |
|
2322 | 2326 | |
|
2323 | 2327 | ``refreshinterval`` |
|
2324 | 2328 | How frequently directory listings re-scan the filesystem for new |
|
2325 | 2329 | repositories, in seconds. This is relevant when wildcards are used |
|
2326 | 2330 | to define paths. Depending on how much filesystem traversal is |
|
2327 | 2331 | required, refreshing may negatively impact performance. |
|
2328 | 2332 | |
|
2329 | 2333 | Values less than or equal to 0 always refresh. |
|
2330 | 2334 | (default: 20) |
|
2331 | 2335 | |
|
2332 | 2336 | ``staticurl`` |
|
2333 | 2337 | Base URL to use for static files. If unset, static files (e.g. the |
|
2334 | 2338 | hgicon.png favicon) will be served by the CGI script itself. Use |
|
2335 | 2339 | this setting to serve them directly with the HTTP server. |
|
2336 | 2340 | Example: ``http://hgserver/static/``. |
|
2337 | 2341 | |
|
2338 | 2342 | ``stripes`` |
|
2339 | 2343 | How many lines a "zebra stripe" should span in multi-line output. |
|
2340 | 2344 | Set to 0 to disable. (default: 1) |
|
2341 | 2345 | |
|
2342 | 2346 | ``style`` |
|
2343 | 2347 | Which template map style to use. The available options are the names of |
|
2344 | 2348 | subdirectories in the HTML templates path. (default: ``paper``) |
|
2345 | 2349 | Example: ``monoblue``. |
|
2346 | 2350 | |
|
2347 | 2351 | ``templates`` |
|
2348 | 2352 | Where to find the HTML templates. The default path to the HTML templates |
|
2349 | 2353 | can be obtained from ``hg debuginstall``. |
|
2350 | 2354 | |
|
2351 | 2355 | ``websub`` |
|
2352 | 2356 | ---------- |
|
2353 | 2357 | |
|
2354 | 2358 | Web substitution filter definition. You can use this section to |
|
2355 | 2359 | define a set of regular expression substitution patterns which |
|
2356 | 2360 | let you automatically modify the hgweb server output. |
|
2357 | 2361 | |
|
2358 | 2362 | The default hgweb templates only apply these substitution patterns |
|
2359 | 2363 | on the revision description fields. You can apply them anywhere |
|
2360 | 2364 | you want when you create your own templates by adding calls to the |
|
2361 | 2365 | "websub" filter (usually after calling the "escape" filter). |
|
2362 | 2366 | |
|
2363 | 2367 | This can be used, for example, to convert issue references to links |
|
2364 | 2368 | to your issue tracker, or to convert "markdown-like" syntax into |
|
2365 | 2369 | HTML (see the examples below). |
|
2366 | 2370 | |
|
2367 | 2371 | Each entry in this section names a substitution filter. |
|
2368 | 2372 | The value of each entry defines the substitution expression itself. |
|
2369 | 2373 | The websub expressions follow the old interhg extension syntax, |
|
2370 | 2374 | which in turn imitates the Unix sed replacement syntax:: |
|
2371 | 2375 | |
|
2372 | 2376 | patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i] |
|
2373 | 2377 | |
|
2374 | 2378 | You can use any separator other than "/". The final "i" is optional |
|
2375 | 2379 | and indicates that the search must be case insensitive. |
|
2376 | 2380 | |
|
2377 | 2381 | Examples:: |
|
2378 | 2382 | |
|
2379 | 2383 | [websub] |
|
2380 | 2384 | issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i |
|
2381 | 2385 | italic = s/\b_(\S+)_\b/<i>\1<\/i>/ |
|
2382 | 2386 | bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/ |
|
2383 | 2387 | |
|
2384 | 2388 | ``worker`` |
|
2385 | 2389 | ---------- |
|
2386 | 2390 | |
|
2387 | 2391 | Parallel master/worker configuration. We currently perform working |
|
2388 | 2392 | directory updates in parallel on Unix-like systems, which greatly |
|
2389 | 2393 | helps performance. |
|
2390 | 2394 | |
|
2391 | 2395 | ``numcpus`` |
|
2392 | 2396 | Number of CPUs to use for parallel operations. A zero or |
|
2393 | 2397 | negative value is treated as ``use the default``. |
|
2394 | 2398 | (default: 4 or the number of CPUs on the system, whichever is larger) |
|
2395 | 2399 | |
|
2396 | 2400 | ``backgroundclose`` |
|
2397 | 2401 | Whether to enable closing file handles on background threads during certain |
|
2398 | 2402 | operations. Some platforms aren't very efficient at closing file |
|
2399 | 2403 | handles that have been written or appended to. By performing file closing |
|
2400 | 2404 | on background threads, file write rate can increase substantially. |
|
2401 | 2405 | (default: true on Windows, false elsewhere) |
|
2402 | 2406 | |
|
2403 | 2407 | ``backgroundcloseminfilecount`` |
|
2404 | 2408 | Minimum number of files required to trigger background file closing. |
|
2405 | 2409 | Operations not writing this many files won't start background close |
|
2406 | 2410 | threads. |
|
2407 | 2411 | (default: 2048) |
|
2408 | 2412 | |
|
2409 | 2413 | ``backgroundclosemaxqueue`` |
|
2410 | 2414 | The maximum number of opened file handles waiting to be closed in the |
|
2411 | 2415 | background. This option only has an effect if ``backgroundclose`` is |
|
2412 | 2416 | enabled. |
|
2413 | 2417 | (default: 384) |
|
2414 | 2418 | |
|
2415 | 2419 | ``backgroundclosethreadcount`` |
|
2416 | 2420 | Number of threads to process background file closes. Only relevant if |
|
2417 | 2421 | ``backgroundclose`` is enabled. |
|
2418 | 2422 | (default: 4) |
@@ -1,407 +1,417 b'' | |||
|
1 | 1 | # streamclone.py - producing and consuming streaming repository data |
|
2 | 2 | # |
|
3 | 3 | # Copyright 2015 Gregory Szorc <gregory.szorc@gmail.com> |
|
4 | 4 | # |
|
5 | 5 | # This software may be used and distributed according to the terms of the |
|
6 | 6 | # GNU General Public License version 2 or any later version. |
|
7 | 7 | |
|
8 | 8 | from __future__ import absolute_import |
|
9 | 9 | |
|
10 | 10 | import struct |
|
11 | 11 | |
|
12 | 12 | from .i18n import _ |
|
13 | 13 | from . import ( |
|
14 | 14 | branchmap, |
|
15 | 15 | error, |
|
16 | phases, | |
|
16 | 17 | store, |
|
17 | 18 | util, |
|
18 | 19 | ) |
|
19 | 20 | |
|
20 | 21 | def canperformstreamclone(pullop, bailifbundle2supported=False): |
|
21 | 22 | """Whether it is possible to perform a streaming clone as part of pull. |
|
22 | 23 | |
|
23 | 24 | ``bailifbundle2supported`` will cause the function to return False if |
|
24 | 25 | bundle2 stream clones are supported. It should only be called by the |
|
25 | 26 | legacy stream clone code path. |
|
26 | 27 | |
|
27 | 28 | Returns a tuple of (supported, requirements). ``supported`` is True if |
|
28 | 29 | streaming clone is supported and False otherwise. ``requirements`` is |
|
29 | 30 | a set of repo requirements from the remote, or ``None`` if stream clone |
|
30 | 31 | isn't supported. |
|
31 | 32 | """ |
|
32 | 33 | repo = pullop.repo |
|
33 | 34 | remote = pullop.remote |
|
34 | 35 | |
|
35 | 36 | bundle2supported = False |
|
36 | 37 | if pullop.canusebundle2: |
|
37 | 38 | if 'v1' in pullop.remotebundle2caps.get('stream', []): |
|
38 | 39 | bundle2supported = True |
|
39 | 40 | # else |
|
40 | 41 | # Server doesn't support bundle2 stream clone or doesn't support |
|
41 | 42 | # the versions we support. Fall back and possibly allow legacy. |
|
42 | 43 | |
|
43 | 44 | # Ensures legacy code path uses available bundle2. |
|
44 | 45 | if bailifbundle2supported and bundle2supported: |
|
45 | 46 | return False, None |
|
46 | 47 | # Ensures bundle2 doesn't try to do a stream clone if it isn't supported. |
|
47 | 48 | #elif not bailifbundle2supported and not bundle2supported: |
|
48 | 49 | # return False, None |
|
49 | 50 | |
|
50 | 51 | # Streaming clone only works on empty repositories. |
|
51 | 52 | if len(repo): |
|
52 | 53 | return False, None |
|
53 | 54 | |
|
54 | 55 | # Streaming clone only works if all data is being requested. |
|
55 | 56 | if pullop.heads: |
|
56 | 57 | return False, None |
|
57 | 58 | |
|
58 | 59 | streamrequested = pullop.streamclonerequested |
|
59 | 60 | |
|
60 | 61 | # If we don't have a preference, let the server decide for us. This |
|
61 | 62 | # likely only comes into play in LANs. |
|
62 | 63 | if streamrequested is None: |
|
63 | 64 | # The server can advertise whether to prefer streaming clone. |
|
64 | 65 | streamrequested = remote.capable('stream-preferred') |
|
65 | 66 | |
|
66 | 67 | if not streamrequested: |
|
67 | 68 | return False, None |
|
68 | 69 | |
|
69 | 70 | # In order for stream clone to work, the client has to support all the |
|
70 | 71 | # requirements advertised by the server. |
|
71 | 72 | # |
|
72 | 73 | # The server advertises its requirements via the "stream" and "streamreqs" |
|
73 | 74 | # capability. "stream" (a value-less capability) is advertised if and only |
|
74 | 75 | # if the only requirement is "revlogv1." Else, the "streamreqs" capability |
|
75 | 76 | # is advertised and contains a comma-delimited list of requirements. |
|
76 | 77 | requirements = set() |
|
77 | 78 | if remote.capable('stream'): |
|
78 | 79 | requirements.add('revlogv1') |
|
79 | 80 | else: |
|
80 | 81 | streamreqs = remote.capable('streamreqs') |
|
81 | 82 | # This is weird and shouldn't happen with modern servers. |
|
82 | 83 | if not streamreqs: |
|
83 | 84 | pullop.repo.ui.warn(_( |
|
84 | 85 | 'warning: stream clone requested but server has them ' |
|
85 | 86 | 'disabled\n')) |
|
86 | 87 | return False, None |
|
87 | 88 | |
|
88 | 89 | streamreqs = set(streamreqs.split(',')) |
|
89 | 90 | # Server requires something we don't support. Bail. |
|
90 | 91 | missingreqs = streamreqs - repo.supportedformats |
|
91 | 92 | if missingreqs: |
|
92 | 93 | pullop.repo.ui.warn(_( |
|
93 | 94 | 'warning: stream clone requested but client is missing ' |
|
94 | 95 | 'requirements: %s\n') % ', '.join(sorted(missingreqs))) |
|
95 | 96 | pullop.repo.ui.warn( |
|
96 | 97 | _('(see https://www.mercurial-scm.org/wiki/MissingRequirement ' |
|
97 | 98 | 'for more information)\n')) |
|
98 | 99 | return False, None |
|
99 | 100 | requirements = streamreqs |
|
100 | 101 | |
|
101 | 102 | return True, requirements |
|
102 | 103 | |
|
103 | 104 | def maybeperformlegacystreamclone(pullop): |
|
104 | 105 | """Possibly perform a legacy stream clone operation. |
|
105 | 106 | |
|
106 | 107 | Legacy stream clones are performed as part of pull but before all other |
|
107 | 108 | operations. |
|
108 | 109 | |
|
109 | 110 | A legacy stream clone will not be performed if a bundle2 stream clone is |
|
110 | 111 | supported. |
|
111 | 112 | """ |
|
112 | 113 | supported, requirements = canperformstreamclone(pullop) |
|
113 | 114 | |
|
114 | 115 | if not supported: |
|
115 | 116 | return |
|
116 | 117 | |
|
117 | 118 | repo = pullop.repo |
|
118 | 119 | remote = pullop.remote |
|
119 | 120 | |
|
120 | 121 | # Save remote branchmap. We will use it later to speed up branchcache |
|
121 | 122 | # creation. |
|
122 | 123 | rbranchmap = None |
|
123 | 124 | if remote.capable('branchmap'): |
|
124 | 125 | rbranchmap = remote.branchmap() |
|
125 | 126 | |
|
126 | 127 | repo.ui.status(_('streaming all changes\n')) |
|
127 | 128 | |
|
128 | 129 | fp = remote.stream_out() |
|
129 | 130 | l = fp.readline() |
|
130 | 131 | try: |
|
131 | 132 | resp = int(l) |
|
132 | 133 | except ValueError: |
|
133 | 134 | raise error.ResponseError( |
|
134 | 135 | _('unexpected response from remote server:'), l) |
|
135 | 136 | if resp == 1: |
|
136 | 137 | raise error.Abort(_('operation forbidden by server')) |
|
137 | 138 | elif resp == 2: |
|
138 | 139 | raise error.Abort(_('locking the remote repository failed')) |
|
139 | 140 | elif resp != 0: |
|
140 | 141 | raise error.Abort(_('the server sent an unknown error code')) |
|
141 | 142 | |
|
142 | 143 | l = fp.readline() |
|
143 | 144 | try: |
|
144 | 145 | filecount, bytecount = map(int, l.split(' ', 1)) |
|
145 | 146 | except (ValueError, TypeError): |
|
146 | 147 | raise error.ResponseError( |
|
147 | 148 | _('unexpected response from remote server:'), l) |
|
148 | 149 | |
|
149 | 150 | with repo.lock(): |
|
150 | 151 | consumev1(repo, fp, filecount, bytecount) |
|
151 | 152 | |
|
152 | 153 | # new requirements = old non-format requirements + |
|
153 | 154 | # new format-related remote requirements |
|
154 | 155 | # requirements from the streamed-in repository |
|
155 | 156 | repo.requirements = requirements | ( |
|
156 | 157 | repo.requirements - repo.supportedformats) |
|
157 | 158 | repo._applyopenerreqs() |
|
158 | 159 | repo._writerequirements() |
|
159 | 160 | |
|
160 | 161 | if rbranchmap: |
|
161 | 162 | branchmap.replacecache(repo, rbranchmap) |
|
162 | 163 | |
|
163 | 164 | repo.invalidate() |
|
164 | 165 | |
|
165 |
def allowservergeneration( |
|
|
166 | def allowservergeneration(repo): | |
|
166 | 167 | """Whether streaming clones are allowed from the server.""" |
|
167 |
|
|
|
168 | if not repo.ui.configbool('server', 'uncompressed', True, untrusted=True): | |
|
169 | return False | |
|
170 | ||
|
171 | # The way stream clone works makes it impossible to hide secret changesets. | |
|
172 | # So don't allow this by default. | |
|
173 | secret = phases.hassecret(repo) | |
|
174 | if secret: | |
|
175 | return repo.ui.configbool('server', 'uncompressedallowsecret', False) | |
|
176 | ||
|
177 | return True | |
|
168 | 178 | |
|
169 | 179 | # This is it's own function so extensions can override it. |
|
170 | 180 | def _walkstreamfiles(repo): |
|
171 | 181 | return repo.store.walk() |
|
172 | 182 | |
|
173 | 183 | def generatev1(repo): |
|
174 | 184 | """Emit content for version 1 of a streaming clone. |
|
175 | 185 | |
|
176 | 186 | This returns a 3-tuple of (file count, byte size, data iterator). |
|
177 | 187 | |
|
178 | 188 | The data iterator consists of N entries for each file being transferred. |
|
179 | 189 | Each file entry starts as a line with the file name and integer size |
|
180 | 190 | delimited by a null byte. |
|
181 | 191 | |
|
182 | 192 | The raw file data follows. Following the raw file data is the next file |
|
183 | 193 | entry, or EOF. |
|
184 | 194 | |
|
185 | 195 | When used on the wire protocol, an additional line indicating protocol |
|
186 | 196 | success will be prepended to the stream. This function is not responsible |
|
187 | 197 | for adding it. |
|
188 | 198 | |
|
189 | 199 | This function will obtain a repository lock to ensure a consistent view of |
|
190 | 200 | the store is captured. It therefore may raise LockError. |
|
191 | 201 | """ |
|
192 | 202 | entries = [] |
|
193 | 203 | total_bytes = 0 |
|
194 | 204 | # Get consistent snapshot of repo, lock during scan. |
|
195 | 205 | with repo.lock(): |
|
196 | 206 | repo.ui.debug('scanning\n') |
|
197 | 207 | for name, ename, size in _walkstreamfiles(repo): |
|
198 | 208 | if size: |
|
199 | 209 | entries.append((name, size)) |
|
200 | 210 | total_bytes += size |
|
201 | 211 | |
|
202 | 212 | repo.ui.debug('%d files, %d bytes to transfer\n' % |
|
203 | 213 | (len(entries), total_bytes)) |
|
204 | 214 | |
|
205 | 215 | svfs = repo.svfs |
|
206 | 216 | oldaudit = svfs.mustaudit |
|
207 | 217 | debugflag = repo.ui.debugflag |
|
208 | 218 | svfs.mustaudit = False |
|
209 | 219 | |
|
210 | 220 | def emitrevlogdata(): |
|
211 | 221 | try: |
|
212 | 222 | for name, size in entries: |
|
213 | 223 | if debugflag: |
|
214 | 224 | repo.ui.debug('sending %s (%d bytes)\n' % (name, size)) |
|
215 | 225 | # partially encode name over the wire for backwards compat |
|
216 | 226 | yield '%s\0%d\n' % (store.encodedir(name), size) |
|
217 | 227 | if size <= 65536: |
|
218 | 228 | with svfs(name, 'rb') as fp: |
|
219 | 229 | yield fp.read(size) |
|
220 | 230 | else: |
|
221 | 231 | for chunk in util.filechunkiter(svfs(name), limit=size): |
|
222 | 232 | yield chunk |
|
223 | 233 | finally: |
|
224 | 234 | svfs.mustaudit = oldaudit |
|
225 | 235 | |
|
226 | 236 | return len(entries), total_bytes, emitrevlogdata() |
|
227 | 237 | |
|
228 | 238 | def generatev1wireproto(repo): |
|
229 | 239 | """Emit content for version 1 of streaming clone suitable for the wire. |
|
230 | 240 | |
|
231 | 241 | This is the data output from ``generatev1()`` with a header line |
|
232 | 242 | indicating file count and byte size. |
|
233 | 243 | """ |
|
234 | 244 | filecount, bytecount, it = generatev1(repo) |
|
235 | 245 | yield '%d %d\n' % (filecount, bytecount) |
|
236 | 246 | for chunk in it: |
|
237 | 247 | yield chunk |
|
238 | 248 | |
|
239 | 249 | def generatebundlev1(repo, compression='UN'): |
|
240 | 250 | """Emit content for version 1 of a stream clone bundle. |
|
241 | 251 | |
|
242 | 252 | The first 4 bytes of the output ("HGS1") denote this as stream clone |
|
243 | 253 | bundle version 1. |
|
244 | 254 | |
|
245 | 255 | The next 2 bytes indicate the compression type. Only "UN" is currently |
|
246 | 256 | supported. |
|
247 | 257 | |
|
248 | 258 | The next 16 bytes are two 64-bit big endian unsigned integers indicating |
|
249 | 259 | file count and byte count, respectively. |
|
250 | 260 | |
|
251 | 261 | The next 2 bytes is a 16-bit big endian unsigned short declaring the length |
|
252 | 262 | of the requirements string, including a trailing \0. The following N bytes |
|
253 | 263 | are the requirements string, which is ASCII containing a comma-delimited |
|
254 | 264 | list of repo requirements that are needed to support the data. |
|
255 | 265 | |
|
256 | 266 | The remaining content is the output of ``generatev1()`` (which may be |
|
257 | 267 | compressed in the future). |
|
258 | 268 | |
|
259 | 269 | Returns a tuple of (requirements, data generator). |
|
260 | 270 | """ |
|
261 | 271 | if compression != 'UN': |
|
262 | 272 | raise ValueError('we do not support the compression argument yet') |
|
263 | 273 | |
|
264 | 274 | requirements = repo.requirements & repo.supportedformats |
|
265 | 275 | requires = ','.join(sorted(requirements)) |
|
266 | 276 | |
|
267 | 277 | def gen(): |
|
268 | 278 | yield 'HGS1' |
|
269 | 279 | yield compression |
|
270 | 280 | |
|
271 | 281 | filecount, bytecount, it = generatev1(repo) |
|
272 | 282 | repo.ui.status(_('writing %d bytes for %d files\n') % |
|
273 | 283 | (bytecount, filecount)) |
|
274 | 284 | |
|
275 | 285 | yield struct.pack('>QQ', filecount, bytecount) |
|
276 | 286 | yield struct.pack('>H', len(requires) + 1) |
|
277 | 287 | yield requires + '\0' |
|
278 | 288 | |
|
279 | 289 | # This is where we'll add compression in the future. |
|
280 | 290 | assert compression == 'UN' |
|
281 | 291 | |
|
282 | 292 | seen = 0 |
|
283 | 293 | repo.ui.progress(_('bundle'), 0, total=bytecount, unit=_('bytes')) |
|
284 | 294 | |
|
285 | 295 | for chunk in it: |
|
286 | 296 | seen += len(chunk) |
|
287 | 297 | repo.ui.progress(_('bundle'), seen, total=bytecount, |
|
288 | 298 | unit=_('bytes')) |
|
289 | 299 | yield chunk |
|
290 | 300 | |
|
291 | 301 | repo.ui.progress(_('bundle'), None) |
|
292 | 302 | |
|
293 | 303 | return requirements, gen() |
|
294 | 304 | |
|
295 | 305 | def consumev1(repo, fp, filecount, bytecount): |
|
296 | 306 | """Apply the contents from version 1 of a streaming clone file handle. |
|
297 | 307 | |
|
298 | 308 | This takes the output from "stream_out" and applies it to the specified |
|
299 | 309 | repository. |
|
300 | 310 | |
|
301 | 311 | Like "stream_out," the status line added by the wire protocol is not |
|
302 | 312 | handled by this function. |
|
303 | 313 | """ |
|
304 | 314 | with repo.lock(): |
|
305 | 315 | repo.ui.status(_('%d files to transfer, %s of data\n') % |
|
306 | 316 | (filecount, util.bytecount(bytecount))) |
|
307 | 317 | handled_bytes = 0 |
|
308 | 318 | repo.ui.progress(_('clone'), 0, total=bytecount, unit=_('bytes')) |
|
309 | 319 | start = util.timer() |
|
310 | 320 | |
|
311 | 321 | # TODO: get rid of (potential) inconsistency |
|
312 | 322 | # |
|
313 | 323 | # If transaction is started and any @filecache property is |
|
314 | 324 | # changed at this point, it causes inconsistency between |
|
315 | 325 | # in-memory cached property and streamclone-ed file on the |
|
316 | 326 | # disk. Nested transaction prevents transaction scope "clone" |
|
317 | 327 | # below from writing in-memory changes out at the end of it, |
|
318 | 328 | # even though in-memory changes are discarded at the end of it |
|
319 | 329 | # regardless of transaction nesting. |
|
320 | 330 | # |
|
321 | 331 | # But transaction nesting can't be simply prohibited, because |
|
322 | 332 | # nesting occurs also in ordinary case (e.g. enabling |
|
323 | 333 | # clonebundles). |
|
324 | 334 | |
|
325 | 335 | with repo.transaction('clone'): |
|
326 | 336 | with repo.svfs.backgroundclosing(repo.ui, expectedcount=filecount): |
|
327 | 337 | for i in xrange(filecount): |
|
328 | 338 | # XXX doesn't support '\n' or '\r' in filenames |
|
329 | 339 | l = fp.readline() |
|
330 | 340 | try: |
|
331 | 341 | name, size = l.split('\0', 1) |
|
332 | 342 | size = int(size) |
|
333 | 343 | except (ValueError, TypeError): |
|
334 | 344 | raise error.ResponseError( |
|
335 | 345 | _('unexpected response from remote server:'), l) |
|
336 | 346 | if repo.ui.debugflag: |
|
337 | 347 | repo.ui.debug('adding %s (%s)\n' % |
|
338 | 348 | (name, util.bytecount(size))) |
|
339 | 349 | # for backwards compat, name was partially encoded |
|
340 | 350 | path = store.decodedir(name) |
|
341 | 351 | with repo.svfs(path, 'w', backgroundclose=True) as ofp: |
|
342 | 352 | for chunk in util.filechunkiter(fp, limit=size): |
|
343 | 353 | handled_bytes += len(chunk) |
|
344 | 354 | repo.ui.progress(_('clone'), handled_bytes, |
|
345 | 355 | total=bytecount, unit=_('bytes')) |
|
346 | 356 | ofp.write(chunk) |
|
347 | 357 | |
|
348 | 358 | # force @filecache properties to be reloaded from |
|
349 | 359 | # streamclone-ed file at next access |
|
350 | 360 | repo.invalidate(clearfilecache=True) |
|
351 | 361 | |
|
352 | 362 | elapsed = util.timer() - start |
|
353 | 363 | if elapsed <= 0: |
|
354 | 364 | elapsed = 0.001 |
|
355 | 365 | repo.ui.progress(_('clone'), None) |
|
356 | 366 | repo.ui.status(_('transferred %s in %.1f seconds (%s/sec)\n') % |
|
357 | 367 | (util.bytecount(bytecount), elapsed, |
|
358 | 368 | util.bytecount(bytecount / elapsed))) |
|
359 | 369 | |
|
360 | 370 | def readbundle1header(fp): |
|
361 | 371 | compression = fp.read(2) |
|
362 | 372 | if compression != 'UN': |
|
363 | 373 | raise error.Abort(_('only uncompressed stream clone bundles are ' |
|
364 | 374 | 'supported; got %s') % compression) |
|
365 | 375 | |
|
366 | 376 | filecount, bytecount = struct.unpack('>QQ', fp.read(16)) |
|
367 | 377 | requireslen = struct.unpack('>H', fp.read(2))[0] |
|
368 | 378 | requires = fp.read(requireslen) |
|
369 | 379 | |
|
370 | 380 | if not requires.endswith('\0'): |
|
371 | 381 | raise error.Abort(_('malformed stream clone bundle: ' |
|
372 | 382 | 'requirements not properly encoded')) |
|
373 | 383 | |
|
374 | 384 | requirements = set(requires.rstrip('\0').split(',')) |
|
375 | 385 | |
|
376 | 386 | return filecount, bytecount, requirements |
|
377 | 387 | |
|
378 | 388 | def applybundlev1(repo, fp): |
|
379 | 389 | """Apply the content from a stream clone bundle version 1. |
|
380 | 390 | |
|
381 | 391 | We assume the 4 byte header has been read and validated and the file handle |
|
382 | 392 | is at the 2 byte compression identifier. |
|
383 | 393 | """ |
|
384 | 394 | if len(repo): |
|
385 | 395 | raise error.Abort(_('cannot apply stream clone bundle on non-empty ' |
|
386 | 396 | 'repo')) |
|
387 | 397 | |
|
388 | 398 | filecount, bytecount, requirements = readbundle1header(fp) |
|
389 | 399 | missingreqs = requirements - repo.supportedformats |
|
390 | 400 | if missingreqs: |
|
391 | 401 | raise error.Abort(_('unable to apply stream clone: ' |
|
392 | 402 | 'unsupported format: %s') % |
|
393 | 403 | ', '.join(sorted(missingreqs))) |
|
394 | 404 | |
|
395 | 405 | consumev1(repo, fp, filecount, bytecount) |
|
396 | 406 | |
|
397 | 407 | class streamcloneapplier(object): |
|
398 | 408 | """Class to manage applying streaming clone bundles. |
|
399 | 409 | |
|
400 | 410 | We need to wrap ``applybundlev1()`` in a dedicated type to enable bundle |
|
401 | 411 | readers to perform bundle type-specific functionality. |
|
402 | 412 | """ |
|
403 | 413 | def __init__(self, fh): |
|
404 | 414 | self._fh = fh |
|
405 | 415 | |
|
406 | 416 | def apply(self, repo): |
|
407 | 417 | return applybundlev1(repo, self._fh) |
@@ -1,1062 +1,1062 b'' | |||
|
1 | 1 | # wireproto.py - generic wire protocol support functions |
|
2 | 2 | # |
|
3 | 3 | # Copyright 2005-2010 Matt Mackall <mpm@selenic.com> |
|
4 | 4 | # |
|
5 | 5 | # This software may be used and distributed according to the terms of the |
|
6 | 6 | # GNU General Public License version 2 or any later version. |
|
7 | 7 | |
|
8 | 8 | from __future__ import absolute_import |
|
9 | 9 | |
|
10 | 10 | import hashlib |
|
11 | 11 | import itertools |
|
12 | 12 | import os |
|
13 | 13 | import tempfile |
|
14 | 14 | |
|
15 | 15 | from .i18n import _ |
|
16 | 16 | from .node import ( |
|
17 | 17 | bin, |
|
18 | 18 | hex, |
|
19 | 19 | nullid, |
|
20 | 20 | ) |
|
21 | 21 | |
|
22 | 22 | from . import ( |
|
23 | 23 | bundle2, |
|
24 | 24 | changegroup as changegroupmod, |
|
25 | 25 | encoding, |
|
26 | 26 | error, |
|
27 | 27 | exchange, |
|
28 | 28 | peer, |
|
29 | 29 | pushkey as pushkeymod, |
|
30 | 30 | pycompat, |
|
31 | 31 | streamclone, |
|
32 | 32 | util, |
|
33 | 33 | ) |
|
34 | 34 | |
|
35 | 35 | urlerr = util.urlerr |
|
36 | 36 | urlreq = util.urlreq |
|
37 | 37 | |
|
38 | 38 | bundle2requiredmain = _('incompatible Mercurial client; bundle2 required') |
|
39 | 39 | bundle2requiredhint = _('see https://www.mercurial-scm.org/wiki/' |
|
40 | 40 | 'IncompatibleClient') |
|
41 | 41 | bundle2required = '%s\n(%s)\n' % (bundle2requiredmain, bundle2requiredhint) |
|
42 | 42 | |
|
43 | 43 | class abstractserverproto(object): |
|
44 | 44 | """abstract class that summarizes the protocol API |
|
45 | 45 | |
|
46 | 46 | Used as reference and documentation. |
|
47 | 47 | """ |
|
48 | 48 | |
|
49 | 49 | def getargs(self, args): |
|
50 | 50 | """return the value for arguments in <args> |
|
51 | 51 | |
|
52 | 52 | returns a list of values (same order as <args>)""" |
|
53 | 53 | raise NotImplementedError() |
|
54 | 54 | |
|
55 | 55 | def getfile(self, fp): |
|
56 | 56 | """write the whole content of a file into a file like object |
|
57 | 57 | |
|
58 | 58 | The file is in the form:: |
|
59 | 59 | |
|
60 | 60 | (<chunk-size>\n<chunk>)+0\n |
|
61 | 61 | |
|
62 | 62 | chunk size is the ascii version of the int. |
|
63 | 63 | """ |
|
64 | 64 | raise NotImplementedError() |
|
65 | 65 | |
|
66 | 66 | def redirect(self): |
|
67 | 67 | """may setup interception for stdout and stderr |
|
68 | 68 | |
|
69 | 69 | See also the `restore` method.""" |
|
70 | 70 | raise NotImplementedError() |
|
71 | 71 | |
|
72 | 72 | # If the `redirect` function does install interception, the `restore` |
|
73 | 73 | # function MUST be defined. If interception is not used, this function |
|
74 | 74 | # MUST NOT be defined. |
|
75 | 75 | # |
|
76 | 76 | # left commented here on purpose |
|
77 | 77 | # |
|
78 | 78 | #def restore(self): |
|
79 | 79 | # """reinstall previous stdout and stderr and return intercepted stdout |
|
80 | 80 | # """ |
|
81 | 81 | # raise NotImplementedError() |
|
82 | 82 | |
|
83 | 83 | class remotebatch(peer.batcher): |
|
84 | 84 | '''batches the queued calls; uses as few roundtrips as possible''' |
|
85 | 85 | def __init__(self, remote): |
|
86 | 86 | '''remote must support _submitbatch(encbatch) and |
|
87 | 87 | _submitone(op, encargs)''' |
|
88 | 88 | peer.batcher.__init__(self) |
|
89 | 89 | self.remote = remote |
|
90 | 90 | def submit(self): |
|
91 | 91 | req, rsp = [], [] |
|
92 | 92 | for name, args, opts, resref in self.calls: |
|
93 | 93 | mtd = getattr(self.remote, name) |
|
94 | 94 | batchablefn = getattr(mtd, 'batchable', None) |
|
95 | 95 | if batchablefn is not None: |
|
96 | 96 | batchable = batchablefn(mtd.im_self, *args, **opts) |
|
97 | 97 | encargsorres, encresref = next(batchable) |
|
98 | 98 | if encresref: |
|
99 | 99 | req.append((name, encargsorres,)) |
|
100 | 100 | rsp.append((batchable, encresref, resref,)) |
|
101 | 101 | else: |
|
102 | 102 | resref.set(encargsorres) |
|
103 | 103 | else: |
|
104 | 104 | if req: |
|
105 | 105 | self._submitreq(req, rsp) |
|
106 | 106 | req, rsp = [], [] |
|
107 | 107 | resref.set(mtd(*args, **opts)) |
|
108 | 108 | if req: |
|
109 | 109 | self._submitreq(req, rsp) |
|
110 | 110 | def _submitreq(self, req, rsp): |
|
111 | 111 | encresults = self.remote._submitbatch(req) |
|
112 | 112 | for encres, r in zip(encresults, rsp): |
|
113 | 113 | batchable, encresref, resref = r |
|
114 | 114 | encresref.set(encres) |
|
115 | 115 | resref.set(next(batchable)) |
|
116 | 116 | |
|
117 | 117 | class remoteiterbatcher(peer.iterbatcher): |
|
118 | 118 | def __init__(self, remote): |
|
119 | 119 | super(remoteiterbatcher, self).__init__() |
|
120 | 120 | self._remote = remote |
|
121 | 121 | |
|
122 | 122 | def __getattr__(self, name): |
|
123 | 123 | if not getattr(self._remote, name, False): |
|
124 | 124 | raise AttributeError( |
|
125 | 125 | 'Attempted to iterbatch non-batchable call to %r' % name) |
|
126 | 126 | return super(remoteiterbatcher, self).__getattr__(name) |
|
127 | 127 | |
|
128 | 128 | def submit(self): |
|
129 | 129 | """Break the batch request into many patch calls and pipeline them. |
|
130 | 130 | |
|
131 | 131 | This is mostly valuable over http where request sizes can be |
|
132 | 132 | limited, but can be used in other places as well. |
|
133 | 133 | """ |
|
134 | 134 | req, rsp = [], [] |
|
135 | 135 | for name, args, opts, resref in self.calls: |
|
136 | 136 | mtd = getattr(self._remote, name) |
|
137 | 137 | batchable = mtd.batchable(mtd.im_self, *args, **opts) |
|
138 | 138 | encargsorres, encresref = next(batchable) |
|
139 | 139 | assert encresref |
|
140 | 140 | req.append((name, encargsorres)) |
|
141 | 141 | rsp.append((batchable, encresref)) |
|
142 | 142 | if req: |
|
143 | 143 | self._resultiter = self._remote._submitbatch(req) |
|
144 | 144 | self._rsp = rsp |
|
145 | 145 | |
|
146 | 146 | def results(self): |
|
147 | 147 | for (batchable, encresref), encres in itertools.izip( |
|
148 | 148 | self._rsp, self._resultiter): |
|
149 | 149 | encresref.set(encres) |
|
150 | 150 | yield next(batchable) |
|
151 | 151 | |
|
152 | 152 | # Forward a couple of names from peer to make wireproto interactions |
|
153 | 153 | # slightly more sensible. |
|
154 | 154 | batchable = peer.batchable |
|
155 | 155 | future = peer.future |
|
156 | 156 | |
|
157 | 157 | # list of nodes encoding / decoding |
|
158 | 158 | |
|
159 | 159 | def decodelist(l, sep=' '): |
|
160 | 160 | if l: |
|
161 | 161 | return map(bin, l.split(sep)) |
|
162 | 162 | return [] |
|
163 | 163 | |
|
164 | 164 | def encodelist(l, sep=' '): |
|
165 | 165 | try: |
|
166 | 166 | return sep.join(map(hex, l)) |
|
167 | 167 | except TypeError: |
|
168 | 168 | raise |
|
169 | 169 | |
|
170 | 170 | # batched call argument encoding |
|
171 | 171 | |
|
172 | 172 | def escapearg(plain): |
|
173 | 173 | return (plain |
|
174 | 174 | .replace(':', ':c') |
|
175 | 175 | .replace(',', ':o') |
|
176 | 176 | .replace(';', ':s') |
|
177 | 177 | .replace('=', ':e')) |
|
178 | 178 | |
|
179 | 179 | def unescapearg(escaped): |
|
180 | 180 | return (escaped |
|
181 | 181 | .replace(':e', '=') |
|
182 | 182 | .replace(':s', ';') |
|
183 | 183 | .replace(':o', ',') |
|
184 | 184 | .replace(':c', ':')) |
|
185 | 185 | |
|
186 | 186 | def encodebatchcmds(req): |
|
187 | 187 | """Return a ``cmds`` argument value for the ``batch`` command.""" |
|
188 | 188 | cmds = [] |
|
189 | 189 | for op, argsdict in req: |
|
190 | 190 | # Old servers didn't properly unescape argument names. So prevent |
|
191 | 191 | # the sending of argument names that may not be decoded properly by |
|
192 | 192 | # servers. |
|
193 | 193 | assert all(escapearg(k) == k for k in argsdict) |
|
194 | 194 | |
|
195 | 195 | args = ','.join('%s=%s' % (escapearg(k), escapearg(v)) |
|
196 | 196 | for k, v in argsdict.iteritems()) |
|
197 | 197 | cmds.append('%s %s' % (op, args)) |
|
198 | 198 | |
|
199 | 199 | return ';'.join(cmds) |
|
200 | 200 | |
|
201 | 201 | # mapping of options accepted by getbundle and their types |
|
202 | 202 | # |
|
203 | 203 | # Meant to be extended by extensions. It is extensions responsibility to ensure |
|
204 | 204 | # such options are properly processed in exchange.getbundle. |
|
205 | 205 | # |
|
206 | 206 | # supported types are: |
|
207 | 207 | # |
|
208 | 208 | # :nodes: list of binary nodes |
|
209 | 209 | # :csv: list of comma-separated values |
|
210 | 210 | # :scsv: list of comma-separated values return as set |
|
211 | 211 | # :plain: string with no transformation needed. |
|
212 | 212 | gboptsmap = {'heads': 'nodes', |
|
213 | 213 | 'common': 'nodes', |
|
214 | 214 | 'obsmarkers': 'boolean', |
|
215 | 215 | 'bundlecaps': 'scsv', |
|
216 | 216 | 'listkeys': 'csv', |
|
217 | 217 | 'cg': 'boolean', |
|
218 | 218 | 'cbattempted': 'boolean'} |
|
219 | 219 | |
|
220 | 220 | # client side |
|
221 | 221 | |
|
222 | 222 | class wirepeer(peer.peerrepository): |
|
223 | 223 | """Client-side interface for communicating with a peer repository. |
|
224 | 224 | |
|
225 | 225 | Methods commonly call wire protocol commands of the same name. |
|
226 | 226 | |
|
227 | 227 | See also httppeer.py and sshpeer.py for protocol-specific |
|
228 | 228 | implementations of this interface. |
|
229 | 229 | """ |
|
230 | 230 | def batch(self): |
|
231 | 231 | if self.capable('batch'): |
|
232 | 232 | return remotebatch(self) |
|
233 | 233 | else: |
|
234 | 234 | return peer.localbatch(self) |
|
235 | 235 | def _submitbatch(self, req): |
|
236 | 236 | """run batch request <req> on the server |
|
237 | 237 | |
|
238 | 238 | Returns an iterator of the raw responses from the server. |
|
239 | 239 | """ |
|
240 | 240 | rsp = self._callstream("batch", cmds=encodebatchcmds(req)) |
|
241 | 241 | chunk = rsp.read(1024) |
|
242 | 242 | work = [chunk] |
|
243 | 243 | while chunk: |
|
244 | 244 | while ';' not in chunk and chunk: |
|
245 | 245 | chunk = rsp.read(1024) |
|
246 | 246 | work.append(chunk) |
|
247 | 247 | merged = ''.join(work) |
|
248 | 248 | while ';' in merged: |
|
249 | 249 | one, merged = merged.split(';', 1) |
|
250 | 250 | yield unescapearg(one) |
|
251 | 251 | chunk = rsp.read(1024) |
|
252 | 252 | work = [merged, chunk] |
|
253 | 253 | yield unescapearg(''.join(work)) |
|
254 | 254 | |
|
255 | 255 | def _submitone(self, op, args): |
|
256 | 256 | return self._call(op, **args) |
|
257 | 257 | |
|
258 | 258 | def iterbatch(self): |
|
259 | 259 | return remoteiterbatcher(self) |
|
260 | 260 | |
|
261 | 261 | @batchable |
|
262 | 262 | def lookup(self, key): |
|
263 | 263 | self.requirecap('lookup', _('look up remote revision')) |
|
264 | 264 | f = future() |
|
265 | 265 | yield {'key': encoding.fromlocal(key)}, f |
|
266 | 266 | d = f.value |
|
267 | 267 | success, data = d[:-1].split(" ", 1) |
|
268 | 268 | if int(success): |
|
269 | 269 | yield bin(data) |
|
270 | 270 | self._abort(error.RepoError(data)) |
|
271 | 271 | |
|
272 | 272 | @batchable |
|
273 | 273 | def heads(self): |
|
274 | 274 | f = future() |
|
275 | 275 | yield {}, f |
|
276 | 276 | d = f.value |
|
277 | 277 | try: |
|
278 | 278 | yield decodelist(d[:-1]) |
|
279 | 279 | except ValueError: |
|
280 | 280 | self._abort(error.ResponseError(_("unexpected response:"), d)) |
|
281 | 281 | |
|
282 | 282 | @batchable |
|
283 | 283 | def known(self, nodes): |
|
284 | 284 | f = future() |
|
285 | 285 | yield {'nodes': encodelist(nodes)}, f |
|
286 | 286 | d = f.value |
|
287 | 287 | try: |
|
288 | 288 | yield [bool(int(b)) for b in d] |
|
289 | 289 | except ValueError: |
|
290 | 290 | self._abort(error.ResponseError(_("unexpected response:"), d)) |
|
291 | 291 | |
|
292 | 292 | @batchable |
|
293 | 293 | def branchmap(self): |
|
294 | 294 | f = future() |
|
295 | 295 | yield {}, f |
|
296 | 296 | d = f.value |
|
297 | 297 | try: |
|
298 | 298 | branchmap = {} |
|
299 | 299 | for branchpart in d.splitlines(): |
|
300 | 300 | branchname, branchheads = branchpart.split(' ', 1) |
|
301 | 301 | branchname = encoding.tolocal(urlreq.unquote(branchname)) |
|
302 | 302 | branchheads = decodelist(branchheads) |
|
303 | 303 | branchmap[branchname] = branchheads |
|
304 | 304 | yield branchmap |
|
305 | 305 | except TypeError: |
|
306 | 306 | self._abort(error.ResponseError(_("unexpected response:"), d)) |
|
307 | 307 | |
|
308 | 308 | def branches(self, nodes): |
|
309 | 309 | n = encodelist(nodes) |
|
310 | 310 | d = self._call("branches", nodes=n) |
|
311 | 311 | try: |
|
312 | 312 | br = [tuple(decodelist(b)) for b in d.splitlines()] |
|
313 | 313 | return br |
|
314 | 314 | except ValueError: |
|
315 | 315 | self._abort(error.ResponseError(_("unexpected response:"), d)) |
|
316 | 316 | |
|
317 | 317 | def between(self, pairs): |
|
318 | 318 | batch = 8 # avoid giant requests |
|
319 | 319 | r = [] |
|
320 | 320 | for i in xrange(0, len(pairs), batch): |
|
321 | 321 | n = " ".join([encodelist(p, '-') for p in pairs[i:i + batch]]) |
|
322 | 322 | d = self._call("between", pairs=n) |
|
323 | 323 | try: |
|
324 | 324 | r.extend(l and decodelist(l) or [] for l in d.splitlines()) |
|
325 | 325 | except ValueError: |
|
326 | 326 | self._abort(error.ResponseError(_("unexpected response:"), d)) |
|
327 | 327 | return r |
|
328 | 328 | |
|
329 | 329 | @batchable |
|
330 | 330 | def pushkey(self, namespace, key, old, new): |
|
331 | 331 | if not self.capable('pushkey'): |
|
332 | 332 | yield False, None |
|
333 | 333 | f = future() |
|
334 | 334 | self.ui.debug('preparing pushkey for "%s:%s"\n' % (namespace, key)) |
|
335 | 335 | yield {'namespace': encoding.fromlocal(namespace), |
|
336 | 336 | 'key': encoding.fromlocal(key), |
|
337 | 337 | 'old': encoding.fromlocal(old), |
|
338 | 338 | 'new': encoding.fromlocal(new)}, f |
|
339 | 339 | d = f.value |
|
340 | 340 | d, output = d.split('\n', 1) |
|
341 | 341 | try: |
|
342 | 342 | d = bool(int(d)) |
|
343 | 343 | except ValueError: |
|
344 | 344 | raise error.ResponseError( |
|
345 | 345 | _('push failed (unexpected response):'), d) |
|
346 | 346 | for l in output.splitlines(True): |
|
347 | 347 | self.ui.status(_('remote: '), l) |
|
348 | 348 | yield d |
|
349 | 349 | |
|
350 | 350 | @batchable |
|
351 | 351 | def listkeys(self, namespace): |
|
352 | 352 | if not self.capable('pushkey'): |
|
353 | 353 | yield {}, None |
|
354 | 354 | f = future() |
|
355 | 355 | self.ui.debug('preparing listkeys for "%s"\n' % namespace) |
|
356 | 356 | yield {'namespace': encoding.fromlocal(namespace)}, f |
|
357 | 357 | d = f.value |
|
358 | 358 | self.ui.debug('received listkey for "%s": %i bytes\n' |
|
359 | 359 | % (namespace, len(d))) |
|
360 | 360 | yield pushkeymod.decodekeys(d) |
|
361 | 361 | |
|
362 | 362 | def stream_out(self): |
|
363 | 363 | return self._callstream('stream_out') |
|
364 | 364 | |
|
365 | 365 | def changegroup(self, nodes, kind): |
|
366 | 366 | n = encodelist(nodes) |
|
367 | 367 | f = self._callcompressable("changegroup", roots=n) |
|
368 | 368 | return changegroupmod.cg1unpacker(f, 'UN') |
|
369 | 369 | |
|
370 | 370 | def changegroupsubset(self, bases, heads, kind): |
|
371 | 371 | self.requirecap('changegroupsubset', _('look up remote changes')) |
|
372 | 372 | bases = encodelist(bases) |
|
373 | 373 | heads = encodelist(heads) |
|
374 | 374 | f = self._callcompressable("changegroupsubset", |
|
375 | 375 | bases=bases, heads=heads) |
|
376 | 376 | return changegroupmod.cg1unpacker(f, 'UN') |
|
377 | 377 | |
|
378 | 378 | def getbundle(self, source, **kwargs): |
|
379 | 379 | self.requirecap('getbundle', _('look up remote changes')) |
|
380 | 380 | opts = {} |
|
381 | 381 | bundlecaps = kwargs.get('bundlecaps') |
|
382 | 382 | if bundlecaps is not None: |
|
383 | 383 | kwargs['bundlecaps'] = sorted(bundlecaps) |
|
384 | 384 | else: |
|
385 | 385 | bundlecaps = () # kwargs could have it to None |
|
386 | 386 | for key, value in kwargs.iteritems(): |
|
387 | 387 | if value is None: |
|
388 | 388 | continue |
|
389 | 389 | keytype = gboptsmap.get(key) |
|
390 | 390 | if keytype is None: |
|
391 | 391 | assert False, 'unexpected' |
|
392 | 392 | elif keytype == 'nodes': |
|
393 | 393 | value = encodelist(value) |
|
394 | 394 | elif keytype in ('csv', 'scsv'): |
|
395 | 395 | value = ','.join(value) |
|
396 | 396 | elif keytype == 'boolean': |
|
397 | 397 | value = '%i' % bool(value) |
|
398 | 398 | elif keytype != 'plain': |
|
399 | 399 | raise KeyError('unknown getbundle option type %s' |
|
400 | 400 | % keytype) |
|
401 | 401 | opts[key] = value |
|
402 | 402 | f = self._callcompressable("getbundle", **opts) |
|
403 | 403 | if any((cap.startswith('HG2') for cap in bundlecaps)): |
|
404 | 404 | return bundle2.getunbundler(self.ui, f) |
|
405 | 405 | else: |
|
406 | 406 | return changegroupmod.cg1unpacker(f, 'UN') |
|
407 | 407 | |
|
408 | 408 | def unbundle(self, cg, heads, url): |
|
409 | 409 | '''Send cg (a readable file-like object representing the |
|
410 | 410 | changegroup to push, typically a chunkbuffer object) to the |
|
411 | 411 | remote server as a bundle. |
|
412 | 412 | |
|
413 | 413 | When pushing a bundle10 stream, return an integer indicating the |
|
414 | 414 | result of the push (see localrepository.addchangegroup()). |
|
415 | 415 | |
|
416 | 416 | When pushing a bundle20 stream, return a bundle20 stream. |
|
417 | 417 | |
|
418 | 418 | `url` is the url the client thinks it's pushing to, which is |
|
419 | 419 | visible to hooks. |
|
420 | 420 | ''' |
|
421 | 421 | |
|
422 | 422 | if heads != ['force'] and self.capable('unbundlehash'): |
|
423 | 423 | heads = encodelist(['hashed', |
|
424 | 424 | hashlib.sha1(''.join(sorted(heads))).digest()]) |
|
425 | 425 | else: |
|
426 | 426 | heads = encodelist(heads) |
|
427 | 427 | |
|
428 | 428 | if util.safehasattr(cg, 'deltaheader'): |
|
429 | 429 | # this a bundle10, do the old style call sequence |
|
430 | 430 | ret, output = self._callpush("unbundle", cg, heads=heads) |
|
431 | 431 | if ret == "": |
|
432 | 432 | raise error.ResponseError( |
|
433 | 433 | _('push failed:'), output) |
|
434 | 434 | try: |
|
435 | 435 | ret = int(ret) |
|
436 | 436 | except ValueError: |
|
437 | 437 | raise error.ResponseError( |
|
438 | 438 | _('push failed (unexpected response):'), ret) |
|
439 | 439 | |
|
440 | 440 | for l in output.splitlines(True): |
|
441 | 441 | self.ui.status(_('remote: '), l) |
|
442 | 442 | else: |
|
443 | 443 | # bundle2 push. Send a stream, fetch a stream. |
|
444 | 444 | stream = self._calltwowaystream('unbundle', cg, heads=heads) |
|
445 | 445 | ret = bundle2.getunbundler(self.ui, stream) |
|
446 | 446 | return ret |
|
447 | 447 | |
|
448 | 448 | def debugwireargs(self, one, two, three=None, four=None, five=None): |
|
449 | 449 | # don't pass optional arguments left at their default value |
|
450 | 450 | opts = {} |
|
451 | 451 | if three is not None: |
|
452 | 452 | opts['three'] = three |
|
453 | 453 | if four is not None: |
|
454 | 454 | opts['four'] = four |
|
455 | 455 | return self._call('debugwireargs', one=one, two=two, **opts) |
|
456 | 456 | |
|
457 | 457 | def _call(self, cmd, **args): |
|
458 | 458 | """execute <cmd> on the server |
|
459 | 459 | |
|
460 | 460 | The command is expected to return a simple string. |
|
461 | 461 | |
|
462 | 462 | returns the server reply as a string.""" |
|
463 | 463 | raise NotImplementedError() |
|
464 | 464 | |
|
465 | 465 | def _callstream(self, cmd, **args): |
|
466 | 466 | """execute <cmd> on the server |
|
467 | 467 | |
|
468 | 468 | The command is expected to return a stream. Note that if the |
|
469 | 469 | command doesn't return a stream, _callstream behaves |
|
470 | 470 | differently for ssh and http peers. |
|
471 | 471 | |
|
472 | 472 | returns the server reply as a file like object. |
|
473 | 473 | """ |
|
474 | 474 | raise NotImplementedError() |
|
475 | 475 | |
|
476 | 476 | def _callcompressable(self, cmd, **args): |
|
477 | 477 | """execute <cmd> on the server |
|
478 | 478 | |
|
479 | 479 | The command is expected to return a stream. |
|
480 | 480 | |
|
481 | 481 | The stream may have been compressed in some implementations. This |
|
482 | 482 | function takes care of the decompression. This is the only difference |
|
483 | 483 | with _callstream. |
|
484 | 484 | |
|
485 | 485 | returns the server reply as a file like object. |
|
486 | 486 | """ |
|
487 | 487 | raise NotImplementedError() |
|
488 | 488 | |
|
489 | 489 | def _callpush(self, cmd, fp, **args): |
|
490 | 490 | """execute a <cmd> on server |
|
491 | 491 | |
|
492 | 492 | The command is expected to be related to a push. Push has a special |
|
493 | 493 | return method. |
|
494 | 494 | |
|
495 | 495 | returns the server reply as a (ret, output) tuple. ret is either |
|
496 | 496 | empty (error) or a stringified int. |
|
497 | 497 | """ |
|
498 | 498 | raise NotImplementedError() |
|
499 | 499 | |
|
500 | 500 | def _calltwowaystream(self, cmd, fp, **args): |
|
501 | 501 | """execute <cmd> on server |
|
502 | 502 | |
|
503 | 503 | The command will send a stream to the server and get a stream in reply. |
|
504 | 504 | """ |
|
505 | 505 | raise NotImplementedError() |
|
506 | 506 | |
|
507 | 507 | def _abort(self, exception): |
|
508 | 508 | """clearly abort the wire protocol connection and raise the exception |
|
509 | 509 | """ |
|
510 | 510 | raise NotImplementedError() |
|
511 | 511 | |
|
512 | 512 | # server side |
|
513 | 513 | |
|
514 | 514 | # wire protocol command can either return a string or one of these classes. |
|
515 | 515 | class streamres(object): |
|
516 | 516 | """wireproto reply: binary stream |
|
517 | 517 | |
|
518 | 518 | The call was successful and the result is a stream. |
|
519 | 519 | |
|
520 | 520 | Accepts either a generator or an object with a ``read(size)`` method. |
|
521 | 521 | |
|
522 | 522 | ``v1compressible`` indicates whether this data can be compressed to |
|
523 | 523 | "version 1" clients (technically: HTTP peers using |
|
524 | 524 | application/mercurial-0.1 media type). This flag should NOT be used on |
|
525 | 525 | new commands because new clients should support a more modern compression |
|
526 | 526 | mechanism. |
|
527 | 527 | """ |
|
528 | 528 | def __init__(self, gen=None, reader=None, v1compressible=False): |
|
529 | 529 | self.gen = gen |
|
530 | 530 | self.reader = reader |
|
531 | 531 | self.v1compressible = v1compressible |
|
532 | 532 | |
|
533 | 533 | class pushres(object): |
|
534 | 534 | """wireproto reply: success with simple integer return |
|
535 | 535 | |
|
536 | 536 | The call was successful and returned an integer contained in `self.res`. |
|
537 | 537 | """ |
|
538 | 538 | def __init__(self, res): |
|
539 | 539 | self.res = res |
|
540 | 540 | |
|
541 | 541 | class pusherr(object): |
|
542 | 542 | """wireproto reply: failure |
|
543 | 543 | |
|
544 | 544 | The call failed. The `self.res` attribute contains the error message. |
|
545 | 545 | """ |
|
546 | 546 | def __init__(self, res): |
|
547 | 547 | self.res = res |
|
548 | 548 | |
|
549 | 549 | class ooberror(object): |
|
550 | 550 | """wireproto reply: failure of a batch of operation |
|
551 | 551 | |
|
552 | 552 | Something failed during a batch call. The error message is stored in |
|
553 | 553 | `self.message`. |
|
554 | 554 | """ |
|
555 | 555 | def __init__(self, message): |
|
556 | 556 | self.message = message |
|
557 | 557 | |
|
558 | 558 | def getdispatchrepo(repo, proto, command): |
|
559 | 559 | """Obtain the repo used for processing wire protocol commands. |
|
560 | 560 | |
|
561 | 561 | The intent of this function is to serve as a monkeypatch point for |
|
562 | 562 | extensions that need commands to operate on different repo views under |
|
563 | 563 | specialized circumstances. |
|
564 | 564 | """ |
|
565 | 565 | return repo.filtered('served') |
|
566 | 566 | |
|
567 | 567 | def dispatch(repo, proto, command): |
|
568 | 568 | repo = getdispatchrepo(repo, proto, command) |
|
569 | 569 | func, spec = commands[command] |
|
570 | 570 | args = proto.getargs(spec) |
|
571 | 571 | return func(repo, proto, *args) |
|
572 | 572 | |
|
573 | 573 | def options(cmd, keys, others): |
|
574 | 574 | opts = {} |
|
575 | 575 | for k in keys: |
|
576 | 576 | if k in others: |
|
577 | 577 | opts[k] = others[k] |
|
578 | 578 | del others[k] |
|
579 | 579 | if others: |
|
580 | 580 | util.stderr.write("warning: %s ignored unexpected arguments %s\n" |
|
581 | 581 | % (cmd, ",".join(others))) |
|
582 | 582 | return opts |
|
583 | 583 | |
|
584 | 584 | def bundle1allowed(repo, action): |
|
585 | 585 | """Whether a bundle1 operation is allowed from the server. |
|
586 | 586 | |
|
587 | 587 | Priority is: |
|
588 | 588 | |
|
589 | 589 | 1. server.bundle1gd.<action> (if generaldelta active) |
|
590 | 590 | 2. server.bundle1.<action> |
|
591 | 591 | 3. server.bundle1gd (if generaldelta active) |
|
592 | 592 | 4. server.bundle1 |
|
593 | 593 | """ |
|
594 | 594 | ui = repo.ui |
|
595 | 595 | gd = 'generaldelta' in repo.requirements |
|
596 | 596 | |
|
597 | 597 | if gd: |
|
598 | 598 | v = ui.configbool('server', 'bundle1gd.%s' % action, None) |
|
599 | 599 | if v is not None: |
|
600 | 600 | return v |
|
601 | 601 | |
|
602 | 602 | v = ui.configbool('server', 'bundle1.%s' % action, None) |
|
603 | 603 | if v is not None: |
|
604 | 604 | return v |
|
605 | 605 | |
|
606 | 606 | if gd: |
|
607 | 607 | v = ui.configbool('server', 'bundle1gd', None) |
|
608 | 608 | if v is not None: |
|
609 | 609 | return v |
|
610 | 610 | |
|
611 | 611 | return ui.configbool('server', 'bundle1', True) |
|
612 | 612 | |
|
613 | 613 | def supportedcompengines(ui, proto, role): |
|
614 | 614 | """Obtain the list of supported compression engines for a request.""" |
|
615 | 615 | assert role in (util.CLIENTROLE, util.SERVERROLE) |
|
616 | 616 | |
|
617 | 617 | compengines = util.compengines.supportedwireengines(role) |
|
618 | 618 | |
|
619 | 619 | # Allow config to override default list and ordering. |
|
620 | 620 | if role == util.SERVERROLE: |
|
621 | 621 | configengines = ui.configlist('server', 'compressionengines') |
|
622 | 622 | config = 'server.compressionengines' |
|
623 | 623 | else: |
|
624 | 624 | # This is currently implemented mainly to facilitate testing. In most |
|
625 | 625 | # cases, the server should be in charge of choosing a compression engine |
|
626 | 626 | # because a server has the most to lose from a sub-optimal choice. (e.g. |
|
627 | 627 | # CPU DoS due to an expensive engine or a network DoS due to poor |
|
628 | 628 | # compression ratio). |
|
629 | 629 | configengines = ui.configlist('experimental', |
|
630 | 630 | 'clientcompressionengines') |
|
631 | 631 | config = 'experimental.clientcompressionengines' |
|
632 | 632 | |
|
633 | 633 | # No explicit config. Filter out the ones that aren't supposed to be |
|
634 | 634 | # advertised and return default ordering. |
|
635 | 635 | if not configengines: |
|
636 | 636 | attr = 'serverpriority' if role == util.SERVERROLE else 'clientpriority' |
|
637 | 637 | return [e for e in compengines |
|
638 | 638 | if getattr(e.wireprotosupport(), attr) > 0] |
|
639 | 639 | |
|
640 | 640 | # If compression engines are listed in the config, assume there is a good |
|
641 | 641 | # reason for it (like server operators wanting to achieve specific |
|
642 | 642 | # performance characteristics). So fail fast if the config references |
|
643 | 643 | # unusable compression engines. |
|
644 | 644 | validnames = set(e.name() for e in compengines) |
|
645 | 645 | invalidnames = set(e for e in configengines if e not in validnames) |
|
646 | 646 | if invalidnames: |
|
647 | 647 | raise error.Abort(_('invalid compression engine defined in %s: %s') % |
|
648 | 648 | (config, ', '.join(sorted(invalidnames)))) |
|
649 | 649 | |
|
650 | 650 | compengines = [e for e in compengines if e.name() in configengines] |
|
651 | 651 | compengines = sorted(compengines, |
|
652 | 652 | key=lambda e: configengines.index(e.name())) |
|
653 | 653 | |
|
654 | 654 | if not compengines: |
|
655 | 655 | raise error.Abort(_('%s config option does not specify any known ' |
|
656 | 656 | 'compression engines') % config, |
|
657 | 657 | hint=_('usable compression engines: %s') % |
|
658 | 658 | ', '.sorted(validnames)) |
|
659 | 659 | |
|
660 | 660 | return compengines |
|
661 | 661 | |
|
662 | 662 | # list of commands |
|
663 | 663 | commands = {} |
|
664 | 664 | |
|
665 | 665 | def wireprotocommand(name, args=''): |
|
666 | 666 | """decorator for wire protocol command""" |
|
667 | 667 | def register(func): |
|
668 | 668 | commands[name] = (func, args) |
|
669 | 669 | return func |
|
670 | 670 | return register |
|
671 | 671 | |
|
672 | 672 | @wireprotocommand('batch', 'cmds *') |
|
673 | 673 | def batch(repo, proto, cmds, others): |
|
674 | 674 | repo = repo.filtered("served") |
|
675 | 675 | res = [] |
|
676 | 676 | for pair in cmds.split(';'): |
|
677 | 677 | op, args = pair.split(' ', 1) |
|
678 | 678 | vals = {} |
|
679 | 679 | for a in args.split(','): |
|
680 | 680 | if a: |
|
681 | 681 | n, v = a.split('=') |
|
682 | 682 | vals[unescapearg(n)] = unescapearg(v) |
|
683 | 683 | func, spec = commands[op] |
|
684 | 684 | if spec: |
|
685 | 685 | keys = spec.split() |
|
686 | 686 | data = {} |
|
687 | 687 | for k in keys: |
|
688 | 688 | if k == '*': |
|
689 | 689 | star = {} |
|
690 | 690 | for key in vals.keys(): |
|
691 | 691 | if key not in keys: |
|
692 | 692 | star[key] = vals[key] |
|
693 | 693 | data['*'] = star |
|
694 | 694 | else: |
|
695 | 695 | data[k] = vals[k] |
|
696 | 696 | result = func(repo, proto, *[data[k] for k in keys]) |
|
697 | 697 | else: |
|
698 | 698 | result = func(repo, proto) |
|
699 | 699 | if isinstance(result, ooberror): |
|
700 | 700 | return result |
|
701 | 701 | res.append(escapearg(result)) |
|
702 | 702 | return ';'.join(res) |
|
703 | 703 | |
|
704 | 704 | @wireprotocommand('between', 'pairs') |
|
705 | 705 | def between(repo, proto, pairs): |
|
706 | 706 | pairs = [decodelist(p, '-') for p in pairs.split(" ")] |
|
707 | 707 | r = [] |
|
708 | 708 | for b in repo.between(pairs): |
|
709 | 709 | r.append(encodelist(b) + "\n") |
|
710 | 710 | return "".join(r) |
|
711 | 711 | |
|
712 | 712 | @wireprotocommand('branchmap') |
|
713 | 713 | def branchmap(repo, proto): |
|
714 | 714 | branchmap = repo.branchmap() |
|
715 | 715 | heads = [] |
|
716 | 716 | for branch, nodes in branchmap.iteritems(): |
|
717 | 717 | branchname = urlreq.quote(encoding.fromlocal(branch)) |
|
718 | 718 | branchnodes = encodelist(nodes) |
|
719 | 719 | heads.append('%s %s' % (branchname, branchnodes)) |
|
720 | 720 | return '\n'.join(heads) |
|
721 | 721 | |
|
722 | 722 | @wireprotocommand('branches', 'nodes') |
|
723 | 723 | def branches(repo, proto, nodes): |
|
724 | 724 | nodes = decodelist(nodes) |
|
725 | 725 | r = [] |
|
726 | 726 | for b in repo.branches(nodes): |
|
727 | 727 | r.append(encodelist(b) + "\n") |
|
728 | 728 | return "".join(r) |
|
729 | 729 | |
|
730 | 730 | @wireprotocommand('clonebundles', '') |
|
731 | 731 | def clonebundles(repo, proto): |
|
732 | 732 | """Server command for returning info for available bundles to seed clones. |
|
733 | 733 | |
|
734 | 734 | Clients will parse this response and determine what bundle to fetch. |
|
735 | 735 | |
|
736 | 736 | Extensions may wrap this command to filter or dynamically emit data |
|
737 | 737 | depending on the request. e.g. you could advertise URLs for the closest |
|
738 | 738 | data center given the client's IP address. |
|
739 | 739 | """ |
|
740 | 740 | return repo.vfs.tryread('clonebundles.manifest') |
|
741 | 741 | |
|
742 | 742 | wireprotocaps = ['lookup', 'changegroupsubset', 'branchmap', 'pushkey', |
|
743 | 743 | 'known', 'getbundle', 'unbundlehash', 'batch'] |
|
744 | 744 | |
|
745 | 745 | def _capabilities(repo, proto): |
|
746 | 746 | """return a list of capabilities for a repo |
|
747 | 747 | |
|
748 | 748 | This function exists to allow extensions to easily wrap capabilities |
|
749 | 749 | computation |
|
750 | 750 | |
|
751 | 751 | - returns a lists: easy to alter |
|
752 | 752 | - change done here will be propagated to both `capabilities` and `hello` |
|
753 | 753 | command without any other action needed. |
|
754 | 754 | """ |
|
755 | 755 | # copy to prevent modification of the global list |
|
756 | 756 | caps = list(wireprotocaps) |
|
757 |
if streamclone.allowservergeneration(repo |
|
|
757 | if streamclone.allowservergeneration(repo): | |
|
758 | 758 | if repo.ui.configbool('server', 'preferuncompressed', False): |
|
759 | 759 | caps.append('stream-preferred') |
|
760 | 760 | requiredformats = repo.requirements & repo.supportedformats |
|
761 | 761 | # if our local revlogs are just revlogv1, add 'stream' cap |
|
762 | 762 | if not requiredformats - {'revlogv1'}: |
|
763 | 763 | caps.append('stream') |
|
764 | 764 | # otherwise, add 'streamreqs' detailing our local revlog format |
|
765 | 765 | else: |
|
766 | 766 | caps.append('streamreqs=%s' % ','.join(sorted(requiredformats))) |
|
767 | 767 | if repo.ui.configbool('experimental', 'bundle2-advertise', True): |
|
768 | 768 | capsblob = bundle2.encodecaps(bundle2.getrepocaps(repo)) |
|
769 | 769 | caps.append('bundle2=' + urlreq.quote(capsblob)) |
|
770 | 770 | caps.append('unbundle=%s' % ','.join(bundle2.bundlepriority)) |
|
771 | 771 | |
|
772 | 772 | if proto.name == 'http': |
|
773 | 773 | caps.append('httpheader=%d' % |
|
774 | 774 | repo.ui.configint('server', 'maxhttpheaderlen', 1024)) |
|
775 | 775 | if repo.ui.configbool('experimental', 'httppostargs', False): |
|
776 | 776 | caps.append('httppostargs') |
|
777 | 777 | |
|
778 | 778 | # FUTURE advertise 0.2rx once support is implemented |
|
779 | 779 | # FUTURE advertise minrx and mintx after consulting config option |
|
780 | 780 | caps.append('httpmediatype=0.1rx,0.1tx,0.2tx') |
|
781 | 781 | |
|
782 | 782 | compengines = supportedcompengines(repo.ui, proto, util.SERVERROLE) |
|
783 | 783 | if compengines: |
|
784 | 784 | comptypes = ','.join(urlreq.quote(e.wireprotosupport().name) |
|
785 | 785 | for e in compengines) |
|
786 | 786 | caps.append('compression=%s' % comptypes) |
|
787 | 787 | |
|
788 | 788 | return caps |
|
789 | 789 | |
|
790 | 790 | # If you are writing an extension and consider wrapping this function. Wrap |
|
791 | 791 | # `_capabilities` instead. |
|
792 | 792 | @wireprotocommand('capabilities') |
|
793 | 793 | def capabilities(repo, proto): |
|
794 | 794 | return ' '.join(_capabilities(repo, proto)) |
|
795 | 795 | |
|
796 | 796 | @wireprotocommand('changegroup', 'roots') |
|
797 | 797 | def changegroup(repo, proto, roots): |
|
798 | 798 | nodes = decodelist(roots) |
|
799 | 799 | cg = changegroupmod.changegroup(repo, nodes, 'serve') |
|
800 | 800 | return streamres(reader=cg, v1compressible=True) |
|
801 | 801 | |
|
802 | 802 | @wireprotocommand('changegroupsubset', 'bases heads') |
|
803 | 803 | def changegroupsubset(repo, proto, bases, heads): |
|
804 | 804 | bases = decodelist(bases) |
|
805 | 805 | heads = decodelist(heads) |
|
806 | 806 | cg = changegroupmod.changegroupsubset(repo, bases, heads, 'serve') |
|
807 | 807 | return streamres(reader=cg, v1compressible=True) |
|
808 | 808 | |
|
809 | 809 | @wireprotocommand('debugwireargs', 'one two *') |
|
810 | 810 | def debugwireargs(repo, proto, one, two, others): |
|
811 | 811 | # only accept optional args from the known set |
|
812 | 812 | opts = options('debugwireargs', ['three', 'four'], others) |
|
813 | 813 | return repo.debugwireargs(one, two, **opts) |
|
814 | 814 | |
|
815 | 815 | @wireprotocommand('getbundle', '*') |
|
816 | 816 | def getbundle(repo, proto, others): |
|
817 | 817 | opts = options('getbundle', gboptsmap.keys(), others) |
|
818 | 818 | for k, v in opts.iteritems(): |
|
819 | 819 | keytype = gboptsmap[k] |
|
820 | 820 | if keytype == 'nodes': |
|
821 | 821 | opts[k] = decodelist(v) |
|
822 | 822 | elif keytype == 'csv': |
|
823 | 823 | opts[k] = list(v.split(',')) |
|
824 | 824 | elif keytype == 'scsv': |
|
825 | 825 | opts[k] = set(v.split(',')) |
|
826 | 826 | elif keytype == 'boolean': |
|
827 | 827 | # Client should serialize False as '0', which is a non-empty string |
|
828 | 828 | # so it evaluates as a True bool. |
|
829 | 829 | if v == '0': |
|
830 | 830 | opts[k] = False |
|
831 | 831 | else: |
|
832 | 832 | opts[k] = bool(v) |
|
833 | 833 | elif keytype != 'plain': |
|
834 | 834 | raise KeyError('unknown getbundle option type %s' |
|
835 | 835 | % keytype) |
|
836 | 836 | |
|
837 | 837 | if not bundle1allowed(repo, 'pull'): |
|
838 | 838 | if not exchange.bundle2requested(opts.get('bundlecaps')): |
|
839 | 839 | if proto.name == 'http': |
|
840 | 840 | return ooberror(bundle2required) |
|
841 | 841 | raise error.Abort(bundle2requiredmain, |
|
842 | 842 | hint=bundle2requiredhint) |
|
843 | 843 | |
|
844 | 844 | try: |
|
845 | 845 | if repo.ui.configbool('server', 'disablefullbundle', False): |
|
846 | 846 | # Check to see if this is a full clone. |
|
847 | 847 | clheads = set(repo.changelog.heads()) |
|
848 | 848 | heads = set(opts.get('heads', set())) |
|
849 | 849 | common = set(opts.get('common', set())) |
|
850 | 850 | common.discard(nullid) |
|
851 | 851 | if not common and clheads == heads: |
|
852 | 852 | raise error.Abort( |
|
853 | 853 | _('server has pull-based clones disabled'), |
|
854 | 854 | hint=_('remove --pull if specified or upgrade Mercurial')) |
|
855 | 855 | |
|
856 | 856 | chunks = exchange.getbundlechunks(repo, 'serve', **opts) |
|
857 | 857 | except error.Abort as exc: |
|
858 | 858 | # cleanly forward Abort error to the client |
|
859 | 859 | if not exchange.bundle2requested(opts.get('bundlecaps')): |
|
860 | 860 | if proto.name == 'http': |
|
861 | 861 | return ooberror(str(exc) + '\n') |
|
862 | 862 | raise # cannot do better for bundle1 + ssh |
|
863 | 863 | # bundle2 request expect a bundle2 reply |
|
864 | 864 | bundler = bundle2.bundle20(repo.ui) |
|
865 | 865 | manargs = [('message', str(exc))] |
|
866 | 866 | advargs = [] |
|
867 | 867 | if exc.hint is not None: |
|
868 | 868 | advargs.append(('hint', exc.hint)) |
|
869 | 869 | bundler.addpart(bundle2.bundlepart('error:abort', |
|
870 | 870 | manargs, advargs)) |
|
871 | 871 | return streamres(gen=bundler.getchunks(), v1compressible=True) |
|
872 | 872 | return streamres(gen=chunks, v1compressible=True) |
|
873 | 873 | |
|
874 | 874 | @wireprotocommand('heads') |
|
875 | 875 | def heads(repo, proto): |
|
876 | 876 | h = repo.heads() |
|
877 | 877 | return encodelist(h) + "\n" |
|
878 | 878 | |
|
879 | 879 | @wireprotocommand('hello') |
|
880 | 880 | def hello(repo, proto): |
|
881 | 881 | '''the hello command returns a set of lines describing various |
|
882 | 882 | interesting things about the server, in an RFC822-like format. |
|
883 | 883 | Currently the only one defined is "capabilities", which |
|
884 | 884 | consists of a line in the form: |
|
885 | 885 | |
|
886 | 886 | capabilities: space separated list of tokens |
|
887 | 887 | ''' |
|
888 | 888 | return "capabilities: %s\n" % (capabilities(repo, proto)) |
|
889 | 889 | |
|
890 | 890 | @wireprotocommand('listkeys', 'namespace') |
|
891 | 891 | def listkeys(repo, proto, namespace): |
|
892 | 892 | d = repo.listkeys(encoding.tolocal(namespace)).items() |
|
893 | 893 | return pushkeymod.encodekeys(d) |
|
894 | 894 | |
|
895 | 895 | @wireprotocommand('lookup', 'key') |
|
896 | 896 | def lookup(repo, proto, key): |
|
897 | 897 | try: |
|
898 | 898 | k = encoding.tolocal(key) |
|
899 | 899 | c = repo[k] |
|
900 | 900 | r = c.hex() |
|
901 | 901 | success = 1 |
|
902 | 902 | except Exception as inst: |
|
903 | 903 | r = str(inst) |
|
904 | 904 | success = 0 |
|
905 | 905 | return "%s %s\n" % (success, r) |
|
906 | 906 | |
|
907 | 907 | @wireprotocommand('known', 'nodes *') |
|
908 | 908 | def known(repo, proto, nodes, others): |
|
909 | 909 | return ''.join(b and "1" or "0" for b in repo.known(decodelist(nodes))) |
|
910 | 910 | |
|
911 | 911 | @wireprotocommand('pushkey', 'namespace key old new') |
|
912 | 912 | def pushkey(repo, proto, namespace, key, old, new): |
|
913 | 913 | # compatibility with pre-1.8 clients which were accidentally |
|
914 | 914 | # sending raw binary nodes rather than utf-8-encoded hex |
|
915 | 915 | if len(new) == 20 and util.escapestr(new) != new: |
|
916 | 916 | # looks like it could be a binary node |
|
917 | 917 | try: |
|
918 | 918 | new.decode('utf-8') |
|
919 | 919 | new = encoding.tolocal(new) # but cleanly decodes as UTF-8 |
|
920 | 920 | except UnicodeDecodeError: |
|
921 | 921 | pass # binary, leave unmodified |
|
922 | 922 | else: |
|
923 | 923 | new = encoding.tolocal(new) # normal path |
|
924 | 924 | |
|
925 | 925 | if util.safehasattr(proto, 'restore'): |
|
926 | 926 | |
|
927 | 927 | proto.redirect() |
|
928 | 928 | |
|
929 | 929 | try: |
|
930 | 930 | r = repo.pushkey(encoding.tolocal(namespace), encoding.tolocal(key), |
|
931 | 931 | encoding.tolocal(old), new) or False |
|
932 | 932 | except error.Abort: |
|
933 | 933 | r = False |
|
934 | 934 | |
|
935 | 935 | output = proto.restore() |
|
936 | 936 | |
|
937 | 937 | return '%s\n%s' % (int(r), output) |
|
938 | 938 | |
|
939 | 939 | r = repo.pushkey(encoding.tolocal(namespace), encoding.tolocal(key), |
|
940 | 940 | encoding.tolocal(old), new) |
|
941 | 941 | return '%s\n' % int(r) |
|
942 | 942 | |
|
943 | 943 | @wireprotocommand('stream_out') |
|
944 | 944 | def stream(repo, proto): |
|
945 | 945 | '''If the server supports streaming clone, it advertises the "stream" |
|
946 | 946 | capability with a value representing the version and flags of the repo |
|
947 | 947 | it is serving. Client checks to see if it understands the format. |
|
948 | 948 | ''' |
|
949 |
if not streamclone.allowservergeneration(repo |
|
|
949 | if not streamclone.allowservergeneration(repo): | |
|
950 | 950 | return '1\n' |
|
951 | 951 | |
|
952 | 952 | def getstream(it): |
|
953 | 953 | yield '0\n' |
|
954 | 954 | for chunk in it: |
|
955 | 955 | yield chunk |
|
956 | 956 | |
|
957 | 957 | try: |
|
958 | 958 | # LockError may be raised before the first result is yielded. Don't |
|
959 | 959 | # emit output until we're sure we got the lock successfully. |
|
960 | 960 | it = streamclone.generatev1wireproto(repo) |
|
961 | 961 | return streamres(gen=getstream(it)) |
|
962 | 962 | except error.LockError: |
|
963 | 963 | return '2\n' |
|
964 | 964 | |
|
965 | 965 | @wireprotocommand('unbundle', 'heads') |
|
966 | 966 | def unbundle(repo, proto, heads): |
|
967 | 967 | their_heads = decodelist(heads) |
|
968 | 968 | |
|
969 | 969 | try: |
|
970 | 970 | proto.redirect() |
|
971 | 971 | |
|
972 | 972 | exchange.check_heads(repo, their_heads, 'preparing changes') |
|
973 | 973 | |
|
974 | 974 | # write bundle data to temporary file because it can be big |
|
975 | 975 | fd, tempname = tempfile.mkstemp(prefix='hg-unbundle-') |
|
976 | 976 | fp = os.fdopen(fd, pycompat.sysstr('wb+')) |
|
977 | 977 | r = 0 |
|
978 | 978 | try: |
|
979 | 979 | proto.getfile(fp) |
|
980 | 980 | fp.seek(0) |
|
981 | 981 | gen = exchange.readbundle(repo.ui, fp, None) |
|
982 | 982 | if (isinstance(gen, changegroupmod.cg1unpacker) |
|
983 | 983 | and not bundle1allowed(repo, 'push')): |
|
984 | 984 | if proto.name == 'http': |
|
985 | 985 | # need to special case http because stderr do not get to |
|
986 | 986 | # the http client on failed push so we need to abuse some |
|
987 | 987 | # other error type to make sure the message get to the |
|
988 | 988 | # user. |
|
989 | 989 | return ooberror(bundle2required) |
|
990 | 990 | raise error.Abort(bundle2requiredmain, |
|
991 | 991 | hint=bundle2requiredhint) |
|
992 | 992 | |
|
993 | 993 | r = exchange.unbundle(repo, gen, their_heads, 'serve', |
|
994 | 994 | proto._client()) |
|
995 | 995 | if util.safehasattr(r, 'addpart'): |
|
996 | 996 | # The return looks streamable, we are in the bundle2 case and |
|
997 | 997 | # should return a stream. |
|
998 | 998 | return streamres(gen=r.getchunks()) |
|
999 | 999 | return pushres(r) |
|
1000 | 1000 | |
|
1001 | 1001 | finally: |
|
1002 | 1002 | fp.close() |
|
1003 | 1003 | os.unlink(tempname) |
|
1004 | 1004 | |
|
1005 | 1005 | except (error.BundleValueError, error.Abort, error.PushRaced) as exc: |
|
1006 | 1006 | # handle non-bundle2 case first |
|
1007 | 1007 | if not getattr(exc, 'duringunbundle2', False): |
|
1008 | 1008 | try: |
|
1009 | 1009 | raise |
|
1010 | 1010 | except error.Abort: |
|
1011 | 1011 | # The old code we moved used util.stderr directly. |
|
1012 | 1012 | # We did not change it to minimise code change. |
|
1013 | 1013 | # This need to be moved to something proper. |
|
1014 | 1014 | # Feel free to do it. |
|
1015 | 1015 | util.stderr.write("abort: %s\n" % exc) |
|
1016 | 1016 | if exc.hint is not None: |
|
1017 | 1017 | util.stderr.write("(%s)\n" % exc.hint) |
|
1018 | 1018 | return pushres(0) |
|
1019 | 1019 | except error.PushRaced: |
|
1020 | 1020 | return pusherr(str(exc)) |
|
1021 | 1021 | |
|
1022 | 1022 | bundler = bundle2.bundle20(repo.ui) |
|
1023 | 1023 | for out in getattr(exc, '_bundle2salvagedoutput', ()): |
|
1024 | 1024 | bundler.addpart(out) |
|
1025 | 1025 | try: |
|
1026 | 1026 | try: |
|
1027 | 1027 | raise |
|
1028 | 1028 | except error.PushkeyFailed as exc: |
|
1029 | 1029 | # check client caps |
|
1030 | 1030 | remotecaps = getattr(exc, '_replycaps', None) |
|
1031 | 1031 | if (remotecaps is not None |
|
1032 | 1032 | and 'pushkey' not in remotecaps.get('error', ())): |
|
1033 | 1033 | # no support remote side, fallback to Abort handler. |
|
1034 | 1034 | raise |
|
1035 | 1035 | part = bundler.newpart('error:pushkey') |
|
1036 | 1036 | part.addparam('in-reply-to', exc.partid) |
|
1037 | 1037 | if exc.namespace is not None: |
|
1038 | 1038 | part.addparam('namespace', exc.namespace, mandatory=False) |
|
1039 | 1039 | if exc.key is not None: |
|
1040 | 1040 | part.addparam('key', exc.key, mandatory=False) |
|
1041 | 1041 | if exc.new is not None: |
|
1042 | 1042 | part.addparam('new', exc.new, mandatory=False) |
|
1043 | 1043 | if exc.old is not None: |
|
1044 | 1044 | part.addparam('old', exc.old, mandatory=False) |
|
1045 | 1045 | if exc.ret is not None: |
|
1046 | 1046 | part.addparam('ret', exc.ret, mandatory=False) |
|
1047 | 1047 | except error.BundleValueError as exc: |
|
1048 | 1048 | errpart = bundler.newpart('error:unsupportedcontent') |
|
1049 | 1049 | if exc.parttype is not None: |
|
1050 | 1050 | errpart.addparam('parttype', exc.parttype) |
|
1051 | 1051 | if exc.params: |
|
1052 | 1052 | errpart.addparam('params', '\0'.join(exc.params)) |
|
1053 | 1053 | except error.Abort as exc: |
|
1054 | 1054 | manargs = [('message', str(exc))] |
|
1055 | 1055 | advargs = [] |
|
1056 | 1056 | if exc.hint is not None: |
|
1057 | 1057 | advargs.append(('hint', exc.hint)) |
|
1058 | 1058 | bundler.addpart(bundle2.bundlepart('error:abort', |
|
1059 | 1059 | manargs, advargs)) |
|
1060 | 1060 | except error.PushRaced as exc: |
|
1061 | 1061 | bundler.newpart('error:pushraced', [('message', str(exc))]) |
|
1062 | 1062 | return streamres(gen=bundler.getchunks()) |
@@ -1,90 +1,161 b'' | |||
|
1 | 1 | #require serve |
|
2 | 2 | |
|
3 | 3 | Initialize repository |
|
4 | 4 | the status call is to check for issue5130 |
|
5 | 5 | |
|
6 | 6 | $ hg init server |
|
7 | 7 | $ cd server |
|
8 | 8 | $ touch foo |
|
9 | 9 | $ hg -q commit -A -m initial |
|
10 | 10 | >>> for i in range(1024): |
|
11 | 11 | ... with open(str(i), 'wb') as fh: |
|
12 | 12 | ... fh.write(str(i)) |
|
13 | 13 | $ hg -q commit -A -m 'add a lot of files' |
|
14 | 14 | $ hg st |
|
15 | 15 | $ hg serve -p $HGPORT -d --pid-file=hg.pid |
|
16 | 16 | $ cat hg.pid >> $DAEMON_PIDS |
|
17 | 17 | $ cd .. |
|
18 | 18 | |
|
19 | 19 | Basic clone |
|
20 | 20 | |
|
21 | 21 | $ hg clone --uncompressed -U http://localhost:$HGPORT clone1 |
|
22 | 22 | streaming all changes |
|
23 | 23 | 1027 files to transfer, 96.3 KB of data |
|
24 | 24 | transferred 96.3 KB in * seconds (*/sec) (glob) |
|
25 | 25 | searching for changes |
|
26 | 26 | no changes found |
|
27 | 27 | |
|
28 | 28 | Clone with background file closing enabled |
|
29 | 29 | |
|
30 | 30 | $ hg --debug --config worker.backgroundclose=true --config worker.backgroundcloseminfilecount=1 clone --uncompressed -U http://localhost:$HGPORT clone-background | grep -v adding |
|
31 | 31 | using http://localhost:$HGPORT/ |
|
32 | 32 | sending capabilities command |
|
33 | 33 | sending branchmap command |
|
34 | 34 | streaming all changes |
|
35 | 35 | sending stream_out command |
|
36 | 36 | 1027 files to transfer, 96.3 KB of data |
|
37 | 37 | starting 4 threads for background file closing |
|
38 | 38 | transferred 96.3 KB in * seconds (*/sec) (glob) |
|
39 | 39 | query 1; heads |
|
40 | 40 | sending batch command |
|
41 | 41 | searching for changes |
|
42 | 42 | all remote heads known locally |
|
43 | 43 | no changes found |
|
44 | 44 | sending getbundle command |
|
45 | 45 | bundle2-input-bundle: with-transaction |
|
46 | 46 | bundle2-input-part: "listkeys" (params: 1 mandatory) supported |
|
47 | 47 | bundle2-input-part: total payload size 58 |
|
48 | 48 | bundle2-input-part: "listkeys" (params: 1 mandatory) supported |
|
49 | 49 | bundle2-input-bundle: 1 parts total |
|
50 | 50 | checking for updated bookmarks |
|
51 | 51 | |
|
52 | Cannot stream clone when there are secret changesets | |
|
53 | ||
|
54 | $ hg -R server phase --force --secret -r tip | |
|
55 | $ hg clone --uncompressed -U http://localhost:$HGPORT secret-denied | |
|
56 | warning: stream clone requested but server has them disabled | |
|
57 | requesting all changes | |
|
58 | adding changesets | |
|
59 | adding manifests | |
|
60 | adding file changes | |
|
61 | added 1 changesets with 1 changes to 1 files | |
|
62 | ||
|
63 | $ killdaemons.py | |
|
64 | ||
|
65 | Streaming of secrets can be overridden by server config | |
|
66 | ||
|
67 | $ cd server | |
|
68 | $ hg --config server.uncompressedallowsecret=true serve -p $HGPORT -d --pid-file=hg.pid | |
|
69 | $ cat hg.pid > $DAEMON_PIDS | |
|
70 | $ cd .. | |
|
71 | ||
|
72 | $ hg clone --uncompressed -U http://localhost:$HGPORT secret-allowed | |
|
73 | streaming all changes | |
|
74 | 1027 files to transfer, 96.3 KB of data | |
|
75 | transferred 96.3 KB in * seconds (*/sec) (glob) | |
|
76 | searching for changes | |
|
77 | no changes found | |
|
78 | ||
|
79 | $ killdaemons.py | |
|
80 | ||
|
81 | Verify interaction between preferuncompressed and secret presence | |
|
82 | ||
|
83 | $ cd server | |
|
84 | $ hg --config server.preferuncompressed=true serve -p $HGPORT -d --pid-file=hg.pid | |
|
85 | $ cat hg.pid > $DAEMON_PIDS | |
|
86 | $ cd .. | |
|
87 | ||
|
88 | $ hg clone -U http://localhost:$HGPORT preferuncompressed-secret | |
|
89 | requesting all changes | |
|
90 | adding changesets | |
|
91 | adding manifests | |
|
92 | adding file changes | |
|
93 | added 1 changesets with 1 changes to 1 files | |
|
94 | ||
|
95 | $ killdaemons.py | |
|
96 | ||
|
97 | Clone not allowed when full bundles disabled and can't serve secrets | |
|
98 | ||
|
99 | $ cd server | |
|
100 | $ hg --config server.disablefullbundle=true serve -p $HGPORT -d --pid-file=hg.pid | |
|
101 | $ cat hg.pid > $DAEMON_PIDS | |
|
102 | $ cd .. | |
|
103 | ||
|
104 | $ hg clone --uncompressed http://localhost:$HGPORT secret-full-disabled | |
|
105 | warning: stream clone requested but server has them disabled | |
|
106 | requesting all changes | |
|
107 | remote: abort: server has pull-based clones disabled | |
|
108 | abort: pull failed on remote | |
|
109 | (remove --pull if specified or upgrade Mercurial) | |
|
110 | [255] | |
|
111 | ||
|
112 | Local stream clone with secrets involved | |
|
113 | (This is just a test over behavior: if you have access to the repo's files, | |
|
114 | there is no security so it isn't important to prevent a clone here.) | |
|
115 | ||
|
116 | $ hg clone -U --uncompressed server local-secret | |
|
117 | warning: stream clone requested but server has them disabled | |
|
118 | requesting all changes | |
|
119 | adding changesets | |
|
120 | adding manifests | |
|
121 | adding file changes | |
|
122 | added 1 changesets with 1 changes to 1 files | |
|
52 | 123 | |
|
53 | 124 | Stream clone while repo is changing: |
|
54 | 125 | |
|
55 | 126 | $ mkdir changing |
|
56 | 127 | $ cd changing |
|
57 | 128 | |
|
58 | 129 | extension for delaying the server process so we reliably can modify the repo |
|
59 | 130 | while cloning |
|
60 | 131 | |
|
61 | 132 | $ cat > delayer.py <<EOF |
|
62 | 133 | > import time |
|
63 | 134 | > from mercurial import extensions, vfs |
|
64 | 135 | > def __call__(orig, self, path, *args, **kwargs): |
|
65 | 136 | > if path == 'data/f1.i': |
|
66 | 137 | > time.sleep(2) |
|
67 | 138 | > return orig(self, path, *args, **kwargs) |
|
68 | 139 | > extensions.wrapfunction(vfs.vfs, '__call__', __call__) |
|
69 | 140 | > EOF |
|
70 | 141 | |
|
71 | 142 | prepare repo with small and big file to cover both code paths in emitrevlogdata |
|
72 | 143 | |
|
73 | 144 | $ hg init repo |
|
74 | 145 | $ touch repo/f1 |
|
75 | 146 | $ $TESTDIR/seq.py 50000 > repo/f2 |
|
76 | 147 | $ hg -R repo ci -Aqm "0" |
|
77 | 148 | $ hg -R repo serve -p $HGPORT1 -d --pid-file=hg.pid --config extensions.delayer=delayer.py |
|
78 | 149 | $ cat hg.pid >> $DAEMON_PIDS |
|
79 | 150 | |
|
80 | 151 | clone while modifying the repo between stating file with write lock and |
|
81 | 152 | actually serving file content |
|
82 | 153 | |
|
83 | 154 |
|
|
84 | 155 | $ sleep 1 |
|
85 | 156 | $ echo >> repo/f1 |
|
86 | 157 | $ echo >> repo/f2 |
|
87 | 158 | $ hg -R repo ci -m "1" |
|
88 | 159 | $ wait |
|
89 | 160 | $ hg -R clone id |
|
90 | 161 | 000000000000 |
General Comments 0
You need to be logged in to leave comments.
Login now