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