Patchwork [v2] help: explain how to access subtopics in internals

login
register
mail settings
Submitter via Mercurial-devel
Date April 26, 2017, 12:48 a.m.
Message ID <b801bcc0a441048af76f.1493167728@matvore-linux.svl.corp.google.com>
Download mbox | patch
Permalink /patch/20299/
State Accepted
Headers show

Comments

via Mercurial-devel - April 26, 2017, 12:48 a.m.
# HG changeset patch
# User Matt DeVore <matvore@google.com>
# Date 1492646662 25200
#      Wed Apr 19 17:04:22 2017 -0700
# Node ID b801bcc0a441048af76f531c6cef897b28ed1002
# Parent  ed42e00a5c4ec7a3bebaec699ef934429cdc2ddd
help: explain how to access subtopics in internals
Sean Farley - April 26, 2017, 5 a.m.
Matt DeVore via Mercurial-devel <mercurial-devel@mercurial-scm.org>
writes:

> # HG changeset patch
> # User Matt DeVore <matvore@google.com>
> # Date 1492646662 25200
> #      Wed Apr 19 17:04:22 2017 -0700
> # Node ID b801bcc0a441048af76f531c6cef897b28ed1002
> # Parent  ed42e00a5c4ec7a3bebaec699ef934429cdc2ddd
> help: explain how to access subtopics in internals

Sure, seems fine me :-)
Augie Fackler - April 27, 2017, 2:46 p.m.
On Tue, Apr 25, 2017 at 05:48:48PM -0700, Matt DeVore via Mercurial-devel wrote:
> # HG changeset patch
> # User Matt DeVore <matvore@google.com>
> # Date 1492646662 25200
> #      Wed Apr 19 17:04:22 2017 -0700
> # Node ID b801bcc0a441048af76f531c6cef897b28ed1002
> # Parent  ed42e00a5c4ec7a3bebaec699ef934429cdc2ddd
> help: explain how to access subtopics in internals

Very nice, many thanks. Queued.

Patch

diff -r ed42e00a5c4e -r b801bcc0a441 mercurial/help.py
--- a/mercurial/help.py	Thu Apr 13 22:31:17 2017 +0900
+++ 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))
 
diff -r ed42e00a5c4e -r b801bcc0a441 tests/test-help.t
--- a/tests/test-help.t	Thu Apr 13 22:31:17 2017 +0900
+++ 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