changeset 13321:95bb4e6a23ea

init.sh: improve comments * tests/init.sh: Recommend the one-line init.sh-sourcing idiom: . "${srcdir=.}/init.sh"; path_prepend_ . Add a note about path_prepend_ and the alternative of using TESTS_ENVIRONMENT.
author Jim Meyering <meyering@redhat.com>
date Fri, 07 May 2010 09:19:41 +0200
parents 4e283fd1efe9
children 741821a201ac
files ChangeLog tests/init.sh
diffstat 2 files changed, 15 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2010-05-07  Jim Meyering  <meyering@redhat.com>
+
+	init.sh: improve comments
+	* tests/init.sh: Recommend the one-line init.sh-sourcing idiom:
+	. "${srcdir=.}/init.sh"; path_prepend_ .
+	Add a note about path_prepend_ and the alternative of using
+	TESTS_ENVIRONMENT.
+
 2010-05-06  Sergey Poznyakoff  <gray@gnu.org.ua>
 
 	exclude: Unescape hashed patterns in wildcard mode.
--- a/tests/init.sh
+++ b/tests/init.sh
@@ -21,11 +21,16 @@
 # The typical skeleton of a test looks like this:
 #
 #   #!/bin/sh
-#   : ${srcdir=.}
-#   . "$srcdir/init.sh"; path_prepend_ .
+#   . "${srcdir=.}/init.sh"; path_prepend_ .
 #   Execute some commands.
 #   Note that these commands are executed in a subdirectory, therefore you
 #   need to prepend "../" to relative filenames in the build directory.
+#   Note that the "path_prepend_ ." is useful only if the body of your
+#   test invokes programs residing in the initial directory.
+#   For example, if the programs you want to test are in src/, and this test
+#   script is named tests/test-1, then you would use "path_prepend_ ../src",
+#   or perhaps export PATH='$(abs_top_builddir)/src$(PATH_SEPARATOR)'"$$PATH"
+#   to all tests via automake's TESTS_ENVIRONMENT.
 #   Set the exit code 0 for success, 77 for skipped, or 1 or other for failure.
 #   Use the skip_ and fail_ functions to print a diagnostic and then exit
 #   with the corresponding exit code.