Check for fstatat.

[obnox/samba/samba-obnox.git] / selftest / README

diff --git a/selftest/README b/selftest/README
index 6a2c406cca499335b40d88cdf7763a050e76a9a1..c23d730d640b9d5d1677e3810152f3f9a69d25ec 100644 (file)
--- a/selftest/README
+++ b/selftest/README
@@ -10,12 +10,12 @@ There are two parts to this:
 
 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".
+format-subunit, which is used by default as part of "make test".
 
 Available testsuites
 ====================
 The available testsuites are obtained from a script, usually 
-source{3,4}/selftest/tests.sh. This script should for each testsuite output 
+source{3,4}/selftest/tests.py. This script should for each testsuite output
 the name of the test, the command to run and the environment that should be 
 provided. Use the included "plantest" function to generate the required output.
 
@@ -37,56 +37,9 @@ This protocol works by writing simple messages to standard output. Any
 messages that can not be interpreted by this protocol are considered comments 
 for the last announced test.
 
-Accepted commands are:
+For a full description of the subunit protocol, see ../lib/subunit/README.
 
-test
-~~~~
-test: <NAME>
-
-Announce that a new test with the specified name is starting
-
-success
-~~~~~~~
-success: <NAME> 
-
-Announce that the test with the specified name is done and ran successfully.
-
-failure
-~~~~~~~
-failure: <NAME> 
-failure: <NAME> [ REASON ]
-
-Announce that the test with the specified name failed. Optionally, it is 
-possible to specify a reason it failed.
-
-The alias "fail" will also work.
-
-xfail
-~~~~~
-xfail: <NAME>
-xfail: <NAME> [ REASON ]
-
-Announce that the test with the specified name failed but that the failure
-was expected, e.g. it's a test for a known bug that hasn't been fixed yet.
-Alternatively it is also possible to simply return "failure:" here but 
-specify in the samba4-knownfailures file that it is failing.
-
-skip
-~~~~
-skip: <NAME>
-skip: <NAME> [ REASON ]
-
-Announce that the test with the specified name was skipped. Optionally a 
-reason can be specified.
-
-time
-~~~~
-time: YYYY-MM-DD HH:mm:ssZ
-
-Announce the current time. This may be used to calculate the duration of 
-various tests.
-
-The following are Samba extensions to Subunit:
+The following commands are Samba extensions to Subunit:
 
 testsuite-count
 ~~~~~~~~~~~~~~~
@@ -95,7 +48,7 @@ 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.
@@ -124,30 +77,31 @@ Tests often need to run against a server with particular things set up,
 a "environment". This environment is provided by the test "target": Samba 3, 
 Samba 4 or Windows.
 
-The following environments are currently available:
+The environments are currently available include
 
  - none: No server set up, no variables set.
- - dc: Domain controller set up. The following environment variables will 
+ - dc,s3dc: Domain controller set up. The following environment variables will
    be set:
 
      * USERNAME: Administrator user name
-        * PASSWORD: Administrator password
-        * DOMAIN: Domain name
-        * REALM: Realm name
-        * SERVER: DC host name 
-        * SERVER_IP: DC IPv4 address
-        * NETBIOSNAME: DC NetBIOS name
-        * NETIOSALIAS: DC NetBIOS alias
-
- - member: Domain controller and member server that is joined to it set up. The
+     * PASSWORD: Administrator password
+     * DOMAIN: Domain name
+     * REALM: Realm name
+     * SERVER: DC host name 
+     * SERVER_IP: DC IPv4 address
+     * NETBIOSNAME: DC NetBIOS name
+     * NETIOSALIAS: DC NetBIOS alias
+
+ - member,s4member,s3member: Domain controller and member server that is joined to it set up. The
    following environment variables will be set:
 
      * USERNAME: Domain administrator user name
-        * PASSWORD: Domain administrator password
-        * DOMAIN: Domain name
-        * REALM: Realm name
-        * SERVER: Name of the member server
+     * PASSWORD: Domain administrator password
+     * DOMAIN: Domain name
+     * REALM: Realm name
+     * SERVER: Name of the member server
 
+See Samba.pm, Samba3.pm and Samba4.pm for the full list.
 
 Running tests
 =============
@@ -156,7 +110,7 @@ To run all the tests use::
 
    make test
 
-To run a quick subset (aiming for about 1 minute of testing) run::
+To run a quicker subset run::
 
    make quicktest