summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAntoine Pitrou <pitrou@free.fr>2017-06-13 08:23:13 (GMT)
committerGitHub <noreply@github.com>2017-06-13 08:23:13 (GMT)
commitd0d63dc1e8a2e71c4cd6497e5ea503c702d0fe3b (patch)
treee19ab4a473f1bb0ceb6152db5b637f260f4e8cc0 /Doc
parent81c05ccc10d044584dff3a69ee531094ed76ee2c (diff)
downloadcpython-d0d63dc1e8a2e71c4cd6497e5ea503c702d0fe3b.zip
cpython-d0d63dc1e8a2e71c4cd6497e5ea503c702d0fe3b.tar.gz
cpython-d0d63dc1e8a2e71c4cd6497e5ea503c702d0fe3b.tar.bz2
[3.6] Mention how to disable signal fd wakeup (GH-2140) (#2149)
(cherry picked from commit d79c1d4a9406384f10a37f26a7515ce79f9fdd78)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/signal.rst6
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.