From: JINMEI Tatuya <jinmei@isc.org>
Date: Fri, 12 Apr 2013 23:31:01 +0000 (-0700)
Subject: [2831] more clarified when mapped setNamedAddress returns true.
X-Git-Tag: bind10-1.2.0beta1-release~457^2~49
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e41c43c1cc533686b04734fa35377bbaebf356ea;p=thirdparty%2Fkea.git

[2831] more clarified when mapped setNamedAddress returns true.
---

diff --git a/src/lib/util/memory_segment_mapped.h b/src/lib/util/memory_segment_mapped.h
index 476974c38a..142d2b7924 100644
--- a/src/lib/util/memory_segment_mapped.h
+++ b/src/lib/util/memory_segment_mapped.h
@@ -163,8 +163,11 @@ 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 (see also \c MemorySegmentLocal
-    /// version of the method).
+    /// This version of method should normally return false.  However,
+    /// it internally allocates memory in the segment for the name and
+    /// address to be stored, which can require segment extension, just like
+    /// allocate().  So it's possible to return true unlike
+    /// \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 MemorySegmentError will be thrown.