diff options
| author | Antoine Pitrou <pitrou@free.fr> | 2017-06-13 08:21:54 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-13 08:21:54 (GMT) |
| commit | e0e0029623248e6ed786df91c3cdf9ff4f283d32 (patch) | |
| tree | ea7a500f7c3ccff3c73d3bbe87943830b37990cf | |
| parent | 5a86154a931083e6a9f9bdf9cc8b3bc33abb673d (diff) | |
| download | cpython-e0e0029623248e6ed786df91c3cdf9ff4f283d32.zip cpython-e0e0029623248e6ed786df91c3cdf9ff4f283d32.tar.gz cpython-e0e0029623248e6ed786df91c3cdf9ff4f283d32.tar.bz2 | |
[3.5] Mention how to disable signal fd wakeup (GH-2140) (#2150)
(cherry picked from commit d79c1d4a9406384f10a37f26a7515ce79f9fdd78)
| -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. |