summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorJack Jansen <jack.jansen@cwi.nl>2003-05-09 14:45:04 (GMT)
committerJack Jansen <jack.jansen@cwi.nl>2003-05-09 14:45:04 (GMT)
commit1662162c04caa474df00d1138f7e0938d73181ee (patch)
treeb6424e455e28ea2b534e1068510b2d1803f50c95 /Doc
parentba5db205585867d55fc94ca11b43b4fc23c0afeb (diff)
downloadcpython-1662162c04caa474df00d1138f7e0938d73181ee.zip
cpython-1662162c04caa474df00d1138f7e0938d73181ee.tar.gz
cpython-1662162c04caa474df00d1138f7e0938d73181ee.tar.bz2
Documented the new autoGIL module.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Makefile.deps1
-rw-r--r--Doc/mac/libautogil.tex26
-rw-r--r--Doc/mac/mac.tex1
3 files changed, 28 insertions, 0 deletions
diff --git a/Doc/Makefile.deps b/Doc/Makefile.deps
index 68e8f56..793cdec 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 0000000..002e872
--- /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 41ff2d3..c67545a 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}