Update docs. Rename DBRW_TEST_NAME to DBRW_TEST_DATABASE.

1 files changed, 60 insertions, 1 deletions

diff --git a/README b/README
index 4c22ea4..68fbe04 100644
--- a/README
+++ b/README
@@ -114,7 +114,66 @@ Once configured, do
 This will build the module.  Finally, do the following command as root:
   
   make install
-  
+
+* Testing
+
+Testing the module requires access to an SQL database which will be
+populated with the test data.  You can either create the database
+and SQL user, or just an SQL user and give him rights for creating it.
+For example:
+
+   GRANT ALL PRIVILEGES on dbrw_test.* to dbrw_test@localhost;
+
+Once done, supply the SQL credentials and the database name with
+extra arguments to configure, as shown in the example below:
+
+  ./configure --with-varnish-source=/usr/src/varnish-3.0.1\
+              DBRW_TEST_DATABASE=dbrw_test\
+              DBRW_TEST_USER=dbrw_test
+
+You can use the following variables:
+
+** DBRW_TEST_DATABASE
+
+Name of the test database.  This one must be supplied in order to
+enable the tests.
+
+** DBRW_TEST_DEBUG
+
+Debugging level to use during the test.  If greater than 0, debugging
+info will be logged via syslog channel daemon.debug.
+
+** DBRW_TEST_DBTYPE
+
+Type of the database to use.  Either mysql or pgsql.  By default,
+mysql is used, if enabled.
+
+** DBRW_TEST_PARAMS
+
+Any additional parameters.  These must be in the format understood
+by dbrw.config function (see vmod_dbrw(3)).
+
+** DBRW_TEST_SERVER
+
+Name or IP address of SQL server.  Defaults to localhost.
+
+** DBRW_TEST_USER
+
+Database user.
+
+** DBRW_TEST_PASS
+
+Password to connect to the server (if necessary).
+
+After running make, do
+
+  make check
+
+to run the tests.  Ideally, they should succeed.  The tests will be skipped
+if the supplied credentials are insufficient to access the SQL server.
+If they fail, the file testsuite.log will contain detailed logs.
+Additional information can then be found in the directory testsuite.dir.
+
 * Bug reporting
 
 Send bug reports and suggestions to <gray@gnu.org>