Update usage instructions, and document test case format.
[oweals/busybox.git] / testsuite / README
1 To run the test suite, change to this directory and run
2 "./runtest".  To only run the test cases for particular applets,
3 specify them as parameters to runtest.
4
5 The test cases for an applet reside in the subdirectory of the
6 applet name.  The name of the test case should be the assertion
7 that is tested.  The test case should be a shell fragment that
8 returns successfully if the test case passes, and unsuccessfully
9 otherwise.  If the test case is known to fail, it should be marked
10 as such by including the string "XFAIL" in a comment.  If a
11 certain feature must be enabled for it to pass, it should indicate
12 that by including the string "UNSUPPORTED: " followed by the
13 feature name in a comment.
14
15 For the entire testsuite, the copyright is as follows:
16
17 Copyright (C) 2001 Matt Kraai
18
19 This program is free software; you can redistribute it and/or
20 modify it under the terms of the GNU General Public License
21 as published by the Free Software Foundation; either version 2
22 of the License, or (at your option) any later version.
23
24 This program is distributed in the hope that it will be useful,
25 but WITHOUT ANY WARRANTY; without even the implied warranty of
26 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27 GNU General Public License for more details.
28
29 You should have received a copy of the GNU General Public License
30 along with this program; if not, write to the Free Software
31 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.