From: Martin v. Löwis <martin@v.loewis.de>
Date: Thu, 13 Apr 2006 07:28:29 +0000 (+0000)
Subject: Stop claiming that Py_Finalize releases all memory.
X-Git-Tag: v2.5a2~275
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=bb3001188093076dedb370b7ad6d82c4360f5fc8;p=thirdparty%2FPython%2Fcpython.git

Stop claiming that Py_Finalize releases all memory.
Fixes part of #1445210.
---

diff --git a/Doc/api/intro.tex b/Doc/api/intro.tex
index d84b65475766..739f0c214198 100644
--- a/Doc/api/intro.tex
+++ b/Doc/api/intro.tex
@@ -572,8 +572,11 @@ defined in \file{Modules/getpath.c}).
 Sometimes, it is desirable to ``uninitialize'' Python.  For instance, 
 the application may want to start over (make another call to 
 \cfunction{Py_Initialize()}) or the application is simply done with its 
-use of Python and wants to free all memory allocated by Python.  This
+use of Python and wants to free memory allocated by Python.  This
 can be accomplished by calling \cfunction{Py_Finalize()}.  The function
 \cfunction{Py_IsInitialized()}\ttindex{Py_IsInitialized()} returns
 true if Python is currently in the initialized state.  More
 information about these functions is given in a later chapter.
+Notice that \cfunction{Py_Finalize} does \emph{not} free all memory
+allocated by the Python interpreter, e.g. memory allocated by extension
+modules currently cannot be released.