upstream/postgresql
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2026-06-10 09:10:33 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Document variables for path substitution in SQL tests

Browse source 
Test suites driven by pg_regress can use the following environment
variables for path substitutions since d1029bb5a2:
- PG_ABS_SRCDIR
- PG_ABS_BUILDDIR
- PG_DLSUFFIX
- PG_LIBDIR

These variables have never been documented, and they can be useful for
out-of-core code based on the options used by the pg_regress command
invoked by installcheck (or equivalent) to build paths to libraries for
various commands, like LOAD or CREATE FUNCTION.

Reviewed-by: Zhang Hu <kongbaik228@gmail.com>
Reviewed-by: Chao Li <li.evan.chao@gmail.com>
Discussion: https://postgr.es/m/abDAWzHaesHLDFke@paquier.xyz
This commit is contained in:
Michael Paquier 2026-03-12 16:35:58 +09:00
parent d841ca2d14
commit 02976b0a17
1 changed files with 64 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
doc/src/sgml/regress.sgml
View file

@ -444,6 +444,70 @@ make check LANG=C ENCODING=EUC_JP
</para>
</sect2>
<sect2 id="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>
</para>
<para>
These variables should be set in the tests with the meta-command
<command>\getenv</command>, like:
<programlisting>
\getenv abs_builddir PG_ABS_BUILDDIR
\getenv abs_srcdir PG_ABS_SRCDIR
</programlisting>
</para>
<para>
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.
</para>
</sect2>
<sect2 id="regress-run-custom-settings">
<title>Custom Server Settings</title>