[pkgsrc/trunk]: pkgsrc/mk/misc mk/misc/show.mk: document how to explicitly ma...

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/2c89bcab0bc4
branches:  trunk
changeset: 400951:2c89bcab0bc4
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sun Sep 08 09:01:04 2019 +0000

description:
mk/misc/show.mk: document how to explicitly mark variables as ignored

An upcoming check in pkglint will require that if a file has a _VARGROUPS
section, it must contain the full truth, mentioning every variable that
is used or defined in the file.

Some variables may be so internal though that they are not interesting in
any scenario for understanding what goes on in the file. These variables
can be explicitly ignored. They will not be listed by "bmake show-all" and
pkglint will not complain about them.

diffstat:

 mk/misc/show.mk |  7 ++++++-
 1 files changed, 6 insertions(+), 1 deletions(-)

diffs (21 lines):

diff -r 417ff12e0d41 -r 2c89bcab0bc4 mk/misc/show.mk
--- a/mk/misc/show.mk   Sun Sep 08 08:17:23 2019 +0000
+++ b/mk/misc/show.mk   Sun Sep 08 09:01:04 2019 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: show.mk,v 1.17 2018/11/30 18:38:20 rillig Exp $
+# $NetBSD: show.mk,v 1.18 2019/09/08 09:01:04 rillig Exp $
 #
 # This file contains some targets that print information gathered from
 # variables. They do not modify any variables.
@@ -124,6 +124,11 @@
 #      All variables that are used by this file, whether internal or
 #      not, primary or not.
 #
+# _IGN_VARS.*
+#      All variables that are used or defined by this file, but which
+#      are not worth being documented. These are listed to enable pkglint
+#      to check whether all variables are covered properly.
+#
 # Variables that control the presentation of individual variables:
 #
 # _SORTED_VARS.*