doc: Tell about "vcregress taptest" for regression tests on Windows
authorMichael Paquier <[email protected]>
Mon, 25 Sep 2023 23:16:44 +0000 (08:16 +0900)
committerMichael Paquier <[email protected]>
Mon, 25 Sep 2023 23:16:44 +0000 (08:16 +0900)
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

doc/src/sgml/install-windows.sgml

index 176f15dea09721d712b3795048171c29911c043c..e4e1abdff395fd4574a5b452ff514aa51cdaf947 100644 (file)
@@ -462,6 +462,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>
 
@@ -469,6 +470,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
@@ -476,9 +483,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>