Re: [PATCH] {maint} docs: automake testsuite doesn't use TESTS_ENVIRONMENT anymore

[Ralf Wildenhues]

* Stefano Lattarini wrote on Mon, Jan 17, 2011 at 10:42:21PM CET:
> docs: automake testsuite doesn't use TESTS_ENVIRONMENT anymore
> 
> * doc/automake.texi (Simple Tests): Do not give the example of a
> TESTS_ENVIRONMENT usage by saying it's what the Automake package
> itself does: this is not true anymore since it switched to the
> parallel-tests driver.

> --- a/doc/automake.texi
> +++ b/doc/automake.texi
> @@ -8596,8 +8596,9 @@ variables for the test run; the environment variable 
> @env{srcdir} is
>  set in the rule.  If all your test programs are scripts, you can also
>  set @code{TESTS_ENVIRONMENT} to an invocation of the shell (e.g.
>  @samp{$(SHELL) -x} can be useful for debugging the tests), or any other
> -interpreter.  For instance the following setup is used by the Automake
> -package to run four tests in Perl.
> +interpreter.  For instance the following setup was used by the Automake
> address@hidden it switched to the use of the
> address@hidden option.} to run four tests in Perl.

Footnotes really impair the read flow, almost like top-posting,
so it should be used very sparingly only.  How about this patch
instead?

Thanks,
Ralf

2011-01-19  Stefano Lattarini  <address@hidden>
            Ralf Wildenhues  <address@hidden>

        docs: automake testsuite doesn't use TESTS_ENVIRONMENT anymore
        * doc/automake.texi (Simple Tests): Do not claim Automake uses
        TESTS_ENVIRONMENT for the perl driver.  Instead, point to the
        parallel-tests driver.

diff --git a/doc/automake.texi b/doc/automake.texi
index 73c0e51..536b65f 100644
--- a/doc/automake.texi
+++ b/doc/automake.texi
@@ -8596,13 +8596,19 @@ Simple Tests
 set in the rule.  If all your test programs are scripts, you can also
 set @code{TESTS_ENVIRONMENT} to an invocation of the shell (e.g.
 @samp{$(SHELL) -x} can be useful for debugging the tests), or any other
-interpreter.  For instance the following setup is used by the Automake
-package to run four tests in Perl.
+interpreter.  For instance the following setup may be used to run tests
+with Perl:
+
 @example
 TESTS_ENVIRONMENT = $(PERL) -Mstrict -I $(top_srcdir)/lib -w
 TESTS = Condition.pl DisjConditions.pl Version.pl Wrap.pl
 @end example
 
+Note that the @option{parallel-tests} driver provides a more elegant
+way to achieve the same effect, freeing the @code{TESTS_ENVIRONMENT}
+variable for the user to override (@pxref{Simple Tests using
+parallel-tests}).
+
 
 @cindex Tests, expected failure
 @cindex Expected test failure