pg_buildext.pod 8.2 KB
Newer Older
1 2 3 4 5 6
=head1 NAME

pg_buildext - Build and install a PostgreSQL extension

=head1 SYNOPSIS

7
B<pg_buildext> [I<options>] I<action> [I<src-dir>] [I<arguments>]
8 9 10 11

=head1 DESCRIPTION

B<pg_buildext> is a script that will build a PostgreSQL extension in a C<VPATH>
12 13
way, for potentially several PostgreSQL server versions in parallel.
It builds for the intersection of versions known in
14 15 16 17
C<debian/pgversions> (versions supported by the package) and in
C</usr/share/postgresql-common/supported-versions> (versions supported in this
release).

18 19 20 21 22 23 24 25 26
=head1 USAGE

Packages using B<pg_buildext> should be prepared to build binaries for
PostgreSQL versions that are not present in Debian unstable, e.g. for older
releases when building backports for Debian (old)stable (possibly including
backports of newer PostgreSQL releases), or for all PostgreSQL releases when
the package is built for B<apt.postgresql.org>.

As the set of binary packages depends on the target PostgreSQL versions,
27 28 29
C<debian/control> is generated from a template in C<debian/control.in> when
B<pg_buildext updatecontrol> is run. Occurrences of B<PGVERSION> in package
sections are replaced by the target PostgreSQL version. Include
30
C</usr/share/postgresql-common/pgxs_debian_control.mk> in C<debian/rules> to
31
run a check at build time if updating debian/control is required.
32 33 34 35 36 37 38 39 40

As B<pg_buildext> invokes B<make> for the B<build>, B<install>, and B<clean>
actions, invocations from C<debian/rules> (which is a makefile) should be prefixed
with B<+> so the sub-makes can talk with the make jobserver.

Many extensions support B<make installcheck> testing using B<pg_regress>. As
this needs the package to be installed, it cannot be run at build time.
Instead, the tests should be run using B<autopkgtest> from C<debian/tests/*>.

41 42 43 44 45
If C<debian/tests/control.in> exists, occurrences of package names containing
B<PGVERSION> are replaced by lists of package names with the target PostgreSQL
versions filled in. (If no replacing is needed in C<debian/tests/control>, it
is fine to provide the tests control file directly.)

46 47 48 49 50 51 52 53 54 55 56 57
=head1 OPTIONS

=over 4

=item B<-cio> I<arg>

=item B<-s>

Passed to B<pg_virtualenv> when running B<installcheck>.

=back

58
=head1 ACTIONS
59

60 61 62 63
Most actions expect a directory name where to build the sources. It will get
created for you if it does not exist. If the I<build-dir> contains a C<%v>
sign, it will get replaced by the specific version of PostgreSQL being built
against. (Usually this parameter is C<build-%v>.)
64

65
=over 4
66

67
=item B<supported-versions>
68

69 70
Print effective list of supported versions, i.e. the intersection of the sets
of versions supported by the system and the package.
71

72 73 74 75 76 77 78 79 80 81
=item B<checkcontrol>

Check if C<debian/control> needs updating from C<debian/control.in>. This is
invoked from C</usr/share/postgresql-common/pgxs_debian_control.mk>. When
building for a B<backports> or B<pgdg> suite as determined by
C<debian/changelog>, this action also updates the control file. Otherwise,
B<updatecontrol> needs to be run manually.

=item B<updatecontrol>

82 83
Update C<debian/control> from C<debian/control.in>, and C<debian/tests/control>
from C<debian/tests/control.in> if the latter exists.
84

85
=item B<configure> [I<src-dir>] I<build-dir> [I<extra-configure-options>]
86

87 88
For every supported version, call B<../configure> from the I<build-dir>
directory. (Most PostgreSQL extensions do not have a configure script.)
89

90
=item B<build> [I<src-dir>] I<build-dir> [I<extra-cflags>]
91

92
Build the extension in the I<build-dir> directory.
93

94
=item B<install> [I<src-dir>] I<build-dir> I<package-pattern>
95

96 97 98 99
Invoke B<make install> from the I<build-dir> directory.
The third parameter specifies the package name to use. Most packages
use B<postgresql-%v-pkgname>. Make will be
called with DESTDIR="$(CURDIR)/debian/I<package>".
100

101
=item B<clean> [I<src-dir>] I<build-dir>
102

103
Clean the build directory.
104

105
=item B<loop> [I<src-dir>] I<package-pattern>
106

107 108 109 110 111
As a variant to calling B<build> and B<install> separately for VPATH builds,
loop over the supported PostgreSQL versions in the top source directory. This
should be used if the package does not support VPATH builds. As it also invokes
B<make install>, it should be placed were installation happens in debian/rules,
rather than where build would normally be called.
112

113
=item B<installcheck> [I<src-dir>] [I<build-dir>]
114 115 116 117 118

Use B<pg_virtualenv make installcheck> to run the extension regression tests.
This is meant to be run from C<debian/tests/control> using B<autopkgtest>. If
I<build-dir> is omitted, the top source directory is used.

119 120
=back

121 122 123 124 125
Sometimes it is desirable to run extra code per version before invoking the
action, in that case the loop over supported versions needs to be in the
calling script. To facilitate this mode, actions can also be called as
I<action>B<->I<version>. See the installcheck example below.

126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
=head1 SUPPORTED VERSIONS

B<pg_buildext> reads C<debian/pgversions> to decide which PostgreSQL to build
modules/extensions for. This file contains one PostgreSQL version number per
line, in the following formats:

=over 4

=item B<all>

Support all versions. This is recommended unless there are known incompatibilities.

=item I<X.Y>

Support this version.

=item I<X.Y>B<+>

Support this and all greater versions.

=item B<#>I<...>

Comment.

=back

For a version to be used, it must also be listed in the output of
C</usr/share/postgresql-common/supported-versions>. See this file for how to
configure the list of supported versions on your system.

156
=head1 EXAMPLE
157

158
=over 4
159

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
=item B<debian/control.in:>

  Source: postgresql-foobar
  Build-Depends: debhelper, postgresql-server-dev-all (>= 153~)
  XS-Testsuite: autopkgtest

  Package: postgresql-PGVERSION-foobar
  Depends: ${misc:Depends}, ${shlibs:Depends}, postgresql-PGVERSION

=item B<debian/pgversions:>

  all

=item B<debian/rules:>

175 176
  #!/usr/bin/make -f

177
  include /usr/share/postgresql-common/pgxs_debian_control.mk
178

179
  # omit this if the package does not use autoconf
180
  override_dh_auto_configure:
181
	  +pg_buildext configure build-%v "--libdir=/usr/lib/postgresql/%v/lib --datadir=/usr/share/postgresql-%v-foobar"
182 183 184 185 186 187 188 189

  override_dh_auto_build:
	  +pg_buildext build build-%v

  override_dh_auto_test:
	  # nothing to do here, see debian/tests/* instead

  override_dh_auto_install:
190
	  +pg_buildext install build-%v postgresql-%v-foobar
191 192 193 194 195 196 197

  override_dh_installdocs:
	  dh_installdocs --all README.*

  override_dh_auto_clean:
	  +pg_buildext clean build-%v

198 199 200 201 202 203 204 205 206
  %:
	  dh $@

=item B<debian/tests/control:>

  Depends: @, postgresql-server-dev-all
  Tests: installcheck
  Restrictions: allow-stderr

207 208 209 210 211 212
=item B<debian/tests/control.in:> (optional)

  Depends: @, postgresql-contrib-PGVERSION, postgresql-PGVERSION-bar
  Tests: installcheck
  Restrictions: allow-stderr

213 214 215 216 217 218
=item B<debian/tests/installcheck:>

  #!/bin/sh
  pg_buildext installcheck
  # alternatively: pg_buildext installcheck build-%v

219 220 221 222 223 224 225 226
  # Running extra code before invoking the actual action:
  set -e
  for v in $(pg_buildext supported-versions); do
	  test -L build-$v/sql || ln -s ../sql build-$v/
	  test -L build-$v/expected || ln -s ../expected build-$v/
	  pg_buildext installcheck-$v build-$v
  done

227 228
=back

229 230 231 232 233 234 235 236
=head1 SOURCE DIRECTORY

If the package source code is not in the top level directory (i.e. the directory
which has C<debian/> as subdirectory), use the I<src-dir> argument. Example:

  override_dh_auto_build:
	  +pg_buildext build $(CURDIR)/postgresql-module build-%v

237 238 239 240
=head1 ENVIRONMENT

B<pg_buildext> sets B<PG_VIRTUALENV_UNSHARE=-n> for the installcheck actions by
default to request a new network namespace, enabling several instances running
241
in parallel to share port 5432. Override by setting to a different value.
242

243 244 245 246 247 248
=head1 COMPATIBILITY

B<pg_buildext loop> was introduced in postgresql-server-dev-all (>= 141~).

The usage of "all" or "X.Y+" in debian/pgversions was introduced in
postgresql-server-dev-all (>= 148~).
249

250 251
B<pg_buildext installcheck> was introduced in postgresql-server-dev-all (>=
153~).
252

253 254
B<PG_VIRTUALENV_UNSHARE=-n> was introduced in postgresql-common (>= 170~).

255 256 257
Handling of C<debian/tests/control.in> with B<PGVERSION> replacement was
introduced in postgresql-common (>= 171~).

258
=head1 SEE ALSO
259

260 261
C</usr/share/postgresql-common/supported-versions>, autopkgtest(1),
pg_virtualenv(1).
262

263
=head1 AUTHORS
264 265 266

Dimitri Fontaine L<E<lt>dim@tapoueh.orgE<gt>>, with extensions by
Christoph Berg L<E<lt>myon@debian.orgE<gt>>.