diff mbox

Clarify mt_allocator documentation w.r.t deallocation

Message ID 20170508151028.GA30154@redhat.com
State New
Headers show

Commit Message

Jonathan Wakely May 8, 2017, 3:10 p.m. UTC
The interwebs seem confused by these docs, and think it means that
mt_allocator just leaks memory instead of deallocating it. The
interwebs are pretty dumb sometimes.

	* doc/xml/manual/mt_allocator.xml: Clarify deallocation behaviour.
	* doc/html/*: Regenerate.

Committed to trunk.
commit 4d46264542fef99c1eaf8d10e996c741f109ba44
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Mon May 8 16:04:53 2017 +0100

    Clarify mt_allocator documentation w.r.t deallocation
    
    	* doc/xml/manual/mt_allocator.xml: Clarify deallocation behaviour.
    	* doc/html/*: Regenerate.
diff mbox

Patch

diff --git a/libstdc++-v3/doc/xml/manual/mt_allocator.xml b/libstdc++-v3/doc/xml/manual/mt_allocator.xml
index 12fe2ee..3254bf8 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:
 
 
 <para> 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