aboutsummaryrefslogtreecommitdiffstats
path: root/man2/io_destroy.2
diff options
context:
space:
mode:
authorAlejandro Colomar <alx@kernel.org>2023-03-17 17:08:01 +0100
committerAlejandro Colomar <alx@kernel.org>2023-03-30 15:14:55 +0200
commit4131356cdab8d37fc395ca5466a0401c8573380c (patch)
tree8c4c6f1c3172358b735b481cbbfdd9cc04b00ed9 /man2/io_destroy.2
parentfd00f831b52d61a91d59cb3b46182869145d9700 (diff)
downloadman-pages-4131356cdab8.tar.gz
man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections
- Add a new HISTORY section that covers the history of an API, both regarding implementations and regarding old standards. This was previously covered in VERSIONS, and in some cases in STANDARDS. - Repurpose VERSIONS to cover differing implementations in _current_ systems. - STANDARDS is reduced to only cover current versions of standards. That basically means only C11 (C99 has been superseeded by C11; C17 is just a bugfix of C11, so not really a new version), and POSIX.1-2008 (*-2001 was superseeded by *-2008; *-2017 was just a bugfix for *-2008). The section also mentions for example 'Linux', 'GNU' or 'BSD' when a non-standard API is Linux- or GNU-only or if it's (de-facto) standard in the BSDs. - In some cases content that should go into one of these sections was in NOTES. Move it from there to where it corresponds. - In the SYNOPSIS, I added [[deprecated]] in some functions that I found are deprecated by the relevant standards. - A few other related changes... Cc: Oskari Pirhonen <xxc3ncoredxx@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man2/io_destroy.2')
-rw-r--r--man2/io_destroy.214
1 files changed, 6 insertions, 8 deletions
diff --git a/man2/io_destroy.2 b/man2/io_destroy.2
index 783d57397c..a94600c5f1 100644
--- a/man2/io_destroy.2
+++ b/man2/io_destroy.2
@@ -30,7 +30,7 @@ The wrapper function provided by
uses a different type for the
.I ctx_id
argument.
-See NOTES.
+See VERSIONS.
.PP
The
.BR io_destroy ()
@@ -44,7 +44,7 @@ that could not be canceled, and will destroy the
On success,
.BR io_destroy ()
returns 0.
-For the failure return, see NOTES.
+For the failure return, see VERSIONS.
.SH ERRORS
.TP
.B EFAULT
@@ -57,12 +57,6 @@ The AIO context specified by \fIctx_id\fP is invalid.
.BR io_destroy ()
is not implemented on this architecture.
.SH VERSIONS
-The asynchronous I/O system calls first appeared in Linux 2.5.
-.SH STANDARDS
-.BR io_destroy ()
-is Linux-specific and should not be used in programs
-that are intended to be portable.
-.SH NOTES
You probably want to use the
.BR io_destroy ()
wrapper function provided by
@@ -89,6 +83,10 @@ 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 STANDARDS
+Linux.
+.SH HISTORY
+Linux 2.5.
.SH SEE ALSO
.BR io_cancel (2),
.BR io_getevents (2),