From a4d6589ff26007c966db8912e4dae1aa937a5968 Mon Sep 17 00:00:00 2001
From: Jay Berkenbilt <ejb@ql.org>
Date: Thu, 25 Feb 2021 06:34:03 -0500
Subject: Have QPDFObjectHandle notice when replaceObject was called

This results in a performance penalty of 1% to 2% when replaceObject
and swapObjects are never called and a somewhat larger penalty if they
are called, but it's worth it to avoid very confusing behavior as
discussed in depth in qpdf#507.
---
 manual/qpdf-manual.xml | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'manual/qpdf-manual.xml')

diff --git a/manual/qpdf-manual.xml b/manual/qpdf-manual.xml
index 565967db..7efbf938 100644
--- a/manual/qpdf-manual.xml
+++ b/manual/qpdf-manual.xml
@@ -5060,6 +5060,32 @@ print "\n";
     </listitem>
    </varlistentry>
 -->
+   <varlistentry>
+    <term>XXX 10.2.1: Month dd, YYYY</term>
+    <listitem>
+     <itemizedlist>
+      <listitem>
+       <para>
+        Bug Fixes
+       </para>
+       <itemizedlist>
+        <listitem>
+         <para>
+          When <function>QPDF::replaceObject</function> or
+          <function>QPDF::swapObjects</function> is called, existing
+          <classname>QPDFObjectHandle</classname> instances no longer
+          point to the old objects. The next time they are
+          accessed, they automatically notice the change to the
+          underlying object and update themselves. This resolves a
+          very longstanding source of confusion, albeit in a very
+          rarely used method call.
+         </para>
+        </listitem>
+       </itemizedlist>
+      </listitem>
+     </itemizedlist>
+    </listitem>
+   </varlistentry>
    <varlistentry>
     <term>10.2.0: February 23, 2021</term>
     <listitem>
-- 
cgit v1.2.3-54-g00ecf