Show More
@@ -1,2070 +1,2079 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 | - ``<install-root>/etc/mercurial/hgrc`` (per-installation) |
|
60 | 60 | - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation) |
|
61 | 61 | - ``/etc/mercurial/hgrc`` (per-system) |
|
62 | 62 | - ``/etc/mercurial/hgrc.d/*.rc`` (per-system) |
|
63 | 63 | - ``<internal>/default.d/*.rc`` (defaults) |
|
64 | 64 | |
|
65 | 65 | .. container:: verbose.windows |
|
66 | 66 | |
|
67 | 67 | On Windows, the following files are consulted: |
|
68 | 68 | |
|
69 | 69 | - ``<repo>/.hg/hgrc`` (per-repository) |
|
70 | 70 | - ``%USERPROFILE%\.hgrc`` (per-user) |
|
71 | 71 | - ``%USERPROFILE%\Mercurial.ini`` (per-user) |
|
72 | 72 | - ``%HOME%\.hgrc`` (per-user) |
|
73 | 73 | - ``%HOME%\Mercurial.ini`` (per-user) |
|
74 | 74 | - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation) |
|
75 | 75 | - ``<install-dir>\hgrc.d\*.rc`` (per-installation) |
|
76 | 76 | - ``<install-dir>\Mercurial.ini`` (per-installation) |
|
77 | 77 | - ``<internal>/default.d/*.rc`` (defaults) |
|
78 | 78 | |
|
79 | 79 | .. note:: |
|
80 | 80 | |
|
81 | 81 | The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial`` |
|
82 | 82 | is used when running 32-bit Python on 64-bit Windows. |
|
83 | 83 | |
|
84 | 84 | .. container:: windows |
|
85 | 85 | |
|
86 | 86 | On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``. |
|
87 | 87 | |
|
88 | 88 | .. container:: verbose.plan9 |
|
89 | 89 | |
|
90 | 90 | On Plan9, the following files are consulted: |
|
91 | 91 | |
|
92 | 92 | - ``<repo>/.hg/hgrc`` (per-repository) |
|
93 | 93 | - ``$home/lib/hgrc`` (per-user) |
|
94 | 94 | - ``<install-root>/lib/mercurial/hgrc`` (per-installation) |
|
95 | 95 | - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation) |
|
96 | 96 | - ``/lib/mercurial/hgrc`` (per-system) |
|
97 | 97 | - ``/lib/mercurial/hgrc.d/*.rc`` (per-system) |
|
98 | 98 | - ``<internal>/default.d/*.rc`` (defaults) |
|
99 | 99 | |
|
100 | 100 | Per-repository configuration options only apply in a |
|
101 | 101 | particular repository. This file is not version-controlled, and |
|
102 | 102 | will not get transferred during a "clone" operation. Options in |
|
103 | 103 | this file override options in all other configuration files. |
|
104 | 104 | |
|
105 | 105 | .. container:: unix.plan9 |
|
106 | 106 | |
|
107 | 107 | On Plan 9 and Unix, most of this file will be ignored if it doesn't |
|
108 | 108 | belong to a trusted user or to a trusted group. See |
|
109 | 109 | :hg:`help config.trusted` for more details. |
|
110 | 110 | |
|
111 | 111 | Per-user configuration file(s) are for the user running Mercurial. Options |
|
112 | 112 | in these files apply to all Mercurial commands executed by this user in any |
|
113 | 113 | directory. Options in these files override per-system and per-installation |
|
114 | 114 | options. |
|
115 | 115 | |
|
116 | 116 | Per-installation configuration files are searched for in the |
|
117 | 117 | directory where Mercurial is installed. ``<install-root>`` is the |
|
118 | 118 | parent directory of the **hg** executable (or symlink) being run. |
|
119 | 119 | |
|
120 | 120 | .. container:: unix.plan9 |
|
121 | 121 | |
|
122 | 122 | For example, if installed in ``/shared/tools/bin/hg``, Mercurial |
|
123 | 123 | will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these |
|
124 | 124 | files apply to all Mercurial commands executed by any user in any |
|
125 | 125 | directory. |
|
126 | 126 | |
|
127 | 127 | Per-installation configuration files are for the system on |
|
128 | 128 | which Mercurial is running. Options in these files apply to all |
|
129 | 129 | Mercurial commands executed by any user in any directory. Registry |
|
130 | 130 | keys contain PATH-like strings, every part of which must reference |
|
131 | 131 | a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will |
|
132 | 132 | be read. Mercurial checks each of these locations in the specified |
|
133 | 133 | order until one or more configuration files are detected. |
|
134 | 134 | |
|
135 | 135 | Per-system configuration files are for the system on which Mercurial |
|
136 | 136 | is running. Options in these files apply to all Mercurial commands |
|
137 | 137 | executed by any user in any directory. Options in these files |
|
138 | 138 | override per-installation options. |
|
139 | 139 | |
|
140 | 140 | Mercurial comes with some default configuration. The default configuration |
|
141 | 141 | files are installed with Mercurial and will be overwritten on upgrades. Default |
|
142 | 142 | configuration files should never be edited by users or administrators but can |
|
143 | 143 | be overridden in other configuration files. So far the directory only contains |
|
144 | 144 | merge tool configuration but packagers can also put other default configuration |
|
145 | 145 | there. |
|
146 | 146 | |
|
147 | 147 | Syntax |
|
148 | 148 | ====== |
|
149 | 149 | |
|
150 | 150 | A configuration file consists of sections, led by a ``[section]`` header |
|
151 | 151 | and followed by ``name = value`` entries (sometimes called |
|
152 | 152 | ``configuration keys``):: |
|
153 | 153 | |
|
154 | 154 | [spam] |
|
155 | 155 | eggs=ham |
|
156 | 156 | green= |
|
157 | 157 | eggs |
|
158 | 158 | |
|
159 | 159 | Each line contains one entry. If the lines that follow are indented, |
|
160 | 160 | they are treated as continuations of that entry. Leading whitespace is |
|
161 | 161 | removed from values. Empty lines are skipped. Lines beginning with |
|
162 | 162 | ``#`` or ``;`` are ignored and may be used to provide comments. |
|
163 | 163 | |
|
164 | 164 | Configuration keys can be set multiple times, in which case Mercurial |
|
165 | 165 | will use the value that was configured last. As an example:: |
|
166 | 166 | |
|
167 | 167 | [spam] |
|
168 | 168 | eggs=large |
|
169 | 169 | ham=serrano |
|
170 | 170 | eggs=small |
|
171 | 171 | |
|
172 | 172 | This would set the configuration key named ``eggs`` to ``small``. |
|
173 | 173 | |
|
174 | 174 | It is also possible to define a section multiple times. A section can |
|
175 | 175 | be redefined on the same and/or on different configuration files. For |
|
176 | 176 | example:: |
|
177 | 177 | |
|
178 | 178 | [foo] |
|
179 | 179 | eggs=large |
|
180 | 180 | ham=serrano |
|
181 | 181 | eggs=small |
|
182 | 182 | |
|
183 | 183 | [bar] |
|
184 | 184 | eggs=ham |
|
185 | 185 | green= |
|
186 | 186 | eggs |
|
187 | 187 | |
|
188 | 188 | [foo] |
|
189 | 189 | ham=prosciutto |
|
190 | 190 | eggs=medium |
|
191 | 191 | bread=toasted |
|
192 | 192 | |
|
193 | 193 | This would set the ``eggs``, ``ham``, and ``bread`` configuration keys |
|
194 | 194 | of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``, |
|
195 | 195 | respectively. As you can see there only thing that matters is the last |
|
196 | 196 | value that was set for each of the configuration keys. |
|
197 | 197 | |
|
198 | 198 | If a configuration key is set multiple times in different |
|
199 | 199 | configuration files the final value will depend on the order in which |
|
200 | 200 | the different configuration files are read, with settings from earlier |
|
201 | 201 | paths overriding later ones as described on the ``Files`` section |
|
202 | 202 | above. |
|
203 | 203 | |
|
204 | 204 | A line of the form ``%include file`` will include ``file`` into the |
|
205 | 205 | current configuration file. The inclusion is recursive, which means |
|
206 | 206 | that included files can include other files. Filenames are relative to |
|
207 | 207 | the configuration file in which the ``%include`` directive is found. |
|
208 | 208 | Environment variables and ``~user`` constructs are expanded in |
|
209 | 209 | ``file``. This lets you do something like:: |
|
210 | 210 | |
|
211 | 211 | %include ~/.hgrc.d/$HOST.rc |
|
212 | 212 | |
|
213 | 213 | to include a different configuration file on each computer you use. |
|
214 | 214 | |
|
215 | 215 | A line with ``%unset name`` will remove ``name`` from the current |
|
216 | 216 | section, if it has been set previously. |
|
217 | 217 | |
|
218 | 218 | The values are either free-form text strings, lists of text strings, |
|
219 | 219 | or Boolean values. Boolean values can be set to true using any of "1", |
|
220 | 220 | "yes", "true", or "on" and to false using "0", "no", "false", or "off" |
|
221 | 221 | (all case insensitive). |
|
222 | 222 | |
|
223 | 223 | List values are separated by whitespace or comma, except when values are |
|
224 | 224 | placed in double quotation marks:: |
|
225 | 225 | |
|
226 | 226 | allow_read = "John Doe, PhD", brian, betty |
|
227 | 227 | |
|
228 | 228 | Quotation marks can be escaped by prefixing them with a backslash. Only |
|
229 | 229 | quotation marks at the beginning of a word is counted as a quotation |
|
230 | 230 | (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``). |
|
231 | 231 | |
|
232 | 232 | Sections |
|
233 | 233 | ======== |
|
234 | 234 | |
|
235 | 235 | This section describes the different sections that may appear in a |
|
236 | 236 | Mercurial configuration file, the purpose of each section, its possible |
|
237 | 237 | keys, and their possible values. |
|
238 | 238 | |
|
239 | 239 | ``alias`` |
|
240 | 240 | --------- |
|
241 | 241 | |
|
242 | 242 | Defines command aliases. |
|
243 | 243 | |
|
244 | 244 | Aliases allow you to define your own commands in terms of other |
|
245 | 245 | commands (or aliases), optionally including arguments. Positional |
|
246 | 246 | arguments in the form of ``$1``, ``$2``, etc. in the alias definition |
|
247 | 247 | are expanded by Mercurial before execution. Positional arguments not |
|
248 | 248 | already used by ``$N`` in the definition are put at the end of the |
|
249 | 249 | command to be executed. |
|
250 | 250 | |
|
251 | 251 | Alias definitions consist of lines of the form:: |
|
252 | 252 | |
|
253 | 253 | <alias> = <command> [<argument>]... |
|
254 | 254 | |
|
255 | 255 | For example, this definition:: |
|
256 | 256 | |
|
257 | 257 | latest = log --limit 5 |
|
258 | 258 | |
|
259 | 259 | creates a new command ``latest`` that shows only the five most recent |
|
260 | 260 | changesets. You can define subsequent aliases using earlier ones:: |
|
261 | 261 | |
|
262 | 262 | stable5 = latest -b stable |
|
263 | 263 | |
|
264 | 264 | .. note:: |
|
265 | 265 | |
|
266 | 266 | It is possible to create aliases with the same names as |
|
267 | 267 | existing commands, which will then override the original |
|
268 | 268 | definitions. This is almost always a bad idea! |
|
269 | 269 | |
|
270 | 270 | An alias can start with an exclamation point (``!``) to make it a |
|
271 | 271 | shell alias. A shell alias is executed with the shell and will let you |
|
272 | 272 | run arbitrary commands. As an example, :: |
|
273 | 273 | |
|
274 | 274 | echo = !echo $@ |
|
275 | 275 | |
|
276 | 276 | will let you do ``hg echo foo`` to have ``foo`` printed in your |
|
277 | 277 | terminal. A better example might be:: |
|
278 | 278 | |
|
279 | 279 | purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm |
|
280 | 280 | |
|
281 | 281 | which will make ``hg purge`` delete all unknown files in the |
|
282 | 282 | repository in the same manner as the purge extension. |
|
283 | 283 | |
|
284 | 284 | Positional arguments like ``$1``, ``$2``, etc. in the alias definition |
|
285 | 285 | expand to the command arguments. Unmatched arguments are |
|
286 | 286 | removed. ``$0`` expands to the alias name and ``$@`` expands to all |
|
287 | 287 | arguments separated by a space. ``"$@"`` (with quotes) expands to all |
|
288 | 288 | arguments quoted individually and separated by a space. These expansions |
|
289 | 289 | happen before the command is passed to the shell. |
|
290 | 290 | |
|
291 | 291 | Shell aliases are executed in an environment where ``$HG`` expands to |
|
292 | 292 | the path of the Mercurial that was used to execute the alias. This is |
|
293 | 293 | useful when you want to call further Mercurial commands in a shell |
|
294 | 294 | alias, as was done above for the purge alias. In addition, |
|
295 | 295 | ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg |
|
296 | 296 | echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``. |
|
297 | 297 | |
|
298 | 298 | .. note:: |
|
299 | 299 | |
|
300 | 300 | Some global configuration options such as ``-R`` are |
|
301 | 301 | processed before shell aliases and will thus not be passed to |
|
302 | 302 | aliases. |
|
303 | 303 | |
|
304 | 304 | |
|
305 | 305 | ``annotate`` |
|
306 | 306 | ------------ |
|
307 | 307 | |
|
308 | 308 | Settings used when displaying file annotations. All values are |
|
309 | 309 | Booleans and default to False. See :hg:`help config.diff` for |
|
310 | 310 | related options for the diff command. |
|
311 | 311 | |
|
312 | 312 | ``ignorews`` |
|
313 | 313 | Ignore white space when comparing lines. |
|
314 | 314 | |
|
315 | 315 | ``ignorewsamount`` |
|
316 | 316 | Ignore changes in the amount of white space. |
|
317 | 317 | |
|
318 | 318 | ``ignoreblanklines`` |
|
319 | 319 | Ignore changes whose lines are all blank. |
|
320 | 320 | |
|
321 | 321 | |
|
322 | 322 | ``auth`` |
|
323 | 323 | -------- |
|
324 | 324 | |
|
325 | 325 | Authentication credentials for HTTP authentication. This section |
|
326 | 326 | allows you to store usernames and passwords for use when logging |
|
327 | 327 | *into* HTTP servers. See :hg:`help config.web` if |
|
328 | 328 | you want to configure *who* can login to your HTTP server. |
|
329 | 329 | |
|
330 | 330 | Each line has the following format:: |
|
331 | 331 | |
|
332 | 332 | <name>.<argument> = <value> |
|
333 | 333 | |
|
334 | 334 | where ``<name>`` is used to group arguments into authentication |
|
335 | 335 | entries. Example:: |
|
336 | 336 | |
|
337 | 337 | foo.prefix = hg.intevation.de/mercurial |
|
338 | 338 | foo.username = foo |
|
339 | 339 | foo.password = bar |
|
340 | 340 | foo.schemes = http https |
|
341 | 341 | |
|
342 | 342 | bar.prefix = secure.example.org |
|
343 | 343 | bar.key = path/to/file.key |
|
344 | 344 | bar.cert = path/to/file.cert |
|
345 | 345 | bar.schemes = https |
|
346 | 346 | |
|
347 | 347 | Supported arguments: |
|
348 | 348 | |
|
349 | 349 | ``prefix`` |
|
350 | 350 | Either ``*`` or a URI prefix with or without the scheme part. |
|
351 | 351 | The authentication entry with the longest matching prefix is used |
|
352 | 352 | (where ``*`` matches everything and counts as a match of length |
|
353 | 353 | 1). If the prefix doesn't include a scheme, the match is performed |
|
354 | 354 | against the URI with its scheme stripped as well, and the schemes |
|
355 | 355 | argument, q.v., is then subsequently consulted. |
|
356 | 356 | |
|
357 | 357 | ``username`` |
|
358 | 358 | Optional. Username to authenticate with. If not given, and the |
|
359 | 359 | remote site requires basic or digest authentication, the user will |
|
360 | 360 | be prompted for it. Environment variables are expanded in the |
|
361 | 361 | username letting you do ``foo.username = $USER``. If the URI |
|
362 | 362 | includes a username, only ``[auth]`` entries with a matching |
|
363 | 363 | username or without a username will be considered. |
|
364 | 364 | |
|
365 | 365 | ``password`` |
|
366 | 366 | Optional. Password to authenticate with. If not given, and the |
|
367 | 367 | remote site requires basic or digest authentication, the user |
|
368 | 368 | will be prompted for it. |
|
369 | 369 | |
|
370 | 370 | ``key`` |
|
371 | 371 | Optional. PEM encoded client certificate key file. Environment |
|
372 | 372 | variables are expanded in the filename. |
|
373 | 373 | |
|
374 | 374 | ``cert`` |
|
375 | 375 | Optional. PEM encoded client certificate chain file. Environment |
|
376 | 376 | variables are expanded in the filename. |
|
377 | 377 | |
|
378 | 378 | ``schemes`` |
|
379 | 379 | Optional. Space separated list of URI schemes to use this |
|
380 | 380 | authentication entry with. Only used if the prefix doesn't include |
|
381 | 381 | a scheme. Supported schemes are http and https. They will match |
|
382 | 382 | static-http and static-https respectively, as well. |
|
383 | 383 | (default: https) |
|
384 | 384 | |
|
385 | 385 | If no suitable authentication entry is found, the user is prompted |
|
386 | 386 | for credentials as usual if required by the remote. |
|
387 | 387 | |
|
388 | 388 | |
|
389 | 389 | ``committemplate`` |
|
390 | 390 | ------------------ |
|
391 | 391 | |
|
392 | 392 | ``changeset`` |
|
393 | 393 | String: configuration in this section is used as the template to |
|
394 | 394 | customize the text shown in the editor when committing. |
|
395 | 395 | |
|
396 | 396 | In addition to pre-defined template keywords, commit log specific one |
|
397 | 397 | below can be used for customization: |
|
398 | 398 | |
|
399 | 399 | ``extramsg`` |
|
400 | 400 | String: Extra message (typically 'Leave message empty to abort |
|
401 | 401 | commit.'). This may be changed by some commands or extensions. |
|
402 | 402 | |
|
403 | 403 | For example, the template configuration below shows as same text as |
|
404 | 404 | one shown by default:: |
|
405 | 405 | |
|
406 | 406 | [committemplate] |
|
407 | 407 | changeset = {desc}\n\n |
|
408 | 408 | HG: Enter commit message. Lines beginning with 'HG:' are removed. |
|
409 | 409 | HG: {extramsg} |
|
410 | 410 | HG: -- |
|
411 | 411 | HG: user: {author}\n{ifeq(p2rev, "-1", "", |
|
412 | 412 | "HG: branch merge\n") |
|
413 | 413 | }HG: branch '{branch}'\n{if(activebookmark, |
|
414 | 414 | "HG: bookmark '{activebookmark}'\n") }{subrepos % |
|
415 | 415 | "HG: subrepo {subrepo}\n" }{file_adds % |
|
416 | 416 | "HG: added {file}\n" }{file_mods % |
|
417 | 417 | "HG: changed {file}\n" }{file_dels % |
|
418 | 418 | "HG: removed {file}\n" }{if(files, "", |
|
419 | 419 | "HG: no files changed\n")} |
|
420 | 420 | |
|
421 | 421 | .. note:: |
|
422 | 422 | |
|
423 | 423 | For some problematic encodings (see :hg:`help win32mbcs` for |
|
424 | 424 | detail), this customization should be configured carefully, to |
|
425 | 425 | avoid showing broken characters. |
|
426 | 426 | |
|
427 | 427 | For example, if a multibyte character ending with backslash (0x5c) is |
|
428 | 428 | followed by the ASCII character 'n' in the customized template, |
|
429 | 429 | the sequence of backslash and 'n' is treated as line-feed unexpectedly |
|
430 | 430 | (and the multibyte character is broken, too). |
|
431 | 431 | |
|
432 | 432 | Customized template is used for commands below (``--edit`` may be |
|
433 | 433 | required): |
|
434 | 434 | |
|
435 | 435 | - :hg:`backout` |
|
436 | 436 | - :hg:`commit` |
|
437 | 437 | - :hg:`fetch` (for merge commit only) |
|
438 | 438 | - :hg:`graft` |
|
439 | 439 | - :hg:`histedit` |
|
440 | 440 | - :hg:`import` |
|
441 | 441 | - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh` |
|
442 | 442 | - :hg:`rebase` |
|
443 | 443 | - :hg:`shelve` |
|
444 | 444 | - :hg:`sign` |
|
445 | 445 | - :hg:`tag` |
|
446 | 446 | - :hg:`transplant` |
|
447 | 447 | |
|
448 | 448 | Configuring items below instead of ``changeset`` allows showing |
|
449 | 449 | customized message only for specific actions, or showing different |
|
450 | 450 | messages for each action. |
|
451 | 451 | |
|
452 | 452 | - ``changeset.backout`` for :hg:`backout` |
|
453 | 453 | - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges |
|
454 | 454 | - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other |
|
455 | 455 | - ``changeset.commit.normal.merge`` for :hg:`commit` on merges |
|
456 | 456 | - ``changeset.commit.normal.normal`` for :hg:`commit` on other |
|
457 | 457 | - ``changeset.fetch`` for :hg:`fetch` (impling merge commit) |
|
458 | 458 | - ``changeset.gpg.sign`` for :hg:`sign` |
|
459 | 459 | - ``changeset.graft`` for :hg:`graft` |
|
460 | 460 | - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit` |
|
461 | 461 | - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit` |
|
462 | 462 | - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit` |
|
463 | 463 | - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit` |
|
464 | 464 | - ``changeset.import.bypass`` for :hg:`import --bypass` |
|
465 | 465 | - ``changeset.import.normal.merge`` for :hg:`import` on merges |
|
466 | 466 | - ``changeset.import.normal.normal`` for :hg:`import` on other |
|
467 | 467 | - ``changeset.mq.qnew`` for :hg:`qnew` |
|
468 | 468 | - ``changeset.mq.qfold`` for :hg:`qfold` |
|
469 | 469 | - ``changeset.mq.qrefresh`` for :hg:`qrefresh` |
|
470 | 470 | - ``changeset.rebase.collapse`` for :hg:`rebase --collapse` |
|
471 | 471 | - ``changeset.rebase.merge`` for :hg:`rebase` on merges |
|
472 | 472 | - ``changeset.rebase.normal`` for :hg:`rebase` on other |
|
473 | 473 | - ``changeset.shelve.shelve`` for :hg:`shelve` |
|
474 | 474 | - ``changeset.tag.add`` for :hg:`tag` without ``--remove`` |
|
475 | 475 | - ``changeset.tag.remove`` for :hg:`tag --remove` |
|
476 | 476 | - ``changeset.transplant.merge`` for :hg:`transplant` on merges |
|
477 | 477 | - ``changeset.transplant.normal`` for :hg:`transplant` on other |
|
478 | 478 | |
|
479 | 479 | These dot-separated lists of names are treated as hierarchical ones. |
|
480 | 480 | For example, ``changeset.tag.remove`` customizes the commit message |
|
481 | 481 | only for :hg:`tag --remove`, but ``changeset.tag`` customizes the |
|
482 | 482 | commit message for :hg:`tag` regardless of ``--remove`` option. |
|
483 | 483 | |
|
484 | 484 | When the external editor is invoked for a commit, the corresponding |
|
485 | 485 | dot-separated list of names without the ``changeset.`` prefix |
|
486 | 486 | (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment |
|
487 | 487 | variable. |
|
488 | 488 | |
|
489 | 489 | In this section, items other than ``changeset`` can be referred from |
|
490 | 490 | others. For example, the configuration to list committed files up |
|
491 | 491 | below can be referred as ``{listupfiles}``:: |
|
492 | 492 | |
|
493 | 493 | [committemplate] |
|
494 | 494 | listupfiles = {file_adds % |
|
495 | 495 | "HG: added {file}\n" }{file_mods % |
|
496 | 496 | "HG: changed {file}\n" }{file_dels % |
|
497 | 497 | "HG: removed {file}\n" }{if(files, "", |
|
498 | 498 | "HG: no files changed\n")} |
|
499 | 499 | |
|
500 | 500 | ``decode/encode`` |
|
501 | 501 | ----------------- |
|
502 | 502 | |
|
503 | 503 | Filters for transforming files on checkout/checkin. This would |
|
504 | 504 | typically be used for newline processing or other |
|
505 | 505 | localization/canonicalization of files. |
|
506 | 506 | |
|
507 | 507 | Filters consist of a filter pattern followed by a filter command. |
|
508 | 508 | Filter patterns are globs by default, rooted at the repository root. |
|
509 | 509 | For example, to match any file ending in ``.txt`` in the root |
|
510 | 510 | directory only, use the pattern ``*.txt``. To match any file ending |
|
511 | 511 | in ``.c`` anywhere in the repository, use the pattern ``**.c``. |
|
512 | 512 | For each file only the first matching filter applies. |
|
513 | 513 | |
|
514 | 514 | The filter command can start with a specifier, either ``pipe:`` or |
|
515 | 515 | ``tempfile:``. If no specifier is given, ``pipe:`` is used by default. |
|
516 | 516 | |
|
517 | 517 | A ``pipe:`` command must accept data on stdin and return the transformed |
|
518 | 518 | data on stdout. |
|
519 | 519 | |
|
520 | 520 | Pipe example:: |
|
521 | 521 | |
|
522 | 522 | [encode] |
|
523 | 523 | # uncompress gzip files on checkin to improve delta compression |
|
524 | 524 | # note: not necessarily a good idea, just an example |
|
525 | 525 | *.gz = pipe: gunzip |
|
526 | 526 | |
|
527 | 527 | [decode] |
|
528 | 528 | # recompress gzip files when writing them to the working dir (we |
|
529 | 529 | # can safely omit "pipe:", because it's the default) |
|
530 | 530 | *.gz = gzip |
|
531 | 531 | |
|
532 | 532 | A ``tempfile:`` command is a template. The string ``INFILE`` is replaced |
|
533 | 533 | with the name of a temporary file that contains the data to be |
|
534 | 534 | filtered by the command. The string ``OUTFILE`` is replaced with the name |
|
535 | 535 | of an empty temporary file, where the filtered data must be written by |
|
536 | 536 | the command. |
|
537 | 537 | |
|
538 | 538 | .. container:: windows |
|
539 | 539 | |
|
540 | 540 | .. note:: |
|
541 | 541 | |
|
542 | 542 | The tempfile mechanism is recommended for Windows systems, |
|
543 | 543 | where the standard shell I/O redirection operators often have |
|
544 | 544 | strange effects and may corrupt the contents of your files. |
|
545 | 545 | |
|
546 | 546 | This filter mechanism is used internally by the ``eol`` extension to |
|
547 | 547 | translate line ending characters between Windows (CRLF) and Unix (LF) |
|
548 | 548 | format. We suggest you use the ``eol`` extension for convenience. |
|
549 | 549 | |
|
550 | 550 | |
|
551 | 551 | ``defaults`` |
|
552 | 552 | ------------ |
|
553 | 553 | |
|
554 | 554 | (defaults are deprecated. Don't use them. Use aliases instead.) |
|
555 | 555 | |
|
556 | 556 | Use the ``[defaults]`` section to define command defaults, i.e. the |
|
557 | 557 | default options/arguments to pass to the specified commands. |
|
558 | 558 | |
|
559 | 559 | The following example makes :hg:`log` run in verbose mode, and |
|
560 | 560 | :hg:`status` show only the modified files, by default:: |
|
561 | 561 | |
|
562 | 562 | [defaults] |
|
563 | 563 | log = -v |
|
564 | 564 | status = -m |
|
565 | 565 | |
|
566 | 566 | The actual commands, instead of their aliases, must be used when |
|
567 | 567 | defining command defaults. The command defaults will also be applied |
|
568 | 568 | to the aliases of the commands defined. |
|
569 | 569 | |
|
570 | 570 | |
|
571 | 571 | ``diff`` |
|
572 | 572 | -------- |
|
573 | 573 | |
|
574 | 574 | Settings used when displaying diffs. Everything except for ``unified`` |
|
575 | 575 | is a Boolean and defaults to False. See :hg:`help config.annotate` |
|
576 | 576 | for related options for the annotate command. |
|
577 | 577 | |
|
578 | 578 | ``git`` |
|
579 | 579 | Use git extended diff format. |
|
580 | 580 | |
|
581 | 581 | ``nobinary`` |
|
582 | 582 | Omit git binary patches. |
|
583 | 583 | |
|
584 | 584 | ``nodates`` |
|
585 | 585 | Don't include dates in diff headers. |
|
586 | 586 | |
|
587 | 587 | ``noprefix`` |
|
588 | 588 | Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode. |
|
589 | 589 | |
|
590 | 590 | ``showfunc`` |
|
591 | 591 | Show which function each change is in. |
|
592 | 592 | |
|
593 | 593 | ``ignorews`` |
|
594 | 594 | Ignore white space when comparing lines. |
|
595 | 595 | |
|
596 | 596 | ``ignorewsamount`` |
|
597 | 597 | Ignore changes in the amount of white space. |
|
598 | 598 | |
|
599 | 599 | ``ignoreblanklines`` |
|
600 | 600 | Ignore changes whose lines are all blank. |
|
601 | 601 | |
|
602 | 602 | ``unified`` |
|
603 | 603 | Number of lines of context to show. |
|
604 | 604 | |
|
605 | 605 | ``email`` |
|
606 | 606 | --------- |
|
607 | 607 | |
|
608 | 608 | Settings for extensions that send email messages. |
|
609 | 609 | |
|
610 | 610 | ``from`` |
|
611 | 611 | Optional. Email address to use in "From" header and SMTP envelope |
|
612 | 612 | of outgoing messages. |
|
613 | 613 | |
|
614 | 614 | ``to`` |
|
615 | 615 | Optional. Comma-separated list of recipients' email addresses. |
|
616 | 616 | |
|
617 | 617 | ``cc`` |
|
618 | 618 | Optional. Comma-separated list of carbon copy recipients' |
|
619 | 619 | email addresses. |
|
620 | 620 | |
|
621 | 621 | ``bcc`` |
|
622 | 622 | Optional. Comma-separated list of blind carbon copy recipients' |
|
623 | 623 | email addresses. |
|
624 | 624 | |
|
625 | 625 | ``method`` |
|
626 | 626 | Optional. Method to use to send email messages. If value is ``smtp`` |
|
627 | 627 | (default), use SMTP (see the ``[smtp]`` section for configuration). |
|
628 | 628 | Otherwise, use as name of program to run that acts like sendmail |
|
629 | 629 | (takes ``-f`` option for sender, list of recipients on command line, |
|
630 | 630 | message on stdin). Normally, setting this to ``sendmail`` or |
|
631 | 631 | ``/usr/sbin/sendmail`` is enough to use sendmail to send messages. |
|
632 | 632 | |
|
633 | 633 | ``charsets`` |
|
634 | 634 | Optional. Comma-separated list of character sets considered |
|
635 | 635 | convenient for recipients. Addresses, headers, and parts not |
|
636 | 636 | containing patches of outgoing messages will be encoded in the |
|
637 | 637 | first character set to which conversion from local encoding |
|
638 | 638 | (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct |
|
639 | 639 | conversion fails, the text in question is sent as is. |
|
640 | 640 | (default: '') |
|
641 | 641 | |
|
642 | 642 | Order of outgoing email character sets: |
|
643 | 643 | |
|
644 | 644 | 1. ``us-ascii``: always first, regardless of settings |
|
645 | 645 | 2. ``email.charsets``: in order given by user |
|
646 | 646 | 3. ``ui.fallbackencoding``: if not in email.charsets |
|
647 | 647 | 4. ``$HGENCODING``: if not in email.charsets |
|
648 | 648 | 5. ``utf-8``: always last, regardless of settings |
|
649 | 649 | |
|
650 | 650 | Email example:: |
|
651 | 651 | |
|
652 | 652 | [email] |
|
653 | 653 | from = Joseph User <joe.user@example.com> |
|
654 | 654 | method = /usr/sbin/sendmail |
|
655 | 655 | # charsets for western Europeans |
|
656 | 656 | # us-ascii, utf-8 omitted, as they are tried first and last |
|
657 | 657 | charsets = iso-8859-1, iso-8859-15, windows-1252 |
|
658 | 658 | |
|
659 | 659 | |
|
660 | 660 | ``extensions`` |
|
661 | 661 | -------------- |
|
662 | 662 | |
|
663 | 663 | Mercurial has an extension mechanism for adding new features. To |
|
664 | 664 | enable an extension, create an entry for it in this section. |
|
665 | 665 | |
|
666 | 666 | If you know that the extension is already in Python's search path, |
|
667 | 667 | you can give the name of the module, followed by ``=``, with nothing |
|
668 | 668 | after the ``=``. |
|
669 | 669 | |
|
670 | 670 | Otherwise, give a name that you choose, followed by ``=``, followed by |
|
671 | 671 | the path to the ``.py`` file (including the file name extension) that |
|
672 | 672 | defines the extension. |
|
673 | 673 | |
|
674 | 674 | To explicitly disable an extension that is enabled in an hgrc of |
|
675 | 675 | broader scope, prepend its path with ``!``, as in ``foo = !/ext/path`` |
|
676 | 676 | or ``foo = !`` when path is not supplied. |
|
677 | 677 | |
|
678 | 678 | Example for ``~/.hgrc``:: |
|
679 | 679 | |
|
680 | 680 | [extensions] |
|
681 | 681 | # (the color extension will get loaded from Mercurial's path) |
|
682 | 682 | color = |
|
683 | 683 | # (this extension will get loaded from the file specified) |
|
684 | 684 | myfeature = ~/.hgext/myfeature.py |
|
685 | 685 | |
|
686 | 686 | |
|
687 | 687 | ``format`` |
|
688 | 688 | ---------- |
|
689 | 689 | |
|
690 | 690 | ``usegeneraldelta`` |
|
691 | 691 | Enable or disable the "generaldelta" repository format which improves |
|
692 | 692 | repository compression by allowing "revlog" to store delta against arbitrary |
|
693 | 693 | revision instead of the previous stored one. This provides significant |
|
694 | 694 | improvement for repositories with branches. |
|
695 | 695 | |
|
696 | 696 | Repositories with this on-disk format require Mercurial version 1.9. |
|
697 | 697 | |
|
698 | 698 | Enabled by default. |
|
699 | 699 | |
|
700 | 700 | ``dotencode`` |
|
701 | 701 | Enable or disable the "dotencode" repository format which enhances |
|
702 | 702 | the "fncache" repository format (which has to be enabled to use |
|
703 | 703 | dotencode) to avoid issues with filenames starting with ._ on |
|
704 | 704 | Mac OS X and spaces on Windows. |
|
705 | 705 | |
|
706 | 706 | Repositories with this on-disk format require Mercurial version 1.7. |
|
707 | 707 | |
|
708 | 708 | Enabled by default. |
|
709 | 709 | |
|
710 | 710 | ``usefncache`` |
|
711 | 711 | Enable or disable the "fncache" repository format which enhances |
|
712 | 712 | the "store" repository format (which has to be enabled to use |
|
713 | 713 | fncache) to allow longer filenames and avoids using Windows |
|
714 | 714 | reserved names, e.g. "nul". |
|
715 | 715 | |
|
716 | 716 | Repositories with this on-disk format require Mercurial version 1.1. |
|
717 | 717 | |
|
718 | 718 | Enabled by default. |
|
719 | 719 | |
|
720 | 720 | ``usestore`` |
|
721 | 721 | Enable or disable the "store" repository format which improves |
|
722 | 722 | compatibility with systems that fold case or otherwise mangle |
|
723 | 723 | filenames. Disabling this option will allow you to store longer filenames |
|
724 | 724 | in some situations at the expense of compatibility. |
|
725 | 725 | |
|
726 | 726 | Repositories with this on-disk format require Mercurial version 0.9.4. |
|
727 | 727 | |
|
728 | 728 | Enabled by default. |
|
729 | 729 | |
|
730 | 730 | ``graph`` |
|
731 | 731 | --------- |
|
732 | 732 | |
|
733 | 733 | Web graph view configuration. This section let you change graph |
|
734 | 734 | elements display properties by branches, for instance to make the |
|
735 | 735 | ``default`` branch stand out. |
|
736 | 736 | |
|
737 | 737 | Each line has the following format:: |
|
738 | 738 | |
|
739 | 739 | <branch>.<argument> = <value> |
|
740 | 740 | |
|
741 | 741 | where ``<branch>`` is the name of the branch being |
|
742 | 742 | customized. Example:: |
|
743 | 743 | |
|
744 | 744 | [graph] |
|
745 | 745 | # 2px width |
|
746 | 746 | default.width = 2 |
|
747 | 747 | # red color |
|
748 | 748 | default.color = FF0000 |
|
749 | 749 | |
|
750 | 750 | Supported arguments: |
|
751 | 751 | |
|
752 | 752 | ``width`` |
|
753 | 753 | Set branch edges width in pixels. |
|
754 | 754 | |
|
755 | 755 | ``color`` |
|
756 | 756 | Set branch edges color in hexadecimal RGB notation. |
|
757 | 757 | |
|
758 | 758 | ``hooks`` |
|
759 | 759 | --------- |
|
760 | 760 | |
|
761 | 761 | Commands or Python functions that get automatically executed by |
|
762 | 762 | various actions such as starting or finishing a commit. Multiple |
|
763 | 763 | hooks can be run for the same action by appending a suffix to the |
|
764 | 764 | action. Overriding a site-wide hook can be done by changing its |
|
765 | 765 | value or setting it to an empty string. Hooks can be prioritized |
|
766 | 766 | by adding a prefix of ``priority.`` to the hook name on a new line |
|
767 | 767 | and setting the priority. The default priority is 0. |
|
768 | 768 | |
|
769 | 769 | Example ``.hg/hgrc``:: |
|
770 | 770 | |
|
771 | 771 | [hooks] |
|
772 | 772 | # update working directory after adding changesets |
|
773 | 773 | changegroup.update = hg update |
|
774 | 774 | # do not use the site-wide hook |
|
775 | 775 | incoming = |
|
776 | 776 | incoming.email = /my/email/hook |
|
777 | 777 | incoming.autobuild = /my/build/hook |
|
778 | 778 | # force autobuild hook to run before other incoming hooks |
|
779 | 779 | priority.incoming.autobuild = 1 |
|
780 | 780 | |
|
781 | 781 | Most hooks are run with environment variables set that give useful |
|
782 | 782 | additional information. For each hook below, the environment |
|
783 | 783 | variables it is passed are listed with names of the form ``$HG_foo``. |
|
784 | 784 | |
|
785 | 785 | ``changegroup`` |
|
786 | 786 | Run after a changegroup has been added via push, pull or unbundle. ID of the |
|
787 | 787 | first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL |
|
788 | 788 | from which changes came is in ``$HG_URL``. |
|
789 | 789 | |
|
790 | 790 | ``commit`` |
|
791 | 791 | Run after a changeset has been created in the local repository. ID |
|
792 | 792 | of the newly created changeset is in ``$HG_NODE``. Parent changeset |
|
793 | 793 | IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. |
|
794 | 794 | |
|
795 | 795 | ``incoming`` |
|
796 | 796 | Run after a changeset has been pulled, pushed, or unbundled into |
|
797 | 797 | the local repository. The ID of the newly arrived changeset is in |
|
798 | 798 | ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``. |
|
799 | 799 | |
|
800 | 800 | ``outgoing`` |
|
801 | 801 | Run after sending changes from local repository to another. ID of |
|
802 | 802 | first changeset sent is in ``$HG_NODE``. Source of operation is in |
|
803 | 803 | ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook. |
|
804 | 804 | |
|
805 | 805 | ``post-<command>`` |
|
806 | 806 | Run after successful invocations of the associated command. The |
|
807 | 807 | contents of the command line are passed as ``$HG_ARGS`` and the result |
|
808 | 808 | code in ``$HG_RESULT``. Parsed command line arguments are passed as |
|
809 | 809 | ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of |
|
810 | 810 | the python data internally passed to <command>. ``$HG_OPTS`` is a |
|
811 | 811 | dictionary of options (with unspecified options set to their defaults). |
|
812 | 812 | ``$HG_PATS`` is a list of arguments. Hook failure is ignored. |
|
813 | 813 | |
|
814 | 814 | ``pre-<command>`` |
|
815 | 815 | Run before executing the associated command. The contents of the |
|
816 | 816 | command line are passed as ``$HG_ARGS``. Parsed command line arguments |
|
817 | 817 | are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string |
|
818 | 818 | representations of the data internally passed to <command>. ``$HG_OPTS`` |
|
819 | 819 | is a dictionary of options (with unspecified options set to their |
|
820 | 820 | defaults). ``$HG_PATS`` is a list of arguments. If the hook returns |
|
821 | 821 | failure, the command doesn't execute and Mercurial returns the failure |
|
822 | 822 | code. |
|
823 | 823 | |
|
824 | 824 | ``prechangegroup`` |
|
825 | 825 | Run before a changegroup is added via push, pull or unbundle. Exit |
|
826 | 826 | status 0 allows the changegroup to proceed. Non-zero status will |
|
827 | 827 | cause the push, pull or unbundle to fail. URL from which changes |
|
828 | 828 | will come is in ``$HG_URL``. |
|
829 | 829 | |
|
830 | 830 | ``precommit`` |
|
831 | 831 | Run before starting a local commit. Exit status 0 allows the |
|
832 | 832 | commit to proceed. Non-zero status will cause the commit to fail. |
|
833 | 833 | Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. |
|
834 | 834 | |
|
835 | 835 | ``prelistkeys`` |
|
836 | 836 | Run before listing pushkeys (like bookmarks) in the |
|
837 | 837 | repository. Non-zero status will cause failure. The key namespace is |
|
838 | 838 | in ``$HG_NAMESPACE``. |
|
839 | 839 | |
|
840 | 840 | ``preoutgoing`` |
|
841 | 841 | Run before collecting changes to send from the local repository to |
|
842 | 842 | another. Non-zero status will cause failure. This lets you prevent |
|
843 | 843 | pull over HTTP or SSH. Also prevents against local pull, push |
|
844 | 844 | (outbound) or bundle commands, but not effective, since you can |
|
845 | 845 | just copy files instead then. Source of operation is in |
|
846 | 846 | ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote |
|
847 | 847 | SSH or HTTP repository. If "push", "pull" or "bundle", operation |
|
848 | 848 | is happening on behalf of repository on same system. |
|
849 | 849 | |
|
850 | 850 | ``prepushkey`` |
|
851 | 851 | Run before a pushkey (like a bookmark) is added to the |
|
852 | 852 | repository. Non-zero status will cause the key to be rejected. The |
|
853 | 853 | key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``, |
|
854 | 854 | the old value (if any) is in ``$HG_OLD``, and the new value is in |
|
855 | 855 | ``$HG_NEW``. |
|
856 | 856 | |
|
857 | 857 | ``pretag`` |
|
858 | 858 | Run before creating a tag. Exit status 0 allows the tag to be |
|
859 | 859 | created. Non-zero status will cause the tag to fail. ID of |
|
860 | 860 | changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is |
|
861 | 861 | local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``. |
|
862 | 862 | |
|
863 | 863 | ``pretxnopen`` |
|
864 | 864 | Run before any new repository transaction is open. The reason for the |
|
865 | 865 | transaction will be in ``$HG_TXNNAME`` and a unique identifier for the |
|
866 | 866 | transaction will be in ``HG_TXNID``. A non-zero status will prevent the |
|
867 | 867 | transaction from being opened. |
|
868 | 868 | |
|
869 | 869 | ``pretxnclose`` |
|
870 | 870 | Run right before the transaction is actually finalized. Any repository change |
|
871 | 871 | will be visible to the hook program. This lets you validate the transaction |
|
872 | 872 | content or change it. Exit status 0 allows the commit to proceed. Non-zero |
|
873 | 873 | status will cause the transaction to be rolled back. The reason for the |
|
874 | 874 | transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for |
|
875 | 875 | the transaction will be in ``HG_TXNID``. The rest of the available data will |
|
876 | 876 | vary according the transaction type. New changesets will add ``$HG_NODE`` (id |
|
877 | 877 | of the first added changeset), ``$HG_NODE_LAST`` (id of the last added |
|
878 | 878 | changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases |
|
879 | 879 | changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc. |
|
880 | 880 | |
|
881 | 881 | ``txnclose`` |
|
882 | 882 | Run after any repository transaction has been committed. At this |
|
883 | 883 | point, the transaction can no longer be rolled back. The hook will run |
|
884 | 884 | after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for |
|
885 | 885 | details about available variables. |
|
886 | 886 | |
|
887 | 887 | ``txnabort`` |
|
888 | 888 | Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose` |
|
889 | 889 | docs for details about available variables. |
|
890 | 890 | |
|
891 | 891 | ``pretxnchangegroup`` |
|
892 | 892 | Run after a changegroup has been added via push, pull or unbundle, but before |
|
893 | 893 | the transaction has been committed. Changegroup is visible to hook program. |
|
894 | 894 | This lets you validate incoming changes before accepting them. Passed the ID |
|
895 | 895 | of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. |
|
896 | 896 | Exit status 0 allows the transaction to commit. Non-zero status will cause |
|
897 | 897 | the transaction to be rolled back and the push, pull or unbundle will fail. |
|
898 | 898 | URL that was source of changes is in ``$HG_URL``. |
|
899 | 899 | |
|
900 | 900 | ``pretxncommit`` |
|
901 | 901 | Run after a changeset has been created but the transaction not yet |
|
902 | 902 | committed. Changeset is visible to hook program. This lets you |
|
903 | 903 | validate commit message and changes. Exit status 0 allows the |
|
904 | 904 | commit to proceed. Non-zero status will cause the transaction to |
|
905 | 905 | be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset |
|
906 | 906 | IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``. |
|
907 | 907 | |
|
908 | 908 | ``preupdate`` |
|
909 | 909 | Run before updating the working directory. Exit status 0 allows |
|
910 | 910 | the update to proceed. Non-zero status will prevent the update. |
|
911 | 911 | Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID |
|
912 | 912 | of second new parent is in ``$HG_PARENT2``. |
|
913 | 913 | |
|
914 | 914 | ``listkeys`` |
|
915 | 915 | Run after listing pushkeys (like bookmarks) in the repository. The |
|
916 | 916 | key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a |
|
917 | 917 | dictionary containing the keys and values. |
|
918 | 918 | |
|
919 | 919 | ``pushkey`` |
|
920 | 920 | Run after a pushkey (like a bookmark) is added to the |
|
921 | 921 | repository. The key namespace is in ``$HG_NAMESPACE``, the key is in |
|
922 | 922 | ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new |
|
923 | 923 | value is in ``$HG_NEW``. |
|
924 | 924 | |
|
925 | 925 | ``tag`` |
|
926 | 926 | Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``. |
|
927 | 927 | Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in |
|
928 | 928 | repository if ``$HG_LOCAL=0``. |
|
929 | 929 | |
|
930 | 930 | ``update`` |
|
931 | 931 | Run after updating the working directory. Changeset ID of first |
|
932 | 932 | new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is |
|
933 | 933 | in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the |
|
934 | 934 | update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``. |
|
935 | 935 | |
|
936 | 936 | .. note:: |
|
937 | 937 | |
|
938 | 938 | It is generally better to use standard hooks rather than the |
|
939 | 939 | generic pre- and post- command hooks as they are guaranteed to be |
|
940 | 940 | called in the appropriate contexts for influencing transactions. |
|
941 | 941 | Also, hooks like "commit" will be called in all contexts that |
|
942 | 942 | generate a commit (e.g. tag) and not just the commit command. |
|
943 | 943 | |
|
944 | 944 | .. note:: |
|
945 | 945 | |
|
946 | 946 | Environment variables with empty values may not be passed to |
|
947 | 947 | hooks on platforms such as Windows. As an example, ``$HG_PARENT2`` |
|
948 | 948 | will have an empty value under Unix-like platforms for non-merge |
|
949 | 949 | changesets, while it will not be available at all under Windows. |
|
950 | 950 | |
|
951 | 951 | The syntax for Python hooks is as follows:: |
|
952 | 952 | |
|
953 | 953 | hookname = python:modulename.submodule.callable |
|
954 | 954 | hookname = python:/path/to/python/module.py:callable |
|
955 | 955 | |
|
956 | 956 | Python hooks are run within the Mercurial process. Each hook is |
|
957 | 957 | called with at least three keyword arguments: a ui object (keyword |
|
958 | 958 | ``ui``), a repository object (keyword ``repo``), and a ``hooktype`` |
|
959 | 959 | keyword that tells what kind of hook is used. Arguments listed as |
|
960 | 960 | environment variables above are passed as keyword arguments, with no |
|
961 | 961 | ``HG_`` prefix, and names in lower case. |
|
962 | 962 | |
|
963 | 963 | If a Python hook returns a "true" value or raises an exception, this |
|
964 | 964 | is treated as a failure. |
|
965 | 965 | |
|
966 | 966 | |
|
967 | 967 | ``hostfingerprints`` |
|
968 | 968 | -------------------- |
|
969 | 969 | |
|
970 | 970 | Fingerprints of the certificates of known HTTPS servers. |
|
971 | 971 | |
|
972 | 972 | A HTTPS connection to a server with a fingerprint configured here will |
|
973 | 973 | only succeed if the servers certificate matches the fingerprint. |
|
974 | 974 | This is very similar to how ssh known hosts works. |
|
975 | 975 | |
|
976 | 976 | The fingerprint is the SHA-1 hash value of the DER encoded certificate. |
|
977 | 977 | Multiple values can be specified (separated by spaces or commas). This can |
|
978 | 978 | be used to define both old and new fingerprints while a host transitions |
|
979 | 979 | to a new certificate. |
|
980 | 980 | |
|
981 | 981 | The CA chain and web.cacerts is not used for servers with a fingerprint. |
|
982 | 982 | |
|
983 | 983 | For example:: |
|
984 | 984 | |
|
985 | 985 | [hostfingerprints] |
|
986 | 986 | hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33 |
|
987 | 987 | hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33 |
|
988 | 988 | |
|
989 | 989 | This feature is only supported when using Python 2.6 or later. |
|
990 | 990 | |
|
991 | 991 | |
|
992 | 992 | ``http_proxy`` |
|
993 | 993 | -------------- |
|
994 | 994 | |
|
995 | 995 | Used to access web-based Mercurial repositories through a HTTP |
|
996 | 996 | proxy. |
|
997 | 997 | |
|
998 | 998 | ``host`` |
|
999 | 999 | Host name and (optional) port of the proxy server, for example |
|
1000 | 1000 | "myproxy:8000". |
|
1001 | 1001 | |
|
1002 | 1002 | ``no`` |
|
1003 | 1003 | Optional. Comma-separated list of host names that should bypass |
|
1004 | 1004 | the proxy. |
|
1005 | 1005 | |
|
1006 | 1006 | ``passwd`` |
|
1007 | 1007 | Optional. Password to authenticate with at the proxy server. |
|
1008 | 1008 | |
|
1009 | 1009 | ``user`` |
|
1010 | 1010 | Optional. User name to authenticate with at the proxy server. |
|
1011 | 1011 | |
|
1012 | 1012 | ``always`` |
|
1013 | 1013 | Optional. Always use the proxy, even for localhost and any entries |
|
1014 | 1014 | in ``http_proxy.no``. (default: False) |
|
1015 | 1015 | |
|
1016 | 1016 | ``merge`` |
|
1017 | 1017 | --------- |
|
1018 | 1018 | |
|
1019 | 1019 | This section specifies behavior during merges and updates. |
|
1020 | 1020 | |
|
1021 | 1021 | ``checkignored`` |
|
1022 | 1022 | Controls behavior when an ignored file on disk has the same name as a tracked |
|
1023 | 1023 | file in the changeset being merged or updated to, and has different |
|
1024 | 1024 | contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``, |
|
1025 | 1025 | abort on such files. With ``warn``, warn on such files and back them up as |
|
1026 | 1026 | .orig. With ``ignore``, don't print a warning and back them up as |
|
1027 | 1027 | .orig. (default: ``abort``) |
|
1028 | 1028 | |
|
1029 | 1029 | ``checkunknown`` |
|
1030 | 1030 | Controls behavior when an unknown file that isn't ignored has the same name |
|
1031 | 1031 | as a tracked file in the changeset being merged or updated to, and has |
|
1032 | 1032 | different contents. Similar to ``merge.checkignored``, except for files that |
|
1033 | 1033 | are not ignored. (default: ``abort``) |
|
1034 | 1034 | |
|
1035 | 1035 | ``merge-patterns`` |
|
1036 | 1036 | ------------------ |
|
1037 | 1037 | |
|
1038 | 1038 | This section specifies merge tools to associate with particular file |
|
1039 | 1039 | patterns. Tools matched here will take precedence over the default |
|
1040 | 1040 | merge tool. Patterns are globs by default, rooted at the repository |
|
1041 | 1041 | root. |
|
1042 | 1042 | |
|
1043 | 1043 | Example:: |
|
1044 | 1044 | |
|
1045 | 1045 | [merge-patterns] |
|
1046 | 1046 | **.c = kdiff3 |
|
1047 | 1047 | **.jpg = myimgmerge |
|
1048 | 1048 | |
|
1049 | 1049 | ``merge-tools`` |
|
1050 | 1050 | --------------- |
|
1051 | 1051 | |
|
1052 | 1052 | This section configures external merge tools to use for file-level |
|
1053 | 1053 | merges. This section has likely been preconfigured at install time. |
|
1054 | 1054 | Use :hg:`config merge-tools` to check the existing configuration. |
|
1055 | 1055 | Also see :hg:`help merge-tools` for more details. |
|
1056 | 1056 | |
|
1057 | 1057 | Example ``~/.hgrc``:: |
|
1058 | 1058 | |
|
1059 | 1059 | [merge-tools] |
|
1060 | 1060 | # Override stock tool location |
|
1061 | 1061 | kdiff3.executable = ~/bin/kdiff3 |
|
1062 | 1062 | # Specify command line |
|
1063 | 1063 | kdiff3.args = $base $local $other -o $output |
|
1064 | 1064 | # Give higher priority |
|
1065 | 1065 | kdiff3.priority = 1 |
|
1066 | 1066 | |
|
1067 | 1067 | # Changing the priority of preconfigured tool |
|
1068 | 1068 | meld.priority = 0 |
|
1069 | 1069 | |
|
1070 | 1070 | # Disable a preconfigured tool |
|
1071 | 1071 | vimdiff.disabled = yes |
|
1072 | 1072 | |
|
1073 | 1073 | # Define new tool |
|
1074 | 1074 | myHtmlTool.args = -m $local $other $base $output |
|
1075 | 1075 | myHtmlTool.regkey = Software\FooSoftware\HtmlMerge |
|
1076 | 1076 | myHtmlTool.priority = 1 |
|
1077 | 1077 | |
|
1078 | 1078 | Supported arguments: |
|
1079 | 1079 | |
|
1080 | 1080 | ``priority`` |
|
1081 | 1081 | The priority in which to evaluate this tool. |
|
1082 | 1082 | (default: 0) |
|
1083 | 1083 | |
|
1084 | 1084 | ``executable`` |
|
1085 | 1085 | Either just the name of the executable or its pathname. |
|
1086 | 1086 | |
|
1087 | 1087 | .. container:: windows |
|
1088 | 1088 | |
|
1089 | 1089 | On Windows, the path can use environment variables with ${ProgramFiles} |
|
1090 | 1090 | syntax. |
|
1091 | 1091 | |
|
1092 | 1092 | (default: the tool name) |
|
1093 | 1093 | |
|
1094 | 1094 | ``args`` |
|
1095 | 1095 | The arguments to pass to the tool executable. You can refer to the |
|
1096 | 1096 | files being merged as well as the output file through these |
|
1097 | 1097 | variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning |
|
1098 | 1098 | of ``$local`` and ``$other`` can vary depending on which action is being |
|
1099 | 1099 | performed. During and update or merge, ``$local`` represents the original |
|
1100 | 1100 | state of the file, while ``$other`` represents the commit you are updating |
|
1101 | 1101 | to or the commit you are merging with. During a rebase ``$local`` |
|
1102 | 1102 | represents the destination of the rebase, and ``$other`` represents the |
|
1103 | 1103 | commit being rebased. |
|
1104 | 1104 | (default: ``$local $base $other``) |
|
1105 | 1105 | |
|
1106 | 1106 | ``premerge`` |
|
1107 | 1107 | Attempt to run internal non-interactive 3-way merge tool before |
|
1108 | 1108 | launching external tool. Options are ``true``, ``false``, ``keep`` or |
|
1109 | 1109 | ``keep-merge3``. The ``keep`` option will leave markers in the file if the |
|
1110 | 1110 | premerge fails. The ``keep-merge3`` will do the same but include information |
|
1111 | 1111 | about the base of the merge in the marker (see internal :merge3 in |
|
1112 | 1112 | :hg:`help merge-tools`). |
|
1113 | 1113 | (default: True) |
|
1114 | 1114 | |
|
1115 | 1115 | ``binary`` |
|
1116 | 1116 | This tool can merge binary files. (default: False, unless tool |
|
1117 | 1117 | was selected by file pattern match) |
|
1118 | 1118 | |
|
1119 | 1119 | ``symlink`` |
|
1120 | 1120 | This tool can merge symlinks. (default: False) |
|
1121 | 1121 | |
|
1122 | 1122 | ``check`` |
|
1123 | 1123 | A list of merge success-checking options: |
|
1124 | 1124 | |
|
1125 | 1125 | ``changed`` |
|
1126 | 1126 | Ask whether merge was successful when the merged file shows no changes. |
|
1127 | 1127 | ``conflicts`` |
|
1128 | 1128 | Check whether there are conflicts even though the tool reported success. |
|
1129 | 1129 | ``prompt`` |
|
1130 | 1130 | Always prompt for merge success, regardless of success reported by tool. |
|
1131 | 1131 | |
|
1132 | 1132 | ``fixeol`` |
|
1133 | 1133 | Attempt to fix up EOL changes caused by the merge tool. |
|
1134 | 1134 | (default: False) |
|
1135 | 1135 | |
|
1136 | 1136 | ``gui`` |
|
1137 | 1137 | This tool requires a graphical interface to run. (default: False) |
|
1138 | 1138 | |
|
1139 | 1139 | .. container:: windows |
|
1140 | 1140 | |
|
1141 | 1141 | ``regkey`` |
|
1142 | 1142 | Windows registry key which describes install location of this |
|
1143 | 1143 | tool. Mercurial will search for this key first under |
|
1144 | 1144 | ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``. |
|
1145 | 1145 | (default: None) |
|
1146 | 1146 | |
|
1147 | 1147 | ``regkeyalt`` |
|
1148 | 1148 | An alternate Windows registry key to try if the first key is not |
|
1149 | 1149 | found. The alternate key uses the same ``regname`` and ``regappend`` |
|
1150 | 1150 | semantics of the primary key. The most common use for this key |
|
1151 | 1151 | is to search for 32bit applications on 64bit operating systems. |
|
1152 | 1152 | (default: None) |
|
1153 | 1153 | |
|
1154 | 1154 | ``regname`` |
|
1155 | 1155 | Name of value to read from specified registry key. |
|
1156 | 1156 | (default: the unnamed (default) value) |
|
1157 | 1157 | |
|
1158 | 1158 | ``regappend`` |
|
1159 | 1159 | String to append to the value read from the registry, typically |
|
1160 | 1160 | the executable name of the tool. |
|
1161 | 1161 | (default: None) |
|
1162 | 1162 | |
|
1163 | 1163 | |
|
1164 | 1164 | ``patch`` |
|
1165 | 1165 | --------- |
|
1166 | 1166 | |
|
1167 | 1167 | Settings used when applying patches, for instance through the 'import' |
|
1168 | 1168 | command or with Mercurial Queues extension. |
|
1169 | 1169 | |
|
1170 | 1170 | ``eol`` |
|
1171 | 1171 | When set to 'strict' patch content and patched files end of lines |
|
1172 | 1172 | are preserved. When set to ``lf`` or ``crlf``, both files end of |
|
1173 | 1173 | lines are ignored when patching and the result line endings are |
|
1174 | 1174 | normalized to either LF (Unix) or CRLF (Windows). When set to |
|
1175 | 1175 | ``auto``, end of lines are again ignored while patching but line |
|
1176 | 1176 | endings in patched files are normalized to their original setting |
|
1177 | 1177 | on a per-file basis. If target file does not exist or has no end |
|
1178 | 1178 | of line, patch line endings are preserved. |
|
1179 | 1179 | (default: strict) |
|
1180 | 1180 | |
|
1181 | 1181 | ``fuzz`` |
|
1182 | 1182 | The number of lines of 'fuzz' to allow when applying patches. This |
|
1183 | 1183 | controls how much context the patcher is allowed to ignore when |
|
1184 | 1184 | trying to apply a patch. |
|
1185 | 1185 | (default: 2) |
|
1186 | 1186 | |
|
1187 | 1187 | ``paths`` |
|
1188 | 1188 | --------- |
|
1189 | 1189 | |
|
1190 | 1190 | Assigns symbolic names and behavior to repositories. |
|
1191 | 1191 | |
|
1192 | 1192 | Options are symbolic names defining the URL or directory that is the |
|
1193 | 1193 | location of the repository. Example:: |
|
1194 | 1194 | |
|
1195 | 1195 | [paths] |
|
1196 | 1196 | my_server = https://example.com/my_repo |
|
1197 | 1197 | local_path = /home/me/repo |
|
1198 | 1198 | |
|
1199 | 1199 | These symbolic names can be used from the command line. To pull |
|
1200 | 1200 | from ``my_server``: :hg:`pull my_server`. To push to ``local_path``: |
|
1201 | 1201 | :hg:`push local_path`. |
|
1202 | 1202 | |
|
1203 | 1203 | Options containing colons (``:``) denote sub-options that can influence |
|
1204 | 1204 | behavior for that specific path. Example:: |
|
1205 | 1205 | |
|
1206 | 1206 | [paths] |
|
1207 | 1207 | my_server = https://example.com/my_path |
|
1208 | 1208 | my_server:pushurl = ssh://example.com/my_path |
|
1209 | 1209 | |
|
1210 | 1210 | The following sub-options can be defined: |
|
1211 | 1211 | |
|
1212 | 1212 | ``pushurl`` |
|
1213 | 1213 | The URL to use for push operations. If not defined, the location |
|
1214 | 1214 | defined by the path's main entry is used. |
|
1215 | 1215 | |
|
1216 | 1216 | The following special named paths exist: |
|
1217 | 1217 | |
|
1218 | 1218 | ``default`` |
|
1219 | 1219 | The URL or directory to use when no source or remote is specified. |
|
1220 | 1220 | |
|
1221 | 1221 | :hg:`clone` will automatically define this path to the location the |
|
1222 | 1222 | repository was cloned from. |
|
1223 | 1223 | |
|
1224 | 1224 | ``default-push`` |
|
1225 | 1225 | (deprecated) The URL or directory for the default :hg:`push` location. |
|
1226 | 1226 | ``default:pushurl`` should be used instead. |
|
1227 | 1227 | |
|
1228 | 1228 | ``phases`` |
|
1229 | 1229 | ---------- |
|
1230 | 1230 | |
|
1231 | 1231 | Specifies default handling of phases. See :hg:`help phases` for more |
|
1232 | 1232 | information about working with phases. |
|
1233 | 1233 | |
|
1234 | 1234 | ``publish`` |
|
1235 | 1235 | Controls draft phase behavior when working as a server. When true, |
|
1236 | 1236 | pushed changesets are set to public in both client and server and |
|
1237 | 1237 | pulled or cloned changesets are set to public in the client. |
|
1238 | 1238 | (default: True) |
|
1239 | 1239 | |
|
1240 | 1240 | ``new-commit`` |
|
1241 | 1241 | Phase of newly-created commits. |
|
1242 | 1242 | (default: draft) |
|
1243 | 1243 | |
|
1244 | 1244 | ``checksubrepos`` |
|
1245 | 1245 | Check the phase of the current revision of each subrepository. Allowed |
|
1246 | 1246 | values are "ignore", "follow" and "abort". For settings other than |
|
1247 | 1247 | "ignore", the phase of the current revision of each subrepository is |
|
1248 | 1248 | checked before committing the parent repository. If any of those phases is |
|
1249 | 1249 | greater than the phase of the parent repository (e.g. if a subrepo is in a |
|
1250 | 1250 | "secret" phase while the parent repo is in "draft" phase), the commit is |
|
1251 | 1251 | either aborted (if checksubrepos is set to "abort") or the higher phase is |
|
1252 | 1252 | used for the parent repository commit (if set to "follow"). |
|
1253 | 1253 | (default: follow) |
|
1254 | 1254 | |
|
1255 | 1255 | |
|
1256 | 1256 | ``profiling`` |
|
1257 | 1257 | ------------- |
|
1258 | 1258 | |
|
1259 | 1259 | Specifies profiling type, format, and file output. Two profilers are |
|
1260 | 1260 | supported: an instrumenting profiler (named ``ls``), and a sampling |
|
1261 | 1261 | profiler (named ``stat``). |
|
1262 | 1262 | |
|
1263 | 1263 | In this section description, 'profiling data' stands for the raw data |
|
1264 | 1264 | collected during profiling, while 'profiling report' stands for a |
|
1265 | 1265 | statistical text report generated from the profiling data. The |
|
1266 | 1266 | profiling is done using lsprof. |
|
1267 | 1267 | |
|
1268 | 1268 | ``type`` |
|
1269 | 1269 | The type of profiler to use. |
|
1270 | 1270 | (default: ls) |
|
1271 | 1271 | |
|
1272 | 1272 | ``ls`` |
|
1273 | 1273 | Use Python's built-in instrumenting profiler. This profiler |
|
1274 | 1274 | works on all platforms, but each line number it reports is the |
|
1275 | 1275 | first line of a function. This restriction makes it difficult to |
|
1276 | 1276 | identify the expensive parts of a non-trivial function. |
|
1277 | 1277 | ``stat`` |
|
1278 | 1278 | Use a third-party statistical profiler, statprof. This profiler |
|
1279 | 1279 | currently runs only on Unix systems, and is most useful for |
|
1280 | 1280 | profiling commands that run for longer than about 0.1 seconds. |
|
1281 | 1281 | |
|
1282 | 1282 | ``format`` |
|
1283 | 1283 | Profiling format. Specific to the ``ls`` instrumenting profiler. |
|
1284 | 1284 | (default: text) |
|
1285 | 1285 | |
|
1286 | 1286 | ``text`` |
|
1287 | 1287 | Generate a profiling report. When saving to a file, it should be |
|
1288 | 1288 | noted that only the report is saved, and the profiling data is |
|
1289 | 1289 | not kept. |
|
1290 | 1290 | ``kcachegrind`` |
|
1291 | 1291 | Format profiling data for kcachegrind use: when saving to a |
|
1292 | 1292 | file, the generated file can directly be loaded into |
|
1293 | 1293 | kcachegrind. |
|
1294 | 1294 | |
|
1295 | 1295 | ``frequency`` |
|
1296 | 1296 | Sampling frequency. Specific to the ``stat`` sampling profiler. |
|
1297 | 1297 | (default: 1000) |
|
1298 | 1298 | |
|
1299 | 1299 | ``output`` |
|
1300 | 1300 | File path where profiling data or report should be saved. If the |
|
1301 | 1301 | file exists, it is replaced. (default: None, data is printed on |
|
1302 | 1302 | stderr) |
|
1303 | 1303 | |
|
1304 | 1304 | ``sort`` |
|
1305 | 1305 | Sort field. Specific to the ``ls`` instrumenting profiler. |
|
1306 | 1306 | One of ``callcount``, ``reccallcount``, ``totaltime`` and |
|
1307 | 1307 | ``inlinetime``. |
|
1308 | 1308 | (default: inlinetime) |
|
1309 | 1309 | |
|
1310 | 1310 | ``limit`` |
|
1311 | 1311 | Number of lines to show. Specific to the ``ls`` instrumenting profiler. |
|
1312 | 1312 | (default: 30) |
|
1313 | 1313 | |
|
1314 | 1314 | ``nested`` |
|
1315 | 1315 | Show at most this number of lines of drill-down info after each main entry. |
|
1316 | 1316 | This can help explain the difference between Total and Inline. |
|
1317 | 1317 | Specific to the ``ls`` instrumenting profiler. |
|
1318 | 1318 | (default: 5) |
|
1319 | 1319 | |
|
1320 | 1320 | ``progress`` |
|
1321 | 1321 | ------------ |
|
1322 | 1322 | |
|
1323 | 1323 | Mercurial commands can draw progress bars that are as informative as |
|
1324 | 1324 | possible. Some progress bars only offer indeterminate information, while others |
|
1325 | 1325 | have a definite end point. |
|
1326 | 1326 | |
|
1327 | 1327 | ``delay`` |
|
1328 | 1328 | Number of seconds (float) before showing the progress bar. (default: 3) |
|
1329 | 1329 | |
|
1330 | 1330 | ``changedelay`` |
|
1331 | 1331 | Minimum delay before showing a new topic. When set to less than 3 * refresh, |
|
1332 | 1332 | that value will be used instead. (default: 1) |
|
1333 | 1333 | |
|
1334 | 1334 | ``refresh`` |
|
1335 | 1335 | Time in seconds between refreshes of the progress bar. (default: 0.1) |
|
1336 | 1336 | |
|
1337 | 1337 | ``format`` |
|
1338 | 1338 | Format of the progress bar. |
|
1339 | 1339 | |
|
1340 | 1340 | Valid entries for the format field are ``topic``, ``bar``, ``number``, |
|
1341 | 1341 | ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the |
|
1342 | 1342 | last 20 characters of the item, but this can be changed by adding either |
|
1343 | 1343 | ``-<num>`` which would take the last num characters, or ``+<num>`` for the |
|
1344 | 1344 | first num characters. |
|
1345 | 1345 | |
|
1346 | 1346 | (default: topic bar number estimate) |
|
1347 | 1347 | |
|
1348 | 1348 | ``width`` |
|
1349 | 1349 | If set, the maximum width of the progress information (that is, min(width, |
|
1350 | 1350 | term width) will be used). |
|
1351 | 1351 | |
|
1352 | 1352 | ``clear-complete`` |
|
1353 | 1353 | Clear the progress bar after it's done. (default: True) |
|
1354 | 1354 | |
|
1355 | 1355 | ``disable`` |
|
1356 | 1356 | If true, don't show a progress bar. |
|
1357 | 1357 | |
|
1358 | 1358 | ``assume-tty`` |
|
1359 | 1359 | If true, ALWAYS show a progress bar, unless disable is given. |
|
1360 | 1360 | |
|
1361 | 1361 | ``rebase`` |
|
1362 | 1362 | ---------- |
|
1363 | 1363 | |
|
1364 | 1364 | ``allowdivergence`` |
|
1365 | 1365 | Default to False, when True allow creating divergence when performing |
|
1366 | 1366 | rebase of obsolete changesets. |
|
1367 | 1367 | |
|
1368 | 1368 | ``revsetalias`` |
|
1369 | 1369 | --------------- |
|
1370 | 1370 | |
|
1371 | 1371 | Alias definitions for revsets. See :hg:`help revsets` for details. |
|
1372 | 1372 | |
|
1373 | 1373 | ``server`` |
|
1374 | 1374 | ---------- |
|
1375 | 1375 | |
|
1376 | 1376 | Controls generic server settings. |
|
1377 | 1377 | |
|
1378 | 1378 | ``uncompressed`` |
|
1379 | 1379 | Whether to allow clients to clone a repository using the |
|
1380 | 1380 | uncompressed streaming protocol. This transfers about 40% more |
|
1381 | 1381 | data than a regular clone, but uses less memory and CPU on both |
|
1382 | 1382 | server and client. Over a LAN (100 Mbps or better) or a very fast |
|
1383 | 1383 | WAN, an uncompressed streaming clone is a lot faster (~10x) than a |
|
1384 | 1384 | regular clone. Over most WAN connections (anything slower than |
|
1385 | 1385 | about 6 Mbps), uncompressed streaming is slower, because of the |
|
1386 | 1386 | extra data transfer overhead. This mode will also temporarily hold |
|
1387 | 1387 | the write lock while determining what data to transfer. |
|
1388 | 1388 | (default: True) |
|
1389 | 1389 | |
|
1390 | 1390 | ``preferuncompressed`` |
|
1391 | 1391 | When set, clients will try to use the uncompressed streaming |
|
1392 | 1392 | protocol. (default: False) |
|
1393 | 1393 | |
|
1394 | 1394 | ``validate`` |
|
1395 | 1395 | Whether to validate the completeness of pushed changesets by |
|
1396 | 1396 | checking that all new file revisions specified in manifests are |
|
1397 | 1397 | present. (default: False) |
|
1398 | 1398 | |
|
1399 | 1399 | ``maxhttpheaderlen`` |
|
1400 | 1400 | Instruct HTTP clients not to send request headers longer than this |
|
1401 | 1401 | many bytes. (default: 1024) |
|
1402 | 1402 | |
|
1403 | 1403 | ``bundle1`` |
|
1404 | 1404 | Whether to allow clients to push and pull using the legacy bundle1 |
|
1405 | 1405 | exchange format. (default: True) |
|
1406 | 1406 | |
|
1407 | 1407 | ``bundle1gd`` |
|
1408 | 1408 | Like ``bundle1`` but only used if the repository is using the |
|
1409 | 1409 | *generaldelta* storage format. (default: True) |
|
1410 | 1410 | |
|
1411 | 1411 | ``bundle1.push`` |
|
1412 | 1412 | Whether to allow clients to push using the legacy bundle1 exchange |
|
1413 | 1413 | format. (default: True) |
|
1414 | 1414 | |
|
1415 | 1415 | ``bundle1gd.push`` |
|
1416 | 1416 | Like ``bundle1.push`` but only used if the repository is using the |
|
1417 | 1417 | *generaldelta* storage format. (default: True) |
|
1418 | 1418 | |
|
1419 | 1419 | ``bundle1.pull`` |
|
1420 | 1420 | Whether to allow clients to pull using the legacy bundle1 exchange |
|
1421 | 1421 | format. (default: True) |
|
1422 | 1422 | |
|
1423 | 1423 | ``bundle1gd.pull`` |
|
1424 | 1424 | Like ``bundle1.pull`` but only used if the repository is using the |
|
1425 | 1425 | *generaldelta* storage format. (default: True) |
|
1426 | 1426 | |
|
1427 | 1427 | Large repositories using the *generaldelta* storage format should |
|
1428 | 1428 | consider setting this option because converting *generaldelta* |
|
1429 | 1429 | repositories to the exchange format required by the bundle1 data |
|
1430 | 1430 | format can consume a lot of CPU. |
|
1431 | 1431 | |
|
1432 | 1432 | ``smtp`` |
|
1433 | 1433 | -------- |
|
1434 | 1434 | |
|
1435 | 1435 | Configuration for extensions that need to send email messages. |
|
1436 | 1436 | |
|
1437 | 1437 | ``host`` |
|
1438 | 1438 | Host name of mail server, e.g. "mail.example.com". |
|
1439 | 1439 | |
|
1440 | 1440 | ``port`` |
|
1441 | 1441 | Optional. Port to connect to on mail server. (default: 465 if |
|
1442 | 1442 | ``tls`` is smtps; 25 otherwise) |
|
1443 | 1443 | |
|
1444 | 1444 | ``tls`` |
|
1445 | 1445 | Optional. Method to enable TLS when connecting to mail server: starttls, |
|
1446 | 1446 | smtps or none. (default: none) |
|
1447 | 1447 | |
|
1448 | 1448 | ``verifycert`` |
|
1449 | 1449 | Optional. Verification for the certificate of mail server, when |
|
1450 | 1450 | ``tls`` is starttls or smtps. "strict", "loose" or False. For |
|
1451 | 1451 | "strict" or "loose", the certificate is verified as same as the |
|
1452 | 1452 | verification for HTTPS connections (see ``[hostfingerprints]`` and |
|
1453 | 1453 | ``[web] cacerts`` also). For "strict", sending email is also |
|
1454 | 1454 | aborted, if there is no configuration for mail server in |
|
1455 | 1455 | ``[hostfingerprints]`` and ``[web] cacerts``. --insecure for |
|
1456 | 1456 | :hg:`email` overwrites this as "loose". (default: strict) |
|
1457 | 1457 | |
|
1458 | 1458 | ``username`` |
|
1459 | 1459 | Optional. User name for authenticating with the SMTP server. |
|
1460 | 1460 | (default: None) |
|
1461 | 1461 | |
|
1462 | 1462 | ``password`` |
|
1463 | 1463 | Optional. Password for authenticating with the SMTP server. If not |
|
1464 | 1464 | specified, interactive sessions will prompt the user for a |
|
1465 | 1465 | password; non-interactive sessions will fail. (default: None) |
|
1466 | 1466 | |
|
1467 | 1467 | ``local_hostname`` |
|
1468 | 1468 | Optional. The hostname that the sender can use to identify |
|
1469 | 1469 | itself to the MTA. |
|
1470 | 1470 | |
|
1471 | 1471 | |
|
1472 | 1472 | ``subpaths`` |
|
1473 | 1473 | ------------ |
|
1474 | 1474 | |
|
1475 | 1475 | Subrepository source URLs can go stale if a remote server changes name |
|
1476 | 1476 | or becomes temporarily unavailable. This section lets you define |
|
1477 | 1477 | rewrite rules of the form:: |
|
1478 | 1478 | |
|
1479 | 1479 | <pattern> = <replacement> |
|
1480 | 1480 | |
|
1481 | 1481 | where ``pattern`` is a regular expression matching a subrepository |
|
1482 | 1482 | source URL and ``replacement`` is the replacement string used to |
|
1483 | 1483 | rewrite it. Groups can be matched in ``pattern`` and referenced in |
|
1484 | 1484 | ``replacements``. For instance:: |
|
1485 | 1485 | |
|
1486 | 1486 | http://server/(.*)-hg/ = http://hg.server/\1/ |
|
1487 | 1487 | |
|
1488 | 1488 | rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``. |
|
1489 | 1489 | |
|
1490 | 1490 | Relative subrepository paths are first made absolute, and the |
|
1491 | 1491 | rewrite rules are then applied on the full (absolute) path. The rules |
|
1492 | 1492 | are applied in definition order. |
|
1493 | 1493 | |
|
1494 | 1494 | ``trusted`` |
|
1495 | 1495 | ----------- |
|
1496 | 1496 | |
|
1497 | 1497 | Mercurial will not use the settings in the |
|
1498 | 1498 | ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted |
|
1499 | 1499 | user or to a trusted group, as various hgrc features allow arbitrary |
|
1500 | 1500 | commands to be run. This issue is often encountered when configuring |
|
1501 | 1501 | hooks or extensions for shared repositories or servers. However, |
|
1502 | 1502 | the web interface will use some safe settings from the ``[web]`` |
|
1503 | 1503 | section. |
|
1504 | 1504 | |
|
1505 | 1505 | This section specifies what users and groups are trusted. The |
|
1506 | 1506 | current user is always trusted. To trust everybody, list a user or a |
|
1507 | 1507 | group with name ``*``. These settings must be placed in an |
|
1508 | 1508 | *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the |
|
1509 | 1509 | user or service running Mercurial. |
|
1510 | 1510 | |
|
1511 | 1511 | ``users`` |
|
1512 | 1512 | Comma-separated list of trusted users. |
|
1513 | 1513 | |
|
1514 | 1514 | ``groups`` |
|
1515 | 1515 | Comma-separated list of trusted groups. |
|
1516 | 1516 | |
|
1517 | 1517 | |
|
1518 | 1518 | ``ui`` |
|
1519 | 1519 | ------ |
|
1520 | 1520 | |
|
1521 | 1521 | User interface controls. |
|
1522 | 1522 | |
|
1523 | 1523 | ``archivemeta`` |
|
1524 | 1524 | Whether to include the .hg_archival.txt file containing meta data |
|
1525 | 1525 | (hashes for the repository base and for tip) in archives created |
|
1526 | 1526 | by the :hg:`archive` command or downloaded via hgweb. |
|
1527 | 1527 | (default: True) |
|
1528 | 1528 | |
|
1529 | 1529 | ``askusername`` |
|
1530 | 1530 | Whether to prompt for a username when committing. If True, and |
|
1531 | 1531 | neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will |
|
1532 | 1532 | be prompted to enter a username. If no username is entered, the |
|
1533 | 1533 | default ``USER@HOST`` is used instead. |
|
1534 | 1534 | (default: False) |
|
1535 | 1535 | |
|
1536 | 1536 | ``clonebundles`` |
|
1537 | 1537 | Whether the "clone bundles" feature is enabled. |
|
1538 | 1538 | |
|
1539 | 1539 | When enabled, :hg:`clone` may download and apply a server-advertised |
|
1540 | 1540 | bundle file from a URL instead of using the normal exchange mechanism. |
|
1541 | 1541 | |
|
1542 | 1542 | This can likely result in faster and more reliable clones. |
|
1543 | 1543 | |
|
1544 | 1544 | (default: True) |
|
1545 | 1545 | |
|
1546 | 1546 | ``clonebundlefallback`` |
|
1547 | 1547 | Whether failure to apply an advertised "clone bundle" from a server |
|
1548 | 1548 | should result in fallback to a regular clone. |
|
1549 | 1549 | |
|
1550 | 1550 | This is disabled by default because servers advertising "clone |
|
1551 | 1551 | bundles" often do so to reduce server load. If advertised bundles |
|
1552 | 1552 | start mass failing and clients automatically fall back to a regular |
|
1553 | 1553 | clone, this would add significant and unexpected load to the server |
|
1554 | 1554 | since the server is expecting clone operations to be offloaded to |
|
1555 | 1555 | pre-generated bundles. Failing fast (the default behavior) ensures |
|
1556 | 1556 | clients don't overwhelm the server when "clone bundle" application |
|
1557 | 1557 | fails. |
|
1558 | 1558 | |
|
1559 | 1559 | (default: False) |
|
1560 | 1560 | |
|
1561 | 1561 | ``clonebundleprefers`` |
|
1562 | 1562 | Defines preferences for which "clone bundles" to use. |
|
1563 | 1563 | |
|
1564 | 1564 | Servers advertising "clone bundles" may advertise multiple available |
|
1565 | 1565 | bundles. Each bundle may have different attributes, such as the bundle |
|
1566 | 1566 | type and compression format. This option is used to prefer a particular |
|
1567 | 1567 | bundle over another. |
|
1568 | 1568 | |
|
1569 | 1569 | The following keys are defined by Mercurial: |
|
1570 | 1570 | |
|
1571 | 1571 | BUNDLESPEC |
|
1572 | 1572 | A bundle type specifier. These are strings passed to :hg:`bundle -t`. |
|
1573 | 1573 | e.g. ``gzip-v2`` or ``bzip2-v1``. |
|
1574 | 1574 | |
|
1575 | 1575 | COMPRESSION |
|
1576 | 1576 | The compression format of the bundle. e.g. ``gzip`` and ``bzip2``. |
|
1577 | 1577 | |
|
1578 | 1578 | Server operators may define custom keys. |
|
1579 | 1579 | |
|
1580 | 1580 | Example values: ``COMPRESSION=bzip2``, |
|
1581 | 1581 | ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``. |
|
1582 | 1582 | |
|
1583 | 1583 | By default, the first bundle advertised by the server is used. |
|
1584 | 1584 | |
|
1585 | 1585 | ``commitsubrepos`` |
|
1586 | 1586 | Whether to commit modified subrepositories when committing the |
|
1587 | 1587 | parent repository. If False and one subrepository has uncommitted |
|
1588 | 1588 | changes, abort the commit. |
|
1589 | 1589 | (default: False) |
|
1590 | 1590 | |
|
1591 | 1591 | ``debug`` |
|
1592 | 1592 | Print debugging information. (default: False) |
|
1593 | 1593 | |
|
1594 | 1594 | ``editor`` |
|
1595 | 1595 | The editor to use during a commit. (default: ``$EDITOR`` or ``vi``) |
|
1596 | 1596 | |
|
1597 | 1597 | ``fallbackencoding`` |
|
1598 | 1598 | Encoding to try if it's not possible to decode the changelog using |
|
1599 | 1599 | UTF-8. (default: ISO-8859-1) |
|
1600 | 1600 | |
|
1601 | 1601 | ``graphnodetemplate`` |
|
1602 | 1602 | The template used to print changeset nodes in an ASCII revision graph. |
|
1603 | 1603 | (default: ``{graphnode}``) |
|
1604 | 1604 | |
|
1605 | 1605 | ``ignore`` |
|
1606 | 1606 | A file to read per-user ignore patterns from. This file should be |
|
1607 | 1607 | in the same format as a repository-wide .hgignore file. Filenames |
|
1608 | 1608 | are relative to the repository root. This option supports hook syntax, |
|
1609 | 1609 | so if you want to specify multiple ignore files, you can do so by |
|
1610 | 1610 | setting something like ``ignore.other = ~/.hgignore2``. For details |
|
1611 | 1611 | of the ignore file format, see the ``hgignore(5)`` man page. |
|
1612 | 1612 | |
|
1613 | 1613 | ``interactive`` |
|
1614 | 1614 | Allow to prompt the user. (default: True) |
|
1615 | 1615 | |
|
1616 | ``interface`` | |
|
1617 | Select the default interface for interactive features (default: text). | |
|
1618 | Possible values are 'text' and 'curses'. | |
|
1619 | ||
|
1620 | ``interface.chunkselector`` | |
|
1621 | Select the interface for change recording (e.g. :hg:`commit` -i). | |
|
1622 | Possible values are 'text' and 'curses'. | |
|
1623 | This config overrides the interface specified by ui.interface. | |
|
1624 | ||
|
1616 | 1625 | ``logtemplate`` |
|
1617 | 1626 | Template string for commands that print changesets. |
|
1618 | 1627 | |
|
1619 | 1628 | ``merge`` |
|
1620 | 1629 | The conflict resolution program to use during a manual merge. |
|
1621 | 1630 | For more information on merge tools see :hg:`help merge-tools`. |
|
1622 | 1631 | For configuring merge tools see the ``[merge-tools]`` section. |
|
1623 | 1632 | |
|
1624 | 1633 | ``mergemarkers`` |
|
1625 | 1634 | Sets the merge conflict marker label styling. The ``detailed`` |
|
1626 | 1635 | style uses the ``mergemarkertemplate`` setting to style the labels. |
|
1627 | 1636 | The ``basic`` style just uses 'local' and 'other' as the marker label. |
|
1628 | 1637 | One of ``basic`` or ``detailed``. |
|
1629 | 1638 | (default: ``basic``) |
|
1630 | 1639 | |
|
1631 | 1640 | ``mergemarkertemplate`` |
|
1632 | 1641 | The template used to print the commit description next to each conflict |
|
1633 | 1642 | marker during merge conflicts. See :hg:`help templates` for the template |
|
1634 | 1643 | format. |
|
1635 | 1644 | |
|
1636 | 1645 | Defaults to showing the hash, tags, branches, bookmarks, author, and |
|
1637 | 1646 | the first line of the commit description. |
|
1638 | 1647 | |
|
1639 | 1648 | If you use non-ASCII characters in names for tags, branches, bookmarks, |
|
1640 | 1649 | authors, and/or commit descriptions, you must pay attention to encodings of |
|
1641 | 1650 | managed files. At template expansion, non-ASCII characters use the encoding |
|
1642 | 1651 | specified by the ``--encoding`` global option, ``HGENCODING`` or other |
|
1643 | 1652 | environment variables that govern your locale. If the encoding of the merge |
|
1644 | 1653 | markers is different from the encoding of the merged files, |
|
1645 | 1654 | serious problems may occur. |
|
1646 | 1655 | |
|
1647 | 1656 | ``origbackuppath`` |
|
1648 | 1657 | The path to a directory used to store generated .orig files. If the path is |
|
1649 | 1658 | not a directory, one will be created. |
|
1650 | 1659 | |
|
1651 | 1660 | ``patch`` |
|
1652 | 1661 | An optional external tool that ``hg import`` and some extensions |
|
1653 | 1662 | will use for applying patches. By default Mercurial uses an |
|
1654 | 1663 | internal patch utility. The external tool must work as the common |
|
1655 | 1664 | Unix ``patch`` program. In particular, it must accept a ``-p`` |
|
1656 | 1665 | argument to strip patch headers, a ``-d`` argument to specify the |
|
1657 | 1666 | current directory, a file name to patch, and a patch file to take |
|
1658 | 1667 | from stdin. |
|
1659 | 1668 | |
|
1660 | 1669 | It is possible to specify a patch tool together with extra |
|
1661 | 1670 | arguments. For example, setting this option to ``patch --merge`` |
|
1662 | 1671 | will use the ``patch`` program with its 2-way merge option. |
|
1663 | 1672 | |
|
1664 | 1673 | ``portablefilenames`` |
|
1665 | 1674 | Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``. |
|
1666 | 1675 | (default: ``warn``) |
|
1667 | 1676 | |
|
1668 | 1677 | ``warn`` |
|
1669 | 1678 | Print a warning message on POSIX platforms, if a file with a non-portable |
|
1670 | 1679 | filename is added (e.g. a file with a name that can't be created on |
|
1671 | 1680 | Windows because it contains reserved parts like ``AUX``, reserved |
|
1672 | 1681 | characters like ``:``, or would cause a case collision with an existing |
|
1673 | 1682 | file). |
|
1674 | 1683 | |
|
1675 | 1684 | ``ignore`` |
|
1676 | 1685 | Don't print a warning. |
|
1677 | 1686 | |
|
1678 | 1687 | ``abort`` |
|
1679 | 1688 | The command is aborted. |
|
1680 | 1689 | |
|
1681 | 1690 | ``true`` |
|
1682 | 1691 | Alias for ``warn``. |
|
1683 | 1692 | |
|
1684 | 1693 | ``false`` |
|
1685 | 1694 | Alias for ``ignore``. |
|
1686 | 1695 | |
|
1687 | 1696 | .. container:: windows |
|
1688 | 1697 | |
|
1689 | 1698 | On Windows, this configuration option is ignored and the command aborted. |
|
1690 | 1699 | |
|
1691 | 1700 | ``quiet`` |
|
1692 | 1701 | Reduce the amount of output printed. |
|
1693 | 1702 | (default: False) |
|
1694 | 1703 | |
|
1695 | 1704 | ``remotecmd`` |
|
1696 | 1705 | Remote command to use for clone/push/pull operations. |
|
1697 | 1706 | (default: ``hg``) |
|
1698 | 1707 | |
|
1699 | 1708 | ``report_untrusted`` |
|
1700 | 1709 | Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a |
|
1701 | 1710 | trusted user or group. |
|
1702 | 1711 | (default: True) |
|
1703 | 1712 | |
|
1704 | 1713 | ``slash`` |
|
1705 | 1714 | Display paths using a slash (``/``) as the path separator. This |
|
1706 | 1715 | only makes a difference on systems where the default path |
|
1707 | 1716 | separator is not the slash character (e.g. Windows uses the |
|
1708 | 1717 | backslash character (``\``)). |
|
1709 | 1718 | (default: False) |
|
1710 | 1719 | |
|
1711 | 1720 | ``statuscopies`` |
|
1712 | 1721 | Display copies in the status command. |
|
1713 | 1722 | |
|
1714 | 1723 | ``ssh`` |
|
1715 | 1724 | Command to use for SSH connections. (default: ``ssh``) |
|
1716 | 1725 | |
|
1717 | 1726 | ``strict`` |
|
1718 | 1727 | Require exact command names, instead of allowing unambiguous |
|
1719 | 1728 | abbreviations. (default: False) |
|
1720 | 1729 | |
|
1721 | 1730 | ``style`` |
|
1722 | 1731 | Name of style to use for command output. |
|
1723 | 1732 | |
|
1724 | 1733 | ``supportcontact`` |
|
1725 | 1734 | A URL where users should report a Mercurial traceback. Use this if you are a |
|
1726 | 1735 | large organisation with its own Mercurial deployment process and crash |
|
1727 | 1736 | reports should be addressed to your internal support. |
|
1728 | 1737 | |
|
1729 | 1738 | ``timeout`` |
|
1730 | 1739 | The timeout used when a lock is held (in seconds), a negative value |
|
1731 | 1740 | means no timeout. (default: 600) |
|
1732 | 1741 | |
|
1733 | 1742 | ``traceback`` |
|
1734 | 1743 | Mercurial always prints a traceback when an unknown exception |
|
1735 | 1744 | occurs. Setting this to True will make Mercurial print a traceback |
|
1736 | 1745 | on all exceptions, even those recognized by Mercurial (such as |
|
1737 | 1746 | IOError or MemoryError). (default: False) |
|
1738 | 1747 | |
|
1739 | 1748 | ``username`` |
|
1740 | 1749 | The committer of a changeset created when running "commit". |
|
1741 | 1750 | Typically a person's name and email address, e.g. ``Fred Widget |
|
1742 | 1751 | <fred@example.com>``. Environment variables in the |
|
1743 | 1752 | username are expanded. |
|
1744 | 1753 | |
|
1745 | 1754 | (default: ``$EMAIL`` or ``username@hostname``. If the username in |
|
1746 | 1755 | hgrc is empty, e.g. if the system admin set ``username =`` in the |
|
1747 | 1756 | system hgrc, it has to be specified manually or in a different |
|
1748 | 1757 | hgrc file) |
|
1749 | 1758 | |
|
1750 | 1759 | ``verbose`` |
|
1751 | 1760 | Increase the amount of output printed. (default: False) |
|
1752 | 1761 | |
|
1753 | 1762 | |
|
1754 | 1763 | ``web`` |
|
1755 | 1764 | ------- |
|
1756 | 1765 | |
|
1757 | 1766 | Web interface configuration. The settings in this section apply to |
|
1758 | 1767 | both the builtin webserver (started by :hg:`serve`) and the script you |
|
1759 | 1768 | run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI |
|
1760 | 1769 | and WSGI). |
|
1761 | 1770 | |
|
1762 | 1771 | The Mercurial webserver does no authentication (it does not prompt for |
|
1763 | 1772 | usernames and passwords to validate *who* users are), but it does do |
|
1764 | 1773 | authorization (it grants or denies access for *authenticated users* |
|
1765 | 1774 | based on settings in this section). You must either configure your |
|
1766 | 1775 | webserver to do authentication for you, or disable the authorization |
|
1767 | 1776 | checks. |
|
1768 | 1777 | |
|
1769 | 1778 | For a quick setup in a trusted environment, e.g., a private LAN, where |
|
1770 | 1779 | you want it to accept pushes from anybody, you can use the following |
|
1771 | 1780 | command line:: |
|
1772 | 1781 | |
|
1773 | 1782 | $ hg --config web.allow_push=* --config web.push_ssl=False serve |
|
1774 | 1783 | |
|
1775 | 1784 | Note that this will allow anybody to push anything to the server and |
|
1776 | 1785 | that this should not be used for public servers. |
|
1777 | 1786 | |
|
1778 | 1787 | The full set of options is: |
|
1779 | 1788 | |
|
1780 | 1789 | ``accesslog`` |
|
1781 | 1790 | Where to output the access log. (default: stdout) |
|
1782 | 1791 | |
|
1783 | 1792 | ``address`` |
|
1784 | 1793 | Interface address to bind to. (default: all) |
|
1785 | 1794 | |
|
1786 | 1795 | ``allow_archive`` |
|
1787 | 1796 | List of archive format (bz2, gz, zip) allowed for downloading. |
|
1788 | 1797 | (default: empty) |
|
1789 | 1798 | |
|
1790 | 1799 | ``allowbz2`` |
|
1791 | 1800 | (DEPRECATED) Whether to allow .tar.bz2 downloading of repository |
|
1792 | 1801 | revisions. |
|
1793 | 1802 | (default: False) |
|
1794 | 1803 | |
|
1795 | 1804 | ``allowgz`` |
|
1796 | 1805 | (DEPRECATED) Whether to allow .tar.gz downloading of repository |
|
1797 | 1806 | revisions. |
|
1798 | 1807 | (default: False) |
|
1799 | 1808 | |
|
1800 | 1809 | ``allowpull`` |
|
1801 | 1810 | Whether to allow pulling from the repository. (default: True) |
|
1802 | 1811 | |
|
1803 | 1812 | ``allow_push`` |
|
1804 | 1813 | Whether to allow pushing to the repository. If empty or not set, |
|
1805 | 1814 | pushing is not allowed. If the special value ``*``, any remote |
|
1806 | 1815 | user can push, including unauthenticated users. Otherwise, the |
|
1807 | 1816 | remote user must have been authenticated, and the authenticated |
|
1808 | 1817 | user name must be present in this list. The contents of the |
|
1809 | 1818 | allow_push list are examined after the deny_push list. |
|
1810 | 1819 | |
|
1811 | 1820 | ``allow_read`` |
|
1812 | 1821 | If the user has not already been denied repository access due to |
|
1813 | 1822 | the contents of deny_read, this list determines whether to grant |
|
1814 | 1823 | repository access to the user. If this list is not empty, and the |
|
1815 | 1824 | user is unauthenticated or not present in the list, then access is |
|
1816 | 1825 | denied for the user. If the list is empty or not set, then access |
|
1817 | 1826 | is permitted to all users by default. Setting allow_read to the |
|
1818 | 1827 | special value ``*`` is equivalent to it not being set (i.e. access |
|
1819 | 1828 | is permitted to all users). The contents of the allow_read list are |
|
1820 | 1829 | examined after the deny_read list. |
|
1821 | 1830 | |
|
1822 | 1831 | ``allowzip`` |
|
1823 | 1832 | (DEPRECATED) Whether to allow .zip downloading of repository |
|
1824 | 1833 | revisions. This feature creates temporary files. |
|
1825 | 1834 | (default: False) |
|
1826 | 1835 | |
|
1827 | 1836 | ``archivesubrepos`` |
|
1828 | 1837 | Whether to recurse into subrepositories when archiving. |
|
1829 | 1838 | (default: False) |
|
1830 | 1839 | |
|
1831 | 1840 | ``baseurl`` |
|
1832 | 1841 | Base URL to use when publishing URLs in other locations, so |
|
1833 | 1842 | third-party tools like email notification hooks can construct |
|
1834 | 1843 | URLs. Example: ``http://hgserver/repos/``. |
|
1835 | 1844 | |
|
1836 | 1845 | ``cacerts`` |
|
1837 | 1846 | Path to file containing a list of PEM encoded certificate |
|
1838 | 1847 | authority certificates. Environment variables and ``~user`` |
|
1839 | 1848 | constructs are expanded in the filename. If specified on the |
|
1840 | 1849 | client, then it will verify the identity of remote HTTPS servers |
|
1841 | 1850 | with these certificates. |
|
1842 | 1851 | |
|
1843 | 1852 | This feature is only supported when using Python 2.6 or later. If you wish |
|
1844 | 1853 | to use it with earlier versions of Python, install the backported |
|
1845 | 1854 | version of the ssl library that is available from |
|
1846 | 1855 | ``http://pypi.python.org``. |
|
1847 | 1856 | |
|
1848 | 1857 | To disable SSL verification temporarily, specify ``--insecure`` from |
|
1849 | 1858 | command line. |
|
1850 | 1859 | |
|
1851 | 1860 | You can use OpenSSL's CA certificate file if your platform has |
|
1852 | 1861 | one. On most Linux systems this will be |
|
1853 | 1862 | ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to |
|
1854 | 1863 | generate this file manually. The form must be as follows:: |
|
1855 | 1864 | |
|
1856 | 1865 | -----BEGIN CERTIFICATE----- |
|
1857 | 1866 | ... (certificate in base64 PEM encoding) ... |
|
1858 | 1867 | -----END CERTIFICATE----- |
|
1859 | 1868 | -----BEGIN CERTIFICATE----- |
|
1860 | 1869 | ... (certificate in base64 PEM encoding) ... |
|
1861 | 1870 | -----END CERTIFICATE----- |
|
1862 | 1871 | |
|
1863 | 1872 | ``cache`` |
|
1864 | 1873 | Whether to support caching in hgweb. (default: True) |
|
1865 | 1874 | |
|
1866 | 1875 | ``certificate`` |
|
1867 | 1876 | Certificate to use when running :hg:`serve`. |
|
1868 | 1877 | |
|
1869 | 1878 | ``collapse`` |
|
1870 | 1879 | With ``descend`` enabled, repositories in subdirectories are shown at |
|
1871 | 1880 | a single level alongside repositories in the current path. With |
|
1872 | 1881 | ``collapse`` also enabled, repositories residing at a deeper level than |
|
1873 | 1882 | the current path are grouped behind navigable directory entries that |
|
1874 | 1883 | lead to the locations of these repositories. In effect, this setting |
|
1875 | 1884 | collapses each collection of repositories found within a subdirectory |
|
1876 | 1885 | into a single entry for that subdirectory. (default: False) |
|
1877 | 1886 | |
|
1878 | 1887 | ``comparisoncontext`` |
|
1879 | 1888 | Number of lines of context to show in side-by-side file comparison. If |
|
1880 | 1889 | negative or the value ``full``, whole files are shown. (default: 5) |
|
1881 | 1890 | |
|
1882 | 1891 | This setting can be overridden by a ``context`` request parameter to the |
|
1883 | 1892 | ``comparison`` command, taking the same values. |
|
1884 | 1893 | |
|
1885 | 1894 | ``contact`` |
|
1886 | 1895 | Name or email address of the person in charge of the repository. |
|
1887 | 1896 | (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty) |
|
1888 | 1897 | |
|
1889 | 1898 | ``deny_push`` |
|
1890 | 1899 | Whether to deny pushing to the repository. If empty or not set, |
|
1891 | 1900 | push is not denied. If the special value ``*``, all remote users are |
|
1892 | 1901 | denied push. Otherwise, unauthenticated users are all denied, and |
|
1893 | 1902 | any authenticated user name present in this list is also denied. The |
|
1894 | 1903 | contents of the deny_push list are examined before the allow_push list. |
|
1895 | 1904 | |
|
1896 | 1905 | ``deny_read`` |
|
1897 | 1906 | Whether to deny reading/viewing of the repository. If this list is |
|
1898 | 1907 | not empty, unauthenticated users are all denied, and any |
|
1899 | 1908 | authenticated user name present in this list is also denied access to |
|
1900 | 1909 | the repository. If set to the special value ``*``, all remote users |
|
1901 | 1910 | are denied access (rarely needed ;). If deny_read is empty or not set, |
|
1902 | 1911 | the determination of repository access depends on the presence and |
|
1903 | 1912 | content of the allow_read list (see description). If both |
|
1904 | 1913 | deny_read and allow_read are empty or not set, then access is |
|
1905 | 1914 | permitted to all users by default. If the repository is being |
|
1906 | 1915 | served via hgwebdir, denied users will not be able to see it in |
|
1907 | 1916 | the list of repositories. The contents of the deny_read list have |
|
1908 | 1917 | priority over (are examined before) the contents of the allow_read |
|
1909 | 1918 | list. |
|
1910 | 1919 | |
|
1911 | 1920 | ``descend`` |
|
1912 | 1921 | hgwebdir indexes will not descend into subdirectories. Only repositories |
|
1913 | 1922 | directly in the current path will be shown (other repositories are still |
|
1914 | 1923 | available from the index corresponding to their containing path). |
|
1915 | 1924 | |
|
1916 | 1925 | ``description`` |
|
1917 | 1926 | Textual description of the repository's purpose or contents. |
|
1918 | 1927 | (default: "unknown") |
|
1919 | 1928 | |
|
1920 | 1929 | ``encoding`` |
|
1921 | 1930 | Character encoding name. (default: the current locale charset) |
|
1922 | 1931 | Example: "UTF-8". |
|
1923 | 1932 | |
|
1924 | 1933 | ``errorlog`` |
|
1925 | 1934 | Where to output the error log. (default: stderr) |
|
1926 | 1935 | |
|
1927 | 1936 | ``guessmime`` |
|
1928 | 1937 | Control MIME types for raw download of file content. |
|
1929 | 1938 | Set to True to let hgweb guess the content type from the file |
|
1930 | 1939 | extension. This will serve HTML files as ``text/html`` and might |
|
1931 | 1940 | allow cross-site scripting attacks when serving untrusted |
|
1932 | 1941 | repositories. (default: False) |
|
1933 | 1942 | |
|
1934 | 1943 | ``hidden`` |
|
1935 | 1944 | Whether to hide the repository in the hgwebdir index. |
|
1936 | 1945 | (default: False) |
|
1937 | 1946 | |
|
1938 | 1947 | ``ipv6`` |
|
1939 | 1948 | Whether to use IPv6. (default: False) |
|
1940 | 1949 | |
|
1941 | 1950 | ``logoimg`` |
|
1942 | 1951 | File name of the logo image that some templates display on each page. |
|
1943 | 1952 | The file name is relative to ``staticurl``. That is, the full path to |
|
1944 | 1953 | the logo image is "staticurl/logoimg". |
|
1945 | 1954 | If unset, ``hglogo.png`` will be used. |
|
1946 | 1955 | |
|
1947 | 1956 | ``logourl`` |
|
1948 | 1957 | Base URL to use for logos. If unset, ``https://mercurial-scm.org/`` |
|
1949 | 1958 | will be used. |
|
1950 | 1959 | |
|
1951 | 1960 | ``maxchanges`` |
|
1952 | 1961 | Maximum number of changes to list on the changelog. (default: 10) |
|
1953 | 1962 | |
|
1954 | 1963 | ``maxfiles`` |
|
1955 | 1964 | Maximum number of files to list per changeset. (default: 10) |
|
1956 | 1965 | |
|
1957 | 1966 | ``maxshortchanges`` |
|
1958 | 1967 | Maximum number of changes to list on the shortlog, graph or filelog |
|
1959 | 1968 | pages. (default: 60) |
|
1960 | 1969 | |
|
1961 | 1970 | ``name`` |
|
1962 | 1971 | Repository name to use in the web interface. |
|
1963 | 1972 | (default: current working directory) |
|
1964 | 1973 | |
|
1965 | 1974 | ``port`` |
|
1966 | 1975 | Port to listen on. (default: 8000) |
|
1967 | 1976 | |
|
1968 | 1977 | ``prefix`` |
|
1969 | 1978 | Prefix path to serve from. (default: '' (server root)) |
|
1970 | 1979 | |
|
1971 | 1980 | ``push_ssl`` |
|
1972 | 1981 | Whether to require that inbound pushes be transported over SSL to |
|
1973 | 1982 | prevent password sniffing. (default: True) |
|
1974 | 1983 | |
|
1975 | 1984 | ``refreshinterval`` |
|
1976 | 1985 | How frequently directory listings re-scan the filesystem for new |
|
1977 | 1986 | repositories, in seconds. This is relevant when wildcards are used |
|
1978 | 1987 | to define paths. Depending on how much filesystem traversal is |
|
1979 | 1988 | required, refreshing may negatively impact performance. |
|
1980 | 1989 | |
|
1981 | 1990 | Values less than or equal to 0 always refresh. |
|
1982 | 1991 | (default: 20) |
|
1983 | 1992 | |
|
1984 | 1993 | ``staticurl`` |
|
1985 | 1994 | Base URL to use for static files. If unset, static files (e.g. the |
|
1986 | 1995 | hgicon.png favicon) will be served by the CGI script itself. Use |
|
1987 | 1996 | this setting to serve them directly with the HTTP server. |
|
1988 | 1997 | Example: ``http://hgserver/static/``. |
|
1989 | 1998 | |
|
1990 | 1999 | ``stripes`` |
|
1991 | 2000 | How many lines a "zebra stripe" should span in multi-line output. |
|
1992 | 2001 | Set to 0 to disable. (default: 1) |
|
1993 | 2002 | |
|
1994 | 2003 | ``style`` |
|
1995 | 2004 | Which template map style to use. The available options are the names of |
|
1996 | 2005 | subdirectories in the HTML templates path. (default: ``paper``) |
|
1997 | 2006 | Example: ``monoblue``. |
|
1998 | 2007 | |
|
1999 | 2008 | ``templates`` |
|
2000 | 2009 | Where to find the HTML templates. The default path to the HTML templates |
|
2001 | 2010 | can be obtained from ``hg debuginstall``. |
|
2002 | 2011 | |
|
2003 | 2012 | ``websub`` |
|
2004 | 2013 | ---------- |
|
2005 | 2014 | |
|
2006 | 2015 | Web substitution filter definition. You can use this section to |
|
2007 | 2016 | define a set of regular expression substitution patterns which |
|
2008 | 2017 | let you automatically modify the hgweb server output. |
|
2009 | 2018 | |
|
2010 | 2019 | The default hgweb templates only apply these substitution patterns |
|
2011 | 2020 | on the revision description fields. You can apply them anywhere |
|
2012 | 2021 | you want when you create your own templates by adding calls to the |
|
2013 | 2022 | "websub" filter (usually after calling the "escape" filter). |
|
2014 | 2023 | |
|
2015 | 2024 | This can be used, for example, to convert issue references to links |
|
2016 | 2025 | to your issue tracker, or to convert "markdown-like" syntax into |
|
2017 | 2026 | HTML (see the examples below). |
|
2018 | 2027 | |
|
2019 | 2028 | Each entry in this section names a substitution filter. |
|
2020 | 2029 | The value of each entry defines the substitution expression itself. |
|
2021 | 2030 | The websub expressions follow the old interhg extension syntax, |
|
2022 | 2031 | which in turn imitates the Unix sed replacement syntax:: |
|
2023 | 2032 | |
|
2024 | 2033 | patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i] |
|
2025 | 2034 | |
|
2026 | 2035 | You can use any separator other than "/". The final "i" is optional |
|
2027 | 2036 | and indicates that the search must be case insensitive. |
|
2028 | 2037 | |
|
2029 | 2038 | Examples:: |
|
2030 | 2039 | |
|
2031 | 2040 | [websub] |
|
2032 | 2041 | issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i |
|
2033 | 2042 | italic = s/\b_(\S+)_\b/<i>\1<\/i>/ |
|
2034 | 2043 | bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/ |
|
2035 | 2044 | |
|
2036 | 2045 | ``worker`` |
|
2037 | 2046 | ---------- |
|
2038 | 2047 | |
|
2039 | 2048 | Parallel master/worker configuration. We currently perform working |
|
2040 | 2049 | directory updates in parallel on Unix-like systems, which greatly |
|
2041 | 2050 | helps performance. |
|
2042 | 2051 | |
|
2043 | 2052 | ``numcpus`` |
|
2044 | 2053 | Number of CPUs to use for parallel operations. A zero or |
|
2045 | 2054 | negative value is treated as ``use the default``. |
|
2046 | 2055 | (default: 4 or the number of CPUs on the system, whichever is larger) |
|
2047 | 2056 | |
|
2048 | 2057 | ``backgroundclose`` |
|
2049 | 2058 | Whether to enable closing file handles on background threads during certain |
|
2050 | 2059 | operations. Some platforms aren't very efficient at closing file |
|
2051 | 2060 | handles that have been written or appended to. By performing file closing |
|
2052 | 2061 | on background threads, file write rate can increase substantially. |
|
2053 | 2062 | (default: true on Windows, false elsewhere) |
|
2054 | 2063 | |
|
2055 | 2064 | ``backgroundcloseminfilecount`` |
|
2056 | 2065 | Minimum number of files required to trigger background file closing. |
|
2057 | 2066 | Operations not writing this many files won't start background close |
|
2058 | 2067 | threads. |
|
2059 | 2068 | (default: 2048) |
|
2060 | 2069 | |
|
2061 | 2070 | ``backgroundclosemaxqueue`` |
|
2062 | 2071 | The maximum number of opened file handles waiting to be closed in the |
|
2063 | 2072 | background. This option only has an effect if ``backgroundclose`` is |
|
2064 | 2073 | enabled. |
|
2065 | 2074 | (default: 384) |
|
2066 | 2075 | |
|
2067 | 2076 | ``backgroundclosethreadcount`` |
|
2068 | 2077 | Number of threads to process background file closes. Only relevant if |
|
2069 | 2078 | ``backgroundclose`` is enabled. |
|
2070 | 2079 | (default: 4) |
@@ -1,1265 +1,1336 b'' | |||
|
1 | 1 | # ui.py - user interface bits for mercurial |
|
2 | 2 | # |
|
3 | 3 | # Copyright 2005-2007 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 errno |
|
11 | 11 | import getpass |
|
12 | 12 | import inspect |
|
13 | 13 | import os |
|
14 | 14 | import re |
|
15 | 15 | import socket |
|
16 | 16 | import sys |
|
17 | 17 | import tempfile |
|
18 | 18 | import traceback |
|
19 | 19 | |
|
20 | 20 | from .i18n import _ |
|
21 | 21 | from .node import hex |
|
22 | 22 | |
|
23 | 23 | from . import ( |
|
24 | 24 | config, |
|
25 | 25 | error, |
|
26 | 26 | formatter, |
|
27 | 27 | progress, |
|
28 | 28 | scmutil, |
|
29 | 29 | util, |
|
30 | 30 | ) |
|
31 | 31 | |
|
32 | 32 | samplehgrcs = { |
|
33 | 33 | 'user': |
|
34 | 34 | """# example user config (see "hg help config" for more info) |
|
35 | 35 | [ui] |
|
36 | 36 | # name and email, e.g. |
|
37 | 37 | # username = Jane Doe <jdoe@example.com> |
|
38 | 38 | username = |
|
39 | 39 | |
|
40 | 40 | [extensions] |
|
41 | 41 | # uncomment these lines to enable some popular extensions |
|
42 | 42 | # (see "hg help extensions" for more info) |
|
43 | 43 | # |
|
44 | 44 | # pager = |
|
45 | 45 | # color =""", |
|
46 | 46 | |
|
47 | 47 | 'cloned': |
|
48 | 48 | """# example repository config (see "hg help config" for more info) |
|
49 | 49 | [paths] |
|
50 | 50 | default = %s |
|
51 | 51 | |
|
52 | 52 | # path aliases to other clones of this repo in URLs or filesystem paths |
|
53 | 53 | # (see "hg help config.paths" for more info) |
|
54 | 54 | # |
|
55 | 55 | # default-push = ssh://jdoe@example.net/hg/jdoes-fork |
|
56 | 56 | # my-fork = ssh://jdoe@example.net/hg/jdoes-fork |
|
57 | 57 | # my-clone = /home/jdoe/jdoes-clone |
|
58 | 58 | |
|
59 | 59 | [ui] |
|
60 | 60 | # name and email (local to this repository, optional), e.g. |
|
61 | 61 | # username = Jane Doe <jdoe@example.com> |
|
62 | 62 | """, |
|
63 | 63 | |
|
64 | 64 | 'local': |
|
65 | 65 | """# example repository config (see "hg help config" for more info) |
|
66 | 66 | [paths] |
|
67 | 67 | # path aliases to other clones of this repo in URLs or filesystem paths |
|
68 | 68 | # (see "hg help config.paths" for more info) |
|
69 | 69 | # |
|
70 | 70 | # default = http://example.com/hg/example-repo |
|
71 | 71 | # default-push = ssh://jdoe@example.net/hg/jdoes-fork |
|
72 | 72 | # my-fork = ssh://jdoe@example.net/hg/jdoes-fork |
|
73 | 73 | # my-clone = /home/jdoe/jdoes-clone |
|
74 | 74 | |
|
75 | 75 | [ui] |
|
76 | 76 | # name and email (local to this repository, optional), e.g. |
|
77 | 77 | # username = Jane Doe <jdoe@example.com> |
|
78 | 78 | """, |
|
79 | 79 | |
|
80 | 80 | 'global': |
|
81 | 81 | """# example system-wide hg config (see "hg help config" for more info) |
|
82 | 82 | |
|
83 | 83 | [extensions] |
|
84 | 84 | # uncomment these lines to enable some popular extensions |
|
85 | 85 | # (see "hg help extensions" for more info) |
|
86 | 86 | # |
|
87 | 87 | # blackbox = |
|
88 | 88 | # color = |
|
89 | 89 | # pager =""", |
|
90 | 90 | } |
|
91 | 91 | |
|
92 | 92 | class ui(object): |
|
93 | 93 | def __init__(self, src=None): |
|
94 | 94 | # _buffers: used for temporary capture of output |
|
95 | 95 | self._buffers = [] |
|
96 | 96 | # 3-tuple describing how each buffer in the stack behaves. |
|
97 | 97 | # Values are (capture stderr, capture subprocesses, apply labels). |
|
98 | 98 | self._bufferstates = [] |
|
99 | 99 | # When a buffer is active, defines whether we are expanding labels. |
|
100 | 100 | # This exists to prevent an extra list lookup. |
|
101 | 101 | self._bufferapplylabels = None |
|
102 | 102 | self.quiet = self.verbose = self.debugflag = self.tracebackflag = False |
|
103 | 103 | self._reportuntrusted = True |
|
104 | 104 | self._ocfg = config.config() # overlay |
|
105 | 105 | self._tcfg = config.config() # trusted |
|
106 | 106 | self._ucfg = config.config() # untrusted |
|
107 | 107 | self._trustusers = set() |
|
108 | 108 | self._trustgroups = set() |
|
109 | 109 | self.callhooks = True |
|
110 | 110 | |
|
111 | 111 | if src: |
|
112 | 112 | self.fout = src.fout |
|
113 | 113 | self.ferr = src.ferr |
|
114 | 114 | self.fin = src.fin |
|
115 | 115 | |
|
116 | 116 | self._tcfg = src._tcfg.copy() |
|
117 | 117 | self._ucfg = src._ucfg.copy() |
|
118 | 118 | self._ocfg = src._ocfg.copy() |
|
119 | 119 | self._trustusers = src._trustusers.copy() |
|
120 | 120 | self._trustgroups = src._trustgroups.copy() |
|
121 | 121 | self.environ = src.environ |
|
122 | 122 | self.callhooks = src.callhooks |
|
123 | 123 | self.fixconfig() |
|
124 | 124 | else: |
|
125 | 125 | self.fout = sys.stdout |
|
126 | 126 | self.ferr = sys.stderr |
|
127 | 127 | self.fin = sys.stdin |
|
128 | 128 | |
|
129 | 129 | # shared read-only environment |
|
130 | 130 | self.environ = os.environ |
|
131 | 131 | # we always trust global config files |
|
132 | 132 | for f in scmutil.rcpath(): |
|
133 | 133 | self.readconfig(f, trust=True) |
|
134 | 134 | |
|
135 | 135 | def copy(self): |
|
136 | 136 | return self.__class__(self) |
|
137 | 137 | |
|
138 | 138 | def formatter(self, topic, opts): |
|
139 | 139 | return formatter.formatter(self, topic, opts) |
|
140 | 140 | |
|
141 | 141 | def _trusted(self, fp, f): |
|
142 | 142 | st = util.fstat(fp) |
|
143 | 143 | if util.isowner(st): |
|
144 | 144 | return True |
|
145 | 145 | |
|
146 | 146 | tusers, tgroups = self._trustusers, self._trustgroups |
|
147 | 147 | if '*' in tusers or '*' in tgroups: |
|
148 | 148 | return True |
|
149 | 149 | |
|
150 | 150 | user = util.username(st.st_uid) |
|
151 | 151 | group = util.groupname(st.st_gid) |
|
152 | 152 | if user in tusers or group in tgroups or user == util.username(): |
|
153 | 153 | return True |
|
154 | 154 | |
|
155 | 155 | if self._reportuntrusted: |
|
156 | 156 | self.warn(_('not trusting file %s from untrusted ' |
|
157 | 157 | 'user %s, group %s\n') % (f, user, group)) |
|
158 | 158 | return False |
|
159 | 159 | |
|
160 | 160 | def readconfig(self, filename, root=None, trust=False, |
|
161 | 161 | sections=None, remap=None): |
|
162 | 162 | try: |
|
163 | 163 | fp = open(filename) |
|
164 | 164 | except IOError: |
|
165 | 165 | if not sections: # ignore unless we were looking for something |
|
166 | 166 | return |
|
167 | 167 | raise |
|
168 | 168 | |
|
169 | 169 | cfg = config.config() |
|
170 | 170 | trusted = sections or trust or self._trusted(fp, filename) |
|
171 | 171 | |
|
172 | 172 | try: |
|
173 | 173 | cfg.read(filename, fp, sections=sections, remap=remap) |
|
174 | 174 | fp.close() |
|
175 | 175 | except error.ConfigError as inst: |
|
176 | 176 | if trusted: |
|
177 | 177 | raise |
|
178 | 178 | self.warn(_("ignored: %s\n") % str(inst)) |
|
179 | 179 | |
|
180 | 180 | if self.plain(): |
|
181 | 181 | for k in ('debug', 'fallbackencoding', 'quiet', 'slash', |
|
182 | 182 | 'logtemplate', 'statuscopies', 'style', |
|
183 | 183 | 'traceback', 'verbose'): |
|
184 | 184 | if k in cfg['ui']: |
|
185 | 185 | del cfg['ui'][k] |
|
186 | 186 | for k, v in cfg.items('defaults'): |
|
187 | 187 | del cfg['defaults'][k] |
|
188 | 188 | # Don't remove aliases from the configuration if in the exceptionlist |
|
189 | 189 | if self.plain('alias'): |
|
190 | 190 | for k, v in cfg.items('alias'): |
|
191 | 191 | del cfg['alias'][k] |
|
192 | 192 | if self.plain('revsetalias'): |
|
193 | 193 | for k, v in cfg.items('revsetalias'): |
|
194 | 194 | del cfg['revsetalias'][k] |
|
195 | 195 | |
|
196 | 196 | if trusted: |
|
197 | 197 | self._tcfg.update(cfg) |
|
198 | 198 | self._tcfg.update(self._ocfg) |
|
199 | 199 | self._ucfg.update(cfg) |
|
200 | 200 | self._ucfg.update(self._ocfg) |
|
201 | 201 | |
|
202 | 202 | if root is None: |
|
203 | 203 | root = os.path.expanduser('~') |
|
204 | 204 | self.fixconfig(root=root) |
|
205 | 205 | |
|
206 | 206 | def fixconfig(self, root=None, section=None): |
|
207 | 207 | if section in (None, 'paths'): |
|
208 | 208 | # expand vars and ~ |
|
209 | 209 | # translate paths relative to root (or home) into absolute paths |
|
210 | 210 | root = root or os.getcwd() |
|
211 | 211 | for c in self._tcfg, self._ucfg, self._ocfg: |
|
212 | 212 | for n, p in c.items('paths'): |
|
213 | 213 | if not p: |
|
214 | 214 | continue |
|
215 | 215 | if '%%' in p: |
|
216 | 216 | self.warn(_("(deprecated '%%' in path %s=%s from %s)\n") |
|
217 | 217 | % (n, p, self.configsource('paths', n))) |
|
218 | 218 | p = p.replace('%%', '%') |
|
219 | 219 | p = util.expandpath(p) |
|
220 | 220 | if not util.hasscheme(p) and not os.path.isabs(p): |
|
221 | 221 | p = os.path.normpath(os.path.join(root, p)) |
|
222 | 222 | c.set("paths", n, p) |
|
223 | 223 | |
|
224 | 224 | if section in (None, 'ui'): |
|
225 | 225 | # update ui options |
|
226 | 226 | self.debugflag = self.configbool('ui', 'debug') |
|
227 | 227 | self.verbose = self.debugflag or self.configbool('ui', 'verbose') |
|
228 | 228 | self.quiet = not self.debugflag and self.configbool('ui', 'quiet') |
|
229 | 229 | if self.verbose and self.quiet: |
|
230 | 230 | self.quiet = self.verbose = False |
|
231 | 231 | self._reportuntrusted = self.debugflag or self.configbool("ui", |
|
232 | 232 | "report_untrusted", True) |
|
233 | 233 | self.tracebackflag = self.configbool('ui', 'traceback', False) |
|
234 | 234 | |
|
235 | 235 | if section in (None, 'trusted'): |
|
236 | 236 | # update trust information |
|
237 | 237 | self._trustusers.update(self.configlist('trusted', 'users')) |
|
238 | 238 | self._trustgroups.update(self.configlist('trusted', 'groups')) |
|
239 | 239 | |
|
240 | 240 | def backupconfig(self, section, item): |
|
241 | 241 | return (self._ocfg.backup(section, item), |
|
242 | 242 | self._tcfg.backup(section, item), |
|
243 | 243 | self._ucfg.backup(section, item),) |
|
244 | 244 | def restoreconfig(self, data): |
|
245 | 245 | self._ocfg.restore(data[0]) |
|
246 | 246 | self._tcfg.restore(data[1]) |
|
247 | 247 | self._ucfg.restore(data[2]) |
|
248 | 248 | |
|
249 | 249 | def setconfig(self, section, name, value, source=''): |
|
250 | 250 | for cfg in (self._ocfg, self._tcfg, self._ucfg): |
|
251 | 251 | cfg.set(section, name, value, source) |
|
252 | 252 | self.fixconfig(section=section) |
|
253 | 253 | |
|
254 | 254 | def _data(self, untrusted): |
|
255 | 255 | return untrusted and self._ucfg or self._tcfg |
|
256 | 256 | |
|
257 | 257 | def configsource(self, section, name, untrusted=False): |
|
258 | 258 | return self._data(untrusted).source(section, name) or 'none' |
|
259 | 259 | |
|
260 | 260 | def config(self, section, name, default=None, untrusted=False): |
|
261 | 261 | if isinstance(name, list): |
|
262 | 262 | alternates = name |
|
263 | 263 | else: |
|
264 | 264 | alternates = [name] |
|
265 | 265 | |
|
266 | 266 | for n in alternates: |
|
267 | 267 | value = self._data(untrusted).get(section, n, None) |
|
268 | 268 | if value is not None: |
|
269 | 269 | name = n |
|
270 | 270 | break |
|
271 | 271 | else: |
|
272 | 272 | value = default |
|
273 | 273 | |
|
274 | 274 | if self.debugflag and not untrusted and self._reportuntrusted: |
|
275 | 275 | for n in alternates: |
|
276 | 276 | uvalue = self._ucfg.get(section, n) |
|
277 | 277 | if uvalue is not None and uvalue != value: |
|
278 | 278 | self.debug("ignoring untrusted configuration option " |
|
279 | 279 | "%s.%s = %s\n" % (section, n, uvalue)) |
|
280 | 280 | return value |
|
281 | 281 | |
|
282 | 282 | def configsuboptions(self, section, name, default=None, untrusted=False): |
|
283 | 283 | """Get a config option and all sub-options. |
|
284 | 284 | |
|
285 | 285 | Some config options have sub-options that are declared with the |
|
286 | 286 | format "key:opt = value". This method is used to return the main |
|
287 | 287 | option and all its declared sub-options. |
|
288 | 288 | |
|
289 | 289 | Returns a 2-tuple of ``(option, sub-options)``, where `sub-options`` |
|
290 | 290 | is a dict of defined sub-options where keys and values are strings. |
|
291 | 291 | """ |
|
292 | 292 | data = self._data(untrusted) |
|
293 | 293 | main = data.get(section, name, default) |
|
294 | 294 | if self.debugflag and not untrusted and self._reportuntrusted: |
|
295 | 295 | uvalue = self._ucfg.get(section, name) |
|
296 | 296 | if uvalue is not None and uvalue != main: |
|
297 | 297 | self.debug('ignoring untrusted configuration option ' |
|
298 | 298 | '%s.%s = %s\n' % (section, name, uvalue)) |
|
299 | 299 | |
|
300 | 300 | sub = {} |
|
301 | 301 | prefix = '%s:' % name |
|
302 | 302 | for k, v in data.items(section): |
|
303 | 303 | if k.startswith(prefix): |
|
304 | 304 | sub[k[len(prefix):]] = v |
|
305 | 305 | |
|
306 | 306 | if self.debugflag and not untrusted and self._reportuntrusted: |
|
307 | 307 | for k, v in sub.items(): |
|
308 | 308 | uvalue = self._ucfg.get(section, '%s:%s' % (name, k)) |
|
309 | 309 | if uvalue is not None and uvalue != v: |
|
310 | 310 | self.debug('ignoring untrusted configuration option ' |
|
311 | 311 | '%s:%s.%s = %s\n' % (section, name, k, uvalue)) |
|
312 | 312 | |
|
313 | 313 | return main, sub |
|
314 | 314 | |
|
315 | 315 | def configpath(self, section, name, default=None, untrusted=False): |
|
316 | 316 | 'get a path config item, expanded relative to repo root or config file' |
|
317 | 317 | v = self.config(section, name, default, untrusted) |
|
318 | 318 | if v is None: |
|
319 | 319 | return None |
|
320 | 320 | if not os.path.isabs(v) or "://" not in v: |
|
321 | 321 | src = self.configsource(section, name, untrusted) |
|
322 | 322 | if ':' in src: |
|
323 | 323 | base = os.path.dirname(src.rsplit(':')[0]) |
|
324 | 324 | v = os.path.join(base, os.path.expanduser(v)) |
|
325 | 325 | return v |
|
326 | 326 | |
|
327 | 327 | def configbool(self, section, name, default=False, untrusted=False): |
|
328 | 328 | """parse a configuration element as a boolean |
|
329 | 329 | |
|
330 | 330 | >>> u = ui(); s = 'foo' |
|
331 | 331 | >>> u.setconfig(s, 'true', 'yes') |
|
332 | 332 | >>> u.configbool(s, 'true') |
|
333 | 333 | True |
|
334 | 334 | >>> u.setconfig(s, 'false', 'no') |
|
335 | 335 | >>> u.configbool(s, 'false') |
|
336 | 336 | False |
|
337 | 337 | >>> u.configbool(s, 'unknown') |
|
338 | 338 | False |
|
339 | 339 | >>> u.configbool(s, 'unknown', True) |
|
340 | 340 | True |
|
341 | 341 | >>> u.setconfig(s, 'invalid', 'somevalue') |
|
342 | 342 | >>> u.configbool(s, 'invalid') |
|
343 | 343 | Traceback (most recent call last): |
|
344 | 344 | ... |
|
345 | 345 | ConfigError: foo.invalid is not a boolean ('somevalue') |
|
346 | 346 | """ |
|
347 | 347 | |
|
348 | 348 | v = self.config(section, name, None, untrusted) |
|
349 | 349 | if v is None: |
|
350 | 350 | return default |
|
351 | 351 | if isinstance(v, bool): |
|
352 | 352 | return v |
|
353 | 353 | b = util.parsebool(v) |
|
354 | 354 | if b is None: |
|
355 | 355 | raise error.ConfigError(_("%s.%s is not a boolean ('%s')") |
|
356 | 356 | % (section, name, v)) |
|
357 | 357 | return b |
|
358 | 358 | |
|
359 | 359 | def configint(self, section, name, default=None, untrusted=False): |
|
360 | 360 | """parse a configuration element as an integer |
|
361 | 361 | |
|
362 | 362 | >>> u = ui(); s = 'foo' |
|
363 | 363 | >>> u.setconfig(s, 'int1', '42') |
|
364 | 364 | >>> u.configint(s, 'int1') |
|
365 | 365 | 42 |
|
366 | 366 | >>> u.setconfig(s, 'int2', '-42') |
|
367 | 367 | >>> u.configint(s, 'int2') |
|
368 | 368 | -42 |
|
369 | 369 | >>> u.configint(s, 'unknown', 7) |
|
370 | 370 | 7 |
|
371 | 371 | >>> u.setconfig(s, 'invalid', 'somevalue') |
|
372 | 372 | >>> u.configint(s, 'invalid') |
|
373 | 373 | Traceback (most recent call last): |
|
374 | 374 | ... |
|
375 | 375 | ConfigError: foo.invalid is not an integer ('somevalue') |
|
376 | 376 | """ |
|
377 | 377 | |
|
378 | 378 | v = self.config(section, name, None, untrusted) |
|
379 | 379 | if v is None: |
|
380 | 380 | return default |
|
381 | 381 | try: |
|
382 | 382 | return int(v) |
|
383 | 383 | except ValueError: |
|
384 | 384 | raise error.ConfigError(_("%s.%s is not an integer ('%s')") |
|
385 | 385 | % (section, name, v)) |
|
386 | 386 | |
|
387 | 387 | def configbytes(self, section, name, default=0, untrusted=False): |
|
388 | 388 | """parse a configuration element as a quantity in bytes |
|
389 | 389 | |
|
390 | 390 | Units can be specified as b (bytes), k or kb (kilobytes), m or |
|
391 | 391 | mb (megabytes), g or gb (gigabytes). |
|
392 | 392 | |
|
393 | 393 | >>> u = ui(); s = 'foo' |
|
394 | 394 | >>> u.setconfig(s, 'val1', '42') |
|
395 | 395 | >>> u.configbytes(s, 'val1') |
|
396 | 396 | 42 |
|
397 | 397 | >>> u.setconfig(s, 'val2', '42.5 kb') |
|
398 | 398 | >>> u.configbytes(s, 'val2') |
|
399 | 399 | 43520 |
|
400 | 400 | >>> u.configbytes(s, 'unknown', '7 MB') |
|
401 | 401 | 7340032 |
|
402 | 402 | >>> u.setconfig(s, 'invalid', 'somevalue') |
|
403 | 403 | >>> u.configbytes(s, 'invalid') |
|
404 | 404 | Traceback (most recent call last): |
|
405 | 405 | ... |
|
406 | 406 | ConfigError: foo.invalid is not a byte quantity ('somevalue') |
|
407 | 407 | """ |
|
408 | 408 | |
|
409 | 409 | value = self.config(section, name) |
|
410 | 410 | if value is None: |
|
411 | 411 | if not isinstance(default, str): |
|
412 | 412 | return default |
|
413 | 413 | value = default |
|
414 | 414 | try: |
|
415 | 415 | return util.sizetoint(value) |
|
416 | 416 | except error.ParseError: |
|
417 | 417 | raise error.ConfigError(_("%s.%s is not a byte quantity ('%s')") |
|
418 | 418 | % (section, name, value)) |
|
419 | 419 | |
|
420 | 420 | def configlist(self, section, name, default=None, untrusted=False): |
|
421 | 421 | """parse a configuration element as a list of comma/space separated |
|
422 | 422 | strings |
|
423 | 423 | |
|
424 | 424 | >>> u = ui(); s = 'foo' |
|
425 | 425 | >>> u.setconfig(s, 'list1', 'this,is "a small" ,test') |
|
426 | 426 | >>> u.configlist(s, 'list1') |
|
427 | 427 | ['this', 'is', 'a small', 'test'] |
|
428 | 428 | """ |
|
429 | 429 | |
|
430 | 430 | def _parse_plain(parts, s, offset): |
|
431 | 431 | whitespace = False |
|
432 | 432 | while offset < len(s) and (s[offset].isspace() or s[offset] == ','): |
|
433 | 433 | whitespace = True |
|
434 | 434 | offset += 1 |
|
435 | 435 | if offset >= len(s): |
|
436 | 436 | return None, parts, offset |
|
437 | 437 | if whitespace: |
|
438 | 438 | parts.append('') |
|
439 | 439 | if s[offset] == '"' and not parts[-1]: |
|
440 | 440 | return _parse_quote, parts, offset + 1 |
|
441 | 441 | elif s[offset] == '"' and parts[-1][-1] == '\\': |
|
442 | 442 | parts[-1] = parts[-1][:-1] + s[offset] |
|
443 | 443 | return _parse_plain, parts, offset + 1 |
|
444 | 444 | parts[-1] += s[offset] |
|
445 | 445 | return _parse_plain, parts, offset + 1 |
|
446 | 446 | |
|
447 | 447 | def _parse_quote(parts, s, offset): |
|
448 | 448 | if offset < len(s) and s[offset] == '"': # "" |
|
449 | 449 | parts.append('') |
|
450 | 450 | offset += 1 |
|
451 | 451 | while offset < len(s) and (s[offset].isspace() or |
|
452 | 452 | s[offset] == ','): |
|
453 | 453 | offset += 1 |
|
454 | 454 | return _parse_plain, parts, offset |
|
455 | 455 | |
|
456 | 456 | while offset < len(s) and s[offset] != '"': |
|
457 | 457 | if (s[offset] == '\\' and offset + 1 < len(s) |
|
458 | 458 | and s[offset + 1] == '"'): |
|
459 | 459 | offset += 1 |
|
460 | 460 | parts[-1] += '"' |
|
461 | 461 | else: |
|
462 | 462 | parts[-1] += s[offset] |
|
463 | 463 | offset += 1 |
|
464 | 464 | |
|
465 | 465 | if offset >= len(s): |
|
466 | 466 | real_parts = _configlist(parts[-1]) |
|
467 | 467 | if not real_parts: |
|
468 | 468 | parts[-1] = '"' |
|
469 | 469 | else: |
|
470 | 470 | real_parts[0] = '"' + real_parts[0] |
|
471 | 471 | parts = parts[:-1] |
|
472 | 472 | parts.extend(real_parts) |
|
473 | 473 | return None, parts, offset |
|
474 | 474 | |
|
475 | 475 | offset += 1 |
|
476 | 476 | while offset < len(s) and s[offset] in [' ', ',']: |
|
477 | 477 | offset += 1 |
|
478 | 478 | |
|
479 | 479 | if offset < len(s): |
|
480 | 480 | if offset + 1 == len(s) and s[offset] == '"': |
|
481 | 481 | parts[-1] += '"' |
|
482 | 482 | offset += 1 |
|
483 | 483 | else: |
|
484 | 484 | parts.append('') |
|
485 | 485 | else: |
|
486 | 486 | return None, parts, offset |
|
487 | 487 | |
|
488 | 488 | return _parse_plain, parts, offset |
|
489 | 489 | |
|
490 | 490 | def _configlist(s): |
|
491 | 491 | s = s.rstrip(' ,') |
|
492 | 492 | if not s: |
|
493 | 493 | return [] |
|
494 | 494 | parser, parts, offset = _parse_plain, [''], 0 |
|
495 | 495 | while parser: |
|
496 | 496 | parser, parts, offset = parser(parts, s, offset) |
|
497 | 497 | return parts |
|
498 | 498 | |
|
499 | 499 | result = self.config(section, name, untrusted=untrusted) |
|
500 | 500 | if result is None: |
|
501 | 501 | result = default or [] |
|
502 | 502 | if isinstance(result, basestring): |
|
503 | 503 | result = _configlist(result.lstrip(' ,\n')) |
|
504 | 504 | if result is None: |
|
505 | 505 | result = default or [] |
|
506 | 506 | return result |
|
507 | 507 | |
|
508 | 508 | def hasconfig(self, section, name, untrusted=False): |
|
509 | 509 | return self._data(untrusted).hasitem(section, name) |
|
510 | 510 | |
|
511 | 511 | def has_section(self, section, untrusted=False): |
|
512 | 512 | '''tell whether section exists in config.''' |
|
513 | 513 | return section in self._data(untrusted) |
|
514 | 514 | |
|
515 | 515 | def configitems(self, section, untrusted=False, ignoresub=False): |
|
516 | 516 | items = self._data(untrusted).items(section) |
|
517 | 517 | if ignoresub: |
|
518 | 518 | newitems = {} |
|
519 | 519 | for k, v in items: |
|
520 | 520 | if ':' not in k: |
|
521 | 521 | newitems[k] = v |
|
522 | 522 | items = newitems.items() |
|
523 | 523 | if self.debugflag and not untrusted and self._reportuntrusted: |
|
524 | 524 | for k, v in self._ucfg.items(section): |
|
525 | 525 | if self._tcfg.get(section, k) != v: |
|
526 | 526 | self.debug("ignoring untrusted configuration option " |
|
527 | 527 | "%s.%s = %s\n" % (section, k, v)) |
|
528 | 528 | return items |
|
529 | 529 | |
|
530 | 530 | def walkconfig(self, untrusted=False): |
|
531 | 531 | cfg = self._data(untrusted) |
|
532 | 532 | for section in cfg.sections(): |
|
533 | 533 | for name, value in self.configitems(section, untrusted): |
|
534 | 534 | yield section, name, value |
|
535 | 535 | |
|
536 | 536 | def plain(self, feature=None): |
|
537 | 537 | '''is plain mode active? |
|
538 | 538 | |
|
539 | 539 | Plain mode means that all configuration variables which affect |
|
540 | 540 | the behavior and output of Mercurial should be |
|
541 | 541 | ignored. Additionally, the output should be stable, |
|
542 | 542 | reproducible and suitable for use in scripts or applications. |
|
543 | 543 | |
|
544 | 544 | The only way to trigger plain mode is by setting either the |
|
545 | 545 | `HGPLAIN' or `HGPLAINEXCEPT' environment variables. |
|
546 | 546 | |
|
547 | 547 | The return value can either be |
|
548 | 548 | - False if HGPLAIN is not set, or feature is in HGPLAINEXCEPT |
|
549 | 549 | - True otherwise |
|
550 | 550 | ''' |
|
551 | 551 | if 'HGPLAIN' not in os.environ and 'HGPLAINEXCEPT' not in os.environ: |
|
552 | 552 | return False |
|
553 | 553 | exceptions = os.environ.get('HGPLAINEXCEPT', '').strip().split(',') |
|
554 | 554 | if feature and exceptions: |
|
555 | 555 | return feature not in exceptions |
|
556 | 556 | return True |
|
557 | 557 | |
|
558 | 558 | def username(self): |
|
559 | 559 | """Return default username to be used in commits. |
|
560 | 560 | |
|
561 | 561 | Searched in this order: $HGUSER, [ui] section of hgrcs, $EMAIL |
|
562 | 562 | and stop searching if one of these is set. |
|
563 | 563 | If not found and ui.askusername is True, ask the user, else use |
|
564 | 564 | ($LOGNAME or $USER or $LNAME or $USERNAME) + "@full.hostname". |
|
565 | 565 | """ |
|
566 | 566 | user = os.environ.get("HGUSER") |
|
567 | 567 | if user is None: |
|
568 | 568 | user = self.config("ui", ["username", "user"]) |
|
569 | 569 | if user is not None: |
|
570 | 570 | user = os.path.expandvars(user) |
|
571 | 571 | if user is None: |
|
572 | 572 | user = os.environ.get("EMAIL") |
|
573 | 573 | if user is None and self.configbool("ui", "askusername"): |
|
574 | 574 | user = self.prompt(_("enter a commit username:"), default=None) |
|
575 | 575 | if user is None and not self.interactive(): |
|
576 | 576 | try: |
|
577 | 577 | user = '%s@%s' % (util.getuser(), socket.getfqdn()) |
|
578 | 578 | self.warn(_("no username found, using '%s' instead\n") % user) |
|
579 | 579 | except KeyError: |
|
580 | 580 | pass |
|
581 | 581 | if not user: |
|
582 | 582 | raise error.Abort(_('no username supplied'), |
|
583 | 583 | hint=_('use "hg config --edit" ' |
|
584 | 584 | 'to set your username')) |
|
585 | 585 | if "\n" in user: |
|
586 | 586 | raise error.Abort(_("username %s contains a newline\n") |
|
587 | 587 | % repr(user)) |
|
588 | 588 | return user |
|
589 | 589 | |
|
590 | 590 | def shortuser(self, user): |
|
591 | 591 | """Return a short representation of a user name or email address.""" |
|
592 | 592 | if not self.verbose: |
|
593 | 593 | user = util.shortuser(user) |
|
594 | 594 | return user |
|
595 | 595 | |
|
596 | 596 | def expandpath(self, loc, default=None): |
|
597 | 597 | """Return repository location relative to cwd or from [paths]""" |
|
598 | 598 | try: |
|
599 | 599 | p = self.paths.getpath(loc) |
|
600 | 600 | if p: |
|
601 | 601 | return p.rawloc |
|
602 | 602 | except error.RepoError: |
|
603 | 603 | pass |
|
604 | 604 | |
|
605 | 605 | if default: |
|
606 | 606 | try: |
|
607 | 607 | p = self.paths.getpath(default) |
|
608 | 608 | if p: |
|
609 | 609 | return p.rawloc |
|
610 | 610 | except error.RepoError: |
|
611 | 611 | pass |
|
612 | 612 | |
|
613 | 613 | return loc |
|
614 | 614 | |
|
615 | 615 | @util.propertycache |
|
616 | 616 | def paths(self): |
|
617 | 617 | return paths(self) |
|
618 | 618 | |
|
619 | 619 | def pushbuffer(self, error=False, subproc=False, labeled=False): |
|
620 | 620 | """install a buffer to capture standard output of the ui object |
|
621 | 621 | |
|
622 | 622 | If error is True, the error output will be captured too. |
|
623 | 623 | |
|
624 | 624 | If subproc is True, output from subprocesses (typically hooks) will be |
|
625 | 625 | captured too. |
|
626 | 626 | |
|
627 | 627 | If labeled is True, any labels associated with buffered |
|
628 | 628 | output will be handled. By default, this has no effect |
|
629 | 629 | on the output returned, but extensions and GUI tools may |
|
630 | 630 | handle this argument and returned styled output. If output |
|
631 | 631 | is being buffered so it can be captured and parsed or |
|
632 | 632 | processed, labeled should not be set to True. |
|
633 | 633 | """ |
|
634 | 634 | self._buffers.append([]) |
|
635 | 635 | self._bufferstates.append((error, subproc, labeled)) |
|
636 | 636 | self._bufferapplylabels = labeled |
|
637 | 637 | |
|
638 | 638 | def popbuffer(self): |
|
639 | 639 | '''pop the last buffer and return the buffered output''' |
|
640 | 640 | self._bufferstates.pop() |
|
641 | 641 | if self._bufferstates: |
|
642 | 642 | self._bufferapplylabels = self._bufferstates[-1][2] |
|
643 | 643 | else: |
|
644 | 644 | self._bufferapplylabels = None |
|
645 | 645 | |
|
646 | 646 | return "".join(self._buffers.pop()) |
|
647 | 647 | |
|
648 | 648 | def write(self, *args, **opts): |
|
649 | 649 | '''write args to output |
|
650 | 650 | |
|
651 | 651 | By default, this method simply writes to the buffer or stdout, |
|
652 | 652 | but extensions or GUI tools may override this method, |
|
653 | 653 | write_err(), popbuffer(), and label() to style output from |
|
654 | 654 | various parts of hg. |
|
655 | 655 | |
|
656 | 656 | An optional keyword argument, "label", can be passed in. |
|
657 | 657 | This should be a string containing label names separated by |
|
658 | 658 | space. Label names take the form of "topic.type". For example, |
|
659 | 659 | ui.debug() issues a label of "ui.debug". |
|
660 | 660 | |
|
661 | 661 | When labeling output for a specific command, a label of |
|
662 | 662 | "cmdname.type" is recommended. For example, status issues |
|
663 | 663 | a label of "status.modified" for modified files. |
|
664 | 664 | ''' |
|
665 | 665 | if self._buffers: |
|
666 | 666 | self._buffers[-1].extend(a for a in args) |
|
667 | 667 | else: |
|
668 | 668 | self._progclear() |
|
669 | 669 | for a in args: |
|
670 | 670 | self.fout.write(a) |
|
671 | 671 | |
|
672 | 672 | def write_err(self, *args, **opts): |
|
673 | 673 | self._progclear() |
|
674 | 674 | try: |
|
675 | 675 | if self._bufferstates and self._bufferstates[-1][0]: |
|
676 | 676 | return self.write(*args, **opts) |
|
677 | 677 | if not getattr(self.fout, 'closed', False): |
|
678 | 678 | self.fout.flush() |
|
679 | 679 | for a in args: |
|
680 | 680 | self.ferr.write(a) |
|
681 | 681 | # stderr may be buffered under win32 when redirected to files, |
|
682 | 682 | # including stdout. |
|
683 | 683 | if not getattr(self.ferr, 'closed', False): |
|
684 | 684 | self.ferr.flush() |
|
685 | 685 | except IOError as inst: |
|
686 | 686 | if inst.errno not in (errno.EPIPE, errno.EIO, errno.EBADF): |
|
687 | 687 | raise |
|
688 | 688 | |
|
689 | 689 | def flush(self): |
|
690 | 690 | try: self.fout.flush() |
|
691 | 691 | except (IOError, ValueError): pass |
|
692 | 692 | try: self.ferr.flush() |
|
693 | 693 | except (IOError, ValueError): pass |
|
694 | 694 | |
|
695 | 695 | def _isatty(self, fh): |
|
696 | 696 | if self.configbool('ui', 'nontty', False): |
|
697 | 697 | return False |
|
698 | 698 | return util.isatty(fh) |
|
699 | 699 | |
|
700 | def interface(self, feature): | |
|
701 | """what interface to use for interactive console features? | |
|
702 | ||
|
703 | The interface is controlled by the value of `ui.interface` but also by | |
|
704 | the value of feature-specific configuration. For example: | |
|
705 | ||
|
706 | ui.interface.histedit = text | |
|
707 | ui.interface.chunkselector = curses | |
|
708 | ||
|
709 | Here the features are "histedit" and "chunkselector". | |
|
710 | ||
|
711 | The configuration above means that the default interfaces for commands | |
|
712 | is curses, the interface for histedit is text and the interface for | |
|
713 | selecting chunk is crecord (the best curses interface available). | |
|
714 | ||
|
715 | Consider the following exemple: | |
|
716 | ui.interface = curses | |
|
717 | ui.interface.histedit = text | |
|
718 | ||
|
719 | Then histedit will use the text interface and chunkselector will use | |
|
720 | the default curses interface (crecord at the moment). | |
|
721 | """ | |
|
722 | alldefaults = frozenset(["text", "curses"]) | |
|
723 | ||
|
724 | featureinterfaces = { | |
|
725 | "chunkselector": [ | |
|
726 | "text", | |
|
727 | "curses", | |
|
728 | ] | |
|
729 | } | |
|
730 | ||
|
731 | # Feature-specific interface | |
|
732 | if feature not in featureinterfaces.keys(): | |
|
733 | # Programming error, not user error | |
|
734 | raise ValueError("Unknown feature requested %s" % feature) | |
|
735 | ||
|
736 | availableinterfaces = frozenset(featureinterfaces[feature]) | |
|
737 | if alldefaults > availableinterfaces: | |
|
738 | # Programming error, not user error. We need a use case to | |
|
739 | # define the right thing to do here. | |
|
740 | raise ValueError( | |
|
741 | "Feature %s does not handle all default interfaces" % | |
|
742 | feature) | |
|
743 | ||
|
744 | if self.plain(): | |
|
745 | return "text" | |
|
746 | ||
|
747 | # Default interface for all the features | |
|
748 | defaultinterface = "text" | |
|
749 | i = self.config("ui", "interface", None) | |
|
750 | if i in alldefaults: | |
|
751 | defaultinterface = i | |
|
752 | ||
|
753 | choseninterface = defaultinterface | |
|
754 | f = self.config("ui", "interface.%s" % feature, None) | |
|
755 | if f in availableinterfaces: | |
|
756 | choseninterface = f | |
|
757 | ||
|
758 | if i is not None and defaultinterface != i: | |
|
759 | if f is not None: | |
|
760 | self.warn(_("invalid value for ui.interface: %s\n") % | |
|
761 | (i,)) | |
|
762 | else: | |
|
763 | self.warn(_("invalid value for ui.interface: %s (using %s)\n") % | |
|
764 | (i, choseninterface)) | |
|
765 | if f is not None and choseninterface != f: | |
|
766 | self.warn(_("invalid value for ui.interface.%s: %s (using %s)\n") % | |
|
767 | (feature, f, choseninterface)) | |
|
768 | ||
|
769 | return choseninterface | |
|
770 | ||
|
700 | 771 | def interactive(self): |
|
701 | 772 | '''is interactive input allowed? |
|
702 | 773 | |
|
703 | 774 | An interactive session is a session where input can be reasonably read |
|
704 | 775 | from `sys.stdin'. If this function returns false, any attempt to read |
|
705 | 776 | from stdin should fail with an error, unless a sensible default has been |
|
706 | 777 | specified. |
|
707 | 778 | |
|
708 | 779 | Interactiveness is triggered by the value of the `ui.interactive' |
|
709 | 780 | configuration variable or - if it is unset - when `sys.stdin' points |
|
710 | 781 | to a terminal device. |
|
711 | 782 | |
|
712 | 783 | This function refers to input only; for output, see `ui.formatted()'. |
|
713 | 784 | ''' |
|
714 | 785 | i = self.configbool("ui", "interactive", None) |
|
715 | 786 | if i is None: |
|
716 | 787 | # some environments replace stdin without implementing isatty |
|
717 | 788 | # usually those are non-interactive |
|
718 | 789 | return self._isatty(self.fin) |
|
719 | 790 | |
|
720 | 791 | return i |
|
721 | 792 | |
|
722 | 793 | def termwidth(self): |
|
723 | 794 | '''how wide is the terminal in columns? |
|
724 | 795 | ''' |
|
725 | 796 | if 'COLUMNS' in os.environ: |
|
726 | 797 | try: |
|
727 | 798 | return int(os.environ['COLUMNS']) |
|
728 | 799 | except ValueError: |
|
729 | 800 | pass |
|
730 | 801 | return util.termwidth() |
|
731 | 802 | |
|
732 | 803 | def formatted(self): |
|
733 | 804 | '''should formatted output be used? |
|
734 | 805 | |
|
735 | 806 | It is often desirable to format the output to suite the output medium. |
|
736 | 807 | Examples of this are truncating long lines or colorizing messages. |
|
737 | 808 | However, this is not often not desirable when piping output into other |
|
738 | 809 | utilities, e.g. `grep'. |
|
739 | 810 | |
|
740 | 811 | Formatted output is triggered by the value of the `ui.formatted' |
|
741 | 812 | configuration variable or - if it is unset - when `sys.stdout' points |
|
742 | 813 | to a terminal device. Please note that `ui.formatted' should be |
|
743 | 814 | considered an implementation detail; it is not intended for use outside |
|
744 | 815 | Mercurial or its extensions. |
|
745 | 816 | |
|
746 | 817 | This function refers to output only; for input, see `ui.interactive()'. |
|
747 | 818 | This function always returns false when in plain mode, see `ui.plain()'. |
|
748 | 819 | ''' |
|
749 | 820 | if self.plain(): |
|
750 | 821 | return False |
|
751 | 822 | |
|
752 | 823 | i = self.configbool("ui", "formatted", None) |
|
753 | 824 | if i is None: |
|
754 | 825 | # some environments replace stdout without implementing isatty |
|
755 | 826 | # usually those are non-interactive |
|
756 | 827 | return self._isatty(self.fout) |
|
757 | 828 | |
|
758 | 829 | return i |
|
759 | 830 | |
|
760 | 831 | def _readline(self, prompt=''): |
|
761 | 832 | if self._isatty(self.fin): |
|
762 | 833 | try: |
|
763 | 834 | # magically add command line editing support, where |
|
764 | 835 | # available |
|
765 | 836 | import readline |
|
766 | 837 | # force demandimport to really load the module |
|
767 | 838 | readline.read_history_file |
|
768 | 839 | # windows sometimes raises something other than ImportError |
|
769 | 840 | except Exception: |
|
770 | 841 | pass |
|
771 | 842 | |
|
772 | 843 | # call write() so output goes through subclassed implementation |
|
773 | 844 | # e.g. color extension on Windows |
|
774 | 845 | self.write(prompt) |
|
775 | 846 | |
|
776 | 847 | # instead of trying to emulate raw_input, swap (self.fin, |
|
777 | 848 | # self.fout) with (sys.stdin, sys.stdout) |
|
778 | 849 | oldin = sys.stdin |
|
779 | 850 | oldout = sys.stdout |
|
780 | 851 | sys.stdin = self.fin |
|
781 | 852 | sys.stdout = self.fout |
|
782 | 853 | # prompt ' ' must exist; otherwise readline may delete entire line |
|
783 | 854 | # - http://bugs.python.org/issue12833 |
|
784 | 855 | line = raw_input(' ') |
|
785 | 856 | sys.stdin = oldin |
|
786 | 857 | sys.stdout = oldout |
|
787 | 858 | |
|
788 | 859 | # When stdin is in binary mode on Windows, it can cause |
|
789 | 860 | # raw_input() to emit an extra trailing carriage return |
|
790 | 861 | if os.linesep == '\r\n' and line and line[-1] == '\r': |
|
791 | 862 | line = line[:-1] |
|
792 | 863 | return line |
|
793 | 864 | |
|
794 | 865 | def prompt(self, msg, default="y"): |
|
795 | 866 | """Prompt user with msg, read response. |
|
796 | 867 | If ui is not interactive, the default is returned. |
|
797 | 868 | """ |
|
798 | 869 | if not self.interactive(): |
|
799 | 870 | self.write(msg, ' ', default or '', "\n") |
|
800 | 871 | return default |
|
801 | 872 | try: |
|
802 | 873 | r = self._readline(self.label(msg, 'ui.prompt')) |
|
803 | 874 | if not r: |
|
804 | 875 | r = default |
|
805 | 876 | if self.configbool('ui', 'promptecho'): |
|
806 | 877 | self.write(r, "\n") |
|
807 | 878 | return r |
|
808 | 879 | except EOFError: |
|
809 | 880 | raise error.ResponseExpected() |
|
810 | 881 | |
|
811 | 882 | @staticmethod |
|
812 | 883 | def extractchoices(prompt): |
|
813 | 884 | """Extract prompt message and list of choices from specified prompt. |
|
814 | 885 | |
|
815 | 886 | This returns tuple "(message, choices)", and "choices" is the |
|
816 | 887 | list of tuple "(response character, text without &)". |
|
817 | 888 | |
|
818 | 889 | >>> ui.extractchoices("awake? $$ &Yes $$ &No") |
|
819 | 890 | ('awake? ', [('y', 'Yes'), ('n', 'No')]) |
|
820 | 891 | >>> ui.extractchoices("line\\nbreak? $$ &Yes $$ &No") |
|
821 | 892 | ('line\\nbreak? ', [('y', 'Yes'), ('n', 'No')]) |
|
822 | 893 | >>> ui.extractchoices("want lots of $$money$$?$$Ye&s$$N&o") |
|
823 | 894 | ('want lots of $$money$$?', [('s', 'Yes'), ('o', 'No')]) |
|
824 | 895 | """ |
|
825 | 896 | |
|
826 | 897 | # Sadly, the prompt string may have been built with a filename |
|
827 | 898 | # containing "$$" so let's try to find the first valid-looking |
|
828 | 899 | # prompt to start parsing. Sadly, we also can't rely on |
|
829 | 900 | # choices containing spaces, ASCII, or basically anything |
|
830 | 901 | # except an ampersand followed by a character. |
|
831 | 902 | m = re.match(r'(?s)(.+?)\$\$([^\$]*&[^ \$].*)', prompt) |
|
832 | 903 | msg = m.group(1) |
|
833 | 904 | choices = [p.strip(' ') for p in m.group(2).split('$$')] |
|
834 | 905 | return (msg, |
|
835 | 906 | [(s[s.index('&') + 1].lower(), s.replace('&', '', 1)) |
|
836 | 907 | for s in choices]) |
|
837 | 908 | |
|
838 | 909 | def promptchoice(self, prompt, default=0): |
|
839 | 910 | """Prompt user with a message, read response, and ensure it matches |
|
840 | 911 | one of the provided choices. The prompt is formatted as follows: |
|
841 | 912 | |
|
842 | 913 | "would you like fries with that (Yn)? $$ &Yes $$ &No" |
|
843 | 914 | |
|
844 | 915 | The index of the choice is returned. Responses are case |
|
845 | 916 | insensitive. If ui is not interactive, the default is |
|
846 | 917 | returned. |
|
847 | 918 | """ |
|
848 | 919 | |
|
849 | 920 | msg, choices = self.extractchoices(prompt) |
|
850 | 921 | resps = [r for r, t in choices] |
|
851 | 922 | while True: |
|
852 | 923 | r = self.prompt(msg, resps[default]) |
|
853 | 924 | if r.lower() in resps: |
|
854 | 925 | return resps.index(r.lower()) |
|
855 | 926 | self.write(_("unrecognized response\n")) |
|
856 | 927 | |
|
857 | 928 | def getpass(self, prompt=None, default=None): |
|
858 | 929 | if not self.interactive(): |
|
859 | 930 | return default |
|
860 | 931 | try: |
|
861 | 932 | self.write_err(self.label(prompt or _('password: '), 'ui.prompt')) |
|
862 | 933 | # disable getpass() only if explicitly specified. it's still valid |
|
863 | 934 | # to interact with tty even if fin is not a tty. |
|
864 | 935 | if self.configbool('ui', 'nontty'): |
|
865 | 936 | return self.fin.readline().rstrip('\n') |
|
866 | 937 | else: |
|
867 | 938 | return getpass.getpass('') |
|
868 | 939 | except EOFError: |
|
869 | 940 | raise error.ResponseExpected() |
|
870 | 941 | def status(self, *msg, **opts): |
|
871 | 942 | '''write status message to output (if ui.quiet is False) |
|
872 | 943 | |
|
873 | 944 | This adds an output label of "ui.status". |
|
874 | 945 | ''' |
|
875 | 946 | if not self.quiet: |
|
876 | 947 | opts['label'] = opts.get('label', '') + ' ui.status' |
|
877 | 948 | self.write(*msg, **opts) |
|
878 | 949 | def warn(self, *msg, **opts): |
|
879 | 950 | '''write warning message to output (stderr) |
|
880 | 951 | |
|
881 | 952 | This adds an output label of "ui.warning". |
|
882 | 953 | ''' |
|
883 | 954 | opts['label'] = opts.get('label', '') + ' ui.warning' |
|
884 | 955 | self.write_err(*msg, **opts) |
|
885 | 956 | def note(self, *msg, **opts): |
|
886 | 957 | '''write note to output (if ui.verbose is True) |
|
887 | 958 | |
|
888 | 959 | This adds an output label of "ui.note". |
|
889 | 960 | ''' |
|
890 | 961 | if self.verbose: |
|
891 | 962 | opts['label'] = opts.get('label', '') + ' ui.note' |
|
892 | 963 | self.write(*msg, **opts) |
|
893 | 964 | def debug(self, *msg, **opts): |
|
894 | 965 | '''write debug message to output (if ui.debugflag is True) |
|
895 | 966 | |
|
896 | 967 | This adds an output label of "ui.debug". |
|
897 | 968 | ''' |
|
898 | 969 | if self.debugflag: |
|
899 | 970 | opts['label'] = opts.get('label', '') + ' ui.debug' |
|
900 | 971 | self.write(*msg, **opts) |
|
901 | 972 | |
|
902 | 973 | def edit(self, text, user, extra=None, editform=None, pending=None): |
|
903 | 974 | extra_defaults = { 'prefix': 'editor' } |
|
904 | 975 | if extra is not None: |
|
905 | 976 | extra_defaults.update(extra) |
|
906 | 977 | extra = extra_defaults |
|
907 | 978 | (fd, name) = tempfile.mkstemp(prefix='hg-' + extra['prefix'] + '-', |
|
908 | 979 | suffix=".txt", text=True) |
|
909 | 980 | try: |
|
910 | 981 | f = os.fdopen(fd, "w") |
|
911 | 982 | f.write(text) |
|
912 | 983 | f.close() |
|
913 | 984 | |
|
914 | 985 | environ = {'HGUSER': user} |
|
915 | 986 | if 'transplant_source' in extra: |
|
916 | 987 | environ.update({'HGREVISION': hex(extra['transplant_source'])}) |
|
917 | 988 | for label in ('intermediate-source', 'source', 'rebase_source'): |
|
918 | 989 | if label in extra: |
|
919 | 990 | environ.update({'HGREVISION': extra[label]}) |
|
920 | 991 | break |
|
921 | 992 | if editform: |
|
922 | 993 | environ.update({'HGEDITFORM': editform}) |
|
923 | 994 | if pending: |
|
924 | 995 | environ.update({'HG_PENDING': pending}) |
|
925 | 996 | |
|
926 | 997 | editor = self.geteditor() |
|
927 | 998 | |
|
928 | 999 | self.system("%s \"%s\"" % (editor, name), |
|
929 | 1000 | environ=environ, |
|
930 | 1001 | onerr=error.Abort, errprefix=_("edit failed")) |
|
931 | 1002 | |
|
932 | 1003 | f = open(name) |
|
933 | 1004 | t = f.read() |
|
934 | 1005 | f.close() |
|
935 | 1006 | finally: |
|
936 | 1007 | os.unlink(name) |
|
937 | 1008 | |
|
938 | 1009 | return t |
|
939 | 1010 | |
|
940 | 1011 | def system(self, cmd, environ=None, cwd=None, onerr=None, errprefix=None): |
|
941 | 1012 | '''execute shell command with appropriate output stream. command |
|
942 | 1013 | output will be redirected if fout is not stdout. |
|
943 | 1014 | ''' |
|
944 | 1015 | out = self.fout |
|
945 | 1016 | if any(s[1] for s in self._bufferstates): |
|
946 | 1017 | out = self |
|
947 | 1018 | return util.system(cmd, environ=environ, cwd=cwd, onerr=onerr, |
|
948 | 1019 | errprefix=errprefix, out=out) |
|
949 | 1020 | |
|
950 | 1021 | def traceback(self, exc=None, force=False): |
|
951 | 1022 | '''print exception traceback if traceback printing enabled or forced. |
|
952 | 1023 | only to call in exception handler. returns true if traceback |
|
953 | 1024 | printed.''' |
|
954 | 1025 | if self.tracebackflag or force: |
|
955 | 1026 | if exc is None: |
|
956 | 1027 | exc = sys.exc_info() |
|
957 | 1028 | cause = getattr(exc[1], 'cause', None) |
|
958 | 1029 | |
|
959 | 1030 | if cause is not None: |
|
960 | 1031 | causetb = traceback.format_tb(cause[2]) |
|
961 | 1032 | exctb = traceback.format_tb(exc[2]) |
|
962 | 1033 | exconly = traceback.format_exception_only(cause[0], cause[1]) |
|
963 | 1034 | |
|
964 | 1035 | # exclude frame where 'exc' was chained and rethrown from exctb |
|
965 | 1036 | self.write_err('Traceback (most recent call last):\n', |
|
966 | 1037 | ''.join(exctb[:-1]), |
|
967 | 1038 | ''.join(causetb), |
|
968 | 1039 | ''.join(exconly)) |
|
969 | 1040 | else: |
|
970 | 1041 | output = traceback.format_exception(exc[0], exc[1], exc[2]) |
|
971 | 1042 | self.write_err(''.join(output)) |
|
972 | 1043 | return self.tracebackflag or force |
|
973 | 1044 | |
|
974 | 1045 | def geteditor(self): |
|
975 | 1046 | '''return editor to use''' |
|
976 | 1047 | if sys.platform == 'plan9': |
|
977 | 1048 | # vi is the MIPS instruction simulator on Plan 9. We |
|
978 | 1049 | # instead default to E to plumb commit messages to |
|
979 | 1050 | # avoid confusion. |
|
980 | 1051 | editor = 'E' |
|
981 | 1052 | else: |
|
982 | 1053 | editor = 'vi' |
|
983 | 1054 | return (os.environ.get("HGEDITOR") or |
|
984 | 1055 | self.config("ui", "editor") or |
|
985 | 1056 | os.environ.get("VISUAL") or |
|
986 | 1057 | os.environ.get("EDITOR", editor)) |
|
987 | 1058 | |
|
988 | 1059 | @util.propertycache |
|
989 | 1060 | def _progbar(self): |
|
990 | 1061 | """setup the progbar singleton to the ui object""" |
|
991 | 1062 | if (self.quiet or self.debugflag |
|
992 | 1063 | or self.configbool('progress', 'disable', False) |
|
993 | 1064 | or not progress.shouldprint(self)): |
|
994 | 1065 | return None |
|
995 | 1066 | return getprogbar(self) |
|
996 | 1067 | |
|
997 | 1068 | def _progclear(self): |
|
998 | 1069 | """clear progress bar output if any. use it before any output""" |
|
999 | 1070 | if '_progbar' not in vars(self): # nothing loaded yet |
|
1000 | 1071 | return |
|
1001 | 1072 | if self._progbar is not None and self._progbar.printed: |
|
1002 | 1073 | self._progbar.clear() |
|
1003 | 1074 | |
|
1004 | 1075 | def progress(self, topic, pos, item="", unit="", total=None): |
|
1005 | 1076 | '''show a progress message |
|
1006 | 1077 | |
|
1007 | 1078 | With stock hg, this is simply a debug message that is hidden |
|
1008 | 1079 | by default, but with extensions or GUI tools it may be |
|
1009 | 1080 | visible. 'topic' is the current operation, 'item' is a |
|
1010 | 1081 | non-numeric marker of the current position (i.e. the currently |
|
1011 | 1082 | in-process file), 'pos' is the current numeric position (i.e. |
|
1012 | 1083 | revision, bytes, etc.), unit is a corresponding unit label, |
|
1013 | 1084 | and total is the highest expected pos. |
|
1014 | 1085 | |
|
1015 | 1086 | Multiple nested topics may be active at a time. |
|
1016 | 1087 | |
|
1017 | 1088 | All topics should be marked closed by setting pos to None at |
|
1018 | 1089 | termination. |
|
1019 | 1090 | ''' |
|
1020 | 1091 | if self._progbar is not None: |
|
1021 | 1092 | self._progbar.progress(topic, pos, item=item, unit=unit, |
|
1022 | 1093 | total=total) |
|
1023 | 1094 | if pos is None or not self.configbool('progress', 'debug'): |
|
1024 | 1095 | return |
|
1025 | 1096 | |
|
1026 | 1097 | if unit: |
|
1027 | 1098 | unit = ' ' + unit |
|
1028 | 1099 | if item: |
|
1029 | 1100 | item = ' ' + item |
|
1030 | 1101 | |
|
1031 | 1102 | if total: |
|
1032 | 1103 | pct = 100.0 * pos / total |
|
1033 | 1104 | self.debug('%s:%s %s/%s%s (%4.2f%%)\n' |
|
1034 | 1105 | % (topic, item, pos, total, unit, pct)) |
|
1035 | 1106 | else: |
|
1036 | 1107 | self.debug('%s:%s %s%s\n' % (topic, item, pos, unit)) |
|
1037 | 1108 | |
|
1038 | 1109 | def log(self, service, *msg, **opts): |
|
1039 | 1110 | '''hook for logging facility extensions |
|
1040 | 1111 | |
|
1041 | 1112 | service should be a readily-identifiable subsystem, which will |
|
1042 | 1113 | allow filtering. |
|
1043 | 1114 | |
|
1044 | 1115 | *msg should be a newline-terminated format string to log, and |
|
1045 | 1116 | then any values to %-format into that format string. |
|
1046 | 1117 | |
|
1047 | 1118 | **opts currently has no defined meanings. |
|
1048 | 1119 | ''' |
|
1049 | 1120 | |
|
1050 | 1121 | def label(self, msg, label): |
|
1051 | 1122 | '''style msg based on supplied label |
|
1052 | 1123 | |
|
1053 | 1124 | Like ui.write(), this just returns msg unchanged, but extensions |
|
1054 | 1125 | and GUI tools can override it to allow styling output without |
|
1055 | 1126 | writing it. |
|
1056 | 1127 | |
|
1057 | 1128 | ui.write(s, 'label') is equivalent to |
|
1058 | 1129 | ui.write(ui.label(s, 'label')). |
|
1059 | 1130 | ''' |
|
1060 | 1131 | return msg |
|
1061 | 1132 | |
|
1062 | 1133 | def develwarn(self, msg, stacklevel=1): |
|
1063 | 1134 | """issue a developer warning message |
|
1064 | 1135 | |
|
1065 | 1136 | Use 'stacklevel' to report the offender some layers further up in the |
|
1066 | 1137 | stack. |
|
1067 | 1138 | """ |
|
1068 | 1139 | msg = 'devel-warn: ' + msg |
|
1069 | 1140 | stacklevel += 1 # get in develwarn |
|
1070 | 1141 | if self.tracebackflag: |
|
1071 | 1142 | util.debugstacktrace(msg, stacklevel, self.ferr, self.fout) |
|
1072 | 1143 | self.log('develwarn', '%s at:\n%s' % |
|
1073 | 1144 | (msg, ''.join(util.getstackframes(stacklevel)))) |
|
1074 | 1145 | else: |
|
1075 | 1146 | curframe = inspect.currentframe() |
|
1076 | 1147 | calframe = inspect.getouterframes(curframe, 2) |
|
1077 | 1148 | self.write_err('%s at: %s:%s (%s)\n' |
|
1078 | 1149 | % ((msg,) + calframe[stacklevel][1:4])) |
|
1079 | 1150 | self.log('develwarn', '%s at: %s:%s (%s)\n', |
|
1080 | 1151 | msg, *calframe[stacklevel][1:4]) |
|
1081 | 1152 | |
|
1082 | 1153 | def deprecwarn(self, msg, version): |
|
1083 | 1154 | """issue a deprecation warning |
|
1084 | 1155 | |
|
1085 | 1156 | - msg: message explaining what is deprecated and how to upgrade, |
|
1086 | 1157 | - version: last version where the API will be supported, |
|
1087 | 1158 | """ |
|
1088 | 1159 | msg += ("\n(compatibility will be dropped after Mercurial-%s," |
|
1089 | 1160 | " update your code.)") % version |
|
1090 | 1161 | self.develwarn(msg, stacklevel=2) |
|
1091 | 1162 | |
|
1092 | 1163 | class paths(dict): |
|
1093 | 1164 | """Represents a collection of paths and their configs. |
|
1094 | 1165 | |
|
1095 | 1166 | Data is initially derived from ui instances and the config files they have |
|
1096 | 1167 | loaded. |
|
1097 | 1168 | """ |
|
1098 | 1169 | def __init__(self, ui): |
|
1099 | 1170 | dict.__init__(self) |
|
1100 | 1171 | |
|
1101 | 1172 | for name, loc in ui.configitems('paths', ignoresub=True): |
|
1102 | 1173 | # No location is the same as not existing. |
|
1103 | 1174 | if not loc: |
|
1104 | 1175 | continue |
|
1105 | 1176 | loc, sub = ui.configsuboptions('paths', name) |
|
1106 | 1177 | self[name] = path(ui, name, rawloc=loc, suboptions=sub) |
|
1107 | 1178 | |
|
1108 | 1179 | def getpath(self, name, default=None): |
|
1109 | 1180 | """Return a ``path`` from a string, falling back to default. |
|
1110 | 1181 | |
|
1111 | 1182 | ``name`` can be a named path or locations. Locations are filesystem |
|
1112 | 1183 | paths or URIs. |
|
1113 | 1184 | |
|
1114 | 1185 | Returns None if ``name`` is not a registered path, a URI, or a local |
|
1115 | 1186 | path to a repo. |
|
1116 | 1187 | """ |
|
1117 | 1188 | # Only fall back to default if no path was requested. |
|
1118 | 1189 | if name is None: |
|
1119 | 1190 | if not default: |
|
1120 | 1191 | default = () |
|
1121 | 1192 | elif not isinstance(default, (tuple, list)): |
|
1122 | 1193 | default = (default,) |
|
1123 | 1194 | for k in default: |
|
1124 | 1195 | try: |
|
1125 | 1196 | return self[k] |
|
1126 | 1197 | except KeyError: |
|
1127 | 1198 | continue |
|
1128 | 1199 | return None |
|
1129 | 1200 | |
|
1130 | 1201 | # Most likely empty string. |
|
1131 | 1202 | # This may need to raise in the future. |
|
1132 | 1203 | if not name: |
|
1133 | 1204 | return None |
|
1134 | 1205 | |
|
1135 | 1206 | try: |
|
1136 | 1207 | return self[name] |
|
1137 | 1208 | except KeyError: |
|
1138 | 1209 | # Try to resolve as a local path or URI. |
|
1139 | 1210 | try: |
|
1140 | 1211 | # We don't pass sub-options in, so no need to pass ui instance. |
|
1141 | 1212 | return path(None, None, rawloc=name) |
|
1142 | 1213 | except ValueError: |
|
1143 | 1214 | raise error.RepoError(_('repository %s does not exist') % |
|
1144 | 1215 | name) |
|
1145 | 1216 | |
|
1146 | 1217 | _pathsuboptions = {} |
|
1147 | 1218 | |
|
1148 | 1219 | def pathsuboption(option, attr): |
|
1149 | 1220 | """Decorator used to declare a path sub-option. |
|
1150 | 1221 | |
|
1151 | 1222 | Arguments are the sub-option name and the attribute it should set on |
|
1152 | 1223 | ``path`` instances. |
|
1153 | 1224 | |
|
1154 | 1225 | The decorated function will receive as arguments a ``ui`` instance, |
|
1155 | 1226 | ``path`` instance, and the string value of this option from the config. |
|
1156 | 1227 | The function should return the value that will be set on the ``path`` |
|
1157 | 1228 | instance. |
|
1158 | 1229 | |
|
1159 | 1230 | This decorator can be used to perform additional verification of |
|
1160 | 1231 | sub-options and to change the type of sub-options. |
|
1161 | 1232 | """ |
|
1162 | 1233 | def register(func): |
|
1163 | 1234 | _pathsuboptions[option] = (attr, func) |
|
1164 | 1235 | return func |
|
1165 | 1236 | return register |
|
1166 | 1237 | |
|
1167 | 1238 | @pathsuboption('pushurl', 'pushloc') |
|
1168 | 1239 | def pushurlpathoption(ui, path, value): |
|
1169 | 1240 | u = util.url(value) |
|
1170 | 1241 | # Actually require a URL. |
|
1171 | 1242 | if not u.scheme: |
|
1172 | 1243 | ui.warn(_('(paths.%s:pushurl not a URL; ignoring)\n') % path.name) |
|
1173 | 1244 | return None |
|
1174 | 1245 | |
|
1175 | 1246 | # Don't support the #foo syntax in the push URL to declare branch to |
|
1176 | 1247 | # push. |
|
1177 | 1248 | if u.fragment: |
|
1178 | 1249 | ui.warn(_('("#fragment" in paths.%s:pushurl not supported; ' |
|
1179 | 1250 | 'ignoring)\n') % path.name) |
|
1180 | 1251 | u.fragment = None |
|
1181 | 1252 | |
|
1182 | 1253 | return str(u) |
|
1183 | 1254 | |
|
1184 | 1255 | class path(object): |
|
1185 | 1256 | """Represents an individual path and its configuration.""" |
|
1186 | 1257 | |
|
1187 | 1258 | def __init__(self, ui, name, rawloc=None, suboptions=None): |
|
1188 | 1259 | """Construct a path from its config options. |
|
1189 | 1260 | |
|
1190 | 1261 | ``ui`` is the ``ui`` instance the path is coming from. |
|
1191 | 1262 | ``name`` is the symbolic name of the path. |
|
1192 | 1263 | ``rawloc`` is the raw location, as defined in the config. |
|
1193 | 1264 | ``pushloc`` is the raw locations pushes should be made to. |
|
1194 | 1265 | |
|
1195 | 1266 | If ``name`` is not defined, we require that the location be a) a local |
|
1196 | 1267 | filesystem path with a .hg directory or b) a URL. If not, |
|
1197 | 1268 | ``ValueError`` is raised. |
|
1198 | 1269 | """ |
|
1199 | 1270 | if not rawloc: |
|
1200 | 1271 | raise ValueError('rawloc must be defined') |
|
1201 | 1272 | |
|
1202 | 1273 | # Locations may define branches via syntax <base>#<branch>. |
|
1203 | 1274 | u = util.url(rawloc) |
|
1204 | 1275 | branch = None |
|
1205 | 1276 | if u.fragment: |
|
1206 | 1277 | branch = u.fragment |
|
1207 | 1278 | u.fragment = None |
|
1208 | 1279 | |
|
1209 | 1280 | self.url = u |
|
1210 | 1281 | self.branch = branch |
|
1211 | 1282 | |
|
1212 | 1283 | self.name = name |
|
1213 | 1284 | self.rawloc = rawloc |
|
1214 | 1285 | self.loc = str(u) |
|
1215 | 1286 | |
|
1216 | 1287 | # When given a raw location but not a symbolic name, validate the |
|
1217 | 1288 | # location is valid. |
|
1218 | 1289 | if not name and not u.scheme and not self._isvalidlocalpath(self.loc): |
|
1219 | 1290 | raise ValueError('location is not a URL or path to a local ' |
|
1220 | 1291 | 'repo: %s' % rawloc) |
|
1221 | 1292 | |
|
1222 | 1293 | suboptions = suboptions or {} |
|
1223 | 1294 | |
|
1224 | 1295 | # Now process the sub-options. If a sub-option is registered, its |
|
1225 | 1296 | # attribute will always be present. The value will be None if there |
|
1226 | 1297 | # was no valid sub-option. |
|
1227 | 1298 | for suboption, (attr, func) in _pathsuboptions.iteritems(): |
|
1228 | 1299 | if suboption not in suboptions: |
|
1229 | 1300 | setattr(self, attr, None) |
|
1230 | 1301 | continue |
|
1231 | 1302 | |
|
1232 | 1303 | value = func(ui, self, suboptions[suboption]) |
|
1233 | 1304 | setattr(self, attr, value) |
|
1234 | 1305 | |
|
1235 | 1306 | def _isvalidlocalpath(self, path): |
|
1236 | 1307 | """Returns True if the given path is a potentially valid repository. |
|
1237 | 1308 | This is its own function so that extensions can change the definition of |
|
1238 | 1309 | 'valid' in this case (like when pulling from a git repo into a hg |
|
1239 | 1310 | one).""" |
|
1240 | 1311 | return os.path.isdir(os.path.join(path, '.hg')) |
|
1241 | 1312 | |
|
1242 | 1313 | @property |
|
1243 | 1314 | def suboptions(self): |
|
1244 | 1315 | """Return sub-options and their values for this path. |
|
1245 | 1316 | |
|
1246 | 1317 | This is intended to be used for presentation purposes. |
|
1247 | 1318 | """ |
|
1248 | 1319 | d = {} |
|
1249 | 1320 | for subopt, (attr, _func) in _pathsuboptions.iteritems(): |
|
1250 | 1321 | value = getattr(self, attr) |
|
1251 | 1322 | if value is not None: |
|
1252 | 1323 | d[subopt] = value |
|
1253 | 1324 | return d |
|
1254 | 1325 | |
|
1255 | 1326 | # we instantiate one globally shared progress bar to avoid |
|
1256 | 1327 | # competing progress bars when multiple UI objects get created |
|
1257 | 1328 | _progresssingleton = None |
|
1258 | 1329 | |
|
1259 | 1330 | def getprogbar(ui): |
|
1260 | 1331 | global _progresssingleton |
|
1261 | 1332 | if _progresssingleton is None: |
|
1262 | 1333 | # passing 'ui' object to the singleton is fishy, |
|
1263 | 1334 | # this is how the extension used to work but feel free to rework it. |
|
1264 | 1335 | _progresssingleton = progress.progbar(ui) |
|
1265 | 1336 | return _progresssingleton |
@@ -1,225 +1,313 b'' | |||
|
1 | 1 | Set up a repo |
|
2 | 2 | |
|
3 | $ cp $HGRCPATH $HGRCPATH.pretest | |
|
3 | 4 | $ cat <<EOF >> $HGRCPATH |
|
4 | 5 | > [ui] |
|
5 | 6 | > interactive = true |
|
6 | 7 | > [experimental] |
|
7 | 8 | > crecord = true |
|
8 | 9 | > crecordtest = testModeCommands |
|
9 | 10 | > EOF |
|
10 | 11 | |
|
11 | 12 | $ hg init a |
|
12 | 13 | $ cd a |
|
13 | 14 | |
|
14 | 15 | Committing some changes but stopping on the way |
|
15 | 16 | |
|
16 | 17 | $ echo "a" > a |
|
17 | 18 | $ hg add a |
|
18 | 19 | $ cat <<EOF >testModeCommands |
|
19 | 20 | > TOGGLE |
|
20 | 21 | > X |
|
21 | 22 | > EOF |
|
22 | 23 | $ hg commit -i -m "a" -d "0 0" |
|
23 | 24 | no changes to record |
|
24 | 25 | $ hg tip |
|
25 | 26 | changeset: -1:000000000000 |
|
26 | 27 | tag: tip |
|
27 | 28 | user: |
|
28 | 29 | date: Thu Jan 01 00:00:00 1970 +0000 |
|
29 | 30 | |
|
30 | 31 | |
|
31 | 32 | Committing some changes |
|
32 | 33 | |
|
33 | 34 | $ cat <<EOF >testModeCommands |
|
34 | 35 | > X |
|
35 | 36 | > EOF |
|
36 | 37 | $ hg commit -i -m "a" -d "0 0" |
|
37 | 38 | $ hg tip |
|
38 | 39 | changeset: 0:cb9a9f314b8b |
|
39 | 40 | tag: tip |
|
40 | 41 | user: test |
|
41 | 42 | date: Thu Jan 01 00:00:00 1970 +0000 |
|
42 | 43 | summary: a |
|
43 | 44 | |
|
44 | 45 | Check that commit -i works with no changes |
|
45 | 46 | $ hg commit -i |
|
46 | 47 | no changes to record |
|
47 | 48 | |
|
48 | 49 | Committing only one file |
|
49 | 50 | |
|
50 | 51 | $ echo "a" >> a |
|
51 | 52 | >>> open('b', 'wb').write("1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n") |
|
52 | 53 | $ hg add b |
|
53 | 54 | $ cat <<EOF >testModeCommands |
|
54 | 55 | > TOGGLE |
|
55 | 56 | > KEY_DOWN |
|
56 | 57 | > X |
|
57 | 58 | > EOF |
|
58 | 59 | $ hg commit -i -m "one file" -d "0 0" |
|
59 | 60 | $ hg tip |
|
60 | 61 | changeset: 1:fb2705a663ea |
|
61 | 62 | tag: tip |
|
62 | 63 | user: test |
|
63 | 64 | date: Thu Jan 01 00:00:00 1970 +0000 |
|
64 | 65 | summary: one file |
|
65 | 66 | |
|
66 | 67 | $ hg cat -r tip a |
|
67 | 68 | a |
|
68 | 69 | $ cat a |
|
69 | 70 | a |
|
70 | 71 | a |
|
71 | 72 | |
|
72 | 73 | Committing only one hunk while aborting edition of hunk |
|
73 | 74 | |
|
74 | 75 | - Untoggle all the hunks, go down to the second file |
|
75 | 76 | - unfold it |
|
76 | 77 | - go down to second hunk (1 for the first hunk, 1 for the first hunkline, 1 for the second hunk, 1 for the second hunklike) |
|
77 | 78 | - toggle the second hunk |
|
78 | 79 | - toggle on and off the amend mode (to check that it toggles off) |
|
79 | 80 | - edit the hunk and quit the editor immediately with non-zero status |
|
80 | 81 | - commit |
|
81 | 82 | |
|
82 | 83 | $ printf "printf 'editor ran\n'; exit 1" > editor.sh |
|
83 | 84 | $ echo "x" > c |
|
84 | 85 | $ cat b >> c |
|
85 | 86 | $ echo "y" >> c |
|
86 | 87 | $ mv c b |
|
87 | 88 | $ cat <<EOF >testModeCommands |
|
88 | 89 | > A |
|
89 | 90 | > KEY_DOWN |
|
90 | 91 | > f |
|
91 | 92 | > KEY_DOWN |
|
92 | 93 | > KEY_DOWN |
|
93 | 94 | > KEY_DOWN |
|
94 | 95 | > KEY_DOWN |
|
95 | 96 | > TOGGLE |
|
96 | 97 | > a |
|
97 | 98 | > a |
|
98 | 99 | > e |
|
99 | 100 | > X |
|
100 | 101 | > EOF |
|
101 | 102 | $ HGEDITOR="\"sh\" \"`pwd`/editor.sh\"" hg commit -i -m "one hunk" -d "0 0" |
|
102 | 103 | editor ran |
|
103 | 104 | $ rm editor.sh |
|
104 | 105 | $ hg tip |
|
105 | 106 | changeset: 2:7d10dfe755a8 |
|
106 | 107 | tag: tip |
|
107 | 108 | user: test |
|
108 | 109 | date: Thu Jan 01 00:00:00 1970 +0000 |
|
109 | 110 | summary: one hunk |
|
110 | 111 | |
|
111 | 112 | $ hg cat -r tip b |
|
112 | 113 | 1 |
|
113 | 114 | 2 |
|
114 | 115 | 3 |
|
115 | 116 | 4 |
|
116 | 117 | 5 |
|
117 | 118 | 6 |
|
118 | 119 | 7 |
|
119 | 120 | 8 |
|
120 | 121 | 9 |
|
121 | 122 | 10 |
|
122 | 123 | y |
|
123 | 124 | $ cat b |
|
124 | 125 | x |
|
125 | 126 | 1 |
|
126 | 127 | 2 |
|
127 | 128 | 3 |
|
128 | 129 | 4 |
|
129 | 130 | 5 |
|
130 | 131 | 6 |
|
131 | 132 | 7 |
|
132 | 133 | 8 |
|
133 | 134 | 9 |
|
134 | 135 | 10 |
|
135 | 136 | y |
|
136 | 137 | $ hg commit -m "other hunks" |
|
137 | 138 | $ hg tip |
|
138 | 139 | changeset: 3:a6735021574d |
|
139 | 140 | tag: tip |
|
140 | 141 | user: test |
|
141 | 142 | date: Thu Jan 01 00:00:00 1970 +0000 |
|
142 | 143 | summary: other hunks |
|
143 | 144 | |
|
144 | 145 | $ hg cat -r tip b |
|
145 | 146 | x |
|
146 | 147 | 1 |
|
147 | 148 | 2 |
|
148 | 149 | 3 |
|
149 | 150 | 4 |
|
150 | 151 | 5 |
|
151 | 152 | 6 |
|
152 | 153 | 7 |
|
153 | 154 | 8 |
|
154 | 155 | 9 |
|
155 | 156 | 10 |
|
156 | 157 | y |
|
157 | 158 | |
|
158 | 159 | Newly added files can be selected with the curses interface |
|
159 | 160 | |
|
160 | 161 | $ hg update -C . |
|
161 | 162 | 0 files updated, 0 files merged, 0 files removed, 0 files unresolved |
|
162 | 163 | $ echo "hello" > x |
|
163 | 164 | $ hg add x |
|
164 | 165 | $ cat <<EOF >testModeCommands |
|
165 | 166 | > TOGGLE |
|
166 | 167 | > TOGGLE |
|
167 | 168 | > X |
|
168 | 169 | > EOF |
|
169 | 170 | $ hg st |
|
170 | 171 | A x |
|
171 | 172 | ? testModeCommands |
|
172 | 173 | $ hg commit -i -m "newly added file" -d "0 0" |
|
173 | 174 | $ hg st |
|
174 | 175 | ? testModeCommands |
|
175 | 176 | |
|
176 | 177 | Amend option works |
|
177 | 178 | $ echo "hello world" > x |
|
178 | 179 | $ hg diff -c . |
|
179 | 180 | diff -r a6735021574d -r 2b0e9be4d336 x |
|
180 | 181 | --- /dev/null Thu Jan 01 00:00:00 1970 +0000 |
|
181 | 182 | +++ b/x Thu Jan 01 00:00:00 1970 +0000 |
|
182 | 183 | @@ -0,0 +1,1 @@ |
|
183 | 184 | +hello |
|
184 | 185 | $ cat <<EOF >testModeCommands |
|
185 | 186 | > a |
|
186 | 187 | > X |
|
187 | 188 | > EOF |
|
188 | 189 | $ hg commit -i -m "newly added file" -d "0 0" |
|
189 | 190 | saved backup bundle to $TESTTMP/a/.hg/strip-backup/2b0e9be4d336-28bbe4e2-amend-backup.hg (glob) |
|
190 | 191 | $ hg diff -c . |
|
191 | 192 | diff -r a6735021574d -r c1d239d165ae x |
|
192 | 193 | --- /dev/null Thu Jan 01 00:00:00 1970 +0000 |
|
193 | 194 | +++ b/x Thu Jan 01 00:00:00 1970 +0000 |
|
194 | 195 | @@ -0,0 +1,1 @@ |
|
195 | 196 | +hello world |
|
196 | 197 | |
|
197 | 198 | Editing a hunk puts you back on that hunk when done editing (issue5041) |
|
198 | 199 | To do that, we change two lines in a file, pretend to edit the second line, |
|
199 | 200 | exit, toggle the line selected at the end of the edit and commit. |
|
200 | 201 | The first line should be recorded if we were put on the second line at the end |
|
201 | 202 | of the edit. |
|
202 | 203 | |
|
203 | 204 | $ hg update -C . |
|
204 | 205 | 0 files updated, 0 files merged, 0 files removed, 0 files unresolved |
|
205 | 206 | $ echo "foo" > x |
|
206 | 207 | $ echo "hello world" >> x |
|
207 | 208 | $ echo "bar" >> x |
|
208 | 209 | $ cat <<EOF >testModeCommands |
|
209 | 210 | > f |
|
210 | 211 | > KEY_DOWN |
|
211 | 212 | > KEY_DOWN |
|
212 | 213 | > KEY_DOWN |
|
213 | 214 | > KEY_DOWN |
|
214 | 215 | > e |
|
215 | 216 | > TOGGLE |
|
216 | 217 | > X |
|
217 | 218 | > EOF |
|
218 | 219 | $ printf "printf 'editor ran\n'; exit 0" > editor.sh |
|
219 | 220 | $ HGEDITOR="\"sh\" \"`pwd`/editor.sh\"" hg commit -i -m "edit hunk" -d "0 0" |
|
220 | 221 | editor ran |
|
221 | 222 | $ hg cat -r . x |
|
222 | 223 | foo |
|
223 | 224 | hello world |
|
224 | 225 | |
|
225 | 226 | |
|
227 | Check ui.interface logic for the chunkselector | |
|
228 | ||
|
229 | The default interface is text | |
|
230 | $ cp $HGRCPATH.pretest $HGRCPATH | |
|
231 | $ chunkselectorinterface() { | |
|
232 | > python <<EOF | |
|
233 | > from mercurial import hg, ui, parsers;\ | |
|
234 | > repo = hg.repository(ui.ui(), ".");\ | |
|
235 | > print repo.ui.interface("chunkselector") | |
|
236 | > EOF | |
|
237 | > } | |
|
238 | $ chunkselectorinterface | |
|
239 | text | |
|
240 | ||
|
241 | If only the default is set, we'll use that for the feature, too | |
|
242 | $ cp $HGRCPATH.pretest $HGRCPATH | |
|
243 | $ cat <<EOF >> $HGRCPATH | |
|
244 | > [ui] | |
|
245 | > interface = curses | |
|
246 | > EOF | |
|
247 | $ chunkselectorinterface | |
|
248 | curses | |
|
249 | ||
|
250 | It is possible to override the default interface with a feature specific | |
|
251 | interface | |
|
252 | $ cp $HGRCPATH.pretest $HGRCPATH | |
|
253 | $ cat <<EOF >> $HGRCPATH | |
|
254 | > [ui] | |
|
255 | > interface = text | |
|
256 | > interface.chunkselector = curses | |
|
257 | > EOF | |
|
258 | ||
|
259 | $ chunkselectorinterface | |
|
260 | curses | |
|
261 | ||
|
262 | $ cp $HGRCPATH.pretest $HGRCPATH | |
|
263 | $ cat <<EOF >> $HGRCPATH | |
|
264 | > [ui] | |
|
265 | > interface = curses | |
|
266 | > interface.chunkselector = text | |
|
267 | > EOF | |
|
268 | ||
|
269 | $ chunkselectorinterface | |
|
270 | text | |
|
271 | ||
|
272 | If a bad interface name is given, we use the default value (with a nice | |
|
273 | error message to suggest that the configuration needs to be fixed) | |
|
274 | ||
|
275 | $ cp $HGRCPATH.pretest $HGRCPATH | |
|
276 | $ cat <<EOF >> $HGRCPATH | |
|
277 | > [ui] | |
|
278 | > interface = blah | |
|
279 | > EOF | |
|
280 | $ chunkselectorinterface | |
|
281 | invalid value for ui.interface: blah (using text) | |
|
282 | text | |
|
283 | ||
|
284 | $ cp $HGRCPATH.pretest $HGRCPATH | |
|
285 | $ cat <<EOF >> $HGRCPATH | |
|
286 | > [ui] | |
|
287 | > interface = curses | |
|
288 | > interface.chunkselector = blah | |
|
289 | > EOF | |
|
290 | $ chunkselectorinterface | |
|
291 | invalid value for ui.interface.chunkselector: blah (using curses) | |
|
292 | curses | |
|
293 | ||
|
294 | $ cp $HGRCPATH.pretest $HGRCPATH | |
|
295 | $ cat <<EOF >> $HGRCPATH | |
|
296 | > [ui] | |
|
297 | > interface = blah | |
|
298 | > interface.chunkselector = curses | |
|
299 | > EOF | |
|
300 | $ chunkselectorinterface | |
|
301 | invalid value for ui.interface: blah | |
|
302 | curses | |
|
303 | ||
|
304 | $ cp $HGRCPATH.pretest $HGRCPATH | |
|
305 | $ cat <<EOF >> $HGRCPATH | |
|
306 | > [ui] | |
|
307 | > interface = blah | |
|
308 | > interface.chunkselector = blah | |
|
309 | > EOF | |
|
310 | $ chunkselectorinterface | |
|
311 | invalid value for ui.interface: blah | |
|
312 | invalid value for ui.interface.chunkselector: blah (using text) | |
|
313 | text |
General Comments 0
You need to be logged in to leave comments.
Login now