summaryrefslogtreecommitdiff
path: root/source4/selftest/README
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2008-01-16 17:40:25 +0100
committerJelmer Vernooij <jelmer@samba.org>2008-01-16 17:58:50 +0100
commita760146e73ea0f6bb30f01276f3756d97644722c (patch)
tree0043c502bc4abc6aea95dd580c7a2cd4daf5fb44 /source4/selftest/README
parentfa6ce1e4a9d285c82faed49a09bb2bd297bbea39 (diff)
downloadsamba-a760146e73ea0f6bb30f01276f3756d97644722c.tar.gz
samba-a760146e73ea0f6bb30f01276f3756d97644722c.tar.bz2
samba-a760146e73ea0f6bb30f01276f3756d97644722c.zip
selftest: Add some more documentation. Rename env => target to avoid confusion.
(This used to be commit 50b8a16d0cb5e1c4352e73900d1e98a812340cca)
Diffstat (limited to 'source4/selftest/README')
-rw-r--r--source4/selftest/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/source4/selftest/README b/source4/selftest/README
index a0afda3d19..3250f32ec7 100644
--- a/source4/selftest/README
+++ b/source4/selftest/README
@@ -1,6 +1,23 @@
+# vim: ft=rst
+
This directory contains test scripts that are useful for running a
bunch of tests all at once.
+===============
+Available tests
+===============
+The available tests are obtained from a script, usually
+selftest/samba{3,4}_tests.sh. This script should for each test output
+the name of the test, the command to run and the environment that should be
+provided.
+
+============
+Environments
+============
+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:
- none: No server set up, no variables set.