From acdf5b2e7a9b3074125bc95bfcf7e6abdc9704b4 Mon Sep 17 00:00:00 2001 From: Jay Berkenbilt Date: Mon, 14 Mar 2022 21:39:29 -0400 Subject: Update process for ABI testing --- manual/installation.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'manual') 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`` -- cgit v1.2.3-54-g00ecf