selftest: Document the fact that test runner and formatter are now

[nivanova/samba-autobuild/.git] / selftest / README

diff --git a/selftest/README b/selftest/README
index a8c5101a61deca7ffbaa5d0ae259a4b214b067a1..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