Documented the new autoGIL module.

This commit is contained in:
Jack Jansen 2003-05-09 14:45:04 +00:00
parent ba5db20558
commit 1662162c04
3 changed files with 28 additions and 0 deletions

View File

@ -362,6 +362,7 @@ MACFILES= $(HOWTOSTYLES) $(INDEXSTYLES) $(COMMONTEX) \
mac/libmacui.tex \ mac/libmacui.tex \
mac/libmacic.tex \ mac/libmacic.tex \
mac/libframework.tex \ mac/libframework.tex \
mac/libautogil.tex \
mac/libminiae.tex \ mac/libminiae.tex \
mac/libscrap.tex mac/libscrap.tex

26
Doc/mac/libautogil.tex Normal file
View File

@ -0,0 +1,26 @@
\section{\module{autoGIL} ---
Global Interpreter Lock handling in event loops}
\declaremodule{extension}{autoGIL}
\platform{Mac}
\modulesynopsis{Global Interpreter Lock handling in event loops.}
\moduleauthor{Just van Rossum}{just@letterror.com}
The \module{autoGIL} module provides a function \function{installAutoGIL} that
automatically locks and unlocks Python's Global Interpreter Lock
when running an event loop.
\begin{excdesc}{AutoGILError}
Raised if the observer callback cannot be installed, for example because
the current thread does not have a run loop.
\end{excdesc}
\begin{funcdesc}{installAutoGIL}{}
Install an observer callback in the event loop (CFRunLoop) for the
current thread, that will lock and unlock the Global Interpreter Lock
(GIL) at appropriate times, allowing other Python threads to run while
the event loop is idle.
Availability: OSX 10.1 or later.
\end{funcdesc}

View File

@ -57,6 +57,7 @@ documented here:
\input{libmacostools} \input{libmacostools}
\input{libmacui} \input{libmacui}
\input{libframework} \input{libframework}
\input{libautogil}
\input{scripting} \input{scripting}