LDP: Update original to LDP v3.68

[linuxjm/LDP_man-pages.git] / original / man2 / io_getevents.2

diff --git a/original/man2/io_getevents.2 b/original/man2/io_getevents.2
index d959045..54d2e0d 100644 (file)
--- a/original/man2/io_getevents.2
+++ b/original/man2/io_getevents.2
@@ -1,21 +1,25 @@
 .\" Copyright (C) 2003 Free Software Foundation, Inc.
+.\"
+.\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
 .\" This file is distributed according to the GNU General Public License.
-.\" See the file COPYING in the top level source directory for details.
+.\" %%%LICENSE_END
 .\"
-.TH IO_GETEVENTS 2 2012-05-08 "Linux" "Linux Programmer's Manual"
+.TH IO_GETEVENTS 2 2013-04-08 "Linux" "Linux Programmer's Manual"
 .SH NAME
 io_getevents \- read asynchronous I/O events from the completion queue
-.SH "SYNOPSIS"
+.SH SYNOPSIS
 .nf
 .BR "#include <linux/aio_abi.h>" "         /* Defines needed types */"
 .BR "#include <linux/time.h>" "            /* Defines 'struct timespec' */"
 
-.sp
 .BI "int io_getevents(aio_context_t " ctx_id ", long " min_nr ", long " nr ,
 .BI "                 struct io_event *" events \
 ", struct timespec *" timeout );
 .fi
-.SH "DESCRIPTION"
+
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
+.SH DESCRIPTION
 .PP
 The
 .BR io_getevents ()
@@ -26,15 +30,14 @@ specified by \fIctx_id\fP.
 The \fItimeout\fP argument specifies the amount of time to wait for events,
 where a NULL timeout waits until at least \fImin_nr\fP events
 have been seen.
-Note that \fItimeout\fP is relative and will be updated if not NULL
-and the operation blocks.
-.SH "RETURN VALUE"
+Note that \fItimeout\fP is relative.
+.SH RETURN VALUE
 On success,
 .BR io_getevents ()
 returns the number of events read: 0 if no events are
 available, or less than \fImin_nr\fP if the \fItimeout\fP has elapsed.
 For the failure return, see NOTES.
-.SH "ERRORS"
+.SH ERRORS
 .TP
 .B EFAULT
 Either \fIevents\fP or \fItimeout\fP is an invalid pointer.
@@ -51,10 +54,10 @@ Interrupted by a signal handler; see
 .B ENOSYS
 .BR io_getevents ()
 is not implemented on this architecture.
-.SH "VERSIONS"
+.SH VERSIONS
 .PP
 The asynchronous I/O system calls first appeared in Linux 2.5.
-.SH "CONFORMING TO"
+.SH CONFORMING TO
 .PP
 .BR io_getevents ()
 is Linux-specific and should not be used in
@@ -89,7 +92,12 @@ then the return value follows the usual conventions for
 indicating an error: \-1, with
 .I errno
 set to a (positive) value that indicates the error.
-.SH "SEE ALSO"
+.SH BUGS
+An invalid
+.IR ctx_id
+may cause a segmentation fault instead of generating the error
+.BR EINVAL .
+.SH SEE ALSO
 .PP
 .BR io_cancel (2),
 .BR io_destroy (2),
@@ -99,3 +107,12 @@ set to a (positive) value that indicates the error.
 .BR time (7)
 .\" .SH AUTHOR
 .\" Kent Yoder.
+.SH COLOPHON
+This page is part of release 3.68 of the Linux
+.I man-pages
+project.
+A description of the project,
+information about reporting bugs,
+and the latest version of this page,
+can be found at
+\%http://www.kernel.org/doc/man\-pages/.