summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2021-03-13 10:51:27 -0500
committerTom Lane <tgl@sss.pgh.pa.us>2021-03-13 11:10:30 -0500
commit58f57490facdec78119e5bab84229dbdc1d5ac6a (patch)
tree89d07025d45b60d978f4b18d47f3d96db404d388 /src
parent945d2cb7d0255e296a55f3e9febb5dce6eaccc3e (diff)
Doc: add note about how to run the pg_amcheck regression tests.
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.
Diffstat (limited to 'src')
-rw-r--r--src/bin/pg_amcheck/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/bin/pg_amcheck/README b/src/bin/pg_amcheck/README
new file mode 100644
index 00000000000..950f8a73667
--- /dev/null
+++ b/src/bin/pg_amcheck/README
@@ -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.