From: Mark Leslie <mark.leslie@lisasoft.com>
Date: Fri, 10 Oct 2008 01:35:58 +0000 (+0000)
Subject: Updating the regression test README file with details about the c preprocessing step... 
X-Git-Tag: 1.4.0b1~640
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=1db757c22551fb5b409705507a425c032c61fe8f;p=postgis

Updating the regression test README file with details about the c preprocessing step and the formatting of the _expected file results.

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

diff --git a/regress/README b/regress/README
index 6097e20f4..c7ea310f8 100644
--- 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.
+
+