CVS commit: pkgsrc/mk/misc

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

Module Name:    pkgsrc
Committed By:   rillig
Date:           Sun Sep  8 09:01:04 UTC 2019

Modified Files:
        pkgsrc/mk/misc: show.mk

Log Message:
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.


To generate a diff of this commit:
cvs rdiff -u -r1.17 -r1.18 pkgsrc/mk/misc/show.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/misc/show.mk
diff -u pkgsrc/mk/misc/show.mk:1.17 pkgsrc/mk/misc/show.mk:1.18
--- pkgsrc/mk/misc/show.mk:1.17 Fri Nov 30 18:38:20 2018
+++ pkgsrc/mk/misc/show.mk      Sun Sep  8 09:01:04 2019
@@ -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 @@ show-build-defs: .PHONY
 #      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.*