public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: Cyril Hrubis <chrubis-AlSwsSmVLrQ@public.gmane.org>
To: Jeff Moyer <jmoyer-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org>
Cc: "Michael Kerrisk (man-pages)"
	<mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>,
	linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Subject: [PATCH] man: Add io_setup.3 and io_destroy.3
Date: Tue, 26 Mar 2013 18:06:26 +0100	[thread overview]
Message-ID: <20130326170626.GA11360@rei.suse.cz> (raw)

This patch adds two missing manual pages.

I've tried to format them in accordance with
Linux man-pages project. If these are acked
I'll reformat the rest of the io_* system call
wrappers man pages to match.

Signed-off-by: Cyril Hrubis <chrubis-AlSwsSmVLrQ@public.gmane.org>
---
 man/io_destroy.3 |   45 +++++++++++++++++++++++++++++++++++++++++++++
 man/io_setup.3   |   45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 90 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..6d84213
--- /dev/null
+++ b/man/io_destroy.3
@@ -0,0 +1,45 @@
+.\" Copyright (C) 2013 Cyril Hrubis <chrubis-AlSwsSmVLrQ@public.gmane.org>
+.\"
+.\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
+.\" This file is distributed according to the GNU General Public License.
+.\" %%%LICENSE_END
+.\"
+.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 <libaio.h>
+
+.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
+system call, see
+.BR io_destroy (2)
+for more information.
+.PP
+See
+.BR io_queue_release (3)
+for
+.I libaio
+highlevel interface.
+.SH "RETURN VALUES"
+On success
+.BR io_setup ()
+returns 0. On failure negative error number is returned.
+.SH NOTES
+Note that Linux system call uses different type
+.RI ( "aio_context_t\ *" )
+for the
+.I ctx
+argument.
+.SH "SEE ALSO"
+.BR io_queue_release (3)
+.BR io_setup (3)
+.BR io_submit (3)
+.BR io_cancel (3)
+.BR io_getevents (3)
diff --git a/man/io_setup.3 b/man/io_setup.3
new file mode 100644
index 0000000..626e954
--- /dev/null
+++ b/man/io_setup.3
@@ -0,0 +1,45 @@
+.\" Copyright (C) 2013 Cyril Hrubis <chrubis-AlSwsSmVLrQ@public.gmane.org>
+.\"
+.\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
+.\" This file is distributed according to the GNU General Public License.
+.\" %%%LICENSE_END
+.\"
+.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 <libaio.h>
+
+.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
+system call, see
+.BR io_setup (2)
+for more information.
+.PP
+See
+.BR io_queue_init (3)
+for
+.I libaio
+highlevel interface.
+.SH "RETURN VALUES"
+On success
+.BR io_setup ()
+returns 0. On failure negative error number is returned.
+.SH NOTES
+Note that Linux system call uses different type
+.RI ( "aio_context_t\ *" )
+for the
+.I ctx
+argument.
+.SH "SEE ALSO"
+.BR io_queue_init (3)
+.BR io_destroy (3)
+.BR io_submit (3)
+.BR io_cancel (3)
+.BR io_getevents (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

             reply	other threads:[~2013-03-26 17:06 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-03-26 17:06 Cyril Hrubis [this message]
     [not found] ` <20130326170626.GA11360-J5syqNJeCN7twjQa/ONI9g@public.gmane.org>
2013-03-28  9:15   ` [PATCH] man: Add io_setup.3 and io_destroy.3 Michael Kerrisk (man-pages)
     [not found]     ` <CAKgNAkgUN7y8j2Gp8sG6hvHMJ=YBV3FGWg=EYj5X1Fg+njNysA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2013-03-28  9:35       ` chrubis-AlSwsSmVLrQ
     [not found]         ` <20130328093501.GA5788-J5syqNJeCN7twjQa/ONI9g@public.gmane.org>
2013-03-28  9:39           ` Michael Kerrisk (man-pages)
2013-03-28  9:45   ` Michael Kerrisk (man-pages)
  -- strict thread matches above, loose matches on Subject: below --
2013-03-28 10:52 Cyril Hrubis
     [not found] ` <20130328105243.GA6202-J5syqNJeCN7twjQa/ONI9g@public.gmane.org>
2013-04-02 18:46   ` Jeff Moyer
     [not found]     ` <x49li9022jm.fsf-RRHT56Q3PSP4kTEheFKJxxDDeQx5vsVwAInAS/Ez/D0@public.gmane.org>
2013-04-03  9:59       ` chrubis-AlSwsSmVLrQ
2013-05-14 16:04       ` chrubis-AlSwsSmVLrQ
     [not found]         ` <20130514160430.GC14418-J5syqNJeCN7twjQa/ONI9g@public.gmane.org>
2013-06-05 12:44           ` chrubis-AlSwsSmVLrQ

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20130326170626.GA11360@rei.suse.cz \
    --to=chrubis-alswssmvlrq@public.gmane.org \
    --cc=jmoyer-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org \
    --cc=linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox