Fix out-of-bounds error when incorporating email from stdin
[mmh] / test / README
index 94b5ab1..e37a4ee 100644 (file)
@@ -1,30 +1,25 @@
-nmh unit test suite.
+Mmh test suite.
 
 
-
-       The testcases are not maintained in mmh, currently.
-       Thus, they likely are broken.     --meillo 2012-04
-
-
-The purpose of these tests is to verify the functionality of the nmh
+The purpose of these tests is to verify the functionality of the mmh
 commands.  The goal of the suite is to create an environment where testing
 commands.  The goal of the suite is to create an environment where testing
-nmh commands is easy and useful.  Each test is a shell script, and is
+mmh commands is easy and useful.  Each test is a shell script, and is
 launched via the 'sh' command. The script should run the test and report
 the result by one of:
 
   * for a test pass: exit with status 0
   * where a test has been skipped (perhaps because it depends on an
 launched via the 'sh' command. The script should run the test and report
 the result by one of:
 
   * for a test pass: exit with status 0
   * where a test has been skipped (perhaps because it depends on an
-    external program which can't be found): print "Test $0 SKIP (reason)"
-    and exit with status 120
+    external program which can't be found) execute: `test_skip "reason"'.
+    (test_skip() is defined in common.sh; it exits with status 120)
   * for a test fail: exit with some status other than 0 or 120
 
 The Suite is arranged as such:
 
 setup-test
   * for a test fail: exit with some status other than 0 or 120
 
 The Suite is arranged as such:
 
 setup-test
-    Create the unit test framework.  This will re-generate your configure
+    Create the test framework.  This will re-generate your configure
     script and make files.
 
 teardown-test
     script and make files.
 
 teardown-test
-    Remove the temporary files created as part of the unit tests.
+    Remove the temporary files created as part of the tests.
 
 runtest
     Run a single test.
 
 runtest
     Run a single test.
@@ -34,8 +29,8 @@ runalltests
 
 tests
     Directory containing the tests.  All files found in this and all
 
 tests
     Directory containing the tests.  All files found in this and all
-    subsequent directories which have the name test-* will be treated as a
-    single test.
+    sub-directories which have the name test-* will be treated as one
+    test each.
 
 Complex tests may be given their own directory as long as there is a file
 named 'test-*' in the directory which will launch the test.
 
 Complex tests may be given their own directory as long as there is a file
 named 'test-*' in the directory which will launch the test.