Document new APIs PyOS_getsig() and PyOS_setsig().

gvanrossum · gvanrossum · commit c96ec6ef2b81 · 2000-09-16T16:30:48.000Z
(Is there no macro to document a typedef?)

Fred, please check my latex!
diff --git a/Doc/api/api.tex b/Doc/api/api.tex
@@ -1092,6 +1092,21 @@ \section{OS Utilities \label{os}}
 code.
 \end{cfuncdesc}
 
+\begin{cfuncdesc}{PyOS_sighandler_t}{PyOS_getsig}{int i}
+Return the current signal handler for signal \var{i}.
+This is a thin wrapper around either \cfunction{sigaction} or
+\cfunction{signal}.  Do not call those functions directly!
+\ctype{PyOS_sighandler_t} is a typedef alias for \ctype{void (*)(int)}.
+\end{cfuncdesc}
+
+\begin{cfuncdesc}{PyOS_sighandler_t}{PyOS_setsig}{int i, PyOS_sighandler_t h}
+Set the signal handler for signal \var{i} to be \var{h};
+return the old signal handler.
+This is a thin wrapper around either \cfunction{sigaction} or
+\cfunction{signal}.  Do not call those functions directly!
+\ctype{PyOS_sighandler_t} is a typedef alias for \ctype{void (*)(int)}.
+\end{cfuncdesc}
+
 
 \section{Process Control \label{processControl}}
 
