perhaps a better fix

[oweals/busybox.git] / testsuite / README

diff --git a/testsuite/README b/testsuite/README
index 1afb9ebd2a25b7a080bcc967f21481356f34cbac..40439bfe8cbf6208088c898ac7cfec30e3595e0e 100644 (file)
--- a/testsuite/README
+++ b/testsuite/README
@@ -1,10 +1,20 @@
-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".  It will
+run all of the test cases, and list those with unexpected outcomes.  Adding the
+-v option will cause it to show expected outcomes as well.  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 relies on a certain feature, it should include the string
+"FEATURE: " followed by the name of the feature in a comment.  If it is always
+expected to fail, it should include the string "XFAIL" in a comment.
 
 For the entire testsuite, the copyright is as follows:
 
-Copyright (C) 2001 Matt Kraai
+Copyright (C) 2001, 2002  Matt Kraai
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License