From 1662162c04caa474df00d1138f7e0938d73181ee Mon Sep 17 00:00:00 2001 From: Jack Jansen Date: Fri, 9 May 2003 14:45:04 +0000 Subject: [PATCH] Documented the new autoGIL module. --- Doc/Makefile.deps | 1 + Doc/mac/libautogil.tex | 26 ++++++++++++++++++++++++++ Doc/mac/mac.tex | 1 + 3 files changed, 28 insertions(+) create mode 100644 Doc/mac/libautogil.tex diff --git a/Doc/Makefile.deps b/Doc/Makefile.deps index 68e8f56c5f9..793cdec9e48 100644 --- a/Doc/Makefile.deps +++ b/Doc/Makefile.deps @@ -362,6 +362,7 @@ MACFILES= $(HOWTOSTYLES) $(INDEXSTYLES) $(COMMONTEX) \ mac/libmacui.tex \ mac/libmacic.tex \ mac/libframework.tex \ + mac/libautogil.tex \ mac/libminiae.tex \ mac/libscrap.tex diff --git a/Doc/mac/libautogil.tex b/Doc/mac/libautogil.tex new file mode 100644 index 00000000000..002e8722855 --- /dev/null +++ b/Doc/mac/libautogil.tex @@ -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} diff --git a/Doc/mac/mac.tex b/Doc/mac/mac.tex index 41ff2d31715..c67545aea95 100644 --- a/Doc/mac/mac.tex +++ b/Doc/mac/mac.tex @@ -57,6 +57,7 @@ documented here: \input{libmacostools} \input{libmacui} \input{libframework} +\input{libautogil} \input{scripting}