Documented the new autoGIL module.

jackjansen · jackjansen · commit 1662162c04ca · 2003-05-09T14:45:04.000Z
diff --git 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
@@ -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
@@ -57,6 +57,7 @@ \chapter{MacPython Modules \label{macpython-modules}}
 \input{libmacostools}
 \input{libmacui}
 \input{libframework}
+\input{libautogil}
 
 \input{scripting}
 
