Mention --enable-tap-tests in the TAP section page

Started by Greg Sabino Mullaneover 4 years ago4 messages
#1Greg Sabino Mullane
htamfids@gmail.com
1 attachment(s)

Quick patch to add mention of the need for compiling with
--enable-tap-tests on the TAP section page

https://www.postgresql.org/docs/current/regress-tap.html

Searching about the TAP tests often leads to this page, but there is no
easy link or mention of the fact that the sample invocations will not work
without the special config flag.

Cheers,
Greg

Attachments:

mention-enable-tap.patchapplication/octet-stream; name=mention-enable-tap.patchDownload
commit c2a9396065b38bc71228ff53cdba192bf7675dab
Author: Greg Sabino Mullane <greg@turnstep.com>
Date:   Thu Jul 1 09:59:27 2021 -0400

    Mention --enable-tap-tests on the TAP page, as searching often leads to arriving directly at https://www.postgresql.org/docs/current/regress-tap.html

diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml
index cb401a45b3..9cd94635c1 100644
--- a/doc/src/sgml/regress.sgml
+++ b/doc/src/sgml/regress.sgml
@@ -801,6 +801,8 @@ make check PROVE_TESTS='t/001_test1.pl t/003_test3.pl'
    <para>
     The TAP tests require the Perl module <literal>IPC::Run</literal>.
     This module is available from CPAN or an operating system package.
+    They also require PostgreSQL to be configured with the option 
+    <option>--enable-tap-tests</option>.
    </para>
 
    <para>
#2Michael Paquier
michael@paquier.xyz
In reply to: Greg Sabino Mullane (#1)
Re: Mention --enable-tap-tests in the TAP section page

On Thu, Jul 01, 2021 at 10:03:10AM -0400, Greg Sabino Mullane wrote:

Searching about the TAP tests often leads to this page, but there is no
easy link or mention of the fact that the sample invocations will not work
without the special config flag.

This is mentioned on a different page, "Running the Tests", but for
the set of extra tests. Adding an extra reference on this page is a
good idea.
--
Michael

#3Andrew Dunstan
andrew@dunslane.net
In reply to: Michael Paquier (#2)
Re: Mention --enable-tap-tests in the TAP section page

On 7/1/21 9:53 PM, Michael Paquier wrote:

On Thu, Jul 01, 2021 at 10:03:10AM -0400, Greg Sabino Mullane wrote:

Searching about the TAP tests often leads to this page, but there is no
easy link or mention of the fact that the sample invocations will not work
without the special config flag.

This is mentioned on a different page, "Running the Tests", but for
the set of extra tests. Adding an extra reference on this page is a
good idea.

Agreed.

cheers

andrew

--
Andrew Dunstan
EDB: https://www.enterprisedb.com

#4Michael Paquier
michael@paquier.xyz
In reply to: Andrew Dunstan (#3)
Re: Mention --enable-tap-tests in the TAP section page

On Fri, Jul 02, 2021 at 09:52:10AM -0400, Andrew Dunstan wrote:

Agreed.

Applied.
--
Michael