[pkgsrc/trunk]: pkgsrc/mk mk/bsd.pkg.mk: improve documentation

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/442bd1ce3a1f
branches:  trunk
changeset: 430686:442bd1ce3a1f
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sun May 03 10:34:00 2020 +0000

description:
mk/bsd.pkg.mk: improve documentation

diffstat:

 mk/bsd.pkg.mk |  9 +++++----
 1 files changed, 5 insertions(+), 4 deletions(-)

diffs (37 lines):

diff -r 02f894f8cb59 -r 442bd1ce3a1f mk/bsd.pkg.mk
--- a/mk/bsd.pkg.mk     Sun May 03 10:16:48 2020 +0000
+++ b/mk/bsd.pkg.mk     Sun May 03 10:34:00 2020 +0000
@@ -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 @@
 
 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+=          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 @@
 
 # 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
 
 #