From: Jelmer Vernooij <jelmer@samba.org>
Date: Fri, 12 Jun 2009 13:54:50 +0000 (+0200)
Subject: selftest: Document the fact that test runner and formatter are now
X-Git-Tag: tdb-1.1.5~43
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=93384da22620f9ab2304ccfc54c8bd6bc8009303;p=thirdparty%2Fsamba.git

selftest: Document the fact that test runner and formatter are now
separate tools.
---

diff --git a/selftest/README b/selftest/README
index a8c5101a61d..4ae043692dd 100644
--- 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