summaryrefslogtreecommitdiff
path: root/testsuite/README
diff options
context:
space:
mode:
authorMatt Kraai2001-11-19 19:28:56 +0000
committerMatt Kraai2001-11-19 19:28:56 +0000
commit36c613a4437b20986dbca9385d79a76288753c6b (patch)
tree00ff98a00ff9cc17011a8f26e7ed469abfc87d9a /testsuite/README
parent9dfe508a3f2ab4092f4b9843838d88ad8077691d (diff)
downloadbusybox-36c613a4437b20986dbca9385d79a76288753c6b.zip
busybox-36c613a4437b20986dbca9385d79a76288753c6b.tar.gz
Update usage instructions, and document test case format.
Diffstat (limited to 'testsuite/README')
-rw-r--r--testsuite/README16
1 files changed, 13 insertions, 3 deletions
diff --git a/testsuite/README b/testsuite/README
index 1afb9eb..a886b42 100644
--- a/testsuite/README
+++ b/testsuite/README
@@ -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: