Mercurial > hg > mercurial-crew-with-dirclash
annotate mercurial/help.py @ 4528:85a69f4d1e80
test-config-case: print only the Section we're interested in.
This allows us to add additional settings to the global hgrc file
created by run-tests.py without breaking this test.
author | Alexis S. L. Carvalho <alexis@cecm.usp.br> |
---|---|
date | Fri, 08 Jun 2007 23:49:12 -0300 |
parents | dbd828167384 |
children | 849f011dbf79 |
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) | |
3798
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
27 |
3813 | 28 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
|
29 |
3813 | 30 "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
|
31 |
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
32 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
|
33 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
|
34 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
|
35 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
|
36 ''', |
3802 | 37 |
3801 | 38 'environment|env|Environment Variables': |
39 r''' | |
40 HGEDITOR:: | |
41 This is the name of the editor to use when committing. Defaults to the | |
42 value of EDITOR. | |
43 | |
44 (deprecated, use .hgrc) | |
45 | |
46 HGENCODING:: | |
47 This overrides the default locale setting detected by Mercurial. | |
48 This setting is used to convert data including usernames, | |
49 changeset descriptions, tag names, and branches. This setting can | |
50 be overridden with the --encoding command-line option. | |
51 | |
52 HGENCODINGMODE:: | |
53 This sets Mercurial's behavior for handling unknown characters | |
54 while transcoding user inputs. The default is "strict", which | |
55 causes Mercurial to abort if it can't translate a character. Other | |
56 settings include "replace", which replaces unknown characters, and | |
57 "ignore", which drops them. This setting can be overridden with | |
58 the --encodingmode command-line option. | |
59 | |
60 HGMERGE:: | |
61 An executable to use for resolving merge conflicts. The program | |
62 will be executed with three arguments: local file, remote file, | |
63 ancestor file. | |
64 | |
65 The default program is "hgmerge", which is a shell script provided | |
66 by Mercurial with some sensible defaults. | |
67 | |
68 (deprecated, use .hgrc) | |
69 | |
70 HGRCPATH:: | |
71 A list of files or directories to search for hgrc files. Item | |
72 separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set, | |
73 platform default search path is used. If empty, only .hg/hgrc of | |
74 current repository is read. | |
75 | |
76 For each element in path, if a directory, all entries in directory | |
77 ending with ".rc" are added to path. Else, element itself is | |
78 added to path. | |
79 | |
80 HGUSER:: | |
81 This is the string used for the author of a commit. | |
82 | |
83 (deprecated, use .hgrc) | |
84 | |
85 EMAIL:: | |
86 If HGUSER is not set, this will be used as the author for a commit. | |
87 | |
88 LOGNAME:: | |
89 If neither HGUSER nor EMAIL is set, LOGNAME will be used (with | |
90 '@hostname' appended) as the author value for a commit. | |
91 | |
92 EDITOR:: | |
93 This is the name of the editor used in the hgmerge script. It will be | |
94 used for commit messages if HGEDITOR isn't set. Defaults to 'vi'. | |
95 | |
96 PYTHONPATH:: | |
97 This is used by Python to find imported modules and may need to be set | |
98 appropriately if Mercurial is not installed system-wide. | |
3802 | 99 ''', |
100 | |
101 "patterns|File Name Patterns": r''' | |
102 Mercurial accepts several notations for identifying one or more | |
103 files at a time. | |
104 | |
105 By default, Mercurial treats filenames as shell-style extended | |
106 glob patterns. | |
107 | |
108 Alternate pattern notations must be specified explicitly. | |
109 | |
110 To use a plain path name without any pattern matching, start a | |
111 name with "path:". These path names must match completely, from | |
112 the root of the current repository. | |
113 | |
114 To use an extended glob, start a name with "glob:". Globs are | |
115 rooted at the current directory; a glob such as "*.c" will match | |
116 files ending in ".c" in the current directory only. | |
117 | |
118 The supported glob syntax extensions are "**" to match any string | |
119 across path separators, and "{a,b}" to mean "a or b". | |
120 | |
121 To use a Perl/Python regular expression, start a name with "re:". | |
122 Regexp pattern matching is anchored at the root of the repository. | |
123 | |
124 Plain examples: | |
125 | |
126 path:foo/bar a name bar in a directory named foo in the root of | |
127 the repository | |
128 path:path:name a file or directory named "path:name" | |
129 | |
130 Glob examples: | |
131 | |
132 glob:*.c any name ending in ".c" in the current directory | |
133 *.c any name ending in ".c" in the current directory | |
134 **.c any name ending in ".c" in the current directory, or | |
135 any subdirectory | |
136 foo/*.c any name ending in ".c" in the directory foo | |
137 foo/**.c any name ending in ".c" in the directory foo, or any | |
138 subdirectory | |
139 | |
140 Regexp examples: | |
141 | |
142 re:.*\.c$ any name ending in ".c", anywhere in the repository | |
143 | |
144 ''', | |
3798
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
145 } |
17a11f4ff260
Add basic support for help topics and a dates topic
Matt Mackall <mpm@selenic.com>
parents:
diff
changeset
|
146 |