diff options
| author | Antoine Pitrou <pitrou@free.fr> | 2017-06-13 08:14:09 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-13 08:14:09 (GMT) |
| commit | d79c1d4a9406384f10a37f26a7515ce79f9fdd78 (patch) | |
| tree | a9ce4ae070290f1eac19ace575f69982d02af5f2 /Doc/library/signal.rst | |
| parent | 2b5cc5ebaff41445200753f1a69fd4e6a9475a1e (diff) | |
| download | cpython-d79c1d4a9406384f10a37f26a7515ce79f9fdd78.zip cpython-d79c1d4a9406384f10a37f26a7515ce79f9fdd78.tar.gz cpython-d79c1d4a9406384f10a37f26a7515ce79f9fdd78.tar.bz2 | |
Mention how to disable signal fd wakeup (#2140)
Diffstat (limited to 'Doc/library/signal.rst')
| -rw-r--r-- | Doc/library/signal.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst index 039b666..46d71de 100644 --- a/Doc/library/signal.rst +++ b/Doc/library/signal.rst @@ -306,8 +306,10 @@ The :mod:`signal` module defines the following functions: a library to wakeup a poll or select call, allowing the signal to be fully processed. - The old wakeup fd is returned. *fd* must be non-blocking. It is up to the - library to remove any bytes before calling poll or select again. + The old wakeup fd is returned (or -1 if file descriptor wakeup was not + enabled). If *fd* is -1, file descriptor wakeup is disabled. + If not -1, *fd* must be non-blocking. It is up to the library to remove + any bytes from *fd* before calling poll or select again. Use for example ``struct.unpack('%uB' % len(data), data)`` to decode the signal numbers list. |