aboutsummaryrefslogtreecommitdiffstats
path: root/manual/release-notes.rst
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2022-02-06 15:19:56 +0100
committerJay Berkenbilt <ejb@ql.org>2022-02-07 23:38:20 +0100
commitdd4f30226f3d4738e198dfcb944ce4cdc7e50a86 (patch)
tree3f9aaec5429e4c744e2df44e7ef027d2f016ff70 /manual/release-notes.rst
parentdf2f5c6a360bd7512d2280aa9cb582bc0aa622bd (diff)
downloadqpdf-dd4f30226f3d4738e198dfcb944ce4cdc7e50a86.tar.zst
Rework PointerHolder transition to make it smoother
* Don't surprise people with deprecation warnings * Provide detailed instructions and support for the transition
Diffstat (limited to 'manual/release-notes.rst')
-rw-r--r--manual/release-notes.rst27
1 files changed, 7 insertions, 20 deletions
diff --git a/manual/release-notes.rst b/manual/release-notes.rst
index 19e172e8..d738e534 100644
--- a/manual/release-notes.rst
+++ b/manual/release-notes.rst
@@ -7,28 +7,15 @@ For a detailed list of changes, please see the file
:file:`ChangeLog` in the source distribution.
10.6.0: XXX
- - Deprecations/future replacement of ``PointerHolder``
+ - Preparation for replacement of ``PointerHolder``
The next major release of qpdf will replace ``PointerHolder`` with
- ``std::shared_ptr`` across all of qpdf's public API. In
- preparation for this change, the following ``PointerHolder``
- methods have been deprecated in favor of interfaces that more
- closely match ``std::shared_ptr``:
-
- - ``getPointer()`` -- use ``get()`` instead; this also fixes
- ``const`` semantics as discussed in
- :file:`include/qpdf/PointerHolder.hh`.
-
- - ``getRefcount()`` -- use ``use_count()`` instead
-
- If you build your code with deprecation warnings enabled and you
- want to suppress these deprecation warnings for now, you can
- ``#define NO_POINTERHOLDER_DEPRECATION`` before including any qpdf
- header files. Code that does this will *require no changes* prior
- to qpdf 11 and may or may not require changes after qpdf 11.
-
- For a detailed discussion of this change and how to prepare for
- it, see :ref:`smart-pointers`.
+ ``std::shared_ptr`` across all of qpdf's public API. No action is
+ required at this time, but if you'd like to prepare, read the
+ comments :file:`include/qpdf/PointerHolder.hh` and see
+ :ref:`smart-pointers` for details on what you can do now to create
+ code that will continue to work with older versions of qpdf and be
+ easier to switch over to qpdf 11 when it comes out.
- Preparation for a new JSON output version