Browse Source

[2440] added note about how long old encoded data must be kept valid for merge.

JINMEI Tatuya 12 years ago
parent
commit
0c87e932ff
1 changed files with 5 additions and 1 deletions
  1. 5 1
      src/lib/datasrc/memory/rdata_serialization.h

+ 5 - 1
src/lib/datasrc/memory/rdata_serialization.h

@@ -169,7 +169,11 @@ public:
     ///
     /// The caller must also ensure that previously encoded data (pointed
     /// to by \c old_data) will be valid and intact throughout the encoding
-    /// session started by this method.
+    /// session started by this method.  The resulting encoded data (by
+    /// \c encode()) won't refer to the previous data, so once encoding the
+    /// merged data is completed (and unless this encoding session continues
+    /// for another attempt of encoding, which is unlikely), the caller can
+    /// modify or destroy the old data.
     ///
     /// \param rrclass The RR class of RDATA to be encoded in the session.
     /// \param rrtype The RR type of RDATA to be encoded in the session.