[Python-checkins] r74795 - python/trunk/Doc/c-api/init.rst

[benjamin.peterson]

Author: benjamin.peterson
Date: Tue Sep 15 05:36:26 2009
New Revision: 74795

Log:
Py_SetPythonHome uses static storage #6913

Modified:
   python/trunk/Doc/c-api/init.rst

Modified: python/trunk/Doc/c-api/init.rst
==============================================================================
--- python/trunk/Doc/c-api/init.rst	(original)
+++ python/trunk/Doc/c-api/init.rst	Tue Sep 15 05:36:26 2009
@@ -374,6 +374,10 @@
    Set the default "home" directory, that is, the location of the standard
    Python libraries.  The libraries are searched in
    :file:`{home}/lib/python{version}` and :file:`{home}/lib/python{version}`.
+   The argument should point to a zero-terminated character string in static
+   storage whose contents will not change for the duration of the program's
+   execution.  No code in the Python interpreter will change the contents of
+   this storage.
 
 
 .. cfunction:: char* Py_GetPythonHome()