VERSION: Bump version up to 3.5.18.

[samba.git] / selftest / README

diff --git a/selftest/README b/selftest/README
index 83a3e6fd491164608c718821e132a1954847ea3a..4ae043692dddba634327a732c47c25b4d164cd5b 100644 (file)
--- a/selftest/README
+++ b/selftest/README
@@ -3,6 +3,15 @@
 This directory contains test scripts that are useful for running a
 bunch of tests all at once. 
 
+There are two parts to this: 
+
+ * The test runner (selftest/selftest.pl)
+ * The test formatter
+
+selftest.pl simply outputs subunit, which can then be formatted or analyzed 
+by tools that understand the subunit protocol. One of these tools is 
+format-subunit.pl, which is used by default as part of "make test".
+
 Available testsuites
 ====================
 The available testsuites are obtained from a script, usually 
@@ -77,12 +86,37 @@ time: YYYY-MM-DD HH:mm:ssZ
 Announce the current time. This may be used to calculate the duration of 
 various tests.
 
-prefix
-~~~~~~
-prefix: Prefix
+The following are Samba extensions to Subunit:
+
+testsuite-count
+~~~~~~~~~~~~~~~
+testsuite-count: number
+
+Announce the number of tests that is going to be run.
+
+start-testsuite
+~~~~~~~~~
+start-testsuite: name
+
+The testsuite name is used as prefix for all containing tests.
+
+skip-testsuite
+~~~~~~~~~~~~~~
+skip-testsuite: name
+
+Mark the testsuite with the specified name as skipped.
+
+testsuite-success
+~~~~~~~~~~~~~~~~~
+testsuite-success: name
+
+Indicate that the testsuite has succeeded successfully.
+
+testsuite-fail
+~~~~~~~~~~~~~~
+testsuite-fail: name
 
-Change the global prefix for test names. To unset the prefix, specify an empty 
-string.
+Indicate that a testsuite has failed.
 
 Environments
 ============