On Tuesday 28 June 2011, Stefano Lattarini wrote:
> On Monday 27 June 2011, Ralf Wildenhues wrote:
> > * Stefano Lattarini wrote on Mon, Jun 27, 2011 at 01:11:51PM CEST:
> > > > > +If the @code{AM_TESTS_ENVIRONMENT} variable is set, its contents
> > > > > +@emph{must} be terminated by a semicolon.
> > > > > >
> > > > Why is that necessarily so?
> > > >
> > > Otherwise the user couldn't safely use TESTS_ENVIRONMENT for overriding
> > > AM_TESTS_ENVIRONMENT; for example, with "foo=0 foo=1 COMMAND ...", some
> > > shells (e.g., bash and dash) will export foo to `0' in the environment
> > > of COMMAND, while other shells (e.g., Solaris /bin/sh) will export foo
> > > to `1'. And BTW, it was you that pointed this out to me originally ;-)
> >
> > See, I simply didn't think of TESTS_ENVIRONMENT. So, the documentation
> > should make it clear that variables actually need to be exported (not
> > just set); it can't hurt to say why the semicolon is useful: "so that
> > the user can set TESTS_ENVIRONMENT to override variables further".
> >
> I like this, and I'll make the change. But notice that the documentation
> about AM_TESTS_ENVIRONMENT we're referring to was already in master, so
> that the right thing to do is to fix it there, merge master to the branch
> 'test-protocols', and rebase the documentation branch on that.
>
Here it is the patch I've applied to master.
From 3e334a272fa601bebb5896e25cfb63f34822a275 Mon Sep 17 00:00:00 2001
Message-Id:
<3e334a272fa601bebb5896e25cfb63f34822a275.1309333773.git.stefano.lattar...@gmail.com>
From: Stefano Lattarini <stefano.lattar...@gmail.com>
Date: Wed, 29 Jun 2011 09:44:14 +0200
Subject: [PATCH] docs: explain why AM_TESTS_ENVIRONMENT must be
semicolon-terminated
* doc/automake.texi (Simple Tests using parallel-tests): Ditto, and
related adjustments.
Suggestion by Ralf Wildenhues.
---
ChangeLog | 7 +++++++
doc/automake.texi | 8 ++++----
2 files changed, 11 insertions(+), 4 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 7c8888e..64c2bbb 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2011-06-29 Stefano Lattarini <stefano.lattar...@gmail.com>
+
+ docs: explain why AM_TESTS_ENVIRONMENT must be semicolon-terminated
+ * doc/automake.texi (Simple Tests using parallel-tests): Ditto, and
+ related adjustments.
+ Suggestion by Ralf Wildenhues.
+
2011-06-29 Stefano Lattarini <stefano.lattar...@gmail.com>
docs: fix unportable example of AM_TESTS_ENVIRONMENT usage
diff --git a/doc/automake.texi b/doc/automake.texi
index d60bfe4..da2e2b4 100644
--- a/doc/automake.texi
+++ b/doc/automake.texi
@@ -8740,10 +8740,10 @@ but should be reserved for the user.
The @code{AM_TESTS_ENVIRONMENT} variable can be used to run initialization
code and set environment variables for the tests' runs. The user can
still employ the @code{TESTS_ENVIRONMENT} variable to override settings
-from @code{AM_TESTS_ENVIRONMENT}. Note that, for implementation reasons,
-if the @code{AM_TESTS_ENVIRONMENT} variable is set, its contents
-@emph{must} be terminated by a semicolon. Here is an example of a
-slightly elaborate definition:
+from @code{AM_TESTS_ENVIRONMENT}; for that to work portably, however,
+the contents of a non-empty @code{AM_TESTS_ENVIRONMENT} @emph{must} be
+terminated by a semicolon. Here is an example of a slightly elaborate
+definition:
@example
AM_TESTS_ENVIRONMENT = \
--
1.7.2.3
