[pkgsrc/trunk]: pkgsrc/mk/tools Improve the documentation in the header comme...

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/381fdbaad44e
branches:  trunk
changeset: 492914:381fdbaad44e
user:      jlam <jlam%pkgsrc.org@localhost>
date:      Fri Apr 22 05:23:12 2005 +0000

description:
Improve the documentation in the header comments.

diffstat:

 mk/tools/bsd.tools.mk |  25 +++++++++++++++++++------
 1 files changed, 19 insertions(+), 6 deletions(-)

diffs (55 lines):

diff -r ecaabba2a8e1 -r 381fdbaad44e mk/tools/bsd.tools.mk
--- a/mk/tools/bsd.tools.mk     Fri Apr 22 04:22:37 2005 +0000
+++ b/mk/tools/bsd.tools.mk     Fri Apr 22 05:23:12 2005 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: bsd.tools.mk,v 1.3 2005/04/22 04:22:37 jlam Exp $
+# $NetBSD: bsd.tools.mk,v 1.4 2005/04/22 05:23:12 jlam Exp $
 #
 # This Makefile fragment creates tools under ${TOOLS_DIR} that are
 # found before similarly-named tools in the system path.
@@ -14,20 +14,29 @@
 #
 # The following variables specify the details of each <tool>:
 #
-#    TOOLS_CMD.<tool> is the path to the tool under ${TOOLS_DIR}
+#    TOOLS_CMD.<tool> is the path to the tool under ${TOOLS_DIR}.  This
+#      variable is optional, and if left unspecified it is either
+#      derived from TOOLS_REAL_CMD.<tool> for symlinks, or placed in
+#      the "bin" directory for wrappers by default.
 #
 #    TOOLS_REAL_CMD.<tool> is the path to the actual command that is
-#      invoked when ${TOOLS_CMD.<tool>} is called.
+#      invoked when ${TOOLS_CMD.<tool>} is called.  If <tool> should
+#      be a symlink, then this variable is required and should be a
+#      full path.  If <tool> should be a wrapper, then this variable
+#      is required unless TOOLS_REAL_CMDLINE.<tool> is defined (see
+#      below).
 #
 # The following variables specify further details of each <tool> and
 # are used only by tools listed in TOOLS_WRAP:
 #
 #    TOOLS_ARGS.<tool> additional arguments that are passed to the real
-#      command ahead of any command-line arguments.
+#      command ahead of any command-line arguments.  This variable is
+#      optional.
 #
 #    TOOLS_REAL_CMDLINE.<tool> specifies the full command-line to invoke
-#      in the wrapper script when <tool> is called.  By default, this
-#      is built up from TOOLS_REAL_CMD.<tool> and TOOLS_ARGS.<tool>.
+#      in the wrapper script when <tool> is called.  This variable is
+#      optional, and if left unspecified, then this is built up from
+#      TOOLS_REAL_CMD.<tool> and TOOLS_ARGS.<tool> by default.
 #
 # The following variables provide shortcuts for creating certain classes
 # of tools:
@@ -61,6 +70,10 @@
 
 USE_TOOLS?=            # empty
 
+# Include the other mk/tools/*.mk files here that help specify the
+# wrappers and symlinks that will be created by this file.  Order
+# matters!
+#
 .include "../../mk/tools/automake.mk"
 .include "../../mk/tools/autoconf.mk"
 .include "../../mk/tools/coreutils.mk"