Skip to contentSkip to conversation

man: Add io_setup.3 and io_destroy.3

PATCH In review Cyril Hrubis 2 participants 5 messages Mar 28, 2013 – Jun 5, 2013 3 messages not in the archive Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 man: Add io_setup.3 and io_destroy.3

This is a second version that includes
fixes proposed by Michael Kerrisk.

---
 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
man/io_destroy.3 new file +41 -0
new file mode 100644
index 0000000..dc662bd
@@ -0,0 +1,41 @@
+.\" Copyright (C) 2013 Cyril Hrubis <[email protected]>
+.\"
+.\" 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 <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 (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)
man/io_setup.3 new file +41 -0

41 lines not on this page · raw message

Signature · 10 lines
1.7.8.6


-- 
Cyril Hrubis
[email protected]
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): 20130328105243.GA6202-J5syqNJeCN7twjQa/[email protected]

#2 lore raw
Quoted 2 lines · Cyril Hrubis

This is a second version that includes
fixes proposed by Michael Kerrisk.

Now that I see what this looks like, I think it's rather confusing to have the user reference both the .2 and .3 pages to write code for libaio. I'd prefer to keep all of the text for how to use the library inside the .3 man pages.

-Jeff
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): x49li9022jm.fsf-RRHT56Q3PSP4kTEheFKJxxDDeQx5vsVwAInAS/Ez/[email protected]

#4 lore raw

Hi!

Quoted 7 lines
Quoted 2 lines

This is a second version that includes
fixes proposed by Michael Kerrisk.

Now that I see what this looks like, I think it's rather confusing to have the user reference both the .2 and .3 pages to write code for libaio. I'd prefer to keep all of the text for how to use the library inside the .3 man pages.

Then we need to duplicate some of the information from the .2 pages to the libaio .3 pages. I'm fine with that, but we should probably finish the .2 pages cleanup first.

Signature · 6 lines
Cyril Hrubis
[email protected]
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
#5 lore raw
In reply to a message not in the archive

Hi!

Quoted 7 lines
Quoted 2 lines

This is a second version that includes
fixes proposed by Michael Kerrisk.

Now that I see what this looks like, I think it's rather confusing to have the user reference both the .2 and .3 pages to write code for libaio. I'd prefer to keep all of the text for how to use the library inside the .3 man pages.

Attached is a new version of the patch that adds io_setup and io_destroy man pages.

The change agains previous version is that the functinonality of the wrappper is described right in the manual page.

Signature · 2 lines
Cyril Hrubis
[email protected]
Quoted 1 line

From b1211ceb3e774075b9abedef15434bd91cdc8fe4 Mon Sep 17 00:00:00 2001

From: Cyril Hrubis <[email protected]>
Date: Tue, 26 Mar 2013 18:00:31 +0100
Subject: [PATCH] man: Add io_setup.3 and io_destroy.3

---
 man/io_destroy.3 |   46 ++++++++++++++++++++++++++++++++++++++++++++++
 man/io_setup.3   |   50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 96 insertions(+), 0 deletions(-)
 create mode 100644 man/io_destroy.3
 create mode 100644 man/io_setup.3
man/io_destroy.3 new file +46 -0
new file mode 100644
index 0000000..10f0e85
@@ -0,0 +1,46 @@
+.\" Copyright (C) 2013 Cyril Hrubis <[email protected]>
+.\"
+.\" 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 <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 (2)
+system call.
+.PP
+See
+.BR io_queue_release (3)
+for the
+.I libaio
+high-level interface.
+
+The \fBio_destroy\fP() will attempt to cancel all outstanding asynchronous I/O
+operations previously submitted to \fIctx\fP. It will block on completion of
+operations that could not be canceled. Upon sucessfull return the I/O context
+\fIctx\fP is destroyed.
+.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)
man/io_setup.3 new file +50 -0

50 lines not on this page · raw message

Signature · 1 line
1.7.8.6
Quoted 1 line

From b1211ceb3e774075b9abedef15434bd91cdc8fe4 Mon Sep 17 00:00:00 2001

From: Cyril Hrubis <[email protected]>
Date: Tue, 26 Mar 2013 18:00:31 +0100
Subject: [PATCH] man: Add io_setup.3 and io_destroy.3

---
 man/io_destroy.3 |   46 ++++++++++++++++++++++++++++++++++++++++++++++
 man/io_setup.3   |   50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 96 insertions(+), 0 deletions(-)
 create mode 100644 man/io_destroy.3
 create mode 100644 man/io_setup.3
man/io_destroy.3 new file +46 -0

46 lines not on this page · raw message

man/io_setup.3 new file +50 -0

50 lines not on this page · raw message

Signature · 1 line
1.7.8.6

A message that is not in the archive (sent off-list or not yet received): 20130514160430.GC14418-J5syqNJeCN7twjQa/[email protected]

#7 lore raw

Hi!

Quoted 8 lines
Quoted 7 lines
Quoted 2 lines

This is a second version that includes
fixes proposed by Michael Kerrisk.

Now that I see what this looks like, I think it's rather confusing to have the user reference both the .2 and .3 pages to write code for libaio. I'd prefer to keep all of the text for how to use the library inside the .3 man pages.

Quoted 5 lines

Attached is a new version of the patch that adds io_setup and io_destroy man pages.

The change agains previous version is that the functinonality of the wrappper is described right in the manual page.

Ping.

Signature · 6 lines
Cyril Hrubis
[email protected]
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html