mirror of https://github.com/python/cpython
#7088: document new functions in signal as Unix-only.
This commit is contained in:
parent
2eee1d4df1
commit
c5026f8a7b
|
@ -158,7 +158,7 @@ The :mod:`signal` module defines the following functions:
|
||||||
The old values are returned as a tuple: (delay, interval).
|
The old values are returned as a tuple: (delay, interval).
|
||||||
|
|
||||||
Attempting to pass an invalid interval timer will cause an
|
Attempting to pass an invalid interval timer will cause an
|
||||||
:exc:`ItimerError`.
|
:exc:`ItimerError`. Availability: Unix.
|
||||||
|
|
||||||
.. versionadded:: 2.6
|
.. versionadded:: 2.6
|
||||||
|
|
||||||
|
@ -166,6 +166,7 @@ The :mod:`signal` module defines the following functions:
|
||||||
.. function:: getitimer(which)
|
.. function:: getitimer(which)
|
||||||
|
|
||||||
Returns current value of a given interval timer specified by *which*.
|
Returns current value of a given interval timer specified by *which*.
|
||||||
|
Availability: Unix.
|
||||||
|
|
||||||
.. versionadded:: 2.6
|
.. versionadded:: 2.6
|
||||||
|
|
||||||
|
@ -186,14 +187,14 @@ The :mod:`signal` module defines the following functions:
|
||||||
|
|
||||||
.. function:: siginterrupt(signalnum, flag)
|
.. function:: siginterrupt(signalnum, flag)
|
||||||
|
|
||||||
Change system call restart behaviour: if *flag* is :const:`False`, system calls
|
Change system call restart behaviour: if *flag* is :const:`False`, system
|
||||||
will be restarted when interrupted by signal *signalnum*, otherwise system calls will
|
calls will be restarted when interrupted by signal *signalnum*, otherwise
|
||||||
be interrupted. Returns nothing. Availability: Unix (see the man page
|
system calls will be interrupted. Returns nothing. Availability: Unix (see
|
||||||
:manpage:`siginterrupt(3)` for further information).
|
the man page :manpage:`siginterrupt(3)` for further information).
|
||||||
|
|
||||||
Note that installing a signal handler with :func:`signal` will reset the restart
|
Note that installing a signal handler with :func:`signal` will reset the
|
||||||
behaviour to interruptible by implicitly calling :cfunc:`siginterrupt` with a true *flag*
|
restart behaviour to interruptible by implicitly calling
|
||||||
value for the given signal.
|
:cfunc:`siginterrupt` with a true *flag* value for the given signal.
|
||||||
|
|
||||||
.. versionadded:: 2.6
|
.. versionadded:: 2.6
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue