]> granicus.if.org Git - python/commitdiff
Documented the new autoGIL module.
authorJack Jansen <jack.jansen@cwi.nl>
Fri, 9 May 2003 14:45:04 +0000 (14:45 +0000)
committerJack Jansen <jack.jansen@cwi.nl>
Fri, 9 May 2003 14:45:04 +0000 (14:45 +0000)
Doc/Makefile.deps
Doc/mac/libautogil.tex [new file with mode: 0644]
Doc/mac/mac.tex

index 68e8f56c5f9fac50ca416d54e6a063195cd5b2bc..793cdec9e48edcf4a05a6093a1a9bd355d7988ee 100644 (file)
@@ -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 (file)
index 0000000..002e872
--- /dev/null
@@ -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}
index 41ff2d31715522e9e2046307daf7e99b968895ac..c67545aea9565aab19de57f89a7eada4fe43e87b 100644 (file)
@@ -57,6 +57,7 @@ documented here:
 \input{libmacostools}
 \input{libmacui}
 \input{libframework}
+\input{libautogil}
 
 \input{scripting}