Doc: add note about how to run the pg_amcheck regression tests.
authorTom Lane <tgl@sss.pgh.pa.us>
Sat, 13 Mar 2021 15:51:27 +0000 (10:51 -0500)
committerTom Lane <tgl@sss.pgh.pa.us>
Sat, 13 Mar 2021 16:10:30 +0000 (11:10 -0500)
It's not immediately obvious what you have to do to get "make
installcheck" to work here, so document that along the same lines
as we've used elsewhere.

src/bin/pg_amcheck/README [new file with mode: 0644]

diff --git a/src/bin/pg_amcheck/README b/src/bin/pg_amcheck/README
new file mode 100644 (file)
index 0000000..950f8a7
--- /dev/null
@@ -0,0 +1,19 @@
+src/bin/pg_amcheck/README
+
+pg_amcheck is a command-line tool for running the amcheck extension.
+
+Running the regression tests
+============================
+
+NOTE: You must have given the --enable-tap-tests argument to configure.
+Also, to use "make installcheck", you must have built and installed
+contrib/amcheck and contrib/pageinspect in addition to the core code.
+
+Run
+    make check
+or
+    make installcheck
+You can use "make installcheck" if you previously did "make install".
+In that case, the code in the installation tree is tested.  With
+"make check", a temporary installation tree is built from the current
+sources and then tested.