[07/22] lio_listio.3: SYNOPSIS: Use 'restrict' in prototypes

Message ID 20210305235105.177359-8-alx.manpages@gmail.com
State Not applicable
Headers
Series man3: SYNOPSIS: Use 'restrict' in prototypes (batch 3) |

Commit Message

Alejandro Colomar March 5, 2021, 11:50 p.m. UTC
  Both POSIX and glibc use 'restrict' in lio_listio().
However, POSIX is a bit more restrictive than glibc
for the second parameter.
Let's document the more restrictive POSIX variant.

$ man 3p lio_listio |sed -n '/^SYNOPSIS/,/;/p'
SYNOPSIS
       #include <aio.h>

       int lio_listio(int mode, struct aiocb *restrict const list[restrict],
           int nent, struct sigevent *restrict sig);
$

.../glibc$ grep_glibc_prototype lio_listio
rt/aio.h:148:
extern int lio_listio (int __mode,
		       struct aiocb *const __list[__restrict_arr],
		       int __nent, struct sigevent *__restrict __sig)
  __THROW __nonnull ((2));
.../glibc$

Cc: Szabolcs Nagy <Szabolcs.Nagy@arm.com>
Cc: "Joseph S. Myers" <joseph@codesourcery.com>
Cc: Ulrich Drepper <drepper@redhat.com>
Cc: Florian Weimer <fweimer@redhat.com>
Cc: glibc <libc-alpha@sourceware.org>
Bug: glibc <https://sourceware.org/bugzilla/show_bug.cgi?id=16747>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
---
 man3/lio_listio.3 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
  

Patch

diff --git a/man3/lio_listio.3 b/man3/lio_listio.3
index d89670f7c..d40ac89fb 100644
--- a/man3/lio_listio.3
+++ b/man3/lio_listio.3
@@ -28,8 +28,8 @@  lio_listio \- initiate a list of I/O requests
 .nf
 .B "#include <aio.h>"
 .PP
-.BI "int lio_listio(int " mode ", struct aiocb *const " aiocb_list [],
-.BI "               int " nitems ", struct sigevent *" sevp );
+.BI "int lio_listio(int " mode ", struct aiocb *restrict const " aiocb_list [restrict],
+.BI "               int " nitems ", struct sigevent *restrict " sevp );
 .PP
 Link with \fI\-lrt\fP.
 .fi