From mboxrd@z Thu Jan 1 00:00:00 1970 From: Cyril Hrubis Subject: [PATCH] man: Add io_setup.3 and io_destroy.3 Date: Thu, 28 Mar 2013 11:52:43 +0100 Message-ID: <20130328105243.GA6202@rei.suse.cz> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Return-path: Content-Disposition: inline Sender: linux-man-owner-u79uwXL29TY76Z2rM5mHXA@public.gmane.org To: Jeff Moyer Cc: "Michael Kerrisk (man-pages)" , linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org List-Id: linux-man@vger.kernel.org This is a second version that includes fixes proposed by Michael Kerrisk. Signed-off-by: Cyril Hrubis --- man/io_destroy.3 | 41 +++++++++++++++++++++++++++++++++++++++++ man/io_setup.3 | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+), 0 deletions(-) create mode 100644 man/io_destroy.3 create mode 100644 man/io_setup.3 diff --git a/man/io_destroy.3 b/man/io_destroy.3 new file mode 100644 index 0000000..dc662bd --- /dev/null +++ b/man/io_destroy.3 @@ -0,0 +1,41 @@ +.\" Copyright (C) 2013 Cyril Hrubis +.\" +.\" This file is distributed according to the GNU General Public License. +.\" +.TH IO_DESTROY 3 2013-03-26 "Linux" "Linux AIO" +.SH NAME +io_destroy \- destroy an asynchronous I/O context +.SH SYNOPSIS +.nf +.B #include + +.BI "int io_destroy(io_context_t ctx)" +.sp +Link with \fI\-laio\fP. +.fi +.SH DESCRIPTION +This is a wrapper for the +.BR io_destroy (2) +system call. +.PP +See +.BR io_queue_release (3) +for the +.I libaio +high-level interface. +.SH RETURN VALUE +On success, +.BR io_setup () +returns 0. On failure, a negative error number is returned. +.SH NOTES +Note that the Linux system call uses a different type +.RI ( "aio_context_t\ *" ) +for the +.I ctx +argument. +.SH SEE ALSO +.BR io_cancel (3) +.BR io_getevents (3) +.BR io_queue_release (3) +.BR io_setup (3) +.BR io_submit (3) diff --git a/man/io_setup.3 b/man/io_setup.3 new file mode 100644 index 0000000..2427204 --- /dev/null +++ b/man/io_setup.3 @@ -0,0 +1,41 @@ +.\" Copyright (C) 2013 Cyril Hrubis +.\" +.\" This file is distributed according to the GNU General Public License. +.\" +.TH IO_SETUP 3 2013-03-26 "Linux" "Linux AIO" +.SH NAME +io_setup \- create an asynchronous I/O context +.SH SYNOPSIS +.nf +.B #include + +.BI "int io_setup(int maxevents, io_context_t *ctx)" +.sp +Link with \fI\-laio\fP. +.fi +.SH DESCRIPTION +This is a wrapper for the +.BR io_setup (2) +system call. +.PP +See +.BR io_queue_init (3) +for the +.I libaio +high-level interface. +.SH RETURN VALUE +On success, +.BR io_setup () +returns 0. On failure, a negative error number is returned. +.SH NOTES +Note that the Linux system call uses a different type +.RI ( "aio_context_t\ *" ) +for the +.I ctx +argument. +.SH SEE ALSO +.BR io_cancel (3) +.BR io_destroy (3) +.BR io_getevents (3) +.BR io_queue_init (3) +.BR io_submit (3) -- 1.7.8.6 -- Cyril Hrubis chrubis-AlSwsSmVLrQ@public.gmane.org -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html