CVS commit: pkgsrc/mk/help

["Roland Illig" <rillig%netbsd.org@localhost>]

Module Name:    pkgsrc
Committed By:   rillig
Date:           Tue Oct 31 16:24:42 UTC 2017

Modified Files:
        pkgsrc/mk/help: help.awk help.mk

Log Message:
Improved index generation for "make help".

The index is sorted alphabetically and mentioned in a plain "make help"
call.


To generate a diff of this commit:
cvs rdiff -u -r1.27 -r1.28 pkgsrc/mk/help/help.awk
cvs rdiff -u -r1.12 -r1.13 pkgsrc/mk/help/help.mk

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

Modified files:

Index: pkgsrc/mk/help/help.awk
diff -u pkgsrc/mk/help/help.awk:1.27 pkgsrc/mk/help/help.awk:1.28
--- pkgsrc/mk/help/help.awk:1.27        Sat Aug 31 21:27:53 2013
+++ pkgsrc/mk/help/help.awk     Tue Oct 31 16:24:42 2017
@@ -1,4 +1,4 @@
-# $NetBSD: help.awk,v 1.27 2013/08/31 21:27:53 rillig Exp $
+# $NetBSD: help.awk,v 1.28 2017/10/31 16:24:42 rillig Exp $
 #
 
 # This program extracts the inline documentation from *.mk files.
@@ -180,8 +180,10 @@ always {
 END {
        end_of_topic();
        if (print_index) {
+               print "Available help topics:";
+               print "";
                for (k in all_keywords) {
-                       print all_keywords[k] "\t" k;
+                       print k | "LC_ALL=C sort";
                }
        } else if (!found_anything) {
                print "No help found for "topic".";

Index: pkgsrc/mk/help/help.mk
diff -u pkgsrc/mk/help/help.mk:1.12 pkgsrc/mk/help/help.mk:1.13
--- pkgsrc/mk/help/help.mk:1.12 Mon Feb  1 18:47:23 2016
+++ pkgsrc/mk/help/help.mk      Tue Oct 31 16:24:42 2017
@@ -1,4 +1,4 @@
-# $NetBSD: help.mk,v 1.12 2016/02/01 18:47:23 leot Exp $
+# $NetBSD: help.mk,v 1.13 2017/10/31 16:24:42 rillig Exp $
 #
 
 # This is the integrated pkgsrc online help system. To query for the
@@ -31,9 +31,12 @@ help:
        @${ECHO} "usage: "${MAKE:Q}" help topic=<topic>"
        @${ECHO} ""
        @${ECHO} "      <topic> may be a variable name or a make target,"
-       @${ECHO} "      for example CONFIGURE_DIRS or patch. For convenience,"
-       @${ECHO} "      you don't need to use uppercase letters when typing"
-       @${ECHO} "      variable names."
+       @${ECHO} "      for example CONFIGURE_DIRS or patch."
+       @${ECHO} ""
+       @${ECHO} "      For convenience, all-uppercase topics such as variable"
+       @${ECHO} "      names may also be given in all-lowercase."
+       @${ECHO} ""
+       @${ECHO} "      The special topic :index lists all available topics."
        @${ECHO} ""
 .else
        ${RUN} cd ${PKGSRCDIR};                                         \