[pkgsrc/trunk]: pkgsrc/mk/check mk/check/check-portability.mk: improve docume...

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/2911514b1425
branches:  trunk
changeset: 431155:2911514b1425
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sat May 09 19:40:10 2020 +0000

description:
mk/check/check-portability.mk: improve documentation

diffstat:

 mk/check/check-portability.mk |  24 ++++++++++++------------
 1 files changed, 12 insertions(+), 12 deletions(-)

diffs (47 lines):

diff -r 4c69a7488f6f -r 2911514b1425 mk/check/check-portability.mk
--- a/mk/check/check-portability.mk     Sat May 09 19:26:39 2020 +0000
+++ b/mk/check/check-portability.mk     Sat May 09 19:40:10 2020 +0000
@@ -1,15 +1,12 @@
-# $NetBSD: check-portability.mk,v 1.16 2020/05/05 05:55:26 rillig Exp $
+# $NetBSD: check-portability.mk,v 1.17 2020/05/09 19:40:10 rillig Exp $
 #
-# This file contains some checks that are applied to the configure
-# scripts to check for certain constructs that are known to cause
-# problems on some platforms. The detailed checks are in
-# check-portability.sh.
+# This file checks that the extracted shell programs don't contain
+# bashisms or other constructs that only work on some platforms.
 #
 # User-settable variables:
 #
 # CHECK_PORTABILITY
-#      Whether to enable some portability checks for the configure
-#      scripts before they are run.
+#      Whether to enable the portability checks.
 #
 #      Default value: yes for PKG_DEVELOPERs, no otherwise.
 #
@@ -23,15 +20,18 @@
 # Package-settable variables:
 #
 # CHECK_PORTABILITY_SKIP
-#      The list of files that should be skipped in the portability
-#      check.
+#      The filename patterns that should not be checked.
+#      Note that a * in a pattern also matches a slash in a pathname.
 #
 #      Default value: ${REPLACE_BASH}
-#      Example: debian/*
+#      Examples: debian/* test/* *.bash
 
 _VARGROUPS+=                   check-portability
-_USER_VARS.check-portability=  CHECK_PORTABILITY
-_PKG_VARS.check-portability=   CHECK_PORTABILITY_SKIP
+_USER_VARS.check-portability=  CHECK_PORTABILITY \
+                               CHECK_PORTABILITY_EXPERIMENTAL
+_PKG_VARS.check-portability=   CHECK_PORTABILITY_SKIP REPLACE_BASH
+_USE_VARS.check-portability=   PKG_DEVELOPER
+_LISTED_VARS.check-portability=        REPLACE_BASH
 
 .if ${PKG_DEVELOPER:Uno} != "no"
 CHECK_PORTABILITY?=            yes