##// END OF EJS Templates
help: wrapped help strings at 78 characters
Martin Geisler -
r9082:31e54756 default
parent child Browse files
Show More
@@ -1,511 +1,491 b''
1 1 # help.py - help data for mercurial
2 2 #
3 3 # Copyright 2006 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, incorporated herein by reference.
7 7
8 8 from i18n import _
9 9 import extensions, util
10 10
11 11
12 12 def moduledoc(file):
13 13 '''return the top-level python documentation for the given file
14 14
15 15 Loosely inspired by pydoc.source_synopsis(), but rewritten to handle \'''
16 16 as well as """ and to return the whole text instead of just the synopsis'''
17 17 result = []
18 18
19 19 line = file.readline()
20 20 while line[:1] == '#' or not line.strip():
21 21 line = file.readline()
22 22 if not line: break
23 23
24 24 start = line[:3]
25 25 if start == '"""' or start == "'''":
26 26 line = line[3:]
27 27 while line:
28 28 if line.rstrip().endswith(start):
29 29 line = line.split(start)[0]
30 30 if line:
31 31 result.append(line)
32 32 break
33 33 elif not line:
34 34 return None # unmatched delimiter
35 35 result.append(line)
36 36 line = file.readline()
37 37 else:
38 38 return None
39 39
40 40 return ''.join(result)
41 41
42 42 def listexts(header, exts, maxlength):
43 43 '''return a text listing of the given extensions'''
44 44 if not exts:
45 45 return ''
46 46 result = '\n%s\n\n' % header
47 47 for name, desc in sorted(exts.iteritems()):
48 48 desc = util.wrap(desc, maxlength + 4)
49 49 result += ' %s %s\n' % (name.ljust(maxlength), desc)
50 50 return result
51 51
52 52 def extshelp():
53 53 doc = _(r'''
54 54 Mercurial has the ability to add new features through the use of
55 extensions. Extensions may add new commands, add options to
56 existing commands, change the default behavior of commands, or
57 implement hooks.
55 extensions. Extensions may add new commands, add options to existing
56 commands, change the default behavior of commands, or implement hooks.
58 57
59 Extensions are not loaded by default for a variety of reasons:
60 they can increase startup overhead; they may be meant for
61 advanced usage only; they may provide potentially dangerous
62 abilities (such as letting you destroy or modify history); they
63 might not be ready for prime time; or they may alter some
64 usual behaviors of stock Mercurial. It is thus up to the user to
65 activate extensions as needed.
58 Extensions are not loaded by default for a variety of reasons: they can
59 increase startup overhead; they may be meant for advanced usage only; they
60 may provide potentially dangerous abilities (such as letting you destroy
61 or modify history); they might not be ready for prime time; or they may
62 alter some usual behaviors of stock Mercurial. It is thus up to the user
63 to activate extensions as needed.
66 64
67 To enable the "foo" extension, either shipped with Mercurial
68 or in the Python search path, create an entry for it in your
69 hgrc, like this:
65 To enable the "foo" extension, either shipped with Mercurial or in the
66 Python search path, create an entry for it in your hgrc, like this:
70 67
71 68 [extensions]
72 69 foo =
73 70
74 71 You may also specify the full path to an extension:
75 72
76 73 [extensions]
77 74 myfeature = ~/.hgext/myfeature.py
78 75
79 To explicitly disable an extension enabled in an hgrc of broader
80 scope, prepend its path with !:
76 To explicitly disable an extension enabled in an hgrc of broader scope,
77 prepend its path with !:
81 78
82 79 [extensions]
83 80 # disabling extension bar residing in /path/to/extension/bar.py
84 81 hgext.bar = !/path/to/extension/bar.py
85 82 # ditto, but no path was supplied for extension baz
86 83 hgext.baz = !
87 84 ''')
88 85
89 86 exts, maxlength = extensions.enabled()
90 87 doc += listexts(_('enabled extensions:'), exts, maxlength)
91 88
92 89 exts, maxlength = extensions.disabled()
93 90 doc += listexts(_('disabled extensions:'), exts, maxlength)
94 91
95 92 return doc
96 93
97 94 helptable = (
98 95 (["dates"], _("Date Formats"),
99 96 _(r'''
100 97 Some commands allow the user to specify a date, e.g.:
101 98 * backout, commit, import, tag: Specify the commit date.
102 99 * log, revert, update: Select revision(s) by date.
103 100
104 101 Many date formats are valid. Here are some examples:
105 102
106 103 "Wed Dec 6 13:18:29 2006" (local timezone assumed)
107 104 "Dec 6 13:18 -0600" (year assumed, time offset provided)
108 105 "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
109 106 "Dec 6" (midnight)
110 107 "13:18" (today assumed)
111 108 "3:39" (3:39AM assumed)
112 109 "3:39pm" (15:39)
113 110 "2006-12-06 13:18:29" (ISO 8601 format)
114 111 "2006-12-6 13:18"
115 112 "2006-12-6"
116 113 "12-6"
117 114 "12/6"
118 115 "12/6/6" (Dec 6 2006)
119 116
120 117 Lastly, there is Mercurial's internal format:
121 118
122 119 "1165432709 0" (Wed Dec 6 13:18:29 2006 UTC)
123 120
124 This is the internal representation format for dates. unixtime is
125 the number of seconds since the epoch (1970-01-01 00:00 UTC).
126 offset is the offset of the local timezone, in seconds west of UTC
127 (negative if the timezone is east of UTC).
121 This is the internal representation format for dates. unixtime is the
122 number of seconds since the epoch (1970-01-01 00:00 UTC). offset is the
123 offset of the local timezone, in seconds west of UTC (negative if the
124 timezone is east of UTC).
128 125
129 126 The log command also accepts date ranges:
130 127
131 128 "<{datetime}" - at or before a given date/time
132 129 ">{datetime}" - on or after a given date/time
133 130 "{datetime} to {datetime}" - a date range, inclusive
134 131 "-{days}" - within a given number of days of today
135 132 ''')),
136 133
137 134 (["patterns"], _("File Name Patterns"),
138 135 _(r'''
139 Mercurial accepts several notations for identifying one or more
140 files at a time.
136 Mercurial accepts several notations for identifying one or more files at a
137 time.
141 138
142 By default, Mercurial treats filenames as shell-style extended
143 glob patterns.
139 By default, Mercurial treats filenames as shell-style extended glob
140 patterns.
144 141
145 142 Alternate pattern notations must be specified explicitly.
146 143
147 To use a plain path name without any pattern matching, start it
148 with "path:". These path names must completely match starting at
149 the current repository root.
144 To use a plain path name without any pattern matching, start it with
145 "path:". These path names must completely match starting at the current
146 repository root.
150 147
151 To use an extended glob, start a name with "glob:". Globs are
152 rooted at the current directory; a glob such as "*.c" will only
153 match files in the current directory ending with ".c".
148 To use an extended glob, start a name with "glob:". Globs are rooted at
149 the current directory; a glob such as "*.c" will only match files in the
150 current directory ending with ".c".
154 151
155 The supported glob syntax extensions are "**" to match any string
156 across path separators and "{a,b}" to mean "a or b".
152 The supported glob syntax extensions are "**" to match any string across
153 path separators and "{a,b}" to mean "a or b".
157 154
158 To use a Perl/Python regular expression, start a name with "re:".
159 Regexp pattern matching is anchored at the root of the repository.
155 To use a Perl/Python regular expression, start a name with "re:". Regexp
156 pattern matching is anchored at the root of the repository.
160 157
161 158 Plain examples:
162 159
163 160 path:foo/bar a name bar in a directory named foo in the root of
164 161 the repository
165 162 path:path:name a file or directory named "path:name"
166 163
167 164 Glob examples:
168 165
169 166 glob:*.c any name ending in ".c" in the current directory
170 167 *.c any name ending in ".c" in the current directory
171 **.c any name ending in ".c" in any subdirectory of the
172 current directory including itself.
168 **.c any name ending in ".c" in any subdirectory of the current
169 directory including itself.
173 170 foo/*.c any name ending in ".c" in the directory foo
174 171 foo/**.c any name ending in ".c" in any subdirectory of foo
175 172 including itself.
176 173
177 174 Regexp examples:
178 175
179 176 re:.*\.c$ any name ending in ".c", anywhere in the repository
180 177
181 178 ''')),
182 179
183 180 (['environment', 'env'], _('Environment Variables'),
184 181 _(r'''
185 182 HG::
186 Path to the 'hg' executable, automatically passed when running
187 hooks, extensions or external tools. If unset or empty, this is
188 the hg executable's name if it's frozen, or an executable named
189 'hg' (with %PATHEXT% [defaulting to COM/EXE/BAT/CMD] extensions on
190 Windows) is searched.
183 Path to the 'hg' executable, automatically passed when running hooks,
184 extensions or external tools. If unset or empty, this is the hg
185 executable's name if it's frozen, or an executable named 'hg' (with
186 %PATHEXT% [defaulting to COM/EXE/BAT/CMD] extensions on Windows) is
187 searched.
191 188
192 189 HGEDITOR::
193 190 This is the name of the editor to run when committing. See EDITOR.
194 191
195 192 (deprecated, use .hgrc)
196 193
197 194 HGENCODING::
198 This overrides the default locale setting detected by Mercurial.
199 This setting is used to convert data including usernames,
200 changeset descriptions, tag names, and branches. This setting can
201 be overridden with the --encoding command-line option.
195 This overrides the default locale setting detected by Mercurial. This
196 setting is used to convert data including usernames, changeset
197 descriptions, tag names, and branches. This setting can be overridden with
198 the --encoding command-line option.
202 199
203 200 HGENCODINGMODE::
204 This sets Mercurial's behavior for handling unknown characters
205 while transcoding user input. The default is "strict", which
206 causes Mercurial to abort if it can't map a character. Other
207 settings include "replace", which replaces unknown characters, and
208 "ignore", which drops them. This setting can be overridden with
209 the --encodingmode command-line option.
201 This sets Mercurial's behavior for handling unknown characters while
202 transcoding user input. The default is "strict", which causes Mercurial to
203 abort if it can't map a character. Other settings include "replace", which
204 replaces unknown characters, and "ignore", which drops them. This setting
205 can be overridden with the --encodingmode command-line option.
210 206
211 207 HGMERGE::
212 An executable to use for resolving merge conflicts. The program
213 will be executed with three arguments: local file, remote file,
214 ancestor file.
208 An executable to use for resolving merge conflicts. The program will be
209 executed with three arguments: local file, remote file, ancestor file.
215 210
216 211 (deprecated, use .hgrc)
217 212
218 213 HGRCPATH::
219 A list of files or directories to search for hgrc files. Item
220 separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set,
221 platform default search path is used. If empty, only the .hg/hgrc
222 from the current repository is read.
214 A list of files or directories to search for hgrc files. Item separator is
215 ":" on Unix, ";" on Windows. If HGRCPATH is not set, platform default
216 search path is used. If empty, only the .hg/hgrc from the current
217 repository is read.
223 218
224 219 For each element in HGRCPATH:
225 220 * if it's a directory, all files ending with .rc are added
226 221 * otherwise, the file itself will be added
227 222
228 223 HGUSER::
229 This is the string used as the author of a commit. If not set,
230 available values will be considered in this order:
224 This is the string used as the author of a commit. If not set, available
225 values will be considered in this order:
231 226
232 227 * HGUSER (deprecated)
233 228 * hgrc files from the HGRCPATH
234 229 * EMAIL
235 230 * interactive prompt
236 231 * LOGNAME (with '@hostname' appended)
237 232
238 233 (deprecated, use .hgrc)
239 234
240 235 EMAIL::
241 236 May be used as the author of a commit; see HGUSER.
242 237
243 238 LOGNAME::
244 239 May be used as the author of a commit; see HGUSER.
245 240
246 241 VISUAL::
247 242 This is the name of the editor to use when committing. See EDITOR.
248 243
249 244 EDITOR::
250 Sometimes Mercurial needs to open a text file in an editor for a
251 user to modify, for example when writing commit messages. The
252 editor it uses is determined by looking at the environment
253 variables HGEDITOR, VISUAL and EDITOR, in that order. The first
254 non-empty one is chosen. If all of them are empty, the editor
255 defaults to 'vi'.
245 Sometimes Mercurial needs to open a text file in an editor for a user to
246 modify, for example when writing commit messages. The editor it uses is
247 determined by looking at the environment variables HGEDITOR, VISUAL and
248 EDITOR, in that order. The first non-empty one is chosen. If all of them
249 are empty, the editor defaults to 'vi'.
256 250
257 251 PYTHONPATH::
258 This is used by Python to find imported modules and may need to be
259 set appropriately if this Mercurial is not installed system-wide.
252 This is used by Python to find imported modules and may need to be set
253 appropriately if this Mercurial is not installed system-wide.
260 254 ''')),
261 255
262 256 (['revs', 'revisions'], _('Specifying Single Revisions'),
263 257 _(r'''
264 258 Mercurial supports several ways to specify individual revisions.
265 259
266 A plain integer is treated as a revision number. Negative integers
267 are treated as topological offsets from the tip, with -1 denoting
268 the tip. As such, negative numbers are only useful if you've
269 memorized your local tree numbers and want to save typing a single
270 digit. This editor suggests copy and paste.
260 A plain integer is treated as a revision number. Negative integers are
261 treated as topological offsets from the tip, with -1 denoting the tip. As
262 such, negative numbers are only useful if you've memorized your local tree
263 numbers and want to save typing a single digit. This editor suggests copy
264 and paste.
271 265
272 A 40-digit hexadecimal string is treated as a unique revision
273 identifier.
266 A 40-digit hexadecimal string is treated as a unique revision identifier.
274 267
275 A hexadecimal string less than 40 characters long is treated as a
276 unique revision identifier, and referred to as a short-form
277 identifier. A short-form identifier is only valid if it is the
278 prefix of exactly one full-length identifier.
268 A hexadecimal string less than 40 characters long is treated as a unique
269 revision identifier, and referred to as a short-form identifier. A
270 short-form identifier is only valid if it is the prefix of exactly one
271 full-length identifier.
279 272
280 Any other string is treated as a tag name, which is a symbolic
281 name associated with a revision identifier. Tag names may not
282 contain the ":" character.
273 Any other string is treated as a tag name, which is a symbolic name
274 associated with a revision identifier. Tag names may not contain the ":"
275 character.
283 276
284 The reserved name "tip" is a special tag that always identifies
285 the most recent revision.
277 The reserved name "tip" is a special tag that always identifies the most
278 recent revision.
286 279
287 The reserved name "null" indicates the null revision. This is the
288 revision of an empty repository, and the parent of revision 0.
280 The reserved name "null" indicates the null revision. This is the revision
281 of an empty repository, and the parent of revision 0.
289 282
290 The reserved name "." indicates the working directory parent. If
291 no working directory is checked out, it is equivalent to null. If
292 an uncommitted merge is in progress, "." is the revision of the
293 first parent.
283 The reserved name "." indicates the working directory parent. If no
284 working directory is checked out, it is equivalent to null. If an
285 uncommitted merge is in progress, "." is the revision of the first parent.
294 286 ''')),
295 287
296 288 (['mrevs', 'multirevs'], _('Specifying Multiple Revisions'),
297 289 _(r'''
298 When Mercurial accepts more than one revision, they may be
299 specified individually, or provided as a topologically continuous
300 range, separated by the ":" character.
290 When Mercurial accepts more than one revision, they may be specified
291 individually, or provided as a topologically continuous range, separated
292 by the ":" character.
301 293
302 The syntax of range notation is [BEGIN]:[END], where BEGIN and END
303 are revision identifiers. Both BEGIN and END are optional. If
304 BEGIN is not specified, it defaults to revision number 0. If END
305 is not specified, it defaults to the tip. The range ":" thus means
306 "all revisions".
294 The syntax of range notation is [BEGIN]:[END], where BEGIN and END are
295 revision identifiers. Both BEGIN and END are optional. If BEGIN is not
296 specified, it defaults to revision number 0. If END is not specified, it
297 defaults to the tip. The range ":" thus means "all revisions".
307 298
308 If BEGIN is greater than END, revisions are treated in reverse
309 order.
299 If BEGIN is greater than END, revisions are treated in reverse order.
310 300
311 A range acts as a closed interval. This means that a range of 3:5
312 gives 3, 4 and 5. Similarly, a range of 9:6 gives 9, 8, 7, and 6.
301 A range acts as a closed interval. This means that a range of 3:5 gives 3,
302 4 and 5. Similarly, a range of 9:6 gives 9, 8, 7, and 6.
313 303 ''')),
314 304
315 305 (['diffs'], _('Diff Formats'),
316 306 _(r'''
317 Mercurial's default format for showing changes between two
318 versions of a file is compatible with the unified format of GNU
319 diff, which can be used by GNU patch and many other standard
320 tools.
307 Mercurial's default format for showing changes between two versions of a
308 file is compatible with the unified format of GNU diff, which can be used
309 by GNU patch and many other standard tools.
321 310
322 311 While this standard format is often enough, it does not encode the
323 312 following information:
324 313
325 314 - executable status and other permission bits
326 315 - copy or rename information
327 316 - changes in binary files
328 317 - creation or deletion of empty files
329 318
330 Mercurial also supports the extended diff format from the git VCS
331 which addresses these limitations. The git diff format is not
332 produced by default because a few widespread tools still do not
333 understand this format.
319 Mercurial also supports the extended diff format from the git VCS which
320 addresses these limitations. The git diff format is not produced by
321 default because a few widespread tools still do not understand this
322 format.
334 323
335 This means that when generating diffs from a Mercurial repository
336 (e.g. with "hg export"), you should be careful about things like
337 file copies and renames or other things mentioned above, because
338 when applying a standard diff to a different repository, this
339 extra information is lost. Mercurial's internal operations (like
340 push and pull) are not affected by this, because they use an
341 internal binary format for communicating changes.
324 This means that when generating diffs from a Mercurial repository (e.g.
325 with "hg export"), you should be careful about things like file copies and
326 renames or other things mentioned above, because when applying a standard
327 diff to a different repository, this extra information is lost.
328 Mercurial's internal operations (like push and pull) are not affected by
329 this, because they use an internal binary format for communicating
330 changes.
342 331
343 To make Mercurial produce the git extended diff format, use the
344 --git option available for many commands, or set 'git = True' in
345 the [diff] section of your hgrc. You do not need to set this
346 option when importing diffs in this format or using them in the mq
347 extension.
332 To make Mercurial produce the git extended diff format, use the --git
333 option available for many commands, or set 'git = True' in the [diff]
334 section of your hgrc. You do not need to set this option when importing
335 diffs in this format or using them in the mq extension.
348 336 ''')),
349 337 (['templating'], _('Template Usage'),
350 338 _(r'''
351 Mercurial allows you to customize output of commands through
352 templates. You can either pass in a template from the command
353 line, via the --template option, or select an existing
354 template-style (--style).
339 Mercurial allows you to customize output of commands through templates.
340 You can either pass in a template from the command line, via the
341 --template option, or select an existing template-style (--style).
355 342
356 You can customize output for any "log-like" command: log,
357 outgoing, incoming, tip, parents, heads and glog.
343 You can customize output for any "log-like" command: log, outgoing,
344 incoming, tip, parents, heads and glog.
358 345
359 Three styles are packaged with Mercurial: default (the style used
360 when no explicit preference is passed), compact and changelog.
361 Usage:
346 Three styles are packaged with Mercurial: default (the style used when no
347 explicit preference is passed), compact and changelog. Usage:
362 348
363 349 $ hg log -r1 --style changelog
364 350
365 A template is a piece of text, with markup to invoke variable
366 expansion:
351 A template is a piece of text, with markup to invoke variable expansion:
367 352
368 353 $ hg log -r1 --template "{node}\n"
369 354 b56ce7b07c52de7d5fd79fb89701ea538af65746
370 355
371 Strings in curly braces are called keywords. The availability of
372 keywords depends on the exact context of the templater. These
373 keywords are usually available for templating a log-like command:
356 Strings in curly braces are called keywords. The availability of keywords
357 depends on the exact context of the templater. These keywords are usually
358 available for templating a log-like command:
374 359
375 360 - author: String. The unmodified author of the changeset.
376 - branches: String. The name of the branch on which the changeset
377 was committed. Will be empty if the branch name was default.
361 - branches: String. The name of the branch on which the changeset was
362 committed. Will be empty if the branch name was default.
378 363 - date: Date information. The date when the changeset was committed.
379 364 - desc: String. The text of the changeset description.
380 - diffstat: String. Statistics of changes with the following
381 format: "modified files: +added/-removed lines"
382 - files: List of strings. All files modified, added, or removed by
383 this changeset.
365 - diffstat: String. Statistics of changes with the following format:
366 "modified files: +added/-removed lines"
367 - files: List of strings. All files modified, added, or removed by this
368 changeset.
384 369 - file_adds: List of strings. Files added by this changeset.
385 370 - file_mods: List of strings. Files modified by this changeset.
386 371 - file_dels: List of strings. Files removed by this changeset.
387 - node: String. The changeset identification hash, as a
388 40-character hexadecimal string.
372 - node: String. The changeset identification hash, as a 40-character
373 hexadecimal string.
389 374 - parents: List of strings. The parents of the changeset.
390 375 - rev: Integer. The repository-local changeset revision number.
391 376 - tags: List of strings. Any tags associated with the changeset.
392 377
393 The "date" keyword does not produce human-readable output. If you
394 want to use a date in your output, you can use a filter to process
395 it. Filters are functions which return a string based on the input
396 variable. You can also use a chain of filters to get the desired
397 output:
378 The "date" keyword does not produce human-readable output. If you want to
379 use a date in your output, you can use a filter to process it. Filters are
380 functions which return a string based on the input variable. You can also
381 use a chain of filters to get the desired output:
398 382
399 383 $ hg tip --template "{date|isodate}\n"
400 384 2008-08-21 18:22 +0000
401 385
402 386 List of filters:
403 387
404 - addbreaks: Any text. Add an XHTML "<br />" tag before the end of
405 every line except the last.
406 - age: Date. Returns a human-readable date/time difference between
407 the given date/time and the current date/time.
408 - basename: Any text. Treats the text as a path, and returns the
409 last component of the path after splitting by the path
410 separator (ignoring trailing separators). For example,
411 "foo/bar/baz" becomes "baz" and "foo/bar//" becomes "bar".
388 - addbreaks: Any text. Add an XHTML "<br />" tag before the end of every
389 line except the last.
390 - age: Date. Returns a human-readable date/time difference between the
391 given date/time and the current date/time.
392 - basename: Any text. Treats the text as a path, and returns the last
393 component of the path after splitting by the path separator
394 (ignoring trailing separators). For example, "foo/bar/baz" becomes
395 "baz" and "foo/bar//" becomes "bar".
412 396 - stripdir: Treat the text as path and strip a directory level, if
413 397 possible. For example, "foo" and "foo/bar" becomes "foo".
414 - date: Date. Returns a date in a Unix date format, including
415 the timezone: "Mon Sep 04 15:13:13 2006 0700".
416 - domain: Any text. Finds the first string that looks like an
417 email address, and extracts just the domain component.
418 Example: 'User <user@example.com>' becomes 'example.com'.
419 - email: Any text. Extracts the first string that looks like an
420 email address. Example: 'User <user@example.com>' becomes
398 - date: Date. Returns a date in a Unix date format, including the
399 timezone: "Mon Sep 04 15:13:13 2006 0700".
400 - domain: Any text. Finds the first string that looks like an email
401 address, and extracts just the domain component. Example: 'User
402 <user@example.com>' becomes 'example.com'.
403 - email: Any text. Extracts the first string that looks like an email
404 address. Example: 'User <user@example.com>' becomes
421 405 'user@example.com'.
422 - escape: Any text. Replaces the special XML/XHTML characters "&",
423 "<" and ">" with XML entities.
406 - escape: Any text. Replaces the special XML/XHTML characters "&", "<" and
407 ">" with XML entities.
424 408 - fill68: Any text. Wraps the text to fit in 68 columns.
425 409 - fill76: Any text. Wraps the text to fit in 76 columns.
426 410 - firstline: Any text. Returns the first line of text.
427 411 - nonempty: Any text. Returns '(none)' if the string is empty.
428 - hgdate: Date. Returns the date as a pair of numbers:
429 "1157407993 25200" (Unix timestamp, timezone offset).
412 - hgdate: Date. Returns the date as a pair of numbers: "1157407993 25200"
413 (Unix timestamp, timezone offset).
430 414 - isodate: Date. Returns the date in ISO 8601 format.
431 415 - localdate: Date. Converts a date to local date.
432 - obfuscate: Any text. Returns the input text rendered as a
433 sequence of XML entities.
416 - obfuscate: Any text. Returns the input text rendered as a sequence of
417 XML entities.
434 418 - person: Any text. Returns the text before an email address.
435 - rfc822date: Date. Returns a date using the same format used
436 in email headers.
437 - short: Changeset hash. Returns the short form of a changeset
438 hash, i.e. a 12-byte hexadecimal string.
419 - rfc822date: Date. Returns a date using the same format used in email
420 headers.
421 - short: Changeset hash. Returns the short form of a changeset hash, i.e.
422 a 12-byte hexadecimal string.
439 423 - shortdate: Date. Returns a date like "2006-09-18".
440 424 - strip: Any text. Strips all leading and trailing whitespace.
441 - tabindent: Any text. Returns the text, with every line except
442 the first starting with a tab character.
443 - urlescape: Any text. Escapes all "special" characters. For
444 example, "foo bar" becomes "foo%20bar".
425 - tabindent: Any text. Returns the text, with every line except the first
426 starting with a tab character.
427 - urlescape: Any text. Escapes all "special" characters. For example, "foo
428 bar" becomes "foo%20bar".
445 429 - user: Any text. Returns the user portion of an email address.
446 430 ''')),
447 431
448 432 (['urls'], _('URL Paths'),
449 433 _(r'''
450 434 Valid URLs are of the form:
451 435
452 436 local/filesystem/path[#revision]
453 437 file://local/filesystem/path[#revision]
454 438 http://[user[:pass]@]host[:port]/[path][#revision]
455 439 https://[user[:pass]@]host[:port]/[path][#revision]
456 440 ssh://[user[:pass]@]host[:port]/[path][#revision]
457 441
458 Paths in the local filesystem can either point to Mercurial
459 repositories or to bundle files (as created by 'hg bundle' or
460 'hg incoming --bundle').
442 Paths in the local filesystem can either point to Mercurial repositories
443 or to bundle files (as created by 'hg bundle' or 'hg incoming --bundle').
461 444
462 An optional identifier after # indicates a particular branch, tag,
463 or changeset to use from the remote repository. See also 'hg help
464 revisions'.
445 An optional identifier after # indicates a particular branch, tag, or
446 changeset to use from the remote repository. See also 'hg help revisions'.
465 447
466 Some features, such as pushing to http:// and https:// URLs are
467 only possible if the feature is explicitly enabled on the remote
468 Mercurial server.
448 Some features, such as pushing to http:// and https:// URLs are only
449 possible if the feature is explicitly enabled on the remote Mercurial
450 server.
469 451
470 452 Some notes about using SSH with Mercurial:
471 - SSH requires an accessible shell account on the destination
472 machine and a copy of hg in the remote path or specified with as
473 remotecmd.
474 - path is relative to the remote user's home directory by default.
475 Use an extra slash at the start of a path to specify an absolute path:
453 - SSH requires an accessible shell account on the destination machine and
454 a copy of hg in the remote path or specified with as remotecmd.
455 - path is relative to the remote user's home directory by default. Use an
456 extra slash at the start of a path to specify an absolute path:
476 457 ssh://example.com//tmp/repository
477 - Mercurial doesn't use its own compression via SSH; the right
478 thing to do is to configure it in your ~/.ssh/config, e.g.:
458 - Mercurial doesn't use its own compression via SSH; the right thing to do
459 is to configure it in your ~/.ssh/config, e.g.:
479 460 Host *.mylocalnetwork.example.com
480 461 Compression no
481 462 Host *
482 463 Compression yes
483 Alternatively specify "ssh -C" as your ssh command in your hgrc
484 or with the --ssh command line option.
464 Alternatively specify "ssh -C" as your ssh command in your hgrc or with
465 the --ssh command line option.
485 466
486 These URLs can all be stored in your hgrc with path aliases under
487 the [paths] section like so:
467 These URLs can all be stored in your hgrc with path aliases under the
468 [paths] section like so:
488 469 [paths]
489 470 alias1 = URL1
490 471 alias2 = URL2
491 472 ...
492 473
493 You can then use the alias for any command that uses a URL (for
494 example 'hg pull alias1' would pull from the 'alias1' path).
474 You can then use the alias for any command that uses a URL (for example
475 'hg pull alias1' would pull from the 'alias1' path).
495 476
496 Two path aliases are special because they are used as defaults
497 when you do not provide the URL to a command:
477 Two path aliases are special because they are used as defaults when you do
478 not provide the URL to a command:
498 479
499 480 default:
500 When you create a repository with hg clone, the clone command
501 saves the location of the source repository as the new
502 repository's 'default' path. This is then used when you omit
503 path from push- and pull-like commands (including incoming and
504 outgoing).
481 When you create a repository with hg clone, the clone command saves the
482 location of the source repository as the new repository's 'default'
483 path. This is then used when you omit path from push- and pull-like
484 commands (including incoming and outgoing).
505 485
506 486 default-push:
507 The push command will look for a path named 'default-push', and
508 prefer it over 'default' if both are defined.
487 The push command will look for a path named 'default-push', and prefer
488 it over 'default' if both are defined.
509 489 ''')),
510 490 (["extensions"], _("Using additional features"), extshelp),
511 491 )
General Comments 0
You need to be logged in to leave comments. Login now