aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorPeter Eisentraut <peter_e@gmx.net>2014-04-14 21:33:46 -0400
committerPeter Eisentraut <peter_e@gmx.net>2014-04-14 21:33:46 -0400
commit7d0f493f19607774fdccb1a1ea06fdd96a3d9698 (patch)
tree71076e4ce36fa06d4637858f1435ef3f7ecd73b6 /doc/src
parent7b5a9d61a8202c46f4cc02878eafa8367080c59a (diff)
downloadpostgresql-7d0f493f19607774fdccb1a1ea06fdd96a3d9698.tar.gz
postgresql-7d0f493f19607774fdccb1a1ea06fdd96a3d9698.zip
Add TAP tests for client programs
Reviewed-by: Pavel Stěhule <pavel.stehule@gmail.com> Reviewed-by: Erik Rijkers <er@xs4all.nl>
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/installation.sgml3
-rw-r--r--doc/src/sgml/regress.sgml28
2 files changed, 30 insertions, 1 deletions
diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml
index efaaad80b40..32160bf33f2 100644
--- a/doc/src/sgml/installation.sgml
+++ b/doc/src/sgml/installation.sgml
@@ -333,7 +333,8 @@ su - postgres
<application>Perl</> 5.8 or later is needed to build from a Git checkout,
or if you changed the input files for any of the build steps that
use Perl scripts. If building on Windows you will need
- <application>Perl</> in any case.
+ <application>Perl</> in any case. <application>Perl</application> is
+ also required to run some test suites.
</para>
</listitem>
</itemizedlist>
diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml
index 16b36211f3d..aee049a3d5a 100644
--- a/doc/src/sgml/regress.sgml
+++ b/doc/src/sgml/regress.sgml
@@ -204,6 +204,12 @@ make installcheck-world
located in <filename>src/test/isolation</>.
</para>
</listitem>
+ <listitem>
+ <para>
+ Tests of client programs under <filename>src/bin</filename>. See
+ also <xref linkend="regress-tap">.
+ </para>
+ </listitem>
</itemizedlist>
<para>
@@ -660,6 +666,28 @@ float8:out:i.86-.*-openbsd=float8-small-is-zero.out
</sect1>
+ <sect1 id="regress-tap">
+ <title>TAP Tests</title>
+
+ <para>
+ The client program tests under <filename>src/bin</filename> use the Perl
+ TAP tools and are run by <command>prove</command>. You can pass
+ command-line options to <command>prove</command> by setting
+ the <command>make</command> variable <varname>PROVE_FLAGS</>, for example:
+<programlisting>
+make -C src/bin check PROVE_FLAGS='--reverse'
+</programlisting>
+ The default is <literal>--verbose</literal>. See the manual page
+ of <command>prove</command> for more information.
+ </para>
+
+ <para>
+ The tests written in Perl require the Perl
+ module <literal>IPC::Run</literal>, otherwise most tests will be skipped.
+ This module is available from CPAN or an operating system package.
+ </para>
+ </sect1>
+
<sect1 id="regress-coverage">
<title>Test Coverage Examination</title>