# $NetBSD: Makefile.params,v 1.23 2023/06/11 10:43:51 lukem Exp $

# $NetBSD: Makefile.params,v 1.23 2023/06/11 10:43:51 lukem Exp $
#
# Makefile fragment for printing build parameters.
#
# Public variables:
# RELEASEVARS
# List of variables whose value should be printed.
#
# PRINT_PARAMS
# A command to print the desired variables and values
# to stdout, without any additional debugging information.
# Values are printed as single-quoted strings, with
# embedded quotes and newlines escaped in a way that's
# acceptable to sh(1). Undefined values are printed
# as "(undefined)" (without quotation marks).
#
# Internal targets:
# _params:
# Prints the names and values of all the variables
# listed in ${RELEASEVARS}. The desired results may be
# redirected somewhere other than stdout, for example by
# setting _params_redirect='>&3'. stdout and stderr may
# contain unwanted debugging information, from make and
# the shell.
#
# Internal variables:
# _params_redirect:
# If set, this should be a shell redirection specification, such
# as '>&3', controlling where the output from "make _params" will
# be sent.
#
# Example:
# . ${NETBSDSRCDIR}/etc/Makefile.params
# show-params: .MAKE .PHONY # print params to stdout
# @${PRINT_PARAMS}
#

include <bsd.own.mk> # for some variables

RELEASEVARS= DISTRIBVER EXTERNAL_TOOLCHAIN HAVE_GCC HAVE_GDB \
HAVE_LLVM HAVE_PCC INSTALLWORLDDIR \
MACHINE MACHINE_ARCH \
NETBSD_OFFICIAL_RELEASE NOCLEANDIR NODISTRIBDIRS NOINCLUDES \
TOOLCHAIN_MISSING \
USE_HESIOD USE_INET6 USE_JEMALLOC USE_KERBEROS USE_LDAP \
USE_PAM USE_SKEY USE_YP \
USETOOLS

if ${MKREPRO:Uno} != "yes"
RELEASEVARS+= BSDOBJDIR BSDSRCDIR BUILDID BUILDINFO BUILDSEED \
DESTDIR KERNARCHDIR KERNCONFDIR KERNOBJDIR KERNSRCDIR MAKE \
KERNEL_DIR MAKECONF MAKEFLAGS MAKEOBJDIR MAKEOBJDIRPREFIX \
MAKEVERBOSE NETBSDSRCDIR OBJMACHINE OBJMACHINE_ARCH \
RELEASEDIR RELEASEMACHINEDIR TOOLDIR USR_OBJMACHINE X11SRCDIR
endif

RELEASEVARS+= ${_MKVARS.yes} ${_MKVARS.no}

#
# Duplicate the DISTRIBVER setting from src/etc/Makefile.
#
ifndef DISTRIBVER
DISTRIBVER!= ${HOST_SH} ${NETBSDSRCDIR}/sys/conf/osrelease.sh
endif

#
# _params does the printing.
#
_params_redirect?= # empty

_params: .PHONY
for var in ${RELEASEVARS:O}
if defined(${var})
@printf "%20s = '%-s'\n" ${var} ${${var}:C/'/'\\\\''/gW:Q} \
${_params_redirect}
else
@printf "%20s = (undefined)\n" ${var} \
${_params_redirect}
endif
endfor

# PRINT_PARAMS:
#
# The output from the "make _params" can include the following types of
# unwanted lines:
#
# make -j prints "--- _params ---";
#
# if MAKEVERBOSE is set to 3 or more then make prints each "printf"
# command in addition to executing it;
#
# if MAKEVERBOSE is set to 4 then the shell prints each command
# (prefixed with "+").
#
# So the resulting output can look like this:
#
# --- _params ---
# + echo 'printf "%20s = '\''%-s'\''\n" BSDOBJDIR /usr/obj'
# printf "%20s = '%-s'\n" BSDOBJDIR /usr/obj
# + printf '%20s = '\''%-s'\''\n' BSDOBJDIR /usr/obj
# BSDOBJDIR = '/usr/obj'
# + echo 'printf "%20s = '\''%-s'\''\n" BSDSRCDIR /usr/src'
# printf "%20s = '%-s'\n" BSDSRCDIR /usr/src
# + printf '%20s = '\''%-s'\''\n' BSDSRCDIR /usr/src
# BSDSRCDIR = '/usr/src'
# [...]
#
# where what we want is just this:
#
# BSDOBJDIR = '/usr/obj'
# BSDSRCDIR = '/usr/src'
# [...]
#
# The shell redirections in ${PRINT_PARAMS} ensure that the unwanted
# noise is discarded (via ">/dev/null"), while the desired information
# ends up on the subshell's stdout (via ">&3" and "3>&1"). The value
# of _params_redirect is passed in the environment instead of on the
# command line, to prevent it from appearing in MAKEFLAGS (which would
# appear in the output).
#
PRINT_PARAMS:= (_params_redirect='>&3' ${MAKE} -f ${.PARSEDIR:Q}/${.PARSEFILE:Q} _params 3>&1 >/dev/null)