Updating the regression test README file with details about the c preprocessing step...

git-svn-id: http://svn.osgeo.org/postgis/trunk@3084 b70326c6-7e19-0410-871a-916f4a2858ee

diff --git a/regress/README b/regress/README
index 6097e20f405b0893998f30e1e629cf1ce0c480b8..c7ea310f8754cd85a9ef5af8e786694bd6123a75 100644 (file)
--- a/regress/README
+++ b/regress/README
@@ -2,8 +2,15 @@ How to add a regression test
 ----------------------------
 
 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 @@ Notes about changes in regression tests introduces with PostGIS 1.1.0
 
 - 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.
+
+