comparison 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

7011:7da76778dbd7

#
# This software may be used and distributed according to the terms
# of the GNU General Public License, incorporated herein by reference.

helptable = (
    ("dates|Date Formats",
    r'''
    Some commands allow the user to specify a date:
    backout, commit, import, tag: Specify the commit date.
    log, revert, update: Select revision(s) by date.

    ">{date}" - on or after a given date
    "{date} to {date}" - 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 time.

    By default, Mercurial treats filenames as shell-style extended

    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, an executable named
    'hg' (with com/exe/bat/cmd extension on Windows) is searched.

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

    ('revs|revisions|Specifying Single Revisions',
    r'''
    Mercurial accepts several notations for identifying individual
    revisions.

    A plain integer is treated as a revision number. Negative

    no working directory is checked out, it is equivalent to null.
    If an uncommitted merge is in progress, "." is the revision of
    the first parent.
    '''),

    ('mrevs|multirevs|Specifying Multiple Revisions',
    r'''
    When Mercurial accepts more than one revision, they may be
    specified individually, or provided as a continuous range,
    separated by the ":" character.

7012:78341ea65d16

#
# This software may be used and distributed according to the terms
# of the GNU General Public License, incorporated herein by reference.

helptable = (
    (["dates"], "Date Formats",
    r'''
    Some commands allow the user to specify a date:
    backout, commit, import, tag: Specify the commit date.
    log, revert, update: Select revision(s) by date.

    ">{date}" - on or after a given date
    "{date} to {date}" - 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 time.

    By default, Mercurial treats filenames as shell-style extended

    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, an executable named
    'hg' (with com/exe/bat/cmd extension on Windows) is searched.

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

    (['revs', 'revisions'], 'Specifying Single Revisions',
    r'''
    Mercurial accepts several notations for identifying individual
    revisions.

    A plain integer is treated as a revision number. Negative

    no working directory is checked out, it is equivalent to null.
    If an uncommitted merge is in progress, "." is the revision of
    the first parent.
    '''),

    (['mrevs', 'multirevs'], 'Specifying Multiple Revisions',
    r'''
    When Mercurial accepts more than one revision, they may be
    specified individually, or provided as a continuous range,
    separated by the ":" character.