[pkgsrc/trunk]: pkgsrc/mk/build More documentation for the purpose of this fi...

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/5515f641e147
branches:  trunk
changeset: 524629:5515f641e147
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sun Jan 28 15:29:11 2007 +0000

description:
More documentation for the purpose of this file and a tiny wording
improvement for TEST_DIRS.

diffstat:

 mk/build/test.mk |  15 +++++++++++----
 1 files changed, 11 insertions(+), 4 deletions(-)

diffs (35 lines):

diff -r 8d6c4325e739 -r 5515f641e147 mk/build/test.mk
--- a/mk/build/test.mk  Sun Jan 28 15:25:11 2007 +0000
+++ b/mk/build/test.mk  Sun Jan 28 15:29:11 2007 +0000
@@ -1,13 +1,18 @@
-# $NetBSD: test.mk,v 1.10 2007/01/27 08:14:07 uebayasi Exp $
+# $NetBSD: test.mk,v 1.11 2007/01/28 15:29:11 rillig Exp $
+#
+# After the "build" phase, many packages provide some sort of self-test
+# that can be run on the not-yet installed package. To enable these
+# tests, the package must define TEST_TARGET or override the do-test
+# target. Additionally, the pkgsrc user must define PKGSRC_RUN_TEST.
 #
 # Package-settable variables:
 #
 # TEST_TARGET is the name of the ${MAKE} target, provided by the
 #      package, which enables the tests to be executed
 #
-# TEST_DIRS is the list of directories in which to perform the build
-#      process.  If the directories are relative paths, then they
-#      are assumed to be relative to ${WRKSRC}.
+# TEST_DIRS is the list of directories in which to run the tests.
+#      If the directories are relative paths, then they are
+#      assumed to be relative to ${WRKSRC}.
 #
 # TEST_ENV is the shell environment that is exported to the make
 #       process.
@@ -25,6 +30,8 @@
 # See also:
 #      mk/build/build.mk
 #
+# Keywords: test check
+#
 
 TEST_DIRS?=            ${BUILD_DIRS}
 TEST_ENV+=             ${MAKE_ENV}