summaryrefslogtreecommitdiffstats
path: root/Doc/api/init.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-04-09 21:09:42 (GMT)
committerFred Drake <fdrake@acm.org>2002-04-09 21:09:42 (GMT)
commit375e30225eeec765d00dfab600f4e7333d8a86d5 (patch)
treeb4cb99ec029e78ecfe5ea58fe1e5c1d36db006c1 /Doc/api/init.tex
parent79bf99c5051451b8af900cb26b6080c56690d4a2 (diff)
downloadcpython-375e30225eeec765d00dfab600f4e7333d8a86d5.zip
cpython-375e30225eeec765d00dfab600f4e7333d8a86d5.tar.gz
cpython-375e30225eeec765d00dfab600f4e7333d8a86d5.tar.bz2
Update to use the new \csimplemacro macro
Diffstat (limited to 'Doc/api/init.tex')
-rw-r--r--Doc/api/init.tex36
1 files changed, 19 insertions, 17 deletions
diff --git a/Doc/api/init.tex b/Doc/api/init.tex
index 5066c5c..712ca54 100644
--- a/Doc/api/init.tex
+++ b/Doc/api/init.tex
@@ -391,12 +391,13 @@ Py_BEGIN_ALLOW_THREADS
Py_END_ALLOW_THREADS
\end{verbatim}
-The \code{Py_BEGIN_ALLOW_THREADS}\ttindex{Py_BEGIN_ALLOW_THREADS} macro
-opens a new block and declares a hidden local variable; the
-\code{Py_END_ALLOW_THREADS}\ttindex{Py_END_ALLOW_THREADS} macro closes
-the block. Another advantage of using these two macros is that when
-Python is compiled without thread support, they are defined empty,
-thus saving the thread state and lock manipulations.
+The
+\csimplemacro{Py_BEGIN_ALLOW_THREADS}\ttindex{Py_BEGIN_ALLOW_THREADS}
+macro opens a new block and declares a hidden local variable; the
+\csimplemacro{Py_END_ALLOW_THREADS}\ttindex{Py_END_ALLOW_THREADS}
+macro closes the block. Another advantage of using these two macros
+is that when Python is compiled without thread support, they are
+defined empty, thus saving the thread state and lock manipulations.
When thread support is enabled, the block above expands to the
following code:
@@ -574,30 +575,31 @@ look for example usage in the Python source distribution.
This macro expands to
\samp{\{ PyThreadState *_save; _save = PyEval_SaveThread();}.
Note that it contains an opening brace; it must be matched with a
- following \code{Py_END_ALLOW_THREADS} macro. See above for further
- discussion of this macro. It is a no-op when thread support is
- disabled at compile time.
+ following \csimplemacro{Py_END_ALLOW_THREADS} macro. See above for
+ further discussion of this macro. It is a no-op when thread support
+ is disabled at compile time.
\end{csimplemacrodesc}
\begin{csimplemacrodesc}{Py_END_ALLOW_THREADS}
This macro expands to \samp{PyEval_RestoreThread(_save); \}}.
Note that it contains a closing brace; it must be matched with an
- earlier \code{Py_BEGIN_ALLOW_THREADS} macro. See above for further
- discussion of this macro. It is a no-op when thread support is
- disabled at compile time.
+ earlier \csimplemacro{Py_BEGIN_ALLOW_THREADS} macro. See above for
+ further discussion of this macro. It is a no-op when thread support
+ is disabled at compile time.
\end{csimplemacrodesc}
\begin{csimplemacrodesc}{Py_BLOCK_THREADS}
This macro expands to \samp{PyEval_RestoreThread(_save);}: it is
- equivalent to \code{Py_END_ALLOW_THREADS} without the closing brace.
- It is a no-op when thread support is disabled at compile time.
+ equivalent to \csimplemacro{Py_END_ALLOW_THREADS} without the
+ closing brace. It is a no-op when thread support is disabled at
+ compile time.
\end{csimplemacrodesc}
\begin{csimplemacrodesc}{Py_UNBLOCK_THREADS}
This macro expands to \samp{_save = PyEval_SaveThread();}: it is
- equivalent to \code{Py_BEGIN_ALLOW_THREADS} without the opening
- brace and variable declaration. It is a no-op when thread support
- is disabled at compile time.
+ equivalent to \csimplemacro{Py_BEGIN_ALLOW_THREADS} without the
+ opening brace and variable declaration. It is a no-op when thread
+ support is disabled at compile time.
\end{csimplemacrodesc}
All of the following functions are only available when thread support