doc: Document how to run regression tests with custom server settings

Author: Craig Ringer <craig.ringer@2ndquadrant.com>
Discussion: https://www.postgresql.org/message-id/flat/CAMsr+YF=+ctXBZj3ywmvKNUjWpxmuTuUKuv-rgbHGX5i5pLstQ@mail.gmail.com

diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml
index 083d0bf46b8916d49c0a765dbe3981f165f5e069..890ec7c88ee74029dc2f5ee022d83299a12715cd 100644 (file)
--- a/doc/src/sgml/regress.sgml
+++ b/doc/src/sgml/regress.sgml
@@ -351,6 +351,31 @@ make check LANG=C ENCODING=EUC_JP
    </para>
   </sect2>
 
+  <sect2>
+   <title>Custom Server Settings</title>
+
+   <para>
+    Custom server settings to use when running a regression test suite can be
+    set in the <varname>PGOPTIONS</varname> environment variable (for settings
+    that allow this):
+<screen>
+make check PGOPTIONS="-c log_checkpoints=on -c work_mem=50MB"
+</screen>
+    When running against a temporary installation, custom settings can also be
+    set by supplying a pre-written <filename>postgresql.conf</filename>:
+<screen>
+echo 'log_checkpoints = on' > test_postgresql.conf
+echo 'work_mem = 50MB' >> test_postgresql.conf
+make check EXTRA_REGRESS_OPTS="--temp-config=test_postgresql.conf"
+</screen>
+   </para>
+
+   <para>
+    This can be useful to enable additional logging, adjust resource limits,
+    or enable extra run-time checks.
+   </para>
+  </sect2>
+
   <sect2>
    <title>Extra Tests</title>