(top level): Explain the point of this test.

diff --git a/test-suite/ChangeLog b/test-suite/ChangeLog
index 9703d7d35230c8e7c85937e5e489df90a27b443b..60990ef3ecf4ac5ab1476a114656d94f606211dd 100644 (file)
--- a/test-suite/ChangeLog
+++ b/test-suite/ChangeLog
@@ -1,6 +1,8 @@
 2007-12-29  Neil Jerram  <neil@ossau.uklinux.net>
 
        * standalone/test-bad-identifiers: New test.
+       (top level): Explain the point of this test.
+
        * standalone/Makefile.am (check_SCRIPTS, TESTS): Add it.
 
 2007-12-13  Stephen Compall  <s11@member.fsf.org>

diff --git a/test-suite/standalone/test-bad-identifiers b/test-suite/standalone/test-bad-identifiers
index 5e263fc7f50615be63b7926aad147e894bdbc25a..6462dbdbe3a9c2e147e9826fb1ac4fae553b87f7 100755 (executable)
--- a/test-suite/standalone/test-bad-identifiers
+++ b/test-suite/standalone/test-bad-identifiers
@@ -2,6 +2,12 @@
 exec guile -s "$0" "$@"
 !#
 
+;; The use of certain identifiers as variable or parameter names has
+;; been found to cause build problems on particular platforms.  The
+;; aim of this test is to cause "make check" to fail (on GNU/Linux,
+;; which most Guile developers use) if we accidentally add new code
+;; that uses those identifiers.
+
 (define bad-identifiers
   '(
     ;; On AIX 5.2 and 5.3, /usr/include/sys/timer.h includes:
@@ -10,6 +16,8 @@ exec guile -s "$0" "$@"
     ;;  #endif
     ;; So we want to avoid using func_data in Guile source code.
     "func_data"
+
+    ;; More troublesome identifiers can be added into the list here.
     ))
 
 (use-modules (ice-9 regex) (ice-9 rdelim))