diff options
author | Jay Berkenbilt <ejb@ql.org> | 2022-09-05 15:26:49 +0200 |
---|---|---|
committer | Jay Berkenbilt <ejb@ql.org> | 2022-09-06 00:52:59 +0200 |
commit | 55cc2ab68094984f4550f75feb0124726146d27e (patch) | |
tree | 845e538f36ff565743d85a608b736df649d23a3b /manual | |
parent | 6c61be00e8366d467e7e4c82a6d91a4d074a1181 (diff) | |
download | qpdf-55cc2ab68094984f4550f75feb0124726146d27e.tar.zst |
Re-introduce QPDFObject.hh as deprecated
* Just removing a header file would cause build errors with no hint as
to what happened. This way, people get a warning rather than error
for the life of qpdf 11, and the warning tells them what to do.
* This avoids build surprises resulting from having two versions of
QPDF headers installed at once. If you were building code out of a
checkout of qpdf but had an older version installed on your system,
if your code included <qpdf/QPDFObject.hh>, everything would work,
but then your code would break without QPDFObject.hh later.
Diffstat (limited to 'manual')
-rw-r--r-- | manual/release-notes.rst | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/manual/release-notes.rst b/manual/release-notes.rst index 0cd34934..8a783a87 100644 --- a/manual/release-notes.rst +++ b/manual/release-notes.rst @@ -95,17 +95,17 @@ For a detailed list of changes, please see the file - API: breaking changes - - Remove ``QPDFObject.hh`` from the public ``include/qpdf`` - directory. The only use case for including - ``qpdf/QPDFObject.hh`` was to get ``QPDFObject::object_type_e``. - Since 10.5.0, this has been an alias to ``qpdf_object_type_e``, - defined in ``qpdf/Constants.h``. To fix your code, replace any - includes of ``qpdf/QPDFObject.hh`` with ``qpdf/Constants.h``, - and replace all occurrences of ``QPDFObject::ot_`` with - ``::ot_``. If you need your code to be backward compatible to - qpdf versions prior to 10.5.0, you can check that the - preprocessor symbol ``QPDF_MAJOR_VERSION`` is defined and ``>= - 11``. + - Deprecate ``QPDFObject.hh`` for removal in qpdf 12. The only use + case for including ``qpdf/QPDFObject.hh`` was to get + ``QPDFObject::object_type_e``. Since 10.5.0, this has been an + alias to ``qpdf_object_type_e``, defined in + ``qpdf/Constants.h``. To fix your code, replace any includes of + ``qpdf/QPDFObject.hh`` with ``qpdf/Constants.h``, and replace + all occurrences of ``QPDFObject::ot_`` with ``::ot_``. If you + need your code to be backward compatible to qpdf versions prior + to 10.5.0, you can check that the preprocessor symbol + ``QPDF_MAJOR_VERSION`` is defined and ``>= 11``. As a stop-gap, + you can `#define QPDF_OBJECT_NOWARN` to suppress the warning. - Pipeline::write now takes ``unsigned char const*`` instead of ``unsigned char*``. Callers don't need to change anything, but |