automake-patches
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[FYI] {maint} tests/README: update obsoleted advice


From: Stefano Lattarini
Subject: [FYI] {maint} tests/README: update obsoleted advice
Date: Fri, 20 May 2011 22:21:09 +0200
User-agent: KMail/1.13.3 (Linux/2.6.30-2-686; KDE/4.4.4; i686; ; )

* tests/README (Section "Writing test cases" subsection "Do"):
Do not suggest to use the `*-p.test' pattern for the names of
hand-written tests which use the `parallel-tests' Automake option.
Not only is this not respected by the existing tests, but it is
more likely to cause conflicts with auto-generated tests.
So, suggest to *avoid* using the `*-p.test' pattern in names
of hand-written tests instead.
(Section "Writing test cases" subsection "Do not"):  When
suggesting not to override Makefile variables using command
line arguments, do not use the badly outdated variables `U'
and 'ANSI2KNR' in the example; instead, use the more common
and typical `DESTDIR'.
---
 ChangeLog    |   16 ++++++++++++++++
 tests/README |   16 ++++++++--------
 2 files changed, 24 insertions(+), 8 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index d50f10f..1df04b8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,19 @@
+2011-05-20  Stefano Lattarini  <address@hidden>
+
+       tests/README: update obsoleted advice
+       * tests/README (Section "Writing test cases" subsection "Do"):
+       Do not suggest to use the `*-p.test' pattern for the names of
+       hand-written tests using the `parallel-tests' Automake option.
+       Not only is this not respected by the existing tests, but it
+       is more likely to cause conflicts with auto-generated tests.
+       So, suggest to *avoid* using the `*-p.test' pattern in names
+       of hand-written tests instead.
+       (Section "Writing test cases" subsection "Do not"):  When
+       suggesting not to override Makefile variables using command
+       line arguments, do not use the badly outdated variables `U'
+       and 'ANSI2KNR' in the example; instead, use the more common
+       and typical `DESTDIR'.
+
 2011-05-19  Stefano Lattarini  <address@hidden>
 
        test defs: rename requirement 'non-cross' -> 'native'
diff --git a/tests/README b/tests/README
index 26ce3ff..8e4d3e4 100644
--- a/tests/README
+++ b/tests/README
@@ -107,8 +107,8 @@ Do
 
   For tests that use the `parallel-tests' Automake option, set the shell
   variable `parallel_tests' to "yes" before including ./defs.  Also,
-  use for them a name that ends in `-p.test' and does not clash with any
-  generated tests in the suite.
+  do not use for them a name that ends in `-p.test', since that would
+  risk to clash with automatically-generated tests.
 
   ./defs sets a skeleton configure.in.  If possible, append to this
   file.  In some cases you'll have to overwrite it, but this should
@@ -177,12 +177,12 @@ Do not
   reason, but at least it makes sure the original error is still
   here.)
 
-  Do not override Makefile variables using make arguments, as in
-    $MAKE ANSI2KNR=./ansi2knr U=_ all
-  this is not portable for recursive targets (targets that
-  call a sub-make may not pass `ANSI2KNR=./ansi2knr U=_' along).
-  Use the following instead.
-    ANSI2KNR=./ansi2knr U=_ $MAKE -e all
+  Do not override Makefile variables using make arguments, as in e.g.:
+    $MAKE DESTDIR=/foo/bar install
+  This is not portable for recursive targets (targets that call a
+  sub-make may not pass `DESTDIR=/foo/bar' along).  Use the following
+  instead:
+    DESTDIR=/foo/bar $MAKE -e install
 
   Do not send a test case without signing a copyright disclaimer.
   See http://sources.redhat.com/automake/contribute.html or
-- 
1.7.2.3




reply via email to

[Prev in Thread] Current Thread [Next in Thread]