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

comparison mercurial/help.py @ 9325:74e717a21779

Merge with mpm

author	Bryan O'Sullivan <bos@serpentine.com>
date	Thu, 06 Aug 2009 18:48:00 -0700
parents	73bec717b825 81028d2db635
children	9a69ab6d7cf7

comparison

equal deleted inserted replaced

-:fb66a7d3f28f
+:74e717a21779
 def listexts(header, exts, maxlength):
 '''return a text listing of the given extensions'''
 if not exts:
 return ''
-result = '\n%s\n\n' % header
+# TODO: literal block is wrong, should be a field list or a simple table.
+result = '\n%s\n\n ::\n\n' % header
 for name, desc in sorted(exts.iteritems()):
-desc = util.wrap(desc, maxlength + 4)
+desc = util.wrap(desc, maxlength + 5)
-result += ' %s   %s\n' % (name.ljust(maxlength), desc)
+result += '  %s   %s\n' % (name.ljust(maxlength), desc)
 return result
 def extshelp():
 doc = _(r'''
 Mercurial has the ability to add new features through the use of
-extensions. Extensions may add new commands, add options to
+extensions. Extensions may add new commands, add options to existing
-existing commands, change the default behavior of commands, or
+commands, change the default behavior of commands, or implement hooks.
-implement hooks.
+Extensions are not loaded by default for a variety of reasons: they can
-Extensions are not loaded by default for a variety of reasons:
+increase startup overhead; they may be meant for advanced usage only; they
-they can increase startup overhead; they may be meant for
+may provide potentially dangerous abilities (such as letting you destroy
-advanced usage only; they may provide potentially dangerous
+or modify history); they might not be ready for prime time; or they may
-abilities (such as letting you destroy or modify history); they
+alter some usual behaviors of stock Mercurial. It is thus up to the user
-might not be ready for prime time; or they may alter some
+to activate extensions as needed.
-usual behaviors of stock Mercurial. It is thus up to the user to
-activate extensions as needed.
+To enable the "foo" extension, either shipped with Mercurial or in the
+Python search path, create an entry for it in your hgrc, like this::
-To enable the "foo" extension, either shipped with Mercurial
-or in the Python search path, create an entry for it in your
-hgrc, like this:
 [extensions]
 foo =
-You may also specify the full path to an extension:
+You may also specify the full path to an extension::
 [extensions]
 myfeature = ~/.hgext/myfeature.py
-To explicitly disable an extension enabled in an hgrc of broader
+To explicitly disable an extension enabled in an hgrc of broader scope,
-scope, prepend its path with !:
+prepend its path with !::
 [extensions]
 # disabling extension bar residing in /path/to/extension/bar.py
 hgext.bar = !/path/to/extension/bar.py
 # ditto, but no path was supplied for extension baz
 helptable = (
 (["dates"], _("Date Formats"),
 _(r'''
 Some commands allow the user to specify a date, e.g.:
-* backout, commit, import, tag: Specify the commit date.
-* log, revert, update: Select revision(s) by date.
+- backout, commit, import, tag: Specify the commit date.
+- log, revert, update: Select revision(s) by date.
-Many date formats are valid. Here are some examples:
+Many date formats are valid. Here are some examples::
-"Wed Dec 6 13:18:29 2006" (local timezone assumed)
-"Dec 6 13:18 -0600" (year assumed, time offset provided)
+"Wed Dec 6 13:18:29 2006" (local timezone assumed)
-"Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
+"Dec 6 13:18 -0600" (year assumed, time offset provided)
-"Dec 6" (midnight)
+"Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
-"13:18" (today assumed)
+"Dec 6" (midnight)
-"3:39" (3:39AM assumed)
+"13:18" (today assumed)
-"3:39pm" (15:39)
+"3:39" (3:39AM assumed)
-"2006-12-06 13:18:29" (ISO 8601 format)
+"3:39pm" (15:39)
-"2006-12-6 13:18"
+"2006-12-06 13:18:29" (ISO 8601 format)
-"2006-12-6"
+"2006-12-6 13:18"
-"12-6"
+"2006-12-6"
-"12/6"
+"12-6"
-"12/6/6" (Dec 6 2006)
+"12/6"
+"12/6/6" (Dec 6 2006)
 Lastly, there is Mercurial's internal format:
 "1165432709 0" (Wed Dec 6 13:18:29 2006 UTC)
-This is the internal representation format for dates. unixtime is
+This is the internal representation format for dates. unixtime is the
-the number of seconds since the epoch (1970-01-01 00:00 UTC).
+number of seconds since the epoch (1970-01-01 00:00 UTC). offset is the
-offset is the offset of the local timezone, in seconds west of UTC
+offset of the local timezone, in seconds west of UTC (negative if the
-(negative if the timezone is east of UTC).
+timezone is east of UTC).
-The log command also accepts date ranges:
+The log command also accepts date ranges::
 "<{datetime}" - at or before a given date/time
 ">{datetime}" - on or after a given date/time
 "{datetime} to {datetime}" - a date range, inclusive
 "-{days}" - within a given number of days of today
 ''')),
 (["patterns"], _("File Name Patterns"),
 _(r'''
-Mercurial accepts several notations for identifying one or more
+Mercurial accepts several notations for identifying one or more files at a
-files at a time.
+time.
-By default, Mercurial treats filenames as shell-style extended
+By default, Mercurial treats filenames as shell-style extended glob
-glob patterns.
+patterns.
 Alternate pattern notations must be specified explicitly.
-To use a plain path name without any pattern matching, start it
+To use a plain path name without any pattern matching, start it with
-with "path:". These path names must completely match starting at
+"path:". These path names must completely match starting at the current
-the current repository root.
+repository root.
-To use an extended glob, start a name with "glob:". Globs are
+To use an extended glob, start a name with "glob:". Globs are rooted at
-rooted at the current directory; a glob such as "*.c" will only
+the current directory; a glob such as "``*.c``" will only match files in the
-match files in the current directory ending with ".c".
+current directory ending with ".c".
-The supported glob syntax extensions are "**" to match any string
+The supported glob syntax extensions are "``**``" to match any string across
-across path separators and "{a,b}" to mean "a or b".
+path separators and "{a,b}" to mean "a or b".
-To use a Perl/Python regular expression, start a name with "re:".
+To use a Perl/Python regular expression, start a name with "re:". Regexp
-Regexp pattern matching is anchored at the root of the repository.
+pattern matching is anchored at the root of the repository.
-Plain examples:
+Plain examples::
 path:foo/bar   a name bar in a directory named foo in the root of
 the repository
 path:path:name a file or directory named "path:name"
-Glob examples:
+Glob examples::
 glob:*.c       any name ending in ".c" in the current directory
 *.c            any name ending in ".c" in the current directory
 **.c           any name ending in ".c" in any subdirectory of the
 current directory including itself.
 foo/*.c        any name ending in ".c" in the directory foo
 foo/**.c       any name ending in ".c" in any subdirectory of foo
 including itself.
-Regexp examples:
+Regexp examples::
 re:.*\.c$      any name ending in ".c", anywhere in the repository
 ''')),
 (['environment', 'env'], _('Environment Variables'),
 _(r'''
-HG::
+HG
-Path to the 'hg' executable, automatically passed when running
+Path to the 'hg' executable, automatically passed when running hooks,
-hooks, extensions or external tools. If unset or empty, this is
+extensions or external tools. If unset or empty, this is the hg
-the hg executable's name if it's frozen, or an executable named
+executable's name if it's frozen, or an executable named 'hg' (with
-'hg' (with %PATHEXT% [defaulting to COM/EXE/BAT/CMD] extensions on
+%PATHEXT% [defaulting to COM/EXE/BAT/CMD] extensions on Windows) is
-Windows) is searched.
+searched.
-HGEDITOR::
+HGEDITOR
 This is the name of the editor to run when committing. See EDITOR.
 (deprecated, use .hgrc)
-HGENCODING::
+HGENCODING
-This overrides the default locale setting detected by Mercurial.
+This overrides the default locale setting detected by Mercurial. This
-This setting is used to convert data including usernames,
+setting is used to convert data including usernames, changeset
-changeset descriptions, tag names, and branches. This setting can
+descriptions, tag names, and branches. This setting can be overridden with
-be overridden with the --encoding command-line option.
+the --encoding command-line option.
-HGENCODINGMODE::
+HGENCODINGMODE
-This sets Mercurial's behavior for handling unknown characters
+This sets Mercurial's behavior for handling unknown characters while
-while transcoding user input. The default is "strict", which
+transcoding user input. The default is "strict", which causes Mercurial to
-causes Mercurial to abort if it can't map a character. Other
+abort if it can't map a character. Other settings include "replace", which
-settings include "replace", which replaces unknown characters, and
+replaces unknown characters, and "ignore", which drops them. This setting
-"ignore", which drops them. This setting can be overridden with
+can be overridden with the --encodingmode command-line option.
-the --encodingmode command-line option.
+HGMERGE
-HGMERGE::
+An executable to use for resolving merge conflicts. The program will be
-An executable to use for resolving merge conflicts. The program
+executed with three arguments: local file, remote file, ancestor file.
-will be executed with three arguments: local file, remote file,
-ancestor file.
 (deprecated, use .hgrc)
-HGRCPATH::
+HGRCPATH
-A list of files or directories to search for hgrc files. Item
+A list of files or directories to search for hgrc files. Item separator is
-separator is ":" on Unix, ";" on Windows. If HGRCPATH is not set,
+":" on Unix, ";" on Windows. If HGRCPATH is not set, platform default
-platform default search path is used. If empty, only the .hg/hgrc
+search path is used. If empty, only the .hg/hgrc from the current
-from the current repository is read.
+repository is read.
 For each element in HGRCPATH:
-* if it's a directory, all files ending with .rc are added
-* otherwise, the file itself will be added
+- if it's a directory, all files ending with .rc are added
+- otherwise, the file itself will be added
-HGUSER::
-This is the string used as the author of a commit. If not set,
+HGUSER
-available values will be considered in this order:
+This is the string used as the author of a commit. If not set, available
+values will be considered in this order:
-* HGUSER (deprecated)
-* hgrc files from the HGRCPATH
+- HGUSER (deprecated)
-* EMAIL
+- hgrc files from the HGRCPATH
-* interactive prompt
+- EMAIL
-* LOGNAME (with '@hostname' appended)
+- interactive prompt
+- LOGNAME (with '@hostname' appended)
 (deprecated, use .hgrc)
-EMAIL::
+EMAIL
 May be used as the author of a commit; see HGUSER.
-LOGNAME::
+LOGNAME
 May be used as the author of a commit; see HGUSER.
-VISUAL::
+VISUAL
 This is the name of the editor to use when committing. See EDITOR.
-EDITOR::
+EDITOR
-Sometimes Mercurial needs to open a text file in an editor for a
+Sometimes Mercurial needs to open a text file in an editor for a user to
-user to modify, for example when writing commit messages. The
+modify, for example when writing commit messages. The editor it uses is
-editor it uses is determined by looking at the environment
+determined by looking at the environment variables HGEDITOR, VISUAL and
-variables HGEDITOR, VISUAL and EDITOR, in that order. The first
+EDITOR, in that order. The first non-empty one is chosen. If all of them
-non-empty one is chosen. If all of them are empty, the editor
+are empty, the editor defaults to 'vi'.
-defaults to 'vi'.
+PYTHONPATH
-PYTHONPATH::
+This is used by Python to find imported modules and may need to be set
-This is used by Python to find imported modules and may need to be
+appropriately if this Mercurial is not installed system-wide.
-set appropriately if this Mercurial is not installed system-wide.
 ''')),
 (['revs', 'revisions'], _('Specifying Single Revisions'),
 _(r'''
 Mercurial supports several ways to specify individual revisions.
-A plain integer is treated as a revision number. Negative integers
+A plain integer is treated as a revision number. Negative integers are
-are treated as sequential offsets from the tip, with -1 denoting
+treated as topological offsets from the tip, with -1 denoting the tip. As
-the tip, -2 denoting the revision prior to the tip, and so forth.
+such, negative numbers are only useful if you've memorized your local tree
+numbers and want to save typing a single digit. This editor suggests copy
-A 40-digit hexadecimal string is treated as a unique revision
+and paste.
-identifier.
+A 40-digit hexadecimal string is treated as a unique revision identifier.
-A hexadecimal string less than 40 characters long is treated as a
-unique revision identifier and is referred to as a short-form
+A hexadecimal string less than 40 characters long is treated as a unique
-identifier. A short-form identifier is only valid if it is the
+revision identifier, and referred to as a short-form identifier. A
-prefix of exactly one full-length identifier.
+short-form identifier is only valid if it is the prefix of exactly one
+full-length identifier.
-Any other string is treated as a tag or branch name. A tag name is
-a symbolic name associated with a revision identifier. A branch
+Any other string is treated as a tag name, which is a symbolic name
-name denotes the tipmost revision of that branch. Tag and branch
+associated with a revision identifier. Tag names may not contain the ":"
-names must not contain the ":" character.
+character.
-The reserved name "tip" is a special tag that always identifies
+The reserved name "tip" is a special tag that always identifies the most
-the most recent revision.
+recent revision.
-The reserved name "null" indicates the null revision. This is the
+The reserved name "null" indicates the null revision. This is the revision
-revision of an empty repository, and the parent of revision 0.
+of an empty repository, and the parent of revision 0.
-The reserved name "." indicates the working directory parent. If
+The reserved name "." indicates the working directory parent. If no
-no working directory is checked out, it is equivalent to null. If
+working directory is checked out, it is equivalent to null. If an
-an uncommitted merge is in progress, "." is the revision of the
+uncommitted merge is in progress, "." is the revision of the first parent.
-first parent.
 ''')),
 (['mrevs', 'multirevs'], _('Specifying Multiple Revisions'),
 _(r'''
-When Mercurial accepts more than one revision, they may be
+When Mercurial accepts more than one revision, they may be specified
-specified individually, or provided as a topologically continuous
+individually, or provided as a topologically continuous range, separated
-range, separated by the ":" character.
+by the ":" character.
-The syntax of range notation is [BEGIN]:[END], where BEGIN and END
+The syntax of range notation is [BEGIN]:[END], where BEGIN and END are
-are revision identifiers. Both BEGIN and END are optional. If
+revision identifiers. Both BEGIN and END are optional. If BEGIN is not
-BEGIN is not specified, it defaults to revision number 0. If END
+specified, it defaults to revision number 0. If END is not specified, it
-is not specified, it defaults to the tip. The range ":" thus means
+defaults to the tip. The range ":" thus means "all revisions".
-"all revisions".
+If BEGIN is greater than END, revisions are treated in reverse order.
-If BEGIN is greater than END, revisions are treated in reverse
-order.
+A range acts as a closed interval. This means that a range of 3:5 gives 3,
+4 and 5. Similarly, a range of 9:6 gives 9, 8, 7, and 6.
-A range acts as a closed interval. This means that a range of 3:5
-gives 3, 4 and 5. Similarly, a range of 9:6 gives 9, 8, 7, and 6.
 ''')),
 (['diffs'], _('Diff Formats'),
 _(r'''
-Mercurial's default format for showing changes between two
+Mercurial's default format for showing changes between two versions of a
-versions of a file is compatible with the unified format of GNU
+file is compatible with the unified format of GNU diff, which can be used
-diff, which can be used by GNU patch and many other standard
+by GNU patch and many other standard tools.
-tools.
 While this standard format is often enough, it does not encode the
 following information:
 - executable status and other permission bits
 - copy or rename information
 - changes in binary files
 - creation or deletion of empty files
-Mercurial also supports the extended diff format from the git VCS
+Mercurial also supports the extended diff format from the git VCS which
-which addresses these limitations. The git diff format is not
+addresses these limitations. The git diff format is not produced by
-produced by default because a few widespread tools still do not
+default because a few widespread tools still do not understand this
-understand this format.
+format.
-This means that when generating diffs from a Mercurial repository
+This means that when generating diffs from a Mercurial repository (e.g.
-(e.g. with "hg export"), you should be careful about things like
+with "hg export"), you should be careful about things like file copies and
-file copies and renames or other things mentioned above, because
+renames or other things mentioned above, because when applying a standard
-when applying a standard diff to a different repository, this
+diff to a different repository, this extra information is lost.
-extra information is lost. Mercurial's internal operations (like
+Mercurial's internal operations (like push and pull) are not affected by
-push and pull) are not affected by this, because they use an
+this, because they use an internal binary format for communicating
-internal binary format for communicating changes.
+changes.
-To make Mercurial produce the git extended diff format, use the
+To make Mercurial produce the git extended diff format, use the --git
---git option available for many commands, or set 'git = True' in
+option available for many commands, or set 'git = True' in the [diff]
-the [diff] section of your hgrc. You do not need to set this
+section of your hgrc. You do not need to set this option when importing
-option when importing diffs in this format or using them in the mq
+diffs in this format or using them in the mq extension.
-extension.
 ''')),
 (['templating'], _('Template Usage'),
 _(r'''
-Mercurial allows you to customize output of commands through
+Mercurial allows you to customize output of commands through templates.
-templates. You can either pass in a template from the command
+You can either pass in a template from the command line, via the
-line, via the --template option, or select an existing
+--template option, or select an existing template-style (--style).
-template-style (--style).
+You can customize output for any "log-like" command: log, outgoing,
-You can customize output for any "log-like" command: log,
+incoming, tip, parents, heads and glog.
-outgoing, incoming, tip, parents, heads and glog.
+Three styles are packaged with Mercurial: default (the style used when no
-Three styles are packaged with Mercurial: default (the style used
+explicit preference is passed), compact and changelog. Usage:
-when no explicit preference is passed), compact and changelog.
-Usage:
 $ hg log -r1 --style changelog
-A template is a piece of text, with markup to invoke variable
+A template is a piece of text, with markup to invoke variable expansion:
-expansion:
 $ hg log -r1 --template "{node}\n"
 b56ce7b07c52de7d5fd79fb89701ea538af65746
-Strings in curly braces are called keywords. The availability of
+Strings in curly braces are called keywords. The availability of keywords
-keywords depends on the exact context of the templater. These
+depends on the exact context of the templater. These keywords are usually
-keywords are usually available for templating a log-like command:
+available for templating a log-like command:
 - author: String. The unmodified author of the changeset.
-- branches: String. The name of the branch on which the changeset
+- branches: String. The name of the branch on which the changeset was
-was committed. Will be empty if the branch name was default.
+committed. Will be empty if the branch name was default.
 - date: Date information. The date when the changeset was committed.
 - desc: String. The text of the changeset description.
-- diffstat: String. Statistics of changes with the following
+- diffstat: String. Statistics of changes with the following format:
-format: "modified files: +added/-removed lines"
+"modified files: +added/-removed lines"
-- files: List of strings. All files modified, added, or removed by
+- files: List of strings. All files modified, added, or removed by this
-this changeset.
+changeset.
 - file_adds: List of strings. Files added by this changeset.
 - file_mods: List of strings. Files modified by this changeset.
 - file_dels: List of strings. Files removed by this changeset.
-- node: String. The changeset identification hash, as a
+- node: String. The changeset identification hash, as a 40-character
-40-character hexadecimal string.
+hexadecimal string.
 - parents: List of strings. The parents of the changeset.
 - rev: Integer. The repository-local changeset revision number.
 - tags: List of strings. Any tags associated with the changeset.
-The "date" keyword does not produce human-readable output. If you
+The "date" keyword does not produce human-readable output. If you want to
-want to use a date in your output, you can use a filter to process
+use a date in your output, you can use a filter to process it. Filters are
-it. Filters are functions which return a string based on the input
+functions which return a string based on the input variable. You can also
-variable. You can also use a chain of filters to get the desired
+use a chain of filters to get the desired output:
-output:
 $ hg tip --template "{date|isodate}\n"
 2008-08-21 18:22 +0000
 List of filters:
-- addbreaks: Any text. Add an XHTML "<br />" tag before the end of
+- addbreaks: Any text. Add an XHTML "<br />" tag before the end of every
-every line except the last.
+line except the last.
-- age: Date. Returns a human-readable date/time difference between
+- age: Date. Returns a human-readable date/time difference between the
-the given date/time and the current date/time.
+given date/time and the current date/time.
-- basename: Any text. Treats the text as a path, and returns the
+- basename: Any text. Treats the text as a path, and returns the last
-last component of the path after splitting by the path
+component of the path after splitting by the path separator (ignoring
-separator (ignoring trailing separators). For example,
+trailing separators). For example, "foo/bar/baz" becomes "baz" and
-"foo/bar/baz" becomes "baz" and "foo/bar//" becomes "bar".
+"foo/bar//" becomes "bar".
 - stripdir: Treat the text as path and strip a directory level, if
 possible. For example, "foo" and "foo/bar" becomes "foo".
-- date: Date. Returns a date in a Unix date format, including
+- date: Date. Returns a date in a Unix date format, including the
-the timezone: "Mon Sep 04 15:13:13 2006 0700".
+timezone: "Mon Sep 04 15:13:13 2006 0700".
-- domain: Any text. Finds the first string that looks like an
+- domain: Any text. Finds the first string that looks like an email
-email address, and extracts just the domain component.
+address, and extracts just the domain component. Example: 'User
-Example: 'User <user@example.com>' becomes 'example.com'.
+<user@example.com>' becomes 'example.com'.
-- email: Any text. Extracts the first string that looks like an
+- email: Any text. Extracts the first string that looks like an email
-email address. Example: 'User <user@example.com>' becomes
+address. Example: 'User <user@example.com>' becomes 'user@example.com'.
-'user@example.com'.
+- escape: Any text. Replaces the special XML/XHTML characters "&", "<" and
-- escape: Any text. Replaces the special XML/XHTML characters "&",
+">" with XML entities.
-"<" and ">" with XML entities.
 - fill68: Any text. Wraps the text to fit in 68 columns.
 - fill76: Any text. Wraps the text to fit in 76 columns.
 - firstline: Any text. Returns the first line of text.
 - nonempty: Any text. Returns '(none)' if the string is empty.
-- hgdate: Date. Returns the date as a pair of numbers:
+- hgdate: Date. Returns the date as a pair of numbers: "1157407993 25200"
-"1157407993 25200" (Unix timestamp, timezone offset).
+(Unix timestamp, timezone offset).
 - isodate: Date. Returns the date in ISO 8601 format.
 - localdate: Date. Converts a date to local date.
-- obfuscate: Any text. Returns the input text rendered as a
+- obfuscate: Any text. Returns the input text rendered as a sequence of
-sequence of XML entities.
+XML entities.
 - person: Any text. Returns the text before an email address.
-- rfc822date: Date. Returns a date using the same format used
+- rfc822date: Date. Returns a date using the same format used in email
-in email headers.
+headers.
-- short: Changeset hash. Returns the short form of a changeset
+- short: Changeset hash. Returns the short form of a changeset hash, i.e.
-hash, i.e. a 12-byte hexadecimal string.
+a 12-byte hexadecimal string.
 - shortdate: Date. Returns a date like "2006-09-18".
 - strip: Any text. Strips all leading and trailing whitespace.
-- tabindent: Any text. Returns the text, with every line except
+- tabindent: Any text. Returns the text, with every line except the first
-the first starting with a tab character.
+starting with a tab character.
-- urlescape: Any text. Escapes all "special" characters. For
+- urlescape: Any text. Escapes all "special" characters. For example, "foo
-example, "foo bar" becomes "foo%20bar".
+bar" becomes "foo%20bar".
 - user: Any text. Returns the user portion of an email address.
 ''')),
 (['urls'], _('URL Paths'),
 _(r'''
-Valid URLs are of the form:
+Valid URLs are of the form::
 local/filesystem/path[#revision]
 file://local/filesystem/path[#revision]
 http://[user[:pass]@]host[:port]/[path][#revision]
 https://[user[:pass]@]host[:port]/[path][#revision]
 ssh://[user[:pass]@]host[:port]/[path][#revision]
-Paths in the local filesystem can either point to Mercurial
+Paths in the local filesystem can either point to Mercurial repositories
-repositories or to bundle files (as created by 'hg bundle' or
+or to bundle files (as created by 'hg bundle' or 'hg incoming --bundle').
-'hg incoming --bundle').
+An optional identifier after # indicates a particular branch, tag, or
-An optional identifier after # indicates a particular branch, tag,
+changeset to use from the remote repository. See also 'hg help revisions'.
-or changeset to use from the remote repository. See also 'hg help
-revisions'.
+Some features, such as pushing to http:// and https:// URLs are only
+possible if the feature is explicitly enabled on the remote Mercurial
-Some features, such as pushing to http:// and https:// URLs are
+server.
-only possible if the feature is explicitly enabled on the remote
-Mercurial server.
 Some notes about using SSH with Mercurial:
-- SSH requires an accessible shell account on the destination
-machine and a copy of hg in the remote path or specified with as
+- SSH requires an accessible shell account on the destination machine and
-remotecmd.
+a copy of hg in the remote path or specified with as remotecmd.
-- path is relative to the remote user's home directory by default.
+- path is relative to the remote user's home directory by default. Use an
-Use an extra slash at the start of a path to specify an absolute path:
+extra slash at the start of a path to specify an absolute path::
 ssh://example.com//tmp/repository
-- Mercurial doesn't use its own compression via SSH; the right
-thing to do is to configure it in your ~/.ssh/config, e.g.:
+- Mercurial doesn't use its own compression via SSH; the right thing to do
+is to configure it in your ~/.ssh/config, e.g.::
 Host *.mylocalnetwork.example.com
 Compression no
 Host *
 Compression yes
-Alternatively specify "ssh -C" as your ssh command in your hgrc
-or with the --ssh command line option.
+Alternatively specify "ssh -C" as your ssh command in your hgrc or with
+the --ssh command line option.
-These URLs can all be stored in your hgrc with path aliases under
-the [paths] section like so:
+These URLs can all be stored in your hgrc with path aliases under the
-[paths]
+[paths] section like so::
-alias1 = URL1
-alias2 = URL2
+[paths]
-...
+alias1 = URL1
+alias2 = URL2
-You can then use the alias for any command that uses a URL (for
+...
-example 'hg pull alias1' would pull from the 'alias1' path).
+You can then use the alias for any command that uses a URL (for example
-Two path aliases are special because they are used as defaults
+'hg pull alias1' would pull from the 'alias1' path).
-when you do not provide the URL to a command:
+Two path aliases are special because they are used as defaults when you do
+not provide the URL to a command:
 default:
-When you create a repository with hg clone, the clone command
+When you create a repository with hg clone, the clone command saves the
-saves the location of the source repository as the new
+location of the source repository as the new repository's 'default'
-repository's 'default' path. This is then used when you omit
+path. This is then used when you omit path from push- and pull-like
-path from push- and pull-like commands (including incoming and
+commands (including incoming and outgoing).
-outgoing).
 default-push:
-The push command will look for a path named 'default-push', and
+The push command will look for a path named 'default-push', and prefer
-prefer it over 'default' if both are defined.
+it over 'default' if both are defined.
 ''')),
 (["extensions"], _("Using additional features"), extshelp),
 )

Mercurial > public > mercurial-scm > hg-stable

comparison mercurial/help.py @ 9325:74e717a21779