Skip to content

Commit 0005487

Browse files
committed
Add docs
1 parent aa11d82 commit 0005487

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

Doc/library/select.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The module defines the following:
6262

6363
*sizehint* informs epoll about the expected number of events to be
6464
registered. It must be positive, or ``-1`` to use the default. It is only
65-
used on older systems where :c:func:`!epoll_create1` is not available;
65+
used on older systems where :manpage:`epoll_create1(2)` is not available;
6666
otherwise it has no effect (though its value is still checked).
6767

6868
*flags* is deprecated and completely ignored. However, when supplied, its
@@ -89,6 +89,11 @@ The module defines the following:
8989
The *flags* parameter. ``select.EPOLL_CLOEXEC`` is used by default now.
9090
Use :func:`os.set_inheritable` to make the file descriptor inheritable.
9191

92+
.. versionchanged:: next
93+
94+
When CPython is built, this function may be disabled using
95+
:option:`--disable-epoll`.
96+
9297

9398
.. function:: poll()
9499

Doc/using/configure.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -463,6 +463,17 @@ General Options
463463

464464
``pkg-config`` options.
465465

466+
.. option:: --disable-epoll
467+
468+
Build without ``epoll``, meaning that :py:func:`select.epoll` will not be
469+
present even if the system provides an
470+
:manpage:`epoll_create <epoll_create(2)>` function.
471+
This may be used on systems where :manpage:`!epoll_create` or
472+
:manpage:`epoll_create1 <epoll_create1(2)>` is available
473+
but incompatible with Linux semantics.
474+
475+
.. versionadded:: next
476+
466477

467478
C compiler options
468479
------------------

0 commit comments

Comments
 (0)