changeset 32076:d7b698ae153b stable

help: explain how to access subtopics in internals
author Matt DeVore <matvore@google.com>
date Wed, 19 Apr 2017 17:04:22 -0700
parents 7000196a8178
children de115db3688e
files mercurial/help.py tests/test-help.t
diffstat 2 files changed, 4 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/help.py	Tue Apr 18 14:51:32 2017 -0700
+++ b/mercurial/help.py	Wed Apr 19 17:04:22 2017 -0700
@@ -203,7 +203,8 @@
 
 def internalshelp(ui):
     """Generate the index for the "internals" topic."""
-    lines = []
+    lines = ['To access a subtopic, use "hg help internals.{subtopic-name}"\n',
+             '\n']
     for names, header, doc in internalstable:
         lines.append(' :%s: %s\n' % (names[0], header))
 
--- a/tests/test-help.t	Tue Apr 18 14:51:32 2017 -0700
+++ b/tests/test-help.t	Wed Apr 19 17:04:22 2017 -0700
@@ -943,6 +943,8 @@
   Technical implementation topics
   """""""""""""""""""""""""""""""
   
+      To access a subtopic, use "hg help internals.{subtopic-name}"
+  
        bundles       Bundles
        censor        Censor
        changegroups  Changegroups