LDP: Update original to LDP v3.79

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

diff --git a/original/man2/io_setup.2 b/original/man2/io_setup.2
index c8e16ea..431f3f4 100644 (file)
--- a/original/man2/io_setup.2
+++ b/original/man2/io_setup.2
@@ -1,38 +1,45 @@
 .\" 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_SETUP 2 2012-05-08 "Linux" "Linux Programmer's Manual"
+.TH IO_SETUP 2 2013-06-21 "Linux" "Linux Programmer's Manual"
 .SH NAME
 io_setup \- create an asynchronous I/O context
-.SH "SYNOPSIS"
+.SH SYNOPSIS
 .nf
 .BR "#include <linux/aio_abi.h>" "          /* Defines needed types */"
 
 .BI "int io_setup(unsigned " nr_events ", aio_context_t *" ctx_idp );
 .fi
-.SH "DESCRIPTION"
+
+.IR Note :
+There is no glibc wrapper for this system call; see NOTES.
+.SH DESCRIPTION
 .PP
 The
 .BR io_setup ()
 system call
-creates an asynchronous I/O context capable of receiving
-at least \fInr_events\fP.
+creates an asynchronous I/O context suitable for concurrently processing
+\fInr_events\fP operations.
 The
 .I ctx_idp
 argument must not point to an AIO context that already exists, and must
 be initialized to 0 prior to the call.
 On successful creation of the AIO context, \fI*ctx_idp\fP is filled in
 with the resulting handle.
-.SH "RETURN VALUE"
+.SH RETURN VALUE
 On success,
 .BR io_setup ()
 returns 0.
 For the failure return, see NOTES.
-.SH "ERRORS"
+.SH ERRORS
 .TP
 .B EAGAIN
-The specified \fInr_events\fP exceeds the user's limit of available events.
+The specified \fInr_events\fP exceeds the user's limit of available events,
+as defined in
+.IR /proc/sys/fs/aio-max-nr .
 .TP
 .B EFAULT
 An invalid pointer is passed for \fIctx_idp\fP.
@@ -48,10 +55,10 @@ Insufficient kernel resources are available.
 .B ENOSYS
 .BR io_setup ()
 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_setup ()
 is Linux-specific and should not be used in programs
@@ -86,7 +93,7 @@ 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 SEE ALSO
 .BR io_cancel (2),
 .BR io_destroy (2),
 .BR io_getevents (2),
@@ -94,3 +101,12 @@ set to a (positive) value that indicates the error.
 .BR aio (7)
 .\" .SH AUTHOR
 .\" Kent Yoder.
+.SH COLOPHON
+This page is part of release 3.79 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/.