Feedback-ID: i0fe9450f:Fastmail
Date: Wed, 11 Mar 2026 10:07:39 +0900
From: Michael Paquier <michael@paquier.xyz>
To: Postgres hackers <pgsql-hackers@lists.postgresql.org>
Subject: Add documentation for PG_ABS_SRCDIR, PG_ABS_BUILDDIR, PG_LIBDIR,
 PG_DLSUFFIX
Message-ID: <abDAWzHaesHLDFke@paquier.xyz>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
	protocol="application/pgp-signature"; boundary="QU91rVFGL/fek8jV"
Content-Disposition: inline
Archived-At: 
 <https://www.postgresql.org/message-id/abDAWzHaesHLDFke%40paquier.xyz>
Precedence: bulk


--QU91rVFGL/fek8jV
Content-Type: multipart/mixed; boundary="u7ieWKw/7Aa48+4t"
Content-Disposition: inline


--u7ieWKw/7Aa48+4t
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

Hi all,

d1029bb5a26c has switched the in-core tests suited based on pg_regress
to do path substitutions based on the set of environment variables
listed in $subject, rather than replacements based on input and output
files, generating new files.

These can be really useful for extension developers who maintain SQL
test suites, so how about documenting them?

I'd like to propose the attached patch, for HEAD, so as one does not
need to guess their existence from the SQL files or pg_regress.c.

Thoughts or comments?
--
Michael

--u7ieWKw/7Aa48+4t
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename=doc-path-subs.patch
Content-Transfer-Encoding: quoted-printable

diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml
index d80dd46c5fdb..e3c4a0525ad7 100644
--- a/doc/src/sgml/regress.sgml
+++ b/doc/src/sgml/regress.sgml
@@ -444,6 +444,59 @@ make check LANG=3DC ENCODING=3DEUC_JP
    </para>
   </sect2>
=20
+  <sect2 id=3D"regress-run-path-substitution">
+   <title>Path Substitution</title>
+
+   <para>
+    The test suites driven by <command>pg_regress</command> can use the
+    following environment variables for path substitutions:
+
+    <variablelist>
+     <varlistentry>
+      <term><literal>PG_ABS_SRCDIR</literal></term>
+      <listitem>
+       <para>
+        Absolute path to the source directory.
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+     <term><literal>PG_ABS_BUILDDIR</literal></term>
+     <listitem>
+      <para>
+       Absolute path to the build directory.
+      </para>
+     </listitem>
+     </varlistentry>
+
+     <varlistentry>
+     <term><literal>PG_DLSUFFIX</literal></term>
+     <listitem>
+      <para>
+       Name of extension for dynamically-loadable modules (e.g.
+       <literal>.so</literal> on Linux).
+      </para>
+     </listitem>
+     </varlistentry>
+
+     <varlistentry>
+     <term><literal>PG_LIBDIR</literal></term>
+     <listitem>
+      <para>
+       Absolute path to dynamic libraries.
+      </para>
+     </listitem>
+     </varlistentry>
+    </variablelist>
+
+    These are useful when dealing with function and object loading
+    that require specific paths to work, like paths defined in a
+    <command>CREATE FUNCTION</command> or <command>LOAD</command>
+    command, for example.
+   </para>
+  </sect2>
+
   <sect2 id=3D"regress-run-custom-settings">
    <title>Custom Server Settings</title>
=20

--u7ieWKw/7Aa48+4t--

--QU91rVFGL/fek8jV
Content-Type: application/pgp-signature; name=signature.asc

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCgAdFiEEG72nH6vTowiyblFKnvQgOdbyQH0FAmmwwFsACgkQnvQgOdby
QH3hew//WTKoJSyGZc7JatM5qGwRrRTTDk58FYxYul/a5kktUKSJXn0hHXVEEcV6
zC4x1LKcb5fie70cejNWwaKGRzmIfuTo3/ZN+s67uzWPkSKy5FVMnx0WQwp9/j3z
LM0DL7FWuaKYb/riGiOkzogazbEyWQbw206XTac3AdnuNy7n9kMH8TXSMhIbLGGa
ZHPtbRDi+0vJ3pLYOQ79VyjQOCAOHVExRh78rHfnqNvR9O78TttK8RhI9GOfDDZZ
KiKT35fBV1CWUl6378OiPOrjo8eoDjbKm2pMuPvj+QMvUX1ncoNsk9dsrrOr2nH8
dZi0i9pyKUR21BLNcUD9MgE7fhaGHL7FcAj+8G0OiqQr3QGC4FHSyNEM9V0g5Wo1
a0UmW6+YTjku9ps1D5ASguH38Fu5CpTPiyTjuTEiXCReUVjhbQgUOWedpEwgcAvT
nOtoOB+JnO9jqJylU9i1g1h1ldtR2azx9SuZBpvFn/FipNT8IDGevdKSLoKMaF54
NfjuVSeOb03epgb+r9GymE0pkUXhHvt4VHC6Pkn3yukqZ6gNg5JWXMZ/4T03cNs1
E05KuJPIsZurAm0/zcpY858fXiywQyPxlldQXZXV3bQOSUlDLqLB10M3+oRvt50Z
1757l8kc921rbNmPILs6N9oxURsT5tuU9f7zrTenE07e2mgxgJU=
=mevh
-----END PGP SIGNATURE-----

--QU91rVFGL/fek8jV--