summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-12-02 18:02:01 +0000
committerGeorg Brandl <georg@python.org>2010-12-02 18:02:01 +0000
commitde0ab5eab31c9ea9a628718778b0dc57df0d8470 (patch)
treee235337f4e6279ce1511c31ad72947fb84c071bc
parentee255681369dcda1104afb6b3df7438108f0f6b1 (diff)
downloadcpython-git-de0ab5eab31c9ea9a628718778b0dc57df0d8470.tar.gz
#10597: fix Py_SetPythonHome docs by pointing to where the meaning of PYTHONHOME is already documented.
-rw-r--r--Doc/c-api/init.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index dbceecc931..671ba2551d 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -412,8 +412,9 @@ Initialization, Finalization, and Threads
.. c:function:: void Py_SetPythonHome(wchar_t *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}`.
+ Python libraries. See :envvar:`PYTHONHOME` for the meaning of the
+ argument string.
+
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