X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=test%2Fregression%2FREADME;h=0d7b96bac4735e0b50b4686415d941e78c6dc49e;hb=d48bccaed9308a737cdfa55ba555891d0ad85b87;hp=a77318279c0722b7315b5a5a7c9d5c4a5d7c20fa;hpb=aaafb116f81536ca6f842885f4a64fbc3c345b99;p=cql-java-moved-to-github.git

diff --git a/test/regression/README b/test/regression/README
index a773182..0d7b96b 100644
--- a/test/regression/README
+++ b/test/regression/README
@@ -1,4 +1,9 @@
-$Id: README,v 1.6 2002-12-09 16:29:44 mike Exp $
+
+If you just don't want to think about it
+----------------------------------------
+
+Just use "make" to run regression tests.
+
 
 CQL-Java's regression-testing framework
 ---------------------------------------
@@ -23,7 +28,9 @@ contain the trusted compiler output of your choice.
 existing XCQL files.  Most often, you'll use this to compare the
 results of your own build of CQL-Java with those of my build.  I'll
 use it to test new versions, and people who've written other compilers
-can use it to test their code.
+can use it to test their code.  (The code of "runtests" and
+"mkanswers" is worryingly similar: they should probably be the same
+program invoked with different command-line arguments.)
 
 "Makefile" controls the building of all this.  You'll need to edit it
 if you want to use different compilers and suchlike from what's
@@ -50,6 +57,14 @@ use "cat" as the second argument.)  xmlpp.pl is a fine XML
 pretty-printer from DecisionSoft, found at
 	http://software.decisionsoft.com/tools.html
 
+"showtest" can be used to run a single test showing more details of
+what goes wrong, if anything.  You don't need it as part of the
+regression test, but it's useful when debugging.
+
+Finally, "runcanon" checks that each of the queries when compiled and
+decompiled back to CQL (i.e. canonicalised) remains identical when
+recompiled and redecompiled.
+
 
 Appendix: queries that should fail
 ----------------------------------