[pkgsrc/trunk]: pkgsrc/mk/check Added documentation.

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/91f263084973
branches:  trunk
changeset: 521357:91f263084973
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Thu Nov 09 21:29:26 2006 +0000

description:
Added documentation.

diffstat:

 mk/check/check-files.mk |  34 ++++++++++++++++++++++++++--------
 1 files changed, 26 insertions(+), 8 deletions(-)

diffs (48 lines):

diff -r a0a7c69fecc6 -r 91f263084973 mk/check/check-files.mk
--- a/mk/check/check-files.mk   Thu Nov 09 21:15:55 2006 +0000
+++ b/mk/check/check-files.mk   Thu Nov 09 21:29:26 2006 +0000
@@ -1,18 +1,36 @@
-# $NetBSD: check-files.mk,v 1.9 2006/10/09 12:25:44 joerg Exp $
+# $NetBSD: check-files.mk,v 1.10 2006/11/09 21:29:26 rillig Exp $
+#
+# This file checks that the list of installed files matches the PLIST.
+# For that purpose it records the file list of LOCALBASE before and
+# after the installation of the package and compares these lists with
+# the PLIST.
+#
+# User-settable variables:
+#
+# CHECK_FILES
+#      "yes" to enable the check, "no" to disable it.
+#
+#      Default value: "yes" for PKG_DEVELOPERs, "no" otherwise.
+#
+# CHECK_FILES_STRICT
+#      When set to "yes", VARBASE and PKG_SYSCONFDIR are checked in
+#      addition to LOCALBASE.
+#
+# Package-settable variables:
+#
+# CHECK_FILES_SKIP
+#      A list of regular expressions (FIXME: all other checks use shell
+#      patterns) that names files to be skipped. This is useful to
+#      avoid getting errors triggered by changes in directories not
+#      really handled by pkgsrc.
+#
 
 .if defined(PKG_DEVELOPER)
 CHECK_FILES?=          yes
 .endif
-
 CHECK_FILES?=          no
 CHECK_FILES_STRICT?=   no
 
-###########################################################################
-# CHECK_FILES_SKIP is a list of file names that will be skipped when
-# analyzing file lists in the check-files target.  This is useful to
-# avoid getting errors triggered by changes in directories not really
-# handled by pkgsrc.
-
 # Info index files updated when a new info file is added.
 .if defined(INFO_FILES)
 CHECK_FILES_SKIP+=     ${PREFIX}/.*/dir$$$$