diff options
author | Jay Berkenbilt <ejb@ql.org> | 2022-08-07 21:49:54 +0200 |
---|---|---|
committer | Jay Berkenbilt <ejb@ql.org> | 2022-08-07 22:20:49 +0200 |
commit | cef6425bcac678157f58e9eafabb7e63c5831d18 (patch) | |
tree | 3889207c93e092679f9b8d01084c5cc1f9d7794f /manual/installation.rst | |
parent | da71dc6f37c69bdf708f1f9876e63ff348ae2296 (diff) | |
download | qpdf-cef6425bcac678157f58e9eafabb7e63c5831d18.tar.zst |
Disable QTC inside the library by default (fixes #714)
This results in measurable performance improvements to packaged binary
libqpdf distributions. QTC remains available for library users and is
still selectively enabled in CI.
Diffstat (limited to 'manual/installation.rst')
-rw-r--r-- | manual/installation.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/manual/installation.rst b/manual/installation.rst index e02380ee..08c49765 100644 --- a/manual/installation.rst +++ b/manual/installation.rst @@ -257,6 +257,16 @@ CHECK_SIZES that ensures an exact match between classes in ``sizes.cc`` and classes in the library's public API. This option requires Python 3. +ENABLE_QTC + This is off by default, except in maintainer mode. When off, + ``QTC::TC`` calls are compiled out by having ``QTC::TC`` be an empty + inline function. The underlying ``QTC::TC`` remains in the library, + so it is possible to build and package the qpdf library with + ``ENABLE_QTC`` turned off while still allowing developer code to use + ``QTC::TC`` if desired. If you are modifying qpdf code, it's a good + idea to have this on for more robust automated testing. Otherwise, + there's no reason to have it on. + GENERATE_AUTO_JOB Some qpdf source files are automatically generated from :file:`job.yml` and the CLI documentation. If you are adding new @@ -297,6 +307,8 @@ MAINTAINER_MODE - ``CHECK_SIZES`` + - ``ENABLE_QTC`` + - ``GENERATE_AUTO_JOB`` - ``WERROR`` |