diff options
author | Cheryl Sabella <cheryl.sabella@gmail.com> | 2018-10-12 14:55:20 (GMT) |
---|---|---|
committer | Victor Stinner <vstinner@redhat.com> | 2018-10-12 14:55:20 (GMT) |
commit | 2d6097d027e0dd3debbabc702aa9c98d94ba32a3 (patch) | |
tree | 283b237b7e8da5afa68b5d79792d61f8d60596ac /Doc/library/signal.rst | |
parent | da2bf9f66d0c95b988c5d87646d168f65499b316 (diff) | |
download | cpython-2d6097d027e0dd3debbabc702aa9c98d94ba32a3.zip cpython-2d6097d027e0dd3debbabc702aa9c98d94ba32a3.tar.gz cpython-2d6097d027e0dd3debbabc702aa9c98d94ba32a3.tar.bz2 |
bpo-11233: Create availability directive for documentation (GH-9692)
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
Original patch by Georg Brandl.
Co-Authored-By: Georg Brandl <georg@python.org>
Diffstat (limited to 'Doc/library/signal.rst')
-rw-r--r-- | Doc/library/signal.rst | 45 |
1 files changed, 26 insertions, 19 deletions
diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst index bf07559..5c48c88 100644 --- a/Doc/library/signal.rst +++ b/Doc/library/signal.rst @@ -106,7 +106,7 @@ The variables defined in the :mod:`signal` module are: The signal corresponding to the :kbd:`Ctrl+C` keystroke event. This signal can only be used with :func:`os.kill`. - Availability: Windows. + .. availability:: Windows. .. versionadded:: 3.2 @@ -116,7 +116,7 @@ The variables defined in the :mod:`signal` module are: The signal corresponding to the :kbd:`Ctrl+Break` keystroke event. This signal can only be used with :func:`os.kill`. - Availability: Windows. + .. availability:: Windows. .. versionadded:: 3.2 @@ -193,7 +193,9 @@ The :mod:`signal` module defines the following functions: then the number of seconds before any previously set alarm was to have been delivered. If *time* is zero, no alarm is scheduled, and any scheduled alarm is canceled. If the return value is zero, no alarm is currently scheduled. (See - the Unix man page :manpage:`alarm(2)`.) Availability: Unix. + the Unix man page :manpage:`alarm(2)`.) + + .. availability:: Unix. .. function:: getsignal(signalnum) @@ -252,8 +254,8 @@ The :mod:`signal` module defines the following functions: If *signalnum* is 0, then no signal is sent, but error checking is still performed; this can be used to check if the target thread is still running. - Availability: Unix (see the man page :manpage:`pthread_kill(3)` for further - information). + .. availability:: Unix (see the man page :manpage:`pthread_kill(3)` for further + information). See also :func:`os.kill`. @@ -283,8 +285,8 @@ The :mod:`signal` module defines the following functions: For example, ``signal.pthread_sigmask(signal.SIG_BLOCK, [])`` reads the signal mask of the calling thread. - Availability: Unix. See the man page :manpage:`sigprocmask(3)` and - :manpage:`pthread_sigmask(3)` for further information. + .. availability:: Unix. See the man page :manpage:`sigprocmask(3)` and + :manpage:`pthread_sigmask(3)` for further information. See also :func:`pause`, :func:`sigpending` and :func:`sigwait`. @@ -309,13 +311,16 @@ The :mod:`signal` module defines the following functions: The old values are returned as a tuple: (delay, interval). Attempting to pass an invalid interval timer will cause an - :exc:`ItimerError`. Availability: Unix. + :exc:`ItimerError`. + + .. availability:: Unix. .. function:: getitimer(which) Returns current value of a given interval timer specified by *which*. - Availability: Unix. + + .. availability:: Unix. .. function:: set_wakeup_fd(fd, *, warn_on_full_buffer=True) @@ -365,8 +370,10 @@ The :mod:`signal` module defines the following functions: Change system call restart behaviour: if *flag* is :const:`False`, system calls will be restarted when interrupted by signal *signalnum*, otherwise - system calls will be interrupted. Returns nothing. Availability: Unix (see - the man page :manpage:`siginterrupt(3)` for further information). + system calls will be interrupted. Returns nothing. + + .. availability:: Unix (see the man page :manpage:`siginterrupt(3)` + for further information). Note that installing a signal handler with :func:`signal` will reset the restart behaviour to interruptible by implicitly calling @@ -405,8 +412,8 @@ The :mod:`signal` module defines the following functions: thread (i.e., the signals which have been raised while blocked). Return the set of the pending signals. - Availability: Unix (see the man page :manpage:`sigpending(2)` for further - information). + .. availability:: Unix (see the man page :manpage:`sigpending(2)` for further + information). See also :func:`pause`, :func:`pthread_sigmask` and :func:`sigwait`. @@ -419,8 +426,8 @@ The :mod:`signal` module defines the following functions: signals specified in the signal set *sigset*. The function accepts the signal (removes it from the pending list of signals), and returns the signal number. - Availability: Unix (see the man page :manpage:`sigwait(3)` for further - information). + .. availability:: Unix (see the man page :manpage:`sigwait(3)` for further + information). See also :func:`pause`, :func:`pthread_sigmask`, :func:`sigpending`, :func:`sigwaitinfo` and :func:`sigtimedwait`. @@ -444,8 +451,8 @@ The :mod:`signal` module defines the following functions: :attr:`si_errno`, :attr:`si_pid`, :attr:`si_uid`, :attr:`si_status`, :attr:`si_band`. - Availability: Unix (see the man page :manpage:`sigwaitinfo(2)` for further - information). + .. availability:: Unix (see the man page :manpage:`sigwaitinfo(2)` for further + information). See also :func:`pause`, :func:`sigwait` and :func:`sigtimedwait`. @@ -463,8 +470,8 @@ The :mod:`signal` module defines the following functions: specifying a timeout. If *timeout* is specified as :const:`0`, a poll is performed. Returns :const:`None` if a timeout occurs. - Availability: Unix (see the man page :manpage:`sigtimedwait(2)` for further - information). + .. availability:: Unix (see the man page :manpage:`sigtimedwait(2)` for further + information). See also :func:`pause`, :func:`sigwait` and :func:`sigwaitinfo`. |