[06/39] io_getevents.2: Use syscall(SYS_...); for system calls without a wrapper

Message ID 20210510175546.28445-7-alx.manpages@gmail.com
State New
Headers show
Series
  • man2: SYNOPSIS: Fix headers, use syscall(), and other fixes
Related show

Commit Message

Mark Brown via Libc-alpha May 10, 2021, 5:55 p.m.
In this case there's a wrapper provided by libaio,
but this page documents the raw syscall.

Also remove <linux/time.h> from the includes: 'struct timespec'
is already documented in system_data_types(7), where the
information is more up to date.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

---
 man2/io_getevents.2 | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

-- 
2.31.1

Patch

diff --git a/man2/io_getevents.2 b/man2/io_getevents.2
index 87eefdd92..7c7e625bf 100644
--- a/man2/io_getevents.2
+++ b/man2/io_getevents.2
@@ -9,16 +9,20 @@ 
 io_getevents \- read asynchronous I/O events from the completion queue
 .SH SYNOPSIS
 .nf
-.BR "#include <linux/aio_abi.h>" "         /* Defines needed types */"
-.BR "#include <linux/time.h>" "            /* Defines 'struct timespec' */"
+.BR "#include <linux/aio_abi.h>" "    /* Definition of " *io_* " types */"
+.BR "#include <sys/syscall.h>" "      /* Definition of " SYS_* " constants */"
+.B #include <unistd.h>
 .PP
-.BI "int io_getevents(aio_context_t " ctx_id ", long " min_nr ", long " nr ,
-.BI "                 struct io_event *" events \
-", struct timespec *" timeout );
+.BI "int syscall(SYS_io_getevents, aio_context_t " ctx_id ,
+.BI "            long " min_nr ", long " nr ", struct io_event *" events ,
+.BI "            struct timespec *" timeout );
 .fi
 .PP
 .IR Note :
-There is no glibc wrapper for this system call; see NOTES.
+glibc provides no wrapper for
+.BR io_getevents (),
+necessitating the use of
+.BR syscall (2).
 .SH DESCRIPTION
 .IR Note :
 this page describes the raw Linux system call interface.
@@ -94,10 +98,7 @@  The asynchronous I/O system calls first appeared in Linux 2.5.
 is Linux-specific and should not be used in
 programs that are intended to be portable.
 .SH NOTES
-Glibc does not provide a wrapper for this system call.
-You could invoke it using
-.BR syscall (2).
-But instead, you probably want to use the
+You probably want to use the
 .BR io_getevents ()
 wrapper function provided by
 .\" http://git.fedorahosted.org/git/?p=libaio.git