Update usage instructions, and document test case format.
authorMatt Kraai <kraai@debian.org>
Mon, 19 Nov 2001 19:28:56 +0000 (19:28 -0000)
committerMatt Kraai <kraai@debian.org>
Mon, 19 Nov 2001 19:28:56 +0000 (19:28 -0000)
testsuite/README

index 1afb9ebd2a25b7a080bcc967f21481356f34cbac..a886b42174f311133639b647fcf9dcb85a6ff086 100644 (file)
@@ -1,6 +1,16 @@
-To use this testsuite, unpack it as a subdirectory of your BusyBox
-build tree.  Then change directory into the testsuite and run
-`./runtest'.
+To run the test suite, change to this directory and run
+"./runtest".  To only run the test cases for particular applets,
+specify them as parameters to runtest.
+
+The test cases for an applet reside in the subdirectory of the
+applet name.  The name of the test case should be the assertion
+that is tested.  The test case should be a shell fragment that
+returns successfully if the test case passes, and unsuccessfully
+otherwise.  If the test case is known to fail, it should be marked
+as such by including the string "XFAIL" in a comment.  If a
+certain feature must be enabled for it to pass, it should indicate
+that by including the string "UNSUPPORTED: " followed by the
+feature name in a comment.
 
 For the entire testsuite, the copyright is as follows: