From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Mon, 10 Jul 2017 04:44:05 +0000 (-0400)
Subject: Doc: remove claim that PROVE_FLAGS defaults to '--verbose'.
X-Git-Tag: REL_10_BETA2~7
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=260ba8525a6365cfb3251d619767cc6ae19ddff8;p=postgresql

Doc: remove claim that PROVE_FLAGS defaults to '--verbose'.

Commit e9c81b601 changed this, but missed updating the documentation.
The adjacent claim that we use TAP tests only in src/bin seems pretty
obsolete as well.  Minor other copy-editing.
---

diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml
index 8229528bd4..7c2b1029c2 100644
--- a/doc/src/sgml/regress.sgml
+++ b/doc/src/sgml/regress.sgml
@@ -207,7 +207,7 @@ make installcheck-world
   </para>
 
   <para>
-   The TAP tests are only run when PostgreSQL was configured with the
+   The TAP-based tests are run only when PostgreSQL was configured with the
    option <option>--enable-tap-tests</option>.  This is recommended for
    development, but can be omitted if there is no suitable Perl installation.
   </para>
@@ -664,20 +664,19 @@ float8:out:i.86-.*-openbsd=float8-small-is-zero.out
    <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
+    Various tests, particularly the client program tests
+    under <filename>src/bin</filename>, use the Perl TAP tools and are run
+    using the Perl testing program <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'
+make -C src/bin check PROVE_FLAGS='--timer'
 </programlisting>
-    The default is <literal>--verbose</literal>.  See the manual page
-    of <command>prove</command> for more information.
+    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>.
+    The TAP tests require the Perl module <literal>IPC::Run</literal>.
     This module is available from CPAN or an operating system package.
    </para>
   </sect1>