Mercurial > hg > mercurial-crew-with-dirclash
annotate mercurial/help.py @ 3861:db36a4f490f6
Indicate the purpose of the dummy changelog file in itself.
Otherwise people getting an error message with an old installation might
wonder why this file is corrupted.
| author | Thomas Arendsen Hein <thomas@intevation.de> |
|---|---|
| date | Sun, 10 Dec 2006 23:03:53 +0100 |
| parents | 6fa11a9d7cac |
| children | dbd828167384 |
| rev | line source |
|---|---|
|
3798
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
1 # help.py - help data for mercurial |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
2 # |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
3 # Copyright 2006 Matt Mackall <mpm@selenic.com> |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
4 # |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
5 # This software may be used and distributed according to the terms |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
6 # of the GNU General Public License, incorporated herein by reference. |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
7 |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
8 helptable = { |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
9 "dates|Date Formats": |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
10 r''' |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
11 Some commands (backout, commit, tag) allow the user to specify a date. |
| 3813 | 12 Many date formats are acceptible. Here are some examples: |
|
3798
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
13 |
| 3813 | 14 "Wed Dec 6 13:18:29 2006" (local timezone assumed) |
| 15 "Dec 6 13:18 -0600" (year assumed, time offset provided) | |
| 16 "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000) | |
| 17 "Dec 6" (midnight) | |
| 18 "13:18" (today assumed) | |
| 19 "3:39" (3:39AM assumed) | |
| 20 "3:39pm" (15:39) | |
| 21 "2006-12-6 13:18:29" (ISO 8601 format) | |
| 22 "2006-12-6 13:18" | |
| 23 "2006-12-6" | |
| 24 "12-6" | |
| 25 "12/6" | |
| 26 "12/6/6" (Dec 6 2006) | |
| 27 "" (Jan 1 00:00:00 1970 UTC) | |
|
3798
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
28 |
| 3813 | 29 Lastly, there is Mercurial's internal format: |
|
3798
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
30 |
| 3813 | 31 "1165432709 0" (Wed Dec 6 13:18:29 2006 UTC) |
|
3798
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
32 |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
33 This is the internal representation format for dates. unixtime is |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
34 the number of seconds since the epoch (1970-01-01 00:00 UTC). offset |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
35 is the offset of the local timezone, in seconds west of UTC (negative |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
36 if the timezone is east of UTC). |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
37 ''', |
| 3802 | 38 |
| 3801 | 39 'environment|env|Environment Variables': |
| 40 r''' | |
| 41 HGEDITOR:: | |
| 42 This is the name of the editor to use when committing. Defaults to the | |
| 43 value of EDITOR. | |
| 44 | |
| 45 (deprecated, use .hgrc) | |
| 46 | |
| 47 HGENCODING:: | |
| 48 This overrides the default locale setting detected by Mercurial. | |
| 49 This setting is used to convert data including usernames, | |
| 50 changeset descriptions, tag names, and branches. This setting can | |
| 51 be overridden with the --encoding command-line option. | |
| 52 | |
| 53 HGENCODINGMODE:: | |
| 54 This sets Mercurial's behavior for handling unknown characters | |
| 55 while transcoding user inputs. The default is "strict", which | |
| 56 causes Mercurial to abort if it can't translate a character. Other | |
| 57 settings include "replace", which replaces unknown characters, and | |
| 58 "ignore", which drops them. This setting can be overridden with | |
| 59 the --encodingmode command-line option. | |
| 60 | |
| 61 HGMERGE:: | |
| 62 An executable to use for resolving merge conflicts. The program | |
| 63 will be executed with three arguments: local file, remote file, | |
| 64 ancestor file. | |
| 65 | |
| 66 The default program is "hgmerge", which is a shell script provided | |
| 67 by Mercurial with some sensible defaults. | |
| 68 | |
| 69 (deprecated, use .hgrc) | |
| 70 | |
| 71 HGRCPATH:: | |
| 72 A list of files or directories to search for hgrc files. Item | |
| 73 separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set, | |
| 74 platform default search path is used. If empty, only .hg/hgrc of | |
| 75 current repository is read. | |
| 76 | |
| 77 For each element in path, if a directory, all entries in directory | |
| 78 ending with ".rc" are added to path. Else, element itself is | |
| 79 added to path. | |
| 80 | |
| 81 HGUSER:: | |
| 82 This is the string used for the author of a commit. | |
| 83 | |
| 84 (deprecated, use .hgrc) | |
| 85 | |
| 86 EMAIL:: | |
| 87 If HGUSER is not set, this will be used as the author for a commit. | |
| 88 | |
| 89 LOGNAME:: | |
| 90 If neither HGUSER nor EMAIL is set, LOGNAME will be used (with | |
| 91 '@hostname' appended) as the author value for a commit. | |
| 92 | |
| 93 EDITOR:: | |
| 94 This is the name of the editor used in the hgmerge script. It will be | |
| 95 used for commit messages if HGEDITOR isn't set. Defaults to 'vi'. | |
| 96 | |
| 97 PYTHONPATH:: | |
| 98 This is used by Python to find imported modules and may need to be set | |
| 99 appropriately if Mercurial is not installed system-wide. | |
| 3802 | 100 ''', |
| 101 | |
| 102 "patterns|File Name Patterns": r''' | |
| 103 Mercurial accepts several notations for identifying one or more | |
| 104 files at a time. | |
| 105 | |
| 106 By default, Mercurial treats filenames as shell-style extended | |
| 107 glob patterns. | |
| 108 | |
| 109 Alternate pattern notations must be specified explicitly. | |
| 110 | |
| 111 To use a plain path name without any pattern matching, start a | |
| 112 name with "path:". These path names must match completely, from | |
| 113 the root of the current repository. | |
| 114 | |
| 115 To use an extended glob, start a name with "glob:". Globs are | |
| 116 rooted at the current directory; a glob such as "*.c" will match | |
| 117 files ending in ".c" in the current directory only. | |
| 118 | |
| 119 The supported glob syntax extensions are "**" to match any string | |
| 120 across path separators, and "{a,b}" to mean "a or b". | |
| 121 | |
| 122 To use a Perl/Python regular expression, start a name with "re:". | |
| 123 Regexp pattern matching is anchored at the root of the repository. | |
| 124 | |
| 125 Plain examples: | |
| 126 | |
| 127 path:foo/bar a name bar in a directory named foo in the root of | |
| 128 the repository | |
| 129 path:path:name a file or directory named "path:name" | |
| 130 | |
| 131 Glob examples: | |
| 132 | |
| 133 glob:*.c any name ending in ".c" in the current directory | |
| 134 *.c any name ending in ".c" in the current directory | |
| 135 **.c any name ending in ".c" in the current directory, or | |
| 136 any subdirectory | |
| 137 foo/*.c any name ending in ".c" in the directory foo | |
| 138 foo/**.c any name ending in ".c" in the directory foo, or any | |
| 139 subdirectory | |
| 140 | |
| 141 Regexp examples: | |
| 142 | |
| 143 re:.*\.c$ any name ending in ".c", anywhere in the repository | |
| 144 | |
| 145 ''', | |
|
3798
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
146 } |
|
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
147 |