Mercurial > hg-stable

changeset 7210:833d1250ce00

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
help: update help make help description 'topic'-oriented rather than 'command'-oriented change 'special' to 'additional'
author Matt Mackall <mpm@selenic.com>
date Wed, 22 Oct 2008 14:30:34 -0500
parents 65f14ca8d2eb
children 25c0dee16ee0
files mercurial/commands.py tests/test-bad-extension.out tests/test-globalopts.out tests/test-help.out
diffstat 4 files changed, 14 insertions(+), 17 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/commands.py	Wed Oct 22 13:05:40 2008 -0500
+++ b/mercurial/commands.py	Wed Oct 22 14:30:34 2008 -0500
@@ -1242,14 +1242,11 @@
         displayer.show(changenode=n)
 
 def help_(ui, name=None, with_version=False):
-    """show help for a command, extension, or list of commands
+    """show help for a given topic or a help overview
 
     With no arguments, print a list of commands and short help.
 
-    Given a command name, print help for that command.
-
-    Given an extension name, print help for that extension, and the
-    commands it provides."""
+    Given a topic, extension, or command name, print help for that topic."""
     option_lists = []
 
     def addglobalopts(aliases):
@@ -1434,7 +1431,7 @@
                                          or "")))
 
     if not name:
-        ui.write(_("\nspecial help topics:\n\n"))
+        ui.write(_("\nadditional help topics:\n\n"))
         topics = []
         for names, header, doc in help.helptable:
             names = [(-len(name), name) for name in names]
@@ -3130,7 +3127,7 @@
          [('r', 'rev', '', _('show only heads which are descendants of rev')),
          ] + templateopts,
          _('hg heads [-r REV] [REV]...')),
-    "help": (help_, [], _('hg help [COMMAND]')),
+    "help": (help_, [], _('hg help [TOPIC]')),
     "identify|id":
         (identify,
          [('r', 'rev', '', _('identify the specified rev')),
--- a/tests/test-bad-extension.out	Wed Oct 22 13:05:40 2008 -0500
+++ b/tests/test-bad-extension.out	Wed Oct 22 14:30:34 2008 -0500
@@ -1,5 +1,5 @@
 *** failed to import extension badext from .../badext.py: bit bucket overflow
 *** failed to import extension badext2: No module named badext2
-hg help [COMMAND]
+hg help [TOPIC]
 
-show help for a command, extension, or list of commands
+show help for a given topic or a help overview
--- a/tests/test-globalopts.out	Wed Oct 22 13:05:40 2008 -0500
+++ b/tests/test-globalopts.out	Wed Oct 22 14:30:34 2008 -0500
@@ -166,7 +166,7 @@
  export       dump the header and diffs for one or more changesets
  grep         search for a pattern in specified files and revisions
  heads        show current repository heads or show branch heads
- help         show help for a command, extension, or list of commands
+ help         show help for a given topic or a help overview
  identify     identify the working copy or specified revision
  import       import an ordered set of patches
  incoming     show new changesets found in source
@@ -198,7 +198,7 @@
  verify       verify the integrity of the repository
  version      output version and copyright information
 
-special help topics:
+additional help topics:
 
  dates        Date Formats
  patterns     File Name Patterns
@@ -228,7 +228,7 @@
  export       dump the header and diffs for one or more changesets
  grep         search for a pattern in specified files and revisions
  heads        show current repository heads or show branch heads
- help         show help for a command, extension, or list of commands
+ help         show help for a given topic or a help overview
  identify     identify the working copy or specified revision
  import       import an ordered set of patches
  incoming     show new changesets found in source
@@ -260,7 +260,7 @@
  verify       verify the integrity of the repository
  version      output version and copyright information
 
-special help topics:
+additional help topics:
 
  dates        Date Formats
  patterns     File Name Patterns
--- a/tests/test-help.out	Wed Oct 22 13:05:40 2008 -0500
+++ b/tests/test-help.out	Wed Oct 22 14:30:34 2008 -0500
@@ -57,7 +57,7 @@
  export       dump the header and diffs for one or more changesets
  grep         search for a pattern in specified files and revisions
  heads        show current repository heads or show branch heads
- help         show help for a command, extension, or list of commands
+ help         show help for a given topic or a help overview
  identify     identify the working copy or specified revision
  import       import an ordered set of patches
  incoming     show new changesets found in source
@@ -89,7 +89,7 @@
  verify       verify the integrity of the repository
  version      output version and copyright information
 
-special help topics:
+additional help topics:
 
  dates        Date Formats
  patterns     File Name Patterns
@@ -115,7 +115,7 @@
  export       dump the header and diffs for one or more changesets
  grep         search for a pattern in specified files and revisions
  heads        show current repository heads or show branch heads
- help         show help for a command, extension, or list of commands
+ help         show help for a given topic or a help overview
  identify     identify the working copy or specified revision
  import       import an ordered set of patches
  incoming     show new changesets found in source
@@ -147,7 +147,7 @@
  verify       verify the integrity of the repository
  version      output version and copyright information
 
-special help topics:
+additional help topics:
 
  dates        Date Formats
  patterns     File Name Patterns