From: JINMEI Tatuya <jinmei@isc.org>
Date: Tue, 9 Apr 2013 21:52:53 +0000 (-0700)
Subject: [2831] described implementation-specific differences of setNamedAddress.
X-Git-Tag: bind10-1.2.0beta1-release~457^2~83
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b8d905c9dffd7f3973854d9f1bc7eac7086f4aa2;p=thirdparty%2Fkea.git

[2831] described implementation-specific differences of setNamedAddress.
---

diff --git a/src/lib/util/memory_segment_local.h b/src/lib/util/memory_segment_local.h
index 26fdd00ca0..2c09fa7f4c 100644
--- a/src/lib/util/memory_segment_local.h
+++ b/src/lib/util/memory_segment_local.h
@@ -76,6 +76,11 @@ public:
     ///
     /// This version does not validate the given address to see whether it
     /// belongs to this segment.
+    ///
+    /// This implementation of this method always returns \c false (but the
+    /// application should expect a return value of \c true unless it knows
+    /// the memory segment class is \c MemorySegmentLocal and needs to
+    /// exploit the fact).
     virtual bool setNamedAddress(const char* name, void* addr);
 
     /// \brief Local segment version of clearNamedAddress.
diff --git a/src/lib/util/memory_segment_mapped.h b/src/lib/util/memory_segment_mapped.h
index 3ced535437..8b2fafb781 100644
--- a/src/lib/util/memory_segment_mapped.h
+++ b/src/lib/util/memory_segment_mapped.h
@@ -134,7 +134,8 @@ public:
     /// This implementation detects if \c addr is invalid (see the base class
     /// description) and throws \c MemorySegmentError in that case.
     ///
-    /// This version can actually return true.
+    /// This version can actually return true (see also \c MemorySegmentLocal
+    /// version of the method).
     ///
     /// This method cannot be called if the segment object is created in the
     /// read-only mode; in that case InvalidOperation will be thrown.