comparison mercurial/help.py @ 9157:9261667e9b82

commands: use minirst parser when displaying help

9156:c9c7e8cdac9c

def listexts(header, exts, maxlength):
    '''return a text listing of the given extensions'''
    if not exts:
        return ''
    result = '\n%s\n\n' % header
    for name, desc in sorted(exts.iteritems()):
        desc = util.wrap(desc, maxlength + 4)
        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

    or modify history); they might not be ready for prime time; or they may
    alter some 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:

      [extensions]
      foo =

    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 scope,
    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.

    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)
    "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
    "Dec 6" (midnight)
    "13:18" (today assumed)
    "3:39" (3:39AM assumed)
    "3:39pm" (15:39)
    "2006-12-06 13:18:29" (ISO 8601 format)
    "2006-12-6 13:18"
    "2006-12-6"
    "12-6"
    "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 the
    number of seconds since the epoch (1970-01-01 00:00 UTC). offset is the
    offset of the local timezone, in seconds west of UTC (negative if the
    timezone is east of UTC).

    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 files at a

    path separators and "{a,b}" to mean "a or b".

    To use a Perl/Python regular expression, start a name with "re:". Regexp
    pattern matching is anchored at the root of the repository.

    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:*.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:

    re:.*\.c$      any name ending in ".c", anywhere in the repository

    ''')),

    (['environment', 'env'], _('Environment Variables'),
     _(r'''
HG::
    Path to the 'hg' executable, automatically passed when running hooks,
    extensions or external tools. If unset or empty, this is the hg
    executable's name if it's frozen, or an executable named 'hg' (with
    %PATHEXT% [defaulting to COM/EXE/BAT/CMD] extensions on Windows) is
    searched.

HGEDITOR::
    This is the name of the editor to run when committing. See EDITOR.

    (deprecated, use .hgrc)

HGENCODING::
    This overrides the default locale setting detected by Mercurial. This
    setting is used to convert data including usernames, changeset
    descriptions, tag names, and branches. This setting can be overridden with
    the --encoding command-line option.

HGENCODINGMODE::
    This sets Mercurial's behavior for handling unknown characters while
    transcoding user input. The default is "strict", which causes Mercurial to
    abort if it can't map a character. Other settings include "replace", which
    replaces unknown characters, and "ignore", which drops them. This setting
    can be overridden with the --encodingmode command-line option.

HGMERGE::
    An executable to use for resolving merge conflicts. The program will be
    executed with three arguments: local file, remote file, ancestor file.

    (deprecated, use .hgrc)

HGRCPATH::
    A list of files or directories to search for hgrc files. Item separator is
    ":" on Unix, ";" on Windows. If HGRCPATH is not set, platform default
    search path is used. If empty, only the .hg/hgrc from the current
    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

HGUSER::
    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
    * EMAIL
    * interactive prompt
    * LOGNAME (with '@hostname' appended)

    (deprecated, use .hgrc)

EMAIL::
    May be used as the author of a commit; see HGUSER.

LOGNAME::
    May be used as the author of a commit; see HGUSER.

VISUAL::
    This is the name of the editor to use when committing. See EDITOR.

EDITOR::
    Sometimes Mercurial needs to open a text file in an editor for a user to
    modify, for example when writing commit messages. The editor it uses is
    determined by looking at the environment variables HGEDITOR, VISUAL and
    EDITOR, in that order. The first non-empty one is chosen. If all of them
    are empty, the editor defaults to 'vi'.

PYTHONPATH::
    This is used by Python to find imported modules and may need to be set
    appropriately if this Mercurial is not installed system-wide.
    ''')),

    (['revs', 'revisions'], _('Specifying Single Revisions'),

    - user: Any text. Returns the user portion of an email address.
    ''')),

    (['urls'], _('URL Paths'),
     _(r'''
    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]

    Some features, such as pushing to http:// and https:// URLs are 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 remotecmd.
    - path is relative to the remote user's home directory by default. Use an
      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.:
        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.

    These URLs can all be stored in your hgrc with path aliases under the
    [paths] section like so:
    [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).

    Two path aliases are special because they are used as defaults when you do

9157:9261667e9b82

def listexts(header, exts, maxlength):
    '''return a text listing of the given extensions'''
    if not exts:
        return ''
    # 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 + 5)
        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

    or modify history); they might not be ready for prime time; or they may
    alter some 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::

      [extensions]
      foo =

    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 scope,
    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.

    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)
      "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
      "Dec 6" (midnight)
      "13:18" (today assumed)
      "3:39" (3:39AM assumed)
      "3:39pm" (15:39)
      "2006-12-06 13:18:29" (ISO 8601 format)
      "2006-12-6 13:18"
      "2006-12-6"
      "12-6"
      "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 the
    number of seconds since the epoch (1970-01-01 00:00 UTC). offset is the
    offset of the local timezone, in seconds west of UTC (negative if the
    timezone is east of UTC).

    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 files at a

    path separators and "{a,b}" to mean "a or b".

    To use a Perl/Python regular expression, start a name with "re:". Regexp
    pattern matching is anchored at the root of the repository.

    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:*.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::

      re:.*\.c$      any name ending in ".c", anywhere in the repository

    ''')),

    (['environment', 'env'], _('Environment Variables'),
     _(r'''
HG
    Path to the 'hg' executable, automatically passed when running hooks,
    extensions or external tools. If unset or empty, this is the hg
    executable's name if it's frozen, or an executable named 'hg' (with
    %PATHEXT% [defaulting to COM/EXE/BAT/CMD] extensions on Windows) is
    searched.

HGEDITOR
    This is the name of the editor to run when committing. See EDITOR.

    (deprecated, use .hgrc)

HGENCODING
    This overrides the default locale setting detected by Mercurial. This
    setting is used to convert data including usernames, changeset
    descriptions, tag names, and branches. This setting can be overridden with
    the --encoding command-line option.

HGENCODINGMODE
    This sets Mercurial's behavior for handling unknown characters while
    transcoding user input. The default is "strict", which causes Mercurial to
    abort if it can't map a character. Other settings include "replace", which
    replaces unknown characters, and "ignore", which drops them. This setting
    can be overridden with the --encodingmode command-line option.

HGMERGE
    An executable to use for resolving merge conflicts. The program will be
    executed with three arguments: local file, remote file, ancestor file.

    (deprecated, use .hgrc)

HGRCPATH
    A list of files or directories to search for hgrc files. Item separator is
    ":" on Unix, ";" on Windows. If HGRCPATH is not set, platform default
    search path is used. If empty, only the .hg/hgrc from the current
    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

HGUSER
    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
    - EMAIL
    - interactive prompt
    - LOGNAME (with '@hostname' appended)

    (deprecated, use .hgrc)

EMAIL
    May be used as the author of a commit; see HGUSER.

LOGNAME
    May be used as the author of a commit; see HGUSER.

VISUAL
    This is the name of the editor to use when committing. See EDITOR.

EDITOR
    Sometimes Mercurial needs to open a text file in an editor for a user to
    modify, for example when writing commit messages. The editor it uses is
    determined by looking at the environment variables HGEDITOR, VISUAL and
    EDITOR, in that order. The first non-empty one is chosen. If all of them
    are empty, the editor defaults to 'vi'.

PYTHONPATH
    This is used by Python to find imported modules and may need to be set
    appropriately if this Mercurial is not installed system-wide.
    ''')),

    (['revs', 'revisions'], _('Specifying Single Revisions'),

    - user: Any text. Returns the user portion of an email address.
    ''')),

    (['urls'], _('URL Paths'),
     _(r'''
    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]

    Some features, such as pushing to http:// and https:// URLs are 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 remotecmd.
    - path is relative to the remote user's home directory by default. Use an
      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.::

        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.

    These URLs can all be stored in your hgrc with path aliases under the
    [paths] section like so::

      [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).

    Two path aliases are special because they are used as defaults when you do