From 0f53bd10322ac70691d8bed06533424eef8db0e6 Mon Sep 17 00:00:00 2001 From: Stefano Lattarini Date: Fri, 20 May 2011 22:15:32 +0200 Subject: [PATCH] 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 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..53dd132 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,19 @@ +2011-05-20 Stefano Lattarini + + 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 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'. + 2011-05-19 Stefano Lattarini 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 -- 2.7.4