CVS commit: pkgsrc/mk

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

Module Name:    pkgsrc
Committed By:   rillig
Date:           Sun May  3 10:34:00 UTC 2020

Modified Files:
        pkgsrc/mk: bsd.pkg.mk

Log Message:
mk/bsd.pkg.mk: improve documentation


To generate a diff of this commit:
cvs rdiff -u -r1.2037 -r1.2038 pkgsrc/mk/bsd.pkg.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/bsd.pkg.mk
diff -u pkgsrc/mk/bsd.pkg.mk:1.2037 pkgsrc/mk/bsd.pkg.mk:1.2038
--- pkgsrc/mk/bsd.pkg.mk:1.2037 Sun May  3 09:22:16 2020
+++ pkgsrc/mk/bsd.pkg.mk        Sun May  3 10:34:00 2020
@@ -1,4 +1,4 @@
-#      $NetBSD: bsd.pkg.mk,v 1.2037 2020/05/03 09:22:16 rillig Exp $
+#      $NetBSD: bsd.pkg.mk,v 1.2038 2020/05/03 10:34:00 rillig Exp $
 #
 # This file is in the public domain.
 #
@@ -154,7 +154,7 @@ ${_var_}+=  ${${_var_}.*}
 
 CPPFLAGS+=     ${CPP_PRECOMP_FLAGS}
 
-# To sanitise environment set PKGSRC_SETENV=${SETENV} -i
+# To sanitize the environment, set PKGSRC_SETENV=${SETENV} -i.
 # This will however cause build failures (e.g. "www/firefox"). Settings
 # like "ALLOW_VULNERABLE_PACKAGES" will also not be correctly passed
 # to dependence builds.
@@ -208,8 +208,8 @@ _BUILD_DEFS+=               PKGINFODIR
 _BUILD_DEFS+=          PKGMANDIR
 _BUILD_DEFS+=          _USE_DESTDIR
 
-# Store the result in the +BUILD_INFO file so we can query for the build
-# options using "pkg_info -Q PKG_OPTIONS <pkg>".
+# Store the result in the +BUILD_INFO file so mk/pkg-build-options.mk
+# can query for the build options using "pkg_info -Q PKG_OPTIONS <pkg>".
 #
 .if defined(PKG_SUPPORTED_OPTIONS) && defined(PKG_OPTIONS)
 _BUILD_DEFS+=            PKG_OPTIONS
@@ -343,6 +343,7 @@ DO_NADA?=           ${TRUE}
 
 # the FAIL command executes its arguments and then exits with a non-zero
 # status.
+# Example: ${FAIL} ${ERROR_MSG} "This is unexpected."
 FAIL?=                 ${SH} ${PKGSRCDIR}/mk/scripts/fail
 
 #