From: Georg Brandl <georg@python.org>
Date: Thu, 5 Feb 2009 11:32:18 +0000 (+0000)
Subject: #5015: document PythonHome API functions.
X-Git-Tag: v2.7a1~2118
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4400d84bf7b424261d618840d38787225033332c;p=python

#5015: document PythonHome API functions.
---

diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index 327aed72ea..ec6207baf4 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -369,6 +369,20 @@ Initialization, Finalization, and Threads
       check w/ Guido.
 
 
+.. cfunction:: void Py_SetPythonHome(char *home)
+
+   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}`.
+
+
+.. cfunction:: char* Py_GetPythonHome()
+
+   Return the default "home", that is, the value set by a previous call to
+   :cfunc:`Py_SetPythonHome`, or the value of the :envvar:`PYTHONHOME`
+   environment variable if it is set.
+
+
 .. _threads:
 
 Thread State and the Global Interpreter Lock