diff options
| author | Jay Berkenbilt <ejb@ql.org> | 2023-06-17 18:20:23 +0200 |
|---|---|---|
| committer | Jay Berkenbilt <ejb@ql.org> | 2023-06-17 20:02:27 +0200 |
| commit | 13761120b1dbe126a9d39b9439086b76b4860b27 (patch) | |
| tree | 1a4dd859c0e0d28f9fff19d97e92120bf28378e2 /manual/packaging.rst | |
| parent | 4101596f1ab61af99b71defa2e2b512d52dcc6ea (diff) | |
| download | qpdf-13761120b1dbe126a9d39b9439086b76b4860b27.tar.zst | |
Enhance documentation about FUTURE build option
Diffstat (limited to 'manual/packaging.rst')
| -rw-r--r-- | manual/packaging.rst | 6 |
1 files changed, 6 insertions, 0 deletions
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 |