docs tidying

[exim.git] / test / README

diff --git a/test/README b/test/README
index 6c9a2d8da52189ef53723f03365c48c50442a29b..1798c4dc20831be1d49a32256c83a70d4a91349b 100644 (file)
--- a/test/README
+++ b/test/README
@@ -132,6 +132,9 @@ In order to run this test suite, the following requirements must be met:
      assumes the simpler I/O model.
      Exim must *not* be built with HEADERS_CHARSET set to UTF-8.
 
      assumes the simpler I/O model.
      Exim must *not* be built with HEADERS_CHARSET set to UTF-8.
 

+(11) If building any dynamically-loaded lookups, LOOKUP_MODULE_DIR should
+     be set to .../exim/test/eximdir.
+

 
 
 OPTIONAL EXTRAS
 
 
 OPTIONAL EXTRAS


@@ -301,6 +304,11 @@ There are some options for the ./runtest script itself:
   -SLOW     For very slow hosts that appear to have Heisenbugs, delay before
             comparing output files from a testcase
 
   -SLOW     For very slow hosts that appear to have Heisenbugs, delay before
             comparing output files from a testcase
 

+  -TLS <client>  For cross-library testing. Specify 'openssl" or 'gnutls'
+            as the client; the other is used as the server (assumes that
+           both have been built: set up Local/Makefile for OpenSSL and
+           "make exim_openssl", then for GnuTLS and "make exim_gnutls")
+

 The options for ./runtest must be given first (but after the name of the
 binary, if present). Any further options, that is, items on the command line
 that start with a hyphen, are passed to the Exim binary when it is run as part
 The options for ./runtest must be given first (but after the name of the
 binary, if present). Any further options, that is, items on the command line
 that start with a hyphen, are passed to the Exim binary when it is run as part


@@ -676,7 +684,12 @@ script. For example:
   # -bS Use of HELO/RSET
 
 A line consisting just of digits is interpreted as the expected return code
   # -bS Use of HELO/RSET
 
 A line consisting just of digits is interpreted as the expected return code

-for the command that follows. The default expectation when no such line exists
+for the command that follows.
+
+A line consisting of a tilde (~) followed by digits indicates a non-expected
+return code for the command that follows.
+
+The default expectation when neither such line exists

 is a zero return code. For example, here is a complete test script, containing
 just one command:
 
 is a zero return code. For example, here is a complete test script, containing
 just one command:
 


@@ -1072,6 +1085,7 @@ Lines in client scripts are of several kinds:
 (1) "??? ": If a line begins with three question marks and a space, the rest of the
     line defines the start of expected output from the server. If what is
     received does not match, the client bombs out with an error message.
 (1) "??? ": If a line begins with three question marks and a space, the rest of the
     line defines the start of expected output from the server. If what is
     received does not match, the client bombs out with an error message.

+    Escape sequences described below in (7) are usable in the expected text.

 
 (2) "???*": If a line begins with three question marks and an asterisk, the server
     is expected to close the connection.
 
 (2) "???*": If a line begins with three question marks and an asterisk, the server
     is expected to close the connection.


@@ -1145,7 +1159,7 @@ are of the following kinds:
     before proceeding.
 
 (3) A line containing "*data" and a number specifies that the client is
     before proceeding.
 
 (3) A line containing "*data" and a number specifies that the client is

-    expected to send that many byte; the server discards them
+    expected to send that many bytes; the server discards them

 
 (4) A line containing "*eof" specifies that the client is expected to close
     the connection at this point.
 
 (4) A line containing "*eof" specifies that the client is expected to close
     the connection at this point.


@@ -1198,7 +1212,7 @@ whose content is fixed, and those whose content needs to be varied according to
 the current environment. The former are kept in the directory aux-fixed. The
 latter are distributed in the directory aux-var-src, and copied with the
 standard substitutions into the directory aux-var at the start of each test
 the current environment. The former are kept in the directory aux-fixed. The
 latter are distributed in the directory aux-var-src, and copied with the
 standard substitutions into the directory aux-var at the start of each test

-run.
+run (with TESTNUM from the numeric prefix of the filename is there is one).

 
 Most of the auxiliary files have names that start with a test number,
 indicating that they are specific to that one test. A few fixed files (for
 
 Most of the auxiliary files have names that start with a test number,
 indicating that they are specific to that one test. A few fixed files (for