Mon Feb 26 22:51:42 2018 UTC ()
mk/misc/show.mk: document the show-all-* targets


(rillig)
diff -r1.12 -r1.13 pkgsrc/mk/misc/show.mk
cvs diff -r1.12 -r1.13 pkgsrc/mk/misc/show.mk (expand / switch to unified diff)

--- pkgsrc/mk/misc/show.mk 2015/01/30 16:45:33 1.12
+++ pkgsrc/mk/misc/show.mk 2018/02/26 22:51:42 1.13
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1# $NetBSD: show.mk,v 1.12 2015/01/30 16:45:33 jperkin Exp $ 1# $NetBSD: show.mk,v 1.13 2018/02/26 22:51:42 rillig Exp $
2# 2#
3# This file contains some targets that print information gathered from 3# This file contains some targets that print information gathered from
4# variables. They do not modify any variables. 4# variables. They do not modify any variables.
5# 5#
6 6
7# show-tools: 7# show-tools:
8# Emits a /bin/sh shell script that defines all known tools 8# Emits a /bin/sh shell script that defines all known tools
9# to the values they have in the pkgsrc infrastructure. 9# to the values they have in the pkgsrc infrastructure.
10# 10#
11show-tools: .PHONY 11show-tools: .PHONY
12.for t in ${_USE_TOOLS} 12.for t in ${_USE_TOOLS}
13. if defined(_TOOLS_VARNAME.${t}) 13. if defined(_TOOLS_VARNAME.${t})
14 @${ECHO} ${_TOOLS_VARNAME.${t}:Q}=${${_TOOLS_VARNAME.${t}}:Q:Q} 14 @${ECHO} ${_TOOLS_VARNAME.${t}:Q}=${${_TOOLS_VARNAME.${t}}:Q:Q}
@@ -78,26 +78,30 @@ show-build-defs: .PHONY @@ -78,26 +78,30 @@ show-build-defs: .PHONY
78 @${ECHO} "==========================================================================" 78 @${ECHO} "=========================================================================="
79.endif 79.endif
80 80
81# show-all: 81# show-all:
82# Prints a list of (hopefully) all pkgsrc variables that are visible 82# Prints a list of (hopefully) all pkgsrc variables that are visible
83# to the user or the package developer. It is intended to give 83# to the user or the package developer. It is intended to give
84# interested parties a better insight into the inner workings of 84# interested parties a better insight into the inner workings of
85# pkgsrc. Each variable name is prefixed with a "category": 85# pkgsrc. Each variable name is prefixed with a "category":
86# 86#
87# * "usr" for user-settable variables, 87# * "usr" for user-settable variables,
88# * "pkg" for package-settable variables, 88# * "pkg" for package-settable variables,
89# * "sys" for system-defined variables. 89# * "sys" for system-defined variables.
90# 90#
 91# For each of the variable groups (e.g. "build", "extract"), a
 92# specialized target show-all-${group} is defined, so that
 93# show-all-extract only shows that group.
 94#
91# CAVEAT: Some few variable values that are shown here may be 95# CAVEAT: Some few variable values that are shown here may be
92# misleading. For example, make(1)'s := operator leaves references 96# misleading. For example, make(1)'s := operator leaves references
93# to undefined variables as-is, so they may be resolved later. So 97# to undefined variables as-is, so they may be resolved later. So
94# if you want to take a snapshot of the exact value of a variable, 98# if you want to take a snapshot of the exact value of a variable,
95# you have to use "snapshot!=printf %s ''${var:q}" instead of 99# you have to use "snapshot!=printf %s ''${var:q}" instead of
96# "snapshot:=${var}". 100# "snapshot:=${var}".
97# 101#
98# Keywords: debug show _vargroups 102# Keywords: debug show _vargroups
99# 103#
100 104
101# The following types of variables are categorized: 105# The following types of variables are categorized:
102# 106#
103# _USER_VARS.* 107# _USER_VARS.*