[pkgsrc/trunk]: pkgsrc/mk mk/pkg-build-options.mk: make the documentation mor...

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/ed7a2c9497d6
branches:  trunk
changeset: 424730:ed7a2c9497d6
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sat Mar 14 10:32:30 2020 +0000

description:
mk/pkg-build-options.mk: make the documentation more precise

diffstat:

 mk/pkg-build-options.mk |  8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)

diffs (27 lines):

diff -r 845424140e66 -r ed7a2c9497d6 mk/pkg-build-options.mk
--- a/mk/pkg-build-options.mk   Sat Mar 14 10:21:53 2020 +0000
+++ b/mk/pkg-build-options.mk   Sat Mar 14 10:32:30 2020 +0000
@@ -1,18 +1,20 @@
-# $NetBSD: pkg-build-options.mk,v 1.12 2017/03/08 16:16:40 jperkin Exp $
+# $NetBSD: pkg-build-options.mk,v 1.13 2020/03/14 10:32:30 rillig Exp $
 #
 # This procedure determines the PKG_OPTIONS that have been in effect
 # when the package ${pkgbase} has been built. When the package is not
-# yet installed, the current PKG_OPTIONS are queried.
+# yet installed, its current PKG_OPTIONS are queried.
 #
 # Parameters:
 #      pkgbase
-#              The basename of the package.
+#              The package identifier, as in the package's buildlink3.mk
+#              file.
 #
 # Returns:
 #      PKG_BUILD_OPTIONS.${pkgbase}
 #              The build options of the package.
 #
 # Example:
+#      .include "../../emulators/wine/buildlink3.mk"
 #      pkgbase := wine
 #      .include "../../mk/pkg-build-options.mk"
 #