]> git.ipfire.org Git - thirdparty/automake.git/commitdiff
check: rename AM_TESTS_SETUP -> AM_TESTS_ENVIRONMENT
authorStefano Lattarini <stefano.lattarini@gmail.com>
Sun, 17 Apr 2011 22:52:03 +0000 (00:52 +0200)
committerStefano Lattarini <stefano.lattarini@gmail.com>
Sun, 17 Apr 2011 22:52:03 +0000 (00:52 +0200)
The AM_TESTS_SETUP naming was not a good one after all.  It may
be technically more correct than AM_TESTS_ENVIRONMENT, but the
latter is a better one simply because it is easier to remember,
and even if you've never heard of it and only know the semantics
of TESTS_ENVIRONMENT, you can have a straightforward way to
figure out how AM_TESTS_ENVIRONMENT would work.

* tests/check.am (am__check_pre): Update.
* doc/automake.in (Simple Tests using parallel-tests): Update.
* tests/parallel-tests-am_tests_setup.test: Renamed ...
* tests/parallel-tests-am_tests_environment.test: ... to this,
and updated.
* tests/Makefile.am (TESTS): Update.

Suggestion and motivation by Ralf Wildenhues.

ChangeLog
doc/automake.texi
lib/Automake/tests/Makefile.in
lib/am/check.am
tests/Makefile.am
tests/Makefile.in
tests/parallel-tests-am_tests_environment.test [moved from tests/parallel-tests-am_tests_setup.test with 91% similarity]

index ed1d4aa329f089b09ebb7517b9f76fb7b1ed19f7..f121e0e0554a582dea7db6766ca020e48a1fe37b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,20 @@
+2011-04-18  Stefano Lattarini  <stefano.lattarini@gmail.com>
+
+       check: rename AM_TESTS_SETUP -> AM_TESTS_ENVIRONMENT
+       The AM_TESTS_SETUP naming was not a good one after all.  It may
+       be technically more correct than AM_TESTS_ENVIRONMENT, but the
+       latter is a better one simply because it is easier to remember,
+       and even if you've never heard of it and only know the semantics
+       of TESTS_ENVIRONMENT, you can have a straightforward way to
+       figure out how AM_TESTS_ENVIRONMENT would work.
+       * tests/check.am (am__check_pre): Update.
+       * doc/automake.in (Simple Tests using parallel-tests): Update.
+       * tests/parallel-tests-am_tests_setup.test: Renamed ...
+       * tests/parallel-tests-am_tests_environment.test: ... to this,
+       and updated.
+       * tests/Makefile.am (TESTS): Update.
+       Suggestion and motivation by Ralf Wildenhues.
+
 2011-04-17  Stefano Lattarini  <stefano.lattarini@gmail.com>
 
        check: new developer-reserved AM_TESTS_SETUP variable
index 6692e7f7dda7dbe4d6448713097a03495951a137..7394253a200fcb3c705807b228ad15fc7867c02c 100644 (file)
@@ -8664,7 +8664,7 @@ for exceptional failures.  Similar to the simple test driver,
 the @code{check_*} variables are honored, and the environment variable
 @env{srcdir} is set during test execution. Also, @code{TESTS_ENVIRONMENT}
 is still honored, but is complemented by a new developer-reserved variable
-@code{AM_TESTS_SETUP} (described below).
+@code{AM_TESTS_ENVIRONMENT} (described below).
 
 This test driver is still experimental and may undergo changes in order
 to satisfy additional portability requirements.
@@ -8736,27 +8736,27 @@ and @samp{./wrapper-script -d baz} to produce @file{foo.log},
 @samp{TESTS_ENVIRONMENT} variable is still expanded before the driver,
 but should be reserved for the user.
 
-@vindex AM_TESTS_SETUP
-The @code{AM_TESTS_SETUP} 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_SETUP}.  Note that, for implementation reasons, if the
-@code{AM_TESTS_SETUP} variable is set, its contents @emph{must} be
-terminated by a semicolon.
-
-@example
-# The tests below are expected to use the file descriptor passed
-# in the environment variable 'warn_fileno' to print warnings
-# (e.g., about skipped and failed tests).  If this variable were
-# to be set to `2' (i.e. default stderr), the warnings would be
-# redirected by the automake parallel-tests driver into the .log
-# files.  But the AM_TESTS_SETUP definition below will cause the
-# reasons for skip/failure to be printed to the console instead.
-# The user can still override this by setting TESTS_ENVIRONMENT
-# to e.g. `warn_fileno=2' at make runtime, which will cause the
-# warnings to be sent to the .log files again.
+@vindex AM_TESTS_ENVIRONMENT
+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.
+
+@example
+# The tests below are expected to use the file descriptor passed in
+# the environment variable 'warn_fileno' to print warnings (e.g.,
+# about skipped and failed tests).  If this variable were to be set
+# to `2' (i.e. default stderr), the warnings would be redirected by
+# the automake parallel-tests driver into the .log files.  But the
+# AM_TESTS_ENVIRONMENT definition below will cause the reasons for
+# skip/failure to be printed to the console instead.  The user
+# can still override this by setting TESTS_ENVIRONMENT to e.g.
+# `warn_fileno=2' at make runtime, which will cause the warnings
+# to be sent to the .log files again.
 TESTS = test1.sh test2.sh ...
-AM_TESTS_SETUP = exec 9>&2; warn_fileno=9; export warn_fileno;
+AM_TESTS_ENVIRONMENT = exec 9>&2; warn_fileno=9; export warn_fileno;
 @end example
 
 @trindex mostlyclean
index bea7a8daebb4c212c1214a57ba09bd4caed150b8..b1916a87acba35135504cd629cefc88c0df5213a 100644 (file)
@@ -122,10 +122,10 @@ am__sh_e_setup = case $$- in *e*) set +e;; esac
 # To be inserted before the command running the test.  Creates the
 # directory for the log if needed.  Stores in $dir the directory
 # containing $f, in $tst the test, in $log the log.  Executes the
-# developer- defined test setup AM_TESTS_SETUP (if any), and passes
-# TESTS_ENVIRONMENT.  Saves and restores TERM around uses of
-# TESTS_ENVIRONMENT and AM_TESTS_SETUP, in case any of them unsets
-# it.
+# developer- defined test setup AM_TESTS_ENVIRONMENT (if any), and
+# passes TESTS_ENVIRONMENT.  Saves and restores TERM around uses of
+# TESTS_ENVIRONMENT and AM_TESTS_ENVIRONMENT, in case any of them
+# unsets it.
 am__check_pre = \
 $(am__sh_e_setup);                                     \
 $(am__vpath_adj_setup) $(am__vpath_adj)                        \
@@ -140,7 +140,7 @@ if test -f "./$$f"; then dir=./;                    \
 elif test -f "$$f"; then dir=;                         \
 else dir="$(srcdir)/"; fi;                             \
 tst=$$dir$$f; log='$@'; __SAVED_TERM=$$TERM;           \
-$(AM_TESTS_SETUP)                                      \
+$(AM_TESTS_ENVIRONMENT)                                        \
 $(TESTS_ENVIRONMENT)
 # To be appended to the command running the test.  Handle the stdout
 # and stderr redirection, and catch the exit status.
index 1827e01143c3371faf5ef9bcbfa936015cf41acf..97ecb68453e2db3e28d2f6fc3e931d5761507a5d 100644 (file)
@@ -94,10 +94,10 @@ am__sh_e_setup = case $$- in *e*) set +e;; esac
 # To be inserted before the command running the test.  Creates the
 # directory for the log if needed.  Stores in $dir the directory
 # containing $f, in $tst the test, in $log the log.  Executes the
-# developer- defined test setup AM_TESTS_SETUP (if any), and passes
-# TESTS_ENVIRONMENT.  Saves and restores TERM around uses of
-# TESTS_ENVIRONMENT and AM_TESTS_SETUP, in case any of them unsets
-# it.
+# developer- defined test setup AM_TESTS_ENVIRONMENT (if any), and
+# passes TESTS_ENVIRONMENT.  Saves and restores TERM around uses of
+# TESTS_ENVIRONMENT and AM_TESTS_ENVIRONMENT, in case any of them
+# unsets it.
 am__check_pre =                                                \
 $(am__sh_e_setup);                                     \
 $(am__vpath_adj_setup) $(am__vpath_adj)                        \
@@ -112,7 +112,7 @@ if test -f "./$$f"; then dir=./;                    \
 elif test -f "$$f"; then dir=;                         \
 else dir="$(srcdir)/"; fi;                             \
 tst=$$dir$$f; log='$@'; __SAVED_TERM=$$TERM;           \
-$(AM_TESTS_SETUP)                                      \
+$(AM_TESTS_ENVIRONMENT)                                        \
 $(TESTS_ENVIRONMENT)
 
 # To be appended to the command running the test.  Handle the stdout
index c6006e325898b20991691538cb076696015427f7..3c98cfc45f700722fdba16867e4bfd413dc3294f 100644 (file)
@@ -580,7 +580,7 @@ parallel-tests7.test \
 parallel-tests8.test \
 parallel-tests9.test \
 parallel-tests10.test \
-parallel-tests-am_tests_setup.test \
+parallel-tests-am_tests_environment.test \
 parallel-tests-unreadable-log.test \
 parallel-tests-subdir.test \
 parse.test \
index 40744a4a4426462a44a942d30df0687793bd4c64..36a63ce07380bf0b42eafee253bb5121add3fc33 100644 (file)
@@ -125,10 +125,10 @@ am__sh_e_setup = case $$- in *e*) set +e;; esac
 # To be inserted before the command running the test.  Creates the
 # directory for the log if needed.  Stores in $dir the directory
 # containing $f, in $tst the test, in $log the log.  Executes the
-# developer- defined test setup AM_TESTS_SETUP (if any), and passes
-# TESTS_ENVIRONMENT.  Saves and restores TERM around uses of
-# TESTS_ENVIRONMENT and AM_TESTS_SETUP, in case any of them unsets
-# it.
+# developer- defined test setup AM_TESTS_ENVIRONMENT (if any), and
+# passes TESTS_ENVIRONMENT.  Saves and restores TERM around uses of
+# TESTS_ENVIRONMENT and AM_TESTS_ENVIRONMENT, in case any of them
+# unsets it.
 am__check_pre = \
 $(am__sh_e_setup);                                     \
 $(am__vpath_adj_setup) $(am__vpath_adj)                        \
@@ -143,7 +143,7 @@ if test -f "./$$f"; then dir=./;                    \
 elif test -f "$$f"; then dir=;                         \
 else dir="$(srcdir)/"; fi;                             \
 tst=$$dir$$f; log='$@'; __SAVED_TERM=$$TERM;           \
-$(AM_TESTS_SETUP)                                      \
+$(AM_TESTS_ENVIRONMENT)                                        \
 $(TESTS_ENVIRONMENT)
 # To be appended to the command running the test.  Handle the stdout
 # and stderr redirection, and catch the exit status.
@@ -853,7 +853,7 @@ parallel-tests7.test \
 parallel-tests8.test \
 parallel-tests9.test \
 parallel-tests10.test \
-parallel-tests-am_tests_setup.test \
+parallel-tests-am_tests_environment.test \
 parallel-tests-unreadable-log.test \
 parallel-tests-subdir.test \
 parse.test \
similarity index 91%
rename from tests/parallel-tests-am_tests_setup.test
rename to tests/parallel-tests-am_tests_environment.test
index bf0d0c64da6c1a26ef2b2a581ead90b710e4c0bc..072e614d4a858d7ce2a988bd1b9822337a5a8e65 100755 (executable)
@@ -14,8 +14,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-# parallel-tests: check AM_TESTS_SETUP support, and its interaction
-# with TESTS_ENVIRONMENT.
+# parallel-tests: check AM_TESTS_ENVIRONMENT support, and its
+# interactions with TESTS_ENVIRONMENT.
 
 parallel_tests=yes
 . ./defs || Exit 1
@@ -31,7 +31,7 @@ cat > Makefile.am << 'END'
 TEST_EXTENSIONS = .sh .test
 TESTS = foo.test bar.sh
 SH_LOG_COMPILER = sh
-AM_TESTS_SETUP = $(MKDIR_P) quux.dir; exec 9>&2; fd=9; export fd;
+AM_TESTS_ENVIRONMENT = $(MKDIR_P) quux.dir; exec 9>&2; fd=9; export fd;
 EXTRA_DIST = $(TESTS)
 END