summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorJoannah Nanjekye <33177550+nanjekyejoannah@users.noreply.github.com>2019-10-04 11:35:42 (GMT)
committerVictor Stinner <vstinner@python.org>2019-10-04 11:35:42 (GMT)
commit8855e47d09d4db1206c65b24efc8ad0df585ac46 (patch)
tree7bad8536eb0439d6c6edfed703b7165cb367ca0b /Doc
parent06cb94bc8419b9a24df6b0d724fcd8e40c6971d6 (diff)
downloadcpython-8855e47d09d4db1206c65b24efc8ad0df585ac46.zip
cpython-8855e47d09d4db1206c65b24efc8ad0df585ac46.tar.gz
cpython-8855e47d09d4db1206c65b24efc8ad0df585ac46.tar.bz2
bpo-38266: Revert bpo-37878: Make PyThreadState_DeleteCurrent() Internal (GH-16558)
Revert the removal of PyThreadState_DeleteCurrent() with documentation.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/init.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index 0b7a84d..5456ad4 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -1035,6 +1035,14 @@ All of the following functions must be called after :c:func:`Py_Initialize`.
:c:func:`PyThreadState_Clear`.
+ .. c:function:: void PyThreadState_DeleteCurrent()
+
+ Destroy the current thread state and release the global interpreter lock.
+ Like :c:func:`PyThreadState_Delete`, the global interpreter lock need not
+ be held. The thread state must have been reset with a previous call
+ to :c:func:`PyThreadState_Clear`.
+
+
.. c:function:: PY_INT64_T PyInterpreterState_GetID(PyInterpreterState *interp)
Return the interpreter's unique ID. If there was any error in doing