[pkgsrc/trunk]: pkgsrc/mk/buildlink3 Reformatted and extended the comment so ...

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/0b4e99bb54b8
branches:  trunk
changeset: 561573:0b4e99bb54b8
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sat Jul 11 07:56:25 2009 +0000

description:
Reformatted and extended the comment so that it can be found by
"make help".

diffstat:

 mk/buildlink3/pkgconfig-builtin.mk |  41 +++++++++++++++++++++++++------------
 1 files changed, 28 insertions(+), 13 deletions(-)

diffs (59 lines):

diff -r 8525168c7e18 -r 0b4e99bb54b8 mk/buildlink3/pkgconfig-builtin.mk
--- a/mk/buildlink3/pkgconfig-builtin.mk        Sat Jul 11 05:52:17 2009 +0000
+++ b/mk/buildlink3/pkgconfig-builtin.mk        Sat Jul 11 07:56:25 2009 +0000
@@ -1,17 +1,34 @@
-# $NetBSD: pkgconfig-builtin.mk,v 1.4 2008/10/06 13:19:11 cube Exp $
+# $NetBSD: pkgconfig-builtin.mk,v 1.5 2009/07/11 07:56:25 rillig Exp $
 
-# This file is used to factor out a common pattern in builtin.mk files backed
-# up by the existence of a pkgconfig file.
+# This file is used to factor out a common pattern in builtin.mk files
+# backed up by the existence of a pkgconfig file.
+#
+# Parameters:
 #
-# Caller has to define BUILTIN_PKG and PKGCONFIG_FILE.<BUILTIN_PKG>.
+# BUILTIN_PKG
+#      The name of the package that is tested.
+#
+# PKGCONFIG_FILE.<BUILTIN_PKG>
+#      The absolute path where the pkgconfig file of the native
+#      implementation of the package is stored.
+#
+#      Example: ${X11BASE}/lib/pkgconfig/fontcacheproto.pc
 #
-# Optionally, caller may define PKGCONFIG_BASE.<BUILTIN_PKG> as the base
-# location for a native implementation of the package.  It conveniently
-# defaults to X11BASE.
+# PKGCONFIG_BASE.<BUILTIN_PKG> (optional)
+#      The base location for a native implementation of the package.
+#
+#      Default: ${X11BASE}
 #
-# The caller may also override the default, pkgconfig-specific, version
-# script.  That means this file can be called by a lot more generic
-# builtin.mk files.
+# BUILTIN_VERSION_SCRIPT.<BUILTIN_PKG> (optional)
+#      The program that is used to extract the version number from the
+#      PKGCONFIG_FILE.<BUILTIN_PKG>. The expected output is the plain
+#      version number on a single line.
+#
+#      By defining a custom script this file can be called by a lot
+#      more generic builtin.mk files.
+#
+#      Default: (something suitable for pkgconfig files)
+# 
 
 BUILTIN_FIND_FILES_VAR:=                       FIND_FILES_${BUILTIN_PKG}
 BUILTIN_FIND_FILES.FIND_FILES_${BUILTIN_PKG}=  ${PKGCONFIG_FILE.${BUILTIN_PKG}}
@@ -33,9 +50,7 @@
     (!empty(FIND_FILES_${BUILTIN_PKG}:M*.pc) || \
      (empty(FIND_FILES_${BUILTIN_PKG}:M__nonexistent__) && \
      defined(BUILTIN_VERSION_SCRIPT.${BUILTIN_PKG})))
-. if !defined(BUILTIN_VERSION_SCRIPT.${BUILTIN_PKG})
-BUILTIN_VERSION_SCRIPT.${BUILTIN_PKG}= ${SED} -n -e 's/Version: //p'
-. endif
+BUILTIN_VERSION_SCRIPT.${BUILTIN_PKG}?=        ${SED} -n -e 's/Version: //p'
 BUILTIN_VERSION.${BUILTIN_PKG}!= ${BUILTIN_VERSION_SCRIPT.${BUILTIN_PKG}} \
                                        ${FIND_FILES_${BUILTIN_PKG}}
 BUILTIN_PKG.${BUILTIN_PKG}:= ${BUILTIN_PKG}-${BUILTIN_VERSION.${BUILTIN_PKG}}