aboutsummaryrefslogtreecommitdiffstats
path: root/manual/installation.rst
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2022-03-15 02:39:29 +0100
committerJay Berkenbilt <jberkenbilt@users.noreply.github.com>2022-03-19 00:53:18 +0100
commitacdf5b2e7a9b3074125bc95bfcf7e6abdc9704b4 (patch)
tree2606c1709893f0011837fe56bdc2ba3337e5440e /manual/installation.rst
parent4c0addfe660fcda049ab1d79d337871c1df798f7 (diff)
downloadqpdf-acdf5b2e7a9b3074125bc95bfcf7e6abdc9704b4.tar.zst
Update process for ABI testing
Diffstat (limited to 'manual/installation.rst')
-rw-r--r--manual/installation.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/manual/installation.rst b/manual/installation.rst
index 28d4ccd9..315b4bd8 100644
--- a/manual/installation.rst
+++ b/manual/installation.rst
@@ -239,6 +239,14 @@ QTEST_COLOR
Options for Working on qpdf
~~~~~~~~~~~~~~~~~~~~~~~~~~~
+CHECK_SIZES
+ The source file :file:`qpdf/sizes.cc` is used to display the sizes
+ of all objects in the public API. Consistency of its output between
+ releases is used as part of the check against accidental breakage of
+ the binary interface (ABI). Turning this on causes a test to be run
+ that ensures an exact match between classes in ``sizes.cc`` and
+ classes in the library's public API. This option requires Python 3.
+
GENERATE_AUTO_JOB
Some qpdf source files are automatically generated from
:file:`job.yml` and the CLI documentation. If you are adding new
@@ -277,6 +285,8 @@ MAINTAINER_MODE
- ``BUILD_DOC``
+ - ``CHECK_SIZES``
+
- ``GENERATE_AUTO_JOB``
- ``WERROR``