r26673: selftest: Document the purpose and output format of samba4_tests.sh.

diff --git a/source/selftest/samba4_tests.sh b/source/selftest/samba4_tests.sh
index 66717c03aef264bf705d27a0dd357786827c03f1..290c06fa6af5cc6f40f28b33f64d8e0cde7352ba 100755 (executable)
--- a/source/selftest/samba4_tests.sh
+++ b/source/selftest/samba4_tests.sh
@@ -1,4 +1,23 @@
 #!/bin/sh
+# This script generates a list of testsuites that should be run as part of 
+# the Samba 4 test suite.
+
+# The output of this script is parsed by selftest.pl, which then decides 
+# which of the tests to actually run. It will, for example, skip all tests 
+# listed in samba4-skip or only run a subset during "make quicktest".
+
+# The idea is that this script outputs all of the tests of Samba 4, not 
+# just those that are known to pass, and list those that should be skipped 
+# or are known to file in samba4-skip/samba4-knownfail. This makes it 
+# very easy to see what functionality is still missing in Samba 4 and makes 
+# it possible to run the testsuite against other servers, such as Samba 3 or 
+# Windows that have a different set of features.
+
+# The syntax for a testsuite is "-- TEST --" on a single line, followed 
+# by the name of the test, the environment it needs and the command to run, all 
+# three separated by newlines. All other lines in the output are considered 
+# comments.
+
 if [ ! -n "$PERL" ]
 then
        PERL=perl