[2.7] Mention how to disable signal fd wakeup (GH-2140) (#2151)

(cherry picked from commit d79c1d4a94)
This commit is contained in:
Antoine Pitrou 2017-06-13 10:21:28 +02:00 committed by GitHub
parent bbb335891c
commit 15a6127e72
1 changed files with 4 additions and 2 deletions

View File

@ -197,8 +197,10 @@ The :mod:`signal` module defines the following functions:
written to the fd. This can be used by 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.
When threads are enabled, this function can only be called from the main thread;
attempting to call it from other threads will cause a :exc:`ValueError`