From: Michael Paquier <michael@paquier.xyz>
Date: Mon, 25 Sep 2023 23:16:47 +0000 (+0900)
Subject: doc: Tell about "vcregress taptest" for regression tests on Windows
X-Git-Tag: REL_12_17~67
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=11bb77da233b0056fd44009b04171692a668626d;p=thirdparty%2Fpostgresql.git

doc: Tell about "vcregress taptest" for regression tests on Windows

There was no mention of this command in the documentation, and it is
useful to run the TAP tests of a target source directory.

Author: Yugo Nagata
Discussion: https://postgr.es/m/20230925153204.926d685d347ee1c8f527090c@sraoss.co.jp
Backpatch-through: 11
---

diff --git a/doc/src/sgml/install-windows.sgml b/doc/src/sgml/install-windows.sgml
index 6b6db2ee17c..ade8f407048 100644
--- a/doc/src/sgml/install-windows.sgml
+++ b/doc/src/sgml/install-windows.sgml
@@ -460,6 +460,7 @@ $ENV{CONFIG}="Debug";
 <userinput>vcregress isolationcheck</userinput>
 <userinput>vcregress bincheck</userinput>
 <userinput>vcregress recoverycheck</userinput>
+<userinput>vcregress taptest</userinput>
 <userinput>vcregress upgradecheck</userinput>
 </screen>
 
@@ -467,6 +468,12 @@ $ENV{CONFIG}="Debug";
    command line like:
 <screen>
 <userinput>vcregress check serial</userinput>
+</screen>
+
+   <command>vcregress taptest</command> can be used to run the TAP tests
+   of a target directory, like:
+<screen>
+<userinput>vcregress taptest src\bin\initdb\</userinput>
 </screen>
 
    For more information about the regression tests, see
@@ -474,9 +481,10 @@ $ENV{CONFIG}="Debug";
   </para>
 
   <para>
-   Running the regression tests on client programs, with
-   <command>vcregress bincheck</command>, or on recovery tests, with
-   <command>vcregress recoverycheck</command>, requires an additional Perl module
+   Running the regression tests on client programs with
+   <command>vcregress bincheck</command>, on recovery tests with
+   <command>vcregress recoverycheck</command>, or TAP tests specified with
+   <command>vcregress taptest</command> requires an additional Perl module
    to be installed:
    <variablelist>
     <varlistentry>