mercurial-scm/hg-stable: mercurial/help.py annotate

annotate mercurial/help.py @ 7012:78341ea65d16

restructure helptable When looking up a help topic, the key is now only matched against the short names for each topic, and not the header. So hg help 'Environment Variables' must be replaced with hg help env

author	Martin Geisler <mg@daimi.au.dk>
date	Tue, 09 Sep 2008 21:32:39 +0200
parents	c68f84448012
children	f56e788fa292

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 #
17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	5 # This software may be used and distributed according to the terms
17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	6 # of the GNU General Public License, incorporated herein by reference.
17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	7
6654 2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	8 helptable = (
7012 78341ea65d16 restructure helptable Martin Geisler <mg@daimi.au.dk> parents: 6773 diff changeset	9 (["dates"], "Date Formats",
3795 17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	10 r'''
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	11 Some commands allow the user to specify a date:
1f733c2f0165 Document log date ranges and mention 'hg help dates' for all commands (issue998) Thomas Arendsen Hein <thomas@intevation.de> parents: 6009 diff changeset	12 backout, commit, import, tag: Specify the commit date.
1f733c2f0165 Document log date ranges and mention 'hg help dates' for all commands (issue998) Thomas Arendsen Hein <thomas@intevation.de> parents: 6009 diff changeset	13 log, revert, update: Select revision(s) by date.
1f733c2f0165 Document log date ranges and mention 'hg help dates' for all commands (issue998) Thomas Arendsen Hein <thomas@intevation.de> parents: 6009 diff changeset	14
1f733c2f0165 Document log date ranges and mention 'hg help dates' for all commands (issue998) Thomas Arendsen Hein <thomas@intevation.de> parents: 6009 diff changeset	15 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	16
3811 6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	17 "Wed Dec 6 13:18:29 2006" (local timezone assumed)
6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	18 "Dec 6 13:18 -0600" (year assumed, time offset provided)
6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	19 "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	20 "Dec 6" (midnight)
6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	21 "13:18" (today assumed)
6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	22 "3:39" (3:39AM assumed)
6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	23 "3:39pm" (15:39)
6773 c68f84448012 fix iso date help Matt Mackall <mpm@selenic.com> parents: 6655 diff changeset	24 "2006-12-06 13:18:29" (ISO 8601 format)
3811 6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	25 "2006-12-6 13:18"
6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	26 "2006-12-6"
6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	27 "12-6"
6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	28 "12/6"
6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	29 "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	30
3811 6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	31 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	32
3811 6fa11a9d7cac Update dates help topic Matt Mackall <mpm@selenic.com> parents: 3799 diff changeset	33 "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	34
17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	35 This is the internal representation format for dates. unixtime is
17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	36 the number of seconds since the epoch (1970-01-01 00:00 UTC). offset
17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	37 is the offset of the local timezone, in seconds west of UTC (negative
17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	38 if the 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	39
1f733c2f0165 Document log date ranges and mention 'hg help dates' for all commands (issue998) Thomas Arendsen Hein <thomas@intevation.de> parents: 6009 diff changeset	40 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	41
1f733c2f0165 Document log date ranges and mention 'hg help dates' for all commands (issue998) Thomas Arendsen Hein <thomas@intevation.de> parents: 6009 diff changeset	42 "<{date}" - on or before a given date
1f733c2f0165 Document log date ranges and mention 'hg help dates' for all commands (issue998) Thomas Arendsen Hein <thomas@intevation.de> parents: 6009 diff changeset	43 ">{date}" - on or after a given date
1f733c2f0165 Document log date ranges and mention 'hg help dates' for all commands (issue998) Thomas Arendsen Hein <thomas@intevation.de> parents: 6009 diff changeset	44 "{date} to {date}" - a date range, inclusive
1f733c2f0165 Document log date ranges and mention 'hg help dates' for all commands (issue998) Thomas Arendsen Hein <thomas@intevation.de> parents: 6009 diff changeset	45 "-{days}" - within a given number of days of today
6654 2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	46 '''),
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	47
7012 78341ea65d16 restructure helptable Martin Geisler <mg@daimi.au.dk> parents: 6773 diff changeset	48 (["patterns"], "File Name Patterns",
6654 2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	49 r'''
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	50 Mercurial accepts several notations for identifying one or more
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	51 files at a time.
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	52
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	53 By default, Mercurial treats filenames as shell-style extended
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	54 glob patterns.
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	55
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	56 Alternate pattern notations must be specified explicitly.
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	57
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	58 To use a plain path name without any pattern matching, start a
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	59 name with "path:". These path names must match completely, from
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	60 the root of the current repository.
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	61
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	62 To use an extended glob, start a name with "glob:". Globs are
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	63 rooted at the current directory; a glob such as "*.c" will match
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	64 files ending in ".c" in the current directory only.
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	65
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	66 The supported glob syntax extensions are "**" to match any string
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	67 across path separators, and "{a,b}" to mean "a or b".
3799 eb66d76c7746 move patterns topics Matt Mackall <mpm@selenic.com> parents: 3798 diff changeset	68
6654 2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	69 To use a Perl/Python regular expression, start a name with "re:".
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	70 Regexp pattern matching is anchored at the root of the repository.
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	71
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	72 Plain examples:
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	73
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	74 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	75 the repository
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	76 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	77
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	78 Glob examples:
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	79
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	80 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	81 *.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	82 **.c any name ending in ".c" in the current directory, or
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	83 any subdirectory
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	84 foo/*.c any name ending in ".c" in the directory foo
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	85 foo/**.c any name ending in ".c" in the directory foo, or any
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	86 subdirectory
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	87
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	88 Regexp examples:
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	89
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	90 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	91
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	92 '''),
2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	93
7012 78341ea65d16 restructure helptable Martin Geisler <mg@daimi.au.dk> parents: 6773 diff changeset	94 (['environment', 'env'], 'Environment Variables',
3798 6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	95 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	96 HG::
5062 3d35c8cb5eb4 Simplify/correct finding the hg executable (fixes issue644) Thomas Arendsen Hein <thomas@intevation.de> parents: 4686 diff changeset	97 Path to the 'hg' executable, automatically passed when running hooks,
3d35c8cb5eb4 Simplify/correct finding the hg executable (fixes issue644) Thomas Arendsen Hein <thomas@intevation.de> parents: 4686 diff changeset	98 extensions or external tools. If unset or empty, an executable named
3d35c8cb5eb4 Simplify/correct finding the hg executable (fixes issue644) Thomas Arendsen Hein <thomas@intevation.de> parents: 4686 diff changeset	99 'hg' (with com/exe/bat/cmd extension on Windows) is 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	100
3798 6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	101 HGEDITOR::
5660 3c80ecdc1bcd Use VISUAL in addition to EDITOR when choosing the editor to use. Osku Salerma <osku@iki.fi> parents: 5062 diff changeset	102 This is the name of the editor to use when committing. See EDITOR.
3798 6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	103
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	104 (deprecated, use .hgrc)
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	105
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	106 HGENCODING::
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	107 This overrides the default locale setting detected by Mercurial.
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	108 This setting is used to convert data including usernames,
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	109 changeset descriptions, tag names, and branches. This setting can
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	110 be overridden with the --encoding command-line option.
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	111
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	112 HGENCODINGMODE::
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	113 This sets Mercurial's behavior for handling unknown characters
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	114 while transcoding user inputs. The default is "strict", which
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	115 causes Mercurial to abort if it can't translate a character. Other
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	116 settings include "replace", which replaces unknown characters, and
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	117 "ignore", which drops them. This setting can be overridden with
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	118 the --encodingmode command-line option.
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	119
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	120 HGMERGE::
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	121 An executable to use for resolving merge conflicts. The program
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	122 will be executed with three arguments: local file, remote file,
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	123 ancestor file.
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	124
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	125 (deprecated, use .hgrc)
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	126
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	127 HGRCPATH::
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	128 A list of files or directories to search for hgrc files. Item
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	129 separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set,
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	130 platform default search path is used. If empty, only .hg/hgrc of
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	131 current repository is read.
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	132
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	133 For each element in path, if a directory, all entries in directory
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	134 ending with ".rc" are added to path. Else, element itself is
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	135 added to path.
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	136
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	137 HGUSER::
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	138 This is the string used for the author of a commit.
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	139
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	140 (deprecated, use .hgrc)
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	141
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	142 EMAIL::
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	143 If HGUSER is not set, this will be used as the author for a commit.
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	144
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	145 LOGNAME::
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	146 If neither HGUSER nor EMAIL is set, LOGNAME will be used (with
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	147 '@hostname' appended) as the author value for a commit.
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	148
5660 3c80ecdc1bcd Use VISUAL in addition to EDITOR when choosing the editor to use. Osku Salerma <osku@iki.fi> parents: 5062 diff changeset	149 VISUAL::
3c80ecdc1bcd Use VISUAL in addition to EDITOR when choosing the editor to use. Osku Salerma <osku@iki.fi> parents: 5062 diff changeset	150 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	151
3798 6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	152 EDITOR::
6009 f077815932ce filemerge: remove the hgmerge script Matt Mackall <mpm@selenic.com> parents: 5660 diff changeset	153 Sometimes Mercurial needs to open a text file in an editor
f077815932ce filemerge: remove the hgmerge script Matt Mackall <mpm@selenic.com> parents: 5660 diff changeset	154 for a user to modify, for example when writing commit messages.
f077815932ce filemerge: remove the hgmerge script Matt Mackall <mpm@selenic.com> parents: 5660 diff changeset	155 The editor it uses is determined by looking at the environment
f077815932ce filemerge: remove the hgmerge script Matt Mackall <mpm@selenic.com> parents: 5660 diff changeset	156 variables HGEDITOR, VISUAL and EDITOR, in that order. The first
f077815932ce filemerge: remove the hgmerge script Matt Mackall <mpm@selenic.com> parents: 5660 diff changeset	157 non-empty one is chosen. If all of them are empty, the editor
5660 3c80ecdc1bcd Use VISUAL in addition to EDITOR when choosing the editor to use. Osku Salerma <osku@iki.fi> parents: 5062 diff changeset	158 defaults to 'vi'.
3798 6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	159
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	160 PYTHONPATH::
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	161 This is used by Python to find imported modules and may need to be set
6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	162 appropriately if Mercurial is not installed system-wide.
6654 2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	163 '''),
6655 ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	164
7012 78341ea65d16 restructure helptable Martin Geisler <mg@daimi.au.dk> parents: 6773 diff changeset	165 (['revs', 'revisions'], 'Specifying Single Revisions',
6655 ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	166 r'''
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	167 Mercurial accepts several notations for identifying individual
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	168 revisions.
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	169
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	170 A plain integer is treated as a revision number. Negative
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	171 integers are treated as offsets from the tip, with -1 denoting the
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	172 tip.
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	173
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	174 A 40-digit hexadecimal string is treated as a unique revision
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	175 identifier.
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	176
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	177 A hexadecimal string less than 40 characters long is treated as a
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	178 unique revision identifier, and referred to as a short-form
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	179 identifier. A short-form identifier is only valid if it is the
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	180 prefix of one full-length identifier.
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	181
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	182 Any other string is treated as a tag name, which is a symbolic
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	183 name associated with a revision identifier. Tag names may not
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	184 contain the ":" character.
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	185
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	186 The reserved name "tip" is a special tag that always identifies
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	187 the most recent revision.
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	188
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	189 The reserved name "null" indicates the null revision. This is the
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	190 revision of an empty repository, and the parent of revision 0.
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	191
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	192 The reserved name "." indicates the working directory parent. If
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	193 no working directory is checked out, it is equivalent to null.
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	194 If an uncommitted merge is in progress, "." is the revision of
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	195 the first parent.
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	196 '''),
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	197
7012 78341ea65d16 restructure helptable Martin Geisler <mg@daimi.au.dk> parents: 6773 diff changeset	198 (['mrevs', 'multirevs'], 'Specifying Multiple Revisions',
6655 ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	199 r'''
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	200 When Mercurial accepts more than one revision, they may be
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	201 specified individually, or provided as a continuous range,
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	202 separated by the ":" character.
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	203
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	204 The syntax of range notation is [BEGIN]:[END], where BEGIN and END
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	205 are revision identifiers. Both BEGIN and END are optional. If
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	206 BEGIN is not specified, it defaults to revision number 0. If END
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	207 is not specified, it defaults to the tip. The range ":" thus
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	208 means "all revisions".
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	209
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	210 If BEGIN is greater than END, revisions are treated in reverse
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	211 order.
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	212
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	213 A range acts as a closed interval. This means that a range of 3:5
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	214 gives 3, 4 and 5. Similarly, a range of 4:2 gives 4, 3, and 2.
ab798a37b846 help: move "revision syntax" help topics into online help Johannes Stezenbach <js@sig21.net> parents: 6654 diff changeset	215 '''),
6654 2713e42dcf4e help: helptable is an ordered collection Johannes Stezenbach <js@sig21.net> parents: 6163 diff changeset	216 )

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/help.py @ 7012:78341ea65d16