summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2019-09-08 09:01:04 +0000
committerrillig <rillig@pkgsrc.org>2019-09-08 09:01:04 +0000
commit55723b56f341f6c882e22a80b439fdb59a75c6ba (patch)
tree6b234c332af03cce641ffd09cfa17e6bea7fe0fe
parent77cadada29ecf8c793d5f0bd1925509185622235 (diff)
downloadpkgsrc-55723b56f341f6c882e22a80b439fdb59a75c6ba.tar.gz
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.
-rw-r--r--mk/misc/show.mk7
1 files changed, 6 insertions, 1 deletions
diff --git a/mk/misc/show.mk b/mk/misc/show.mk
index 28c6ebce011..b516720acf2 100644
--- a/mk/misc/show.mk
+++ b/mk/misc/show.mk
@@ -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.*