epoll_create.2: Clarify distinction between epoll instance and epoll file descriptor

Reword so that the notion of an epoll instance is made clear,
and made distinct from the notion of an epoll file descriptor.
Some other minor rewordings also.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2009-01-16 07:31:16 +13:00
parent 689cdcf175
commit 700e0efd68
1 changed files with 11 additions and 8 deletions

View File

@ -22,7 +22,7 @@
.\" Modified 2005-04-04 by Marko Kohtala <marko.kohtala@gmail.com>
.\" 2008-10-10, mtk: add description of epoll_create1()
.\"
.TH EPOLL_CREATE 2 2008-10-10 "Linux" "Linux Programmer's Manual"
.TH EPOLL_CREATE 2 2009-01-17 "Linux" "Linux Programmer's Manual"
.SH NAME
epoll_create, epoll_create1 \- open an epoll file descriptor
.SH SYNOPSIS
@ -34,10 +34,8 @@ epoll_create, epoll_create1 \- open an epoll file descriptor
.fi
.SH DESCRIPTION
.BR epoll_create ()
opens an
.B epoll
file descriptor by requesting the kernel to allocate
an event backing store dimensioned for
creates an epoll "instance",
requesting the kernel to allocate an event backing store dimensioned for
.I size
descriptors.
The
@ -48,13 +46,18 @@ just a hint to the kernel about how to dimension internal structures.
.I size
is ignored; see NOTES below.)
The returned file descriptor is used for all the subsequent calls to the
.BR epoll_create ()
returns a file descriptor referring to the new epoll instance.
This file descriptor is used for all the subsequent calls to the
.B epoll
interface.
The file descriptor returned by
When no longer required, the file descriptor returned by
.BR epoll_create ()
must be closed by using
should be closed by using
.BR close (2).
When all file descriptors referring to an epoll instance have been closed,
the kernel destroys the instance
and releases the associated resources for re-use.
If
.I flags