From 13761120b1dbe126a9d39b9439086b76b4860b27 Mon Sep 17 00:00:00 2001 From: Jay Berkenbilt Date: Sat, 17 Jun 2023 12:20:23 -0400 Subject: Enhance documentation about FUTURE build option --- manual/packaging.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'manual/packaging.rst') diff --git a/manual/packaging.rst b/manual/packaging.rst index 1bd89758..ca32554a 100644 --- a/manual/packaging.rst +++ b/manual/packaging.rst @@ -26,6 +26,12 @@ particularly useful to packagers. combined with either ``ctest --verbose`` or ``ctest --output-on-failure``. +- Packagers should never define the ``FUTURE`` build option. API + changes enabled by ``FUTURE`` are not stable and may be + API/ABI-breaking. That option is intended only for people who are + testing their code with a local build of qpdf to provide early + feedback or prepare for possible future changes to the API. + - qpdf's install targets do not install completion files by default since there is no standard location for them. As a packager, it's good if you install them wherever your distribution expects such -- cgit v1.2.3-54-g00ecf