[pkgsrc/trunk]: pkgsrc/mk/help Documented the pkgsrc online help.

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/2953c8a879a4
branches:  trunk
changeset: 538821:2953c8a879a4
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Tue Feb 19 22:25:23 2008 +0000

description:
Documented the pkgsrc online help.

diffstat:

 mk/help/help.help |  35 +++++++++++++++++++++++++++++++++++
 1 files changed, 35 insertions(+), 0 deletions(-)

diffs (39 lines):

diff -r db2102bfad4d -r 2953c8a879a4 mk/help/help.help
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/mk/help/help.help Tue Feb 19 22:25:23 2008 +0000
@@ -0,0 +1,35 @@
+# $NetBSD: help.help,v 1.1 2008/02/19 22:25:23 rillig Exp $
+#
+# The reference documentation of pkgsrc contains mostly of comments in
+# various files. To save users and developers from knowing where to find
+# what, this online help provides a convenient way to query the
+# documentation for keywords.
+#
+# === Using the online help ===
+#
+# The online help is called like "bmake help topic=<topic>", where
+# <topic> may be a variable name (like SUBST_VARS), a make target (like
+# pre-configure), or some other keyword (like mount, lvalue).
+#
+# === Making the documentation accessible to the online help ===
+#
+# The online help searches all files called *.mk or *.help in the mk/
+# directory and some others. It looks at the comments (like this one) to
+# find keywords. The most obvious way to declare keywords is in a line
+# that starts with "# Keywords:". Since it would be annoying to declare
+# all these keywords explicitly, some keywords are extracted
+# automatically, if they have one of the following forms:
+#
+# * A default definition of a variable, for example "PAPERSIZE?= a4".
+#   This occurs often in mk/defaults/mk.conf.
+#
+# * An overriding definition of a variable.
+#
+# * A variable definition that is commented out, without any white-space
+#   between the comment character (#) and the variable name.
+#
+# * A make target, either commented out or not. It may not have any
+#   upper-case letters and must end with a colon.
+#
+# Keywords: help
+#