Show More
@@ -17,27 +17,25 b' FILES' | |||
|
17 | 17 | |
|
18 | 18 | Mercurial reads configuration data from several files, if they exist. |
|
19 | 19 | The names of these files depend on the system on which Mercurial is |
|
20 | installed. *.rc files from a single directory are read in | |
|
21 |
|
|
|
22 |
|
|
|
23 | earlier ones. | |
|
20 | installed. *.rc files from a single directory are read in alphabetical | |
|
21 | order, later ones overriding earlier ones. Where multiple paths are | |
|
22 | given below, settings from later paths override earlier ones. | |
|
24 | 23 | |
|
25 | 24 | (Unix) <install-root>/etc/mercurial/hgrc.d/*.rc:: |
|
26 | 25 | (Unix) <install-root>/etc/mercurial/hgrc:: |
|
27 | 26 | Per-installation configuration files, searched for in the |
|
28 | 27 | directory where Mercurial is installed. <install-root> is the |
|
29 | parent directory of the hg executable (or symlink) being run. | |
|
30 |
|
|
|
31 |
|
|
|
32 |
|
|
|
33 | directory. | |
|
28 | parent directory of the hg executable (or symlink) being run. For | |
|
29 | example, if installed in /shared/tools/bin/hg, Mercurial will look | |
|
30 | in /shared/tools/etc/mercurial/hgrc. Options in these files apply | |
|
31 | to all Mercurial commands executed by any user in any directory. | |
|
34 | 32 | |
|
35 | 33 | (Unix) /etc/mercurial/hgrc.d/*.rc:: |
|
36 | 34 | (Unix) /etc/mercurial/hgrc:: |
|
37 | 35 | Per-system configuration files, for the system on which Mercurial |
|
38 | is running. Options in these files apply to all Mercurial | |
|
39 |
|
|
|
40 |
|
|
|
36 | is running. Options in these files apply to all Mercurial commands | |
|
37 | executed by any user in any directory. Options in these files | |
|
38 | override per-installation options. | |
|
41 | 39 | |
|
42 | 40 | (Windows) <install-dir>\Mercurial.ini:: |
|
43 | 41 | or else:: |
@@ -46,30 +44,30 b' earlier ones.' | |||
|
46 | 44 | (Windows) C:\Mercurial\Mercurial.ini:: |
|
47 | 45 | Per-installation/system configuration files, for the system on |
|
48 | 46 | which Mercurial is running. Options in these files apply to all |
|
49 | Mercurial commands executed by any user in any directory. | |
|
50 |
|
|
|
51 |
|
|
|
52 |
|
|
|
47 | Mercurial commands executed by any user in any directory. Registry | |
|
48 | keys contain PATH-like strings, every part of which must reference | |
|
49 | a Mercurial.ini file or be a directory where *.rc files will be | |
|
50 | read. | |
|
53 | 51 | |
|
54 | 52 | (Unix) $HOME/.hgrc:: |
|
55 | 53 | (Windows) %HOME%\Mercurial.ini:: |
|
56 | 54 | (Windows) %HOME%\.hgrc:: |
|
57 | 55 | (Windows) %USERPROFILE%\Mercurial.ini:: |
|
58 | 56 | (Windows) %USERPROFILE%\.hgrc:: |
|
59 | Per-user configuration file(s), for the user running Mercurial. | |
|
60 |
|
|
|
61 | Options in these files apply to all Mercurial commands executed | |
|
62 |
|
|
|
57 | Per-user configuration file(s), for the user running Mercurial. On | |
|
58 | Windows 9x, %HOME% is replaced by %APPDATA%. | |
|
59 | Options in these files apply to all Mercurial commands executed by | |
|
60 | this user in any directory. Options in thes files override | |
|
63 | 61 | per-installation and per-system options. |
|
64 | 62 | |
|
65 | 63 | (Unix, Windows) <repo>/.hg/hgrc:: |
|
66 | 64 | Per-repository configuration options that only apply in a |
|
67 | 65 | particular repository. This file is not version-controlled, and |
|
68 | 66 | will not get transferred during a "clone" operation. Options in |
|
69 | this file override options in all other configuration files. | |
|
70 |
|
|
|
71 |
t |
|
|
72 |
|
|
|
67 | this file override options in all other configuration files. On | |
|
68 | Unix, most of this file will be ignored if it doesn't belong to a | |
|
69 | trusted user or to a trusted group. See the documentation for the | |
|
70 | trusted section below for more details. | |
|
73 | 71 | |
|
74 | 72 | SYNTAX |
|
75 | 73 | ------ |
@@ -97,8 +95,8 b' SECTIONS' | |||
|
97 | 95 | -------- |
|
98 | 96 | |
|
99 | 97 | This section describes the different sections that may appear in a |
|
100 | Mercurial "hgrc" file, the purpose of each section, its possible | |
|
101 |
|
|
|
98 | Mercurial "hgrc" file, the purpose of each section, its possible keys, | |
|
99 | and their possible values. | |
|
102 | 100 | |
|
103 | 101 | [[alias]] |
|
104 | 102 | alias:: |
@@ -120,18 +118,17 b' changesets. You can define subsequent al' | |||
|
120 | 118 | stable5 = latest -b stable |
|
121 | 119 | + |
|
122 | 120 | *Note*: It is possible to create aliases with the same names as |
|
123 | existing commands, which will then override the original | |
|
124 |
|
|
|
121 | existing commands, which will then override the original definitions. | |
|
122 | This is almost always a bad idea! | |
|
125 | 123 | |
|
126 | 124 | [[auth]] |
|
127 | 125 | auth:: |
|
128 | Authentication credentials for HTTP authentication. | |
|
129 |
|
|
|
126 | Authentication credentials for HTTP authentication. Each line has | |
|
127 | the following format: | |
|
130 | 128 | |
|
131 | 129 | <name>.<argument> = <value> |
|
132 | 130 | |
|
133 | where <name> is used to group arguments into authentication | |
|
134 | entries. | |
|
131 | where <name> is used to group arguments into authentication entries. | |
|
135 | 132 | Example: |
|
136 | 133 | |
|
137 | 134 | foo.prefix = hg.intevation.org/mercurial |
@@ -145,23 +142,23 b' auth::' | |||
|
145 | 142 | Either '*' or a URI prefix with or without the scheme part. The |
|
146 | 143 | authentication entry with the longest matching prefix is used |
|
147 | 144 | (where '*' matches everything and counts as a match of length 1). |
|
148 |
If the prefix doesn't include a scheme, the match is performed |
|
|
149 |
the URI with its scheme stripped as well, and the schemes |
|
|
150 | q.v., is then subsequently consulted. | |
|
145 | If the prefix doesn't include a scheme, the match is performed | |
|
146 | against the URI with its scheme stripped as well, and the schemes | |
|
147 | argument, q.v., is then subsequently consulted. | |
|
151 | 148 | username;; |
|
152 | 149 | Username to authenticate with. |
|
153 | 150 | password;; |
|
154 |
Optional. Password to authenticate with. If not given the user |
|
|
155 | prompted for it. | |
|
151 | Optional. Password to authenticate with. If not given the user | |
|
152 | will be prompted for it. | |
|
156 | 153 | schemes;; |
|
157 |
Optional. Space separated list of URI schemes to use this |
|
|
158 |
entry with. Only used if the prefix doesn't include |
|
|
159 |
schemes are http and https. They will match |
|
|
160 | respectively, as well. | |
|
154 | Optional. Space separated list of URI schemes to use this | |
|
155 | authentication entry with. Only used if the prefix doesn't include | |
|
156 | a scheme. Supported schemes are http and https. They will match | |
|
157 | static-http and static-https respectively, as well. | |
|
161 | 158 | Default: https. |
|
162 | 159 | |
|
163 | If no suitable authentication entry is found, the user is | |
|
164 |
|
|
|
160 | If no suitable authentication entry is found, the user is prompted | |
|
161 | for credentials as usual if required by the remote. | |
|
165 | 162 | |
|
166 | 163 | [[decode]] |
|
167 | 164 | decode/encode:: |
@@ -170,14 +167,13 b' decode/encode::' | |||
|
170 | 167 | localization/canonicalization of files. |
|
171 | 168 | |
|
172 | 169 | Filters consist of a filter pattern followed by a filter command. |
|
173 | Filter patterns are globs by default, rooted at the repository | |
|
174 |
|
|
|
175 | directory only, use the pattern "*.txt". To match any file ending | |
|
176 |
|
|
|
170 | Filter patterns are globs by default, rooted at the repository root. | |
|
171 | For example, to match any file ending in ".txt" in the root | |
|
172 | directory only, use the pattern "*.txt". To match any file ending in | |
|
173 | ".c" anywhere in the repository, use the pattern "**.c". | |
|
177 | 174 | |
|
178 | 175 | The filter command can start with a specifier, either "pipe:" or |
|
179 | "tempfile:". If no specifier is given, "pipe:" is used by | |
|
180 | default. | |
|
176 | "tempfile:". If no specifier is given, "pipe:" is used by default. | |
|
181 | 177 | |
|
182 | 178 | A "pipe:" command must accept data on stdin and return the |
|
183 | 179 | transformed data on stdout. |
@@ -194,19 +190,18 b' decode/encode::' | |||
|
194 | 190 | # can safely omit "pipe:", because it's the default) |
|
195 | 191 | *.gz = gzip |
|
196 | 192 | |
|
197 | A "tempfile:" command is a template. The string INFILE is | |
|
198 |
|
|
|
199 |
|
|
|
200 |
|
|
|
201 |
|
|
|
193 | A "tempfile:" command is a template. The string INFILE is replaced | |
|
194 | with the name of a temporary file that contains the data to be | |
|
195 | filtered by the command. The string OUTFILE is replaced with the | |
|
196 | name of an empty temporary file, where the filtered data must be | |
|
197 | written by the command. | |
|
202 | 198 | |
|
203 | 199 | NOTE: the tempfile mechanism is recommended for Windows systems, |
|
204 | 200 | where the standard shell I/O redirection operators often have |
|
205 | 201 | strange effects and may corrupt the contents of your files. |
|
206 | 202 | |
|
207 | The most common usage is for LF <-> CRLF translation on Windows. | |
|
208 |
|
|
|
209 | files: | |
|
203 | The most common usage is for LF <-> CRLF translation on Windows. For | |
|
204 | this, use the "smart" convertors which check for binary files: | |
|
210 | 205 | |
|
211 | 206 | [extensions] |
|
212 | 207 | hgext.win32text = |
@@ -229,16 +224,16 b' defaults::' | |||
|
229 | 224 | Use the [defaults] section to define command defaults, i.e. the |
|
230 | 225 | default options/arguments to pass to the specified commands. |
|
231 | 226 | |
|
232 | The following example makes 'hg log' run in verbose mode, and | |
|
233 |
|
|
|
227 | The following example makes 'hg log' run in verbose mode, and 'hg | |
|
228 | status' show only the modified files, by default. | |
|
234 | 229 | |
|
235 | 230 | [defaults] |
|
236 | 231 | log = -v |
|
237 | 232 | status = -m |
|
238 | 233 | |
|
239 | 234 | The actual commands, instead of their aliases, must be used when |
|
240 | defining command defaults. The command defaults will also be | |
|
241 |
|
|
|
235 | defining command defaults. The command defaults will also be applied | |
|
236 | to the aliases of the commands defined. | |
|
242 | 237 | |
|
243 | 238 | [[diff]] |
|
244 | 239 | diff:: |
@@ -269,24 +264,22 b' email::' | |||
|
269 | 264 | Optional. Comma-separated list of carbon copy recipients' |
|
270 | 265 | email addresses. |
|
271 | 266 | bcc;; |
|
272 | Optional. Comma-separated list of blind carbon copy | |
|
273 |
|
|
|
267 | Optional. Comma-separated list of blind carbon copy recipients' | |
|
268 | email addresses. Cannot be set interactively. | |
|
274 | 269 | method;; |
|
275 | Optional. Method to use to send email messages. If value is | |
|
276 |
|
|
|
277 |
|
|
|
278 |
|
|
|
279 |
|
|
|
280 |
|
|
|
281 | sendmail to send messages. | |
|
270 | Optional. Method to use to send email messages. If value is "smtp" | |
|
271 | (default), use SMTP (see section "[smtp]" for configuration). | |
|
272 | Otherwise, use as name of program to run that acts like sendmail | |
|
273 | (takes "-f" option for sender, list of recipients on command line, | |
|
274 | message on stdin). Normally, setting this to "sendmail" or | |
|
275 | "/usr/sbin/sendmail" is enough to use sendmail to send messages. | |
|
282 | 276 | charsets;; |
|
283 | Optional. Comma-separated list of charsets considered | |
|
284 |
|
|
|
285 |
|
|
|
286 |
t |
|
|
287 |
|
|
|
288 | conversion fails, the text in question is sent as is. | |
|
289 | Defaults to empty (explicit) list. | |
|
277 | Optional. Comma-separated list of charsets considered convenient | |
|
278 | for recipients. Addresses, headers, and parts not containing | |
|
279 | patches of outgoing messages will be encoded in the first charset | |
|
280 | to which conversion from local encoding ($HGENCODING, | |
|
281 | ui.fallbackencoding) succeeds. If correct conversion fails, the | |
|
282 | text in question is sent as is. Defaults to empty (explicit) list. | |
|
290 | 283 | |
|
291 | 284 | Order of outgoing email charsets: |
|
292 | 285 | |
@@ -310,13 +303,13 b' extensions::' | |||
|
310 | 303 | Mercurial has an extension mechanism for adding new features. To |
|
311 | 304 | enable an extension, create an entry for it in this section. |
|
312 | 305 | |
|
313 | If you know that the extension is already in Python's search | |
|
314 |
|
|
|
315 |
|
|
|
306 | If you know that the extension is already in Python's search path, | |
|
307 | you can give the name of the module, followed by "=", with nothing | |
|
308 | after the "=". | |
|
316 | 309 | |
|
317 | Otherwise, give a name that you choose, followed by "=", followed | |
|
318 |
|
|
|
319 |
|
|
|
310 | Otherwise, give a name that you choose, followed by "=", followed by | |
|
311 | the path to the ".py" file (including the file name extension) that | |
|
312 | defines the extension. | |
|
320 | 313 | |
|
321 | 314 | To explicitly disable an extension that is enabled in an hgrc of |
|
322 | 315 | broader scope, prepend its path with '!', as in |
@@ -345,16 +338,17 b' format::' | |||
|
345 | 338 | usefncache;; |
|
346 | 339 | Enable or disable the "fncache" repository format which enhances |
|
347 | 340 | the "store" repository format (which has to be enabled to use |
|
348 |
fncache) to allow longer filenames and avoids using Windows |
|
|
349 |
names, e.g. "nul". Enabled by default. Disabling this |
|
|
350 |
that the on-disk format of newly created |
|
|
351 | compatible with Mercurial before version 1.1. | |
|
341 | fncache) to allow longer filenames and avoids using Windows | |
|
342 | reserved names, e.g. "nul". Enabled by default. Disabling this | |
|
343 | option ensures that the on-disk format of newly created | |
|
344 | repositories will be compatible with Mercurial before version 1.1. | |
|
352 | 345 | |
|
353 | 346 | [[merge-patterns]] |
|
354 | 347 | merge-patterns:: |
|
355 | 348 | This section specifies merge tools to associate with particular file |
|
356 | 349 | patterns. Tools matched here will take precedence over the default |
|
357 |
merge tool. Patterns are globs by default, rooted at the repository |
|
|
350 | merge tool. Patterns are globs by default, rooted at the repository | |
|
351 | root. | |
|
358 | 352 | |
|
359 | 353 | Example: |
|
360 | 354 | |
@@ -391,9 +385,9 b' merge-tools::' | |||
|
391 | 385 | Either just the name of the executable or its pathname. |
|
392 | 386 | Default: the tool name. |
|
393 | 387 | args;; |
|
394 |
The arguments to pass to the tool executable. You can refer to the |
|
|
395 |
being merged as well as the output file through these |
|
|
396 | $local, $other, $output. | |
|
388 | The arguments to pass to the tool executable. You can refer to the | |
|
389 | files being merged as well as the output file through these | |
|
390 | variables: $base, $local, $other, $output. | |
|
397 | 391 | Default: $local $base $other |
|
398 | 392 | premerge;; |
|
399 | 393 | Attempt to run internal non-interactive 3-way merge tool before |
@@ -419,15 +413,17 b' merge-tools::' | |||
|
419 | 413 | gui;; |
|
420 | 414 | This tool requires a graphical interface to run. Default: False |
|
421 | 415 | regkey;; |
|
422 |
Windows registry key which describes install location of this |
|
|
423 |
Mercurial will search for this key first under |
|
|
424 |
then under HKEY_LOCAL_MACHINE. |
|
|
416 | Windows registry key which describes install location of this | |
|
417 | tool. Mercurial will search for this key first under | |
|
418 | HKEY_CURRENT_USER and then under HKEY_LOCAL_MACHINE. | |
|
419 | Default: None | |
|
425 | 420 | regname;; |
|
426 | 421 | Name of value to read from specified registry key. Defaults to the |
|
427 | 422 | unnamed (default) value. |
|
428 | 423 | regappend;; |
|
429 |
String to append to the value read from the registry, typically |
|
|
430 |
executable name of the tool. |
|
|
424 | String to append to the value read from the registry, typically | |
|
425 | the executable name of the tool. | |
|
426 | Default: None | |
|
431 | 427 | |
|
432 | 428 | [[hooks]] |
|
433 | 429 | hooks:: |
@@ -450,13 +446,13 b' hooks::' | |||
|
450 | 446 | variables it is passed are listed with names of the form "$HG_foo". |
|
451 | 447 | |
|
452 | 448 | changegroup;; |
|
453 | Run after a changegroup has been added via push, pull or | |
|
454 |
|
|
|
455 |
|
|
|
449 | Run after a changegroup has been added via push, pull or unbundle. | |
|
450 | ID of the first new changeset is in $HG_NODE. URL from which | |
|
451 | changes came is in $HG_URL. | |
|
456 | 452 | commit;; |
|
457 | Run after a changeset has been created in the local repository. | |
|
458 |
|
|
|
459 |
|
|
|
453 | Run after a changeset has been created in the local repository. ID | |
|
454 | of the newly created changeset is in $HG_NODE. Parent changeset | |
|
455 | IDs are in $HG_PARENT1 and $HG_PARENT2. | |
|
460 | 456 | incoming;; |
|
461 | 457 | Run after a changeset has been pulled, pushed, or unbundled into |
|
462 | 458 | the local repository. The ID of the newly arrived changeset is in |
@@ -472,39 +468,40 b' hooks::' | |||
|
472 | 468 | pre-<command>;; |
|
473 | 469 | Run before executing the associated command. The contents of the |
|
474 | 470 | command line are passed as $HG_ARGS. If the hook returns failure, |
|
475 |
the command doesn't execute and Mercurial returns the failure |
|
|
471 | the command doesn't execute and Mercurial returns the failure | |
|
472 | code. | |
|
476 | 473 | prechangegroup;; |
|
477 | Run before a changegroup is added via push, pull or unbundle. | |
|
478 |
|
|
|
479 |
|
|
|
480 |
|
|
|
474 | Run before a changegroup is added via push, pull or unbundle. Exit | |
|
475 | status 0 allows the changegroup to proceed. Non-zero status will | |
|
476 | cause the push, pull or unbundle to fail. URL from which changes | |
|
477 | will come is in $HG_URL. | |
|
481 | 478 | precommit;; |
|
482 | 479 | Run before starting a local commit. Exit status 0 allows the |
|
483 | 480 | commit to proceed. Non-zero status will cause the commit to fail. |
|
484 | 481 | Parent changeset IDs are in $HG_PARENT1 and $HG_PARENT2. |
|
485 | 482 | preoutgoing;; |
|
486 | 483 | Run before collecting changes to send from the local repository to |
|
487 | another. Non-zero status will cause failure. This lets you | |
|
488 |
p |
|
|
489 |
|
|
|
490 |
|
|
|
491 | $HG_SOURCE. If "serve", operation is happening on behalf of | |
|
492 |
|
|
|
493 |
|
|
|
484 | another. Non-zero status will cause failure. This lets you prevent | |
|
485 | pull over http or ssh. Also prevents against local pull, push | |
|
486 | (outbound) or bundle commands, but not effective, since you can | |
|
487 | just copy files instead then. Source of operation is in | |
|
488 | $HG_SOURCE. If "serve", operation is happening on behalf of remote | |
|
489 | ssh or http repository. If "push", "pull" or "bundle", operation | |
|
490 | is happening on behalf of repository on same system. | |
|
494 | 491 | pretag;; |
|
495 | 492 | Run before creating a tag. Exit status 0 allows the tag to be |
|
496 | 493 | created. Non-zero status will cause the tag to fail. ID of |
|
497 | changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag | |
|
498 |
|
|
|
494 | changeset to tag is in $HG_NODE. Name of tag is in $HG_TAG. Tag is | |
|
495 | local if $HG_LOCAL=1, in repo if $HG_LOCAL=0. | |
|
499 | 496 | pretxnchangegroup;; |
|
500 | 497 | Run after a changegroup has been added via push, pull or unbundle, |
|
501 | 498 | but before the transaction has been committed. Changegroup is |
|
502 | 499 | visible to hook program. This lets you validate incoming changes |
|
503 | before accepting them. Passed the ID of the first new changeset | |
|
504 |
|
|
|
505 |
|
|
|
506 |
|
|
|
507 |
|
|
|
500 | before accepting them. Passed the ID of the first new changeset in | |
|
501 | $HG_NODE. Exit status 0 allows the transaction to commit. Non-zero | |
|
502 | status will cause the transaction to be rolled back and the push, | |
|
503 | pull or unbundle will fail. URL that was source of changes is in | |
|
504 | $HG_URL. | |
|
508 | 505 | pretxncommit;; |
|
509 | 506 | Run after a changeset has been created but the transaction not yet |
|
510 | 507 | committed. Changeset is visible to hook program. This lets you |
@@ -518,43 +515,40 b' hooks::' | |||
|
518 | 515 | Changeset ID of first new parent is in $HG_PARENT1. If merge, ID |
|
519 | 516 | of second new parent is in $HG_PARENT2. |
|
520 | 517 | tag;; |
|
521 | Run after a tag is created. ID of tagged changeset is in | |
|
522 |
|
|
|
523 | $HG_LOCAL=1, in repo if $HG_LOCAL=0. | |
|
518 | Run after a tag is created. ID of tagged changeset is in $HG_NODE. | |
|
519 | Name of tag is in $HG_TAG. Tag is local if $HG_LOCAL=1, in repo if | |
|
520 | $HG_LOCAL=0. | |
|
524 | 521 | update;; |
|
525 | 522 | Run after updating the working directory. Changeset ID of first |
|
526 | new parent is in $HG_PARENT1. If merge, ID of second new parent | |
|
527 |
i |
|
|
523 | new parent is in $HG_PARENT1. If merge, ID of second new parent is | |
|
524 | in $HG_PARENT2. If the update succeeded, $HG_ERROR=0. If the | |
|
528 | 525 | update failed (e.g. because conflicts not resolved), $HG_ERROR=1. |
|
529 | 526 | |
|
530 | Note: it is generally better to use standard hooks rather | |
|
531 |
|
|
|
532 |
|
|
|
533 | influencing transactions. Also, hooks like "commit" will be | |
|
534 | called in all contexts that generate a commit (e.g. tag) and | |
|
535 | not just the commit command. | |
|
527 | Note: it is generally better to use standard hooks rather than the | |
|
528 | generic pre- and post- command hooks as they are guaranteed to be | |
|
529 | called in the appropriate contexts for influencing transactions. | |
|
530 | Also, hooks like "commit" will be called in all contexts that | |
|
531 | generate a commit (e.g. tag) and not just the commit command. | |
|
536 | 532 | |
|
537 | Note2: Environment variables with empty values may not be | |
|
538 |
|
|
|
539 | example, $HG_PARENT2 will have an empty value under | |
|
540 | Unix-like platforms for non-merge changesets, while it | |
|
541 | will not be available at all under Windows. | |
|
533 | Note2: Environment variables with empty values may not be passed to | |
|
534 | hooks on platforms such as Windows. As an example, $HG_PARENT2 will | |
|
535 | have an empty value under Unix-like platforms for non-merge | |
|
536 | changesets, while it will not be available at all under Windows. | |
|
542 | 537 | |
|
543 | 538 | The syntax for Python hooks is as follows: |
|
544 | 539 | |
|
545 | 540 | hookname = python:modulename.submodule.callable |
|
546 | 541 | hookname = python:/path/to/python/module.py:callable |
|
547 | 542 | |
|
548 | Python hooks are run within the Mercurial process. Each hook | |
|
549 |
|
|
|
550 |
|
|
|
551 |
|
|
|
552 |
|
|
|
553 |
|
|
|
554 | case. | |
|
543 | Python hooks are run within the Mercurial process. Each hook is | |
|
544 | called with at least three keyword arguments: a ui object (keyword | |
|
545 | "ui"), a repository object (keyword "repo"), and a "hooktype" | |
|
546 | keyword that tells what kind of hook is used. Arguments listed as | |
|
547 | environment variables above are passed as keyword arguments, with no | |
|
548 | "HG_" prefix, and names in lower case. | |
|
555 | 549 | |
|
556 | If a Python hook returns a "true" value or raises an | |
|
557 |
|
|
|
550 | If a Python hook returns a "true" value or raises an exception, this | |
|
551 | is treated as a failure. | |
|
558 | 552 | |
|
559 | 553 | [[http_proxy]] |
|
560 | 554 | http_proxy:: |
@@ -582,53 +576,53 b' smtp::' | |||
|
582 | 576 | Optional. Whether to connect to mail server using TLS. True or |
|
583 | 577 | False. Default: False. |
|
584 | 578 | username;; |
|
585 | Optional. User name to authenticate to SMTP server with. | |
|
586 |
|
|
|
579 | Optional. User name to authenticate to SMTP server with. If | |
|
580 | username is specified, password must also be specified. | |
|
587 | 581 | Default: none. |
|
588 | 582 | password;; |
|
589 | Optional. Password to authenticate to SMTP server with. | |
|
590 |
|
|
|
583 | Optional. Password to authenticate to SMTP server with. If | |
|
584 | username is specified, password must also be specified. | |
|
591 | 585 | Default: none. |
|
592 | 586 | local_hostname;; |
|
593 |
Optional. It's the hostname that the sender can use to identify |
|
|
594 | to the MTA. | |
|
587 | Optional. It's the hostname that the sender can use to identify | |
|
588 | itself to the MTA. | |
|
595 | 589 | |
|
596 | 590 | [[paths]] |
|
597 | 591 | paths:: |
|
598 | 592 | Assigns symbolic names to repositories. The left side is the |
|
599 | 593 | symbolic name, and the right gives the directory or URL that is the |
|
600 | location of the repository. Default paths can be declared by | |
|
601 |
|
|
|
594 | location of the repository. Default paths can be declared by setting | |
|
595 | the following entries. | |
|
602 | 596 | default;; |
|
603 | 597 | Directory or URL to use when pulling if no source is specified. |
|
604 | Default is set to repository from which the current repository | |
|
605 |
|
|
|
598 | Default is set to repository from which the current repository was | |
|
599 | cloned. | |
|
606 | 600 | default-push;; |
|
607 | 601 | Optional. Directory or URL to use when pushing if no destination |
|
608 | 602 | is specified. |
|
609 | 603 | |
|
610 | 604 | [[profiling]] |
|
611 | 605 | profiling:: |
|
612 | Specifies profiling format and file output. | |
|
613 |
|
|
|
614 |
|
|
|
615 |
|
|
|
616 | The profiling is done using lsprof. | |
|
606 | Specifies profiling format and file output. In this section | |
|
607 | description, 'profiling data' stands for the raw data collected | |
|
608 | during profiling, while 'profiling report' stands for a statistical | |
|
609 | text report generated from the profiling data. The profiling is done | |
|
610 | using lsprof. | |
|
617 | 611 | format;; |
|
618 | 612 | Profiling format. |
|
619 | 613 | Default: text. |
|
620 | 614 | text;; |
|
621 | Generate a profiling report. | |
|
622 | When saving to a file, it should be noted that only the report is saved, | |
|
623 | and the profiling data is not kept. | |
|
615 | Generate a profiling report. When saving to a file, it should be | |
|
616 | noted that only the report is saved, and the profiling data is | |
|
617 | not kept. | |
|
624 | 618 | kcachegrind;; |
|
625 | Format profiling data for kcachegrind use: | |
|
626 |
|
|
|
627 |
|
|
|
619 | Format profiling data for kcachegrind use: when saving to a | |
|
620 | file, the generated file can directly be loaded into | |
|
621 | kcachegrind. | |
|
628 | 622 | output;; |
|
629 | File path where profiling data or report should be saved. | |
|
630 |
|
|
|
631 | Default: None, data is printed on stderr | |
|
623 | File path where profiling data or report should be saved. If the | |
|
624 | file exists, it is replaced. Default: None, data is printed on | |
|
625 | stderr | |
|
632 | 626 | |
|
633 | 627 | [[server]] |
|
634 | 628 | server:: |
@@ -645,15 +639,15 b' server::' | |||
|
645 | 639 | |
|
646 | 640 | [[trusted]] |
|
647 | 641 | trusted:: |
|
648 | For security reasons, Mercurial will not use the settings in | |
|
649 |
|
|
|
650 |
|
|
|
651 |
w |
|
|
652 |
|
|
|
642 | For security reasons, Mercurial will not use the settings in the | |
|
643 | .hg/hgrc file from a repository if it doesn't belong to a trusted | |
|
644 | user or to a trusted group. The main exception is the web interface, | |
|
645 | which automatically uses some safe settings, since it's common to | |
|
646 | serve repositories from different users. | |
|
653 | 647 | |
|
654 | 648 | This section specifies what users and groups are trusted. The |
|
655 | current user is always trusted. To trust everybody, list a user | |
|
656 |
|
|
|
649 | current user is always trusted. To trust everybody, list a user or a | |
|
650 | group with name "*". | |
|
657 | 651 | |
|
658 | 652 | users;; |
|
659 | 653 | Comma-separated list of trusted users. |
@@ -665,8 +659,8 b' ui::' | |||
|
665 | 659 | User interface controls. |
|
666 | 660 | archivemeta;; |
|
667 | 661 | Whether to include the .hg_archival.txt file containing metadata |
|
668 |
(hashes for the repository base and for tip) in archives created |
|
|
669 | the hg archive command or downloaded via hgweb. | |
|
662 | (hashes for the repository base and for tip) in archives created | |
|
663 | by the hg archive command or downloaded via hgweb. | |
|
670 | 664 | Default is true. |
|
671 | 665 | askusername;; |
|
672 | 666 | Whether to prompt for a username when committing. If True, and |
@@ -682,10 +676,10 b' ui::' | |||
|
682 | 676 | Encoding to try if it's not possible to decode the changelog using |
|
683 | 677 | UTF-8. Default is ISO-8859-1. |
|
684 | 678 | ignore;; |
|
685 |
A file to read per-user ignore patterns from. This file should be |
|
|
686 |
the same format as a repository-wide .hgignore file. This |
|
|
687 |
supports hook syntax, so if you want to specify multiple |
|
|
688 | files, you can do so by setting something like | |
|
679 | A file to read per-user ignore patterns from. This file should be | |
|
680 | in the same format as a repository-wide .hgignore file. This | |
|
681 | option supports hook syntax, so if you want to specify multiple | |
|
682 | ignore files, you can do so by setting something like | |
|
689 | 683 | "ignore.other = ~/.hgignore2". For details of the ignore file |
|
690 | 684 | format, see the hgignore(5) man page. |
|
691 | 685 | interactive;; |
@@ -709,8 +703,8 b' ui::' | |||
|
709 | 703 | merge-tools section. |
|
710 | 704 | |
|
711 | 705 | patch;; |
|
712 |
command to use to apply patches. Look for 'gpatch' or 'patch' in |
|
|
713 | unset. | |
|
706 | command to use to apply patches. Look for 'gpatch' or 'patch' in | |
|
707 | PATH if unset. | |
|
714 | 708 | quiet;; |
|
715 | 709 | Reduce the amount of output printed. True or False. Default is False. |
|
716 | 710 | remotecmd;; |
@@ -720,8 +714,9 b' ui::' | |||
|
720 | 714 | trusted user or group. True or False. Default is True. |
|
721 | 715 | slash;; |
|
722 | 716 | Display paths using a slash ("/") as the path separator. This only |
|
723 |
makes a difference on systems where the default path separator is |
|
|
724 |
the slash character (e.g. Windows uses the backslash character |
|
|
717 | makes a difference on systems where the default path separator is | |
|
718 | not the slash character (e.g. Windows uses the backslash character | |
|
719 | ("\")). | |
|
725 | 720 | Default is False. |
|
726 | 721 | ssh;; |
|
727 | 722 | command to use for SSH connections. Default is 'ssh'. |
@@ -736,10 +731,10 b' ui::' | |||
|
736 | 731 | username;; |
|
737 | 732 | The committer of a changeset created when running "commit". |
|
738 | 733 | Typically a person's name and email address, e.g. "Fred Widget |
|
739 | <fred@example.com>". Default is $EMAIL or username@hostname. | |
|
740 |
|
|
|
741 |
in a different hgrc file (e.g. $HOME/.hgrc, if the admin set |
|
|
742 | in the system hgrc). | |
|
734 | <fred@example.com>". Default is $EMAIL or username@hostname. If | |
|
735 | the username in hgrc is empty, it has to be specified manually or | |
|
736 | in a different hgrc file (e.g. $HOME/.hgrc, if the admin set | |
|
737 | "username =" in the system hgrc). | |
|
743 | 738 | verbose;; |
|
744 | 739 | Increase the amount of output printed. True or False. Default is False. |
|
745 | 740 | |
@@ -764,51 +759,55 b' web::' | |||
|
764 | 759 | Whether to allow pulling from the repository. Default is true. |
|
765 | 760 | allow_push;; |
|
766 | 761 | Whether to allow pushing to the repository. If empty or not set, |
|
767 | push is not allowed. If the special value "*", any remote user | |
|
768 |
|
|
|
769 |
|
|
|
770 |
|
|
|
771 |
|
|
|
772 |
|
|
|
762 | push is not allowed. If the special value "*", any remote user can | |
|
763 | push, including unauthenticated users. Otherwise, the remote user | |
|
764 | must have been authenticated, and the authenticated user name must | |
|
765 | be present in this list (separated by whitespace or ","). The | |
|
766 | contents of the allow_push list are examined after the deny_push | |
|
767 | list. | |
|
773 | 768 | allow_read;; |
|
774 |
If the user has not already been denied repository access due to |
|
|
775 |
contents of deny_read, this list determines whether to grant |
|
|
776 |
access to the user. If this list is not empty, and the |
|
|
777 |
unauthenticated or not present in the list (separated by |
|
|
778 |
then access is denied for the user. |
|
|
779 | access is permitted to all users by default. Setting allow_read to the | |
|
780 | special value "*" is equivalent to it not being set (i.e. access is | |
|
781 | permitted to all users). The contents of the allow_read list are examined | |
|
782 | after the deny_read list. | |
|
769 | If the user has not already been denied repository access due to | |
|
770 | the contents of deny_read, this list determines whether to grant | |
|
771 | repository access to the user. If this list is not empty, and the | |
|
772 | user is unauthenticated or not present in the list (separated by | |
|
773 | whitespace or ","), then access is denied for the user. If the | |
|
774 | list is empty or not set, then access is permitted to all users by | |
|
775 | default. Setting allow_read to the special value "*" is equivalent | |
|
776 | to it not being set (i.e. access is permitted to all users). The | |
|
777 | contents of the allow_read list are examined after the deny_read | |
|
778 | list. | |
|
783 | 779 | allowzip;; |
|
784 | 780 | (DEPRECATED) Whether to allow .zip downloading of repo revisions. |
|
785 | 781 | Default is false. This feature creates temporary files. |
|
786 | 782 | baseurl;; |
|
787 | 783 | Base URL to use when publishing URLs in other locations, so |
|
788 |
third-party tools like email notification hooks can construct |
|
|
789 | Example: "http://hgserver/repos/" | |
|
784 | third-party tools like email notification hooks can construct | |
|
785 | URLs. Example: "http://hgserver/repos/" | |
|
790 | 786 | contact;; |
|
791 | 787 | Name or email address of the person in charge of the repository. |
|
792 | 788 | Defaults to ui.username or $EMAIL or "unknown" if unset or empty. |
|
793 | 789 | deny_push;; |
|
794 | 790 | Whether to deny pushing to the repository. If empty or not set, |
|
795 | push is not denied. If the special value "*", all remote users | |
|
796 |
|
|
|
797 |
an |
|
|
791 | push is not denied. If the special value "*", all remote users are | |
|
792 | denied push. Otherwise, unauthenticated users are all denied, and | |
|
793 | any authenticated user name present in this list (separated by | |
|
798 | 794 | whitespace or ",") is also denied. The contents of the deny_push |
|
799 | 795 | list are examined before the allow_push list. |
|
800 | 796 | deny_read;; |
|
801 |
Whether to deny reading/viewing of the repository. |
|
|
802 |
empty, unauthenticated users are all denied, and any |
|
|
803 | present in this list (separated by whitespace or ",") is also denied access | |
|
804 | to the repository. If set to the special value "*", all remote users are | |
|
805 | denied access (rarely needed ;). If deny_read is empty or not set, the | |
|
806 | determination of repository access depends on the presence and content of | |
|
807 | the allow_read list (see description). If both deny_read and allow_read are | |
|
808 | empty or not set, then access is permitted to all users by default. If the | |
|
809 | repository is being served via hgwebdir, denied users will not be able to | |
|
810 | see it in the list of repositories. The contents of the deny_read list have | |
|
811 | priority over (are examined before) the contents of the allow_read list. | |
|
797 | Whether to deny reading/viewing of the repository. If this list is | |
|
798 | not empty, unauthenticated users are all denied, and any | |
|
799 | authenticated user name present in this list (separated by | |
|
800 | whitespace or ",") is also denied access to the repository. If set | |
|
801 | to the special value "*", all remote users are denied access | |
|
802 | (rarely needed ;). If deny_read is empty or not set, the | |
|
803 | determination of repository access depends on the presence and | |
|
804 | content of the allow_read list (see description). If both | |
|
805 | deny_read and allow_read are empty or not set, then access is | |
|
806 | permitted to all users by default. If the repository is being | |
|
807 | served via hgwebdir, denied users will not be able to see it in | |
|
808 | the list of repositories. The contents of the deny_read list have | |
|
809 | priority over (are examined before) the contents of the allow_read | |
|
810 | list. | |
|
812 | 811 | description;; |
|
813 | 812 | Textual description of the repository's purpose or contents. |
|
814 | 813 | Default is "unknown". |
@@ -818,7 +817,8 b' web::' | |||
|
818 | 817 | errorlog;; |
|
819 | 818 | Where to output the error log. Default is stderr. |
|
820 | 819 | hidden;; |
|
821 |
Whether to hide the repository in the hgwebdir index. |
|
|
820 | Whether to hide the repository in the hgwebdir index. | |
|
821 | Default is false. | |
|
822 | 822 | ipv6;; |
|
823 | 823 | Whether to use IPv6. Default is false. |
|
824 | 824 | name;; |
@@ -836,9 +836,9 b' web::' | |||
|
836 | 836 | Whether to require that inbound pushes be transported over SSL to |
|
837 | 837 | prevent password sniffing. Default is true. |
|
838 | 838 | staticurl;; |
|
839 | Base URL to use for static files. If unset, static files (e.g. | |
|
840 |
|
|
|
841 |
|
|
|
839 | Base URL to use for static files. If unset, static files (e.g. the | |
|
840 | hgicon.png favicon) will be served by the CGI script itself. Use | |
|
841 | this setting to serve them directly with the HTTP server. | |
|
842 | 842 | Example: "http://hgserver/static/" |
|
843 | 843 | stripes;; |
|
844 | 844 | How many lines a "zebra stripe" should span in multiline output. |
General Comments 0
You need to be logged in to leave comments.
Login now