From 6d430cbd127b01170b4774c772ade33b0b665eba Mon Sep 17 00:00:00 2001
From: Jonathan Wakely
Date: Mon, 8 May 2017 16:09:08 +0100
Subject: [PATCH] Clarify mt_allocator documentation w.r.t deallocation
* doc/xml/manual/mt_allocator.xml: Clarify deallocation behaviour.
* doc/html/*: Regenerate.
From-SVN: r247742
---
libstdc++-v3/ChangeLog | 5 +++++
libstdc++-v3/doc/html/manual/mt_allocator_impl.html | 3 ++-
libstdc++-v3/doc/xml/manual/mt_allocator.xml | 3 ++-
3 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog
index 7e39c092e46..b5a67190e79 100644
--- a/libstdc++-v3/ChangeLog
+++ b/libstdc++-v3/ChangeLog
@@ -1,3 +1,8 @@
+2017-05-08 Jonathan Wakely
+
+ * doc/xml/manual/mt_allocator.xml: Clarify deallocation behaviour.
+ * doc/html/*: Regenerate.
+
2017-05-02 Hugo Beauzée-Luyssen
PR libstdc++/69506
diff --git a/libstdc++-v3/doc/html/manual/mt_allocator_impl.html b/libstdc++-v3/doc/html/manual/mt_allocator_impl.html
index 7b3379aa1d4..206d1a806ae 100644
--- a/libstdc++-v3/doc/html/manual/mt_allocator_impl.html
+++ b/libstdc++-v3/doc/html/manual/mt_allocator_impl.html
@@ -131,7 +131,8 @@ The _S_initialize() function:
are grabbed from the global list to a thread specific list or when
a thread decides to return some blocks to the global freelist.
Notes about deallocation. This allocator does not explicitly
-release memory. Because of this, memory debugging programs like
+release memory back to the OS, but keeps its own freelists instead.
+Because of this, memory debugging programs like
valgrind or purify may notice leaks: sorry about this
inconvenience. Operating systems will reclaim allocated memory at
program termination anyway. If sidestepping this kind of noise is
diff --git a/libstdc++-v3/doc/xml/manual/mt_allocator.xml b/libstdc++-v3/doc/xml/manual/mt_allocator.xml
index 12fe2ee3b64..3254bf88d2c 100644
--- a/libstdc++-v3/doc/xml/manual/mt_allocator.xml
+++ b/libstdc++-v3/doc/xml/manual/mt_allocator.xml
@@ -281,7 +281,8 @@ The _S_initialize() function:
Notes about deallocation. This allocator does not explicitly
-release memory. Because of this, memory debugging programs like
+release memory back to the OS, but keeps its own freelists instead.
+Because of this, memory debugging programs like
valgrind or purify may notice leaks: sorry about this
inconvenience. Operating systems will reclaim allocated memory at
program termination anyway. If sidestepping this kind of noise is
--
2.30.2