[postgis-commits] svn - r3084 - trunk/regress

[postgis-commits at postgis.refractions.net]

Author: mleslie
Date: 2008-10-09 18:35:58 -0700 (Thu, 09 Oct 2008)
New Revision: 3084

Modified:
   trunk/regress/README
Log:
Updating the regression test README file with details about the c preprocessing step and the formatting of the _expected file results.

Modified: trunk/regress/README
===================================================================
--- trunk/regress/README	2008-10-08 18:57:11 UTC (rev 3083)
+++ trunk/regress/README	2008-10-10 01:35:58 UTC (rev 3084)
@@ -2,8 +2,15 @@
 ----------------------------
 
 1. Write a /regress/<testname>.sql file with data and sql queries for testing
-2. Write a /regress/<testname>_expected file with expected results per query
+2. Write a /regress/<testname>_expected or <testname>_expected.in file with 
+   expected results per query
+   The expected results provided in the <testname>_expected file must be 
+   formatted using the following psql options:
+      -a -- unaligned columns
+      -f | -- use | (pipe) as the field separator between columns
+      -t -- output rows only, ie. no table header
 3. Edit regress/Makefile adding <testname> to the TESTS variable.
+   Any _expected.in files need to be added to the PREPROC variable.
 
 Notes about changes in regression tests introduces with PostGIS 1.1.0
 ---------------------------------------------------------------------
@@ -24,3 +31,18 @@
 
 - truly_inside does not exist anymore
   [updated to use within]
+
+Notes about <testname>_expected.in
+----------------------------------
+
+The first line of the <testname>_expected.in should include the postgis
+configuration header.
+
+  #include "../postgis_config.h"
+
+The ability to run a c preprocessor over the expected results prior to 
+regression testing was needed for testing curved string functionality that
+would elicit different responses from JTS vs GEOS compilations.  Since
+JTS is no longer supported, this may not be required anymore.
+
+