From: Ammar Faizi <ammarfaizi2@gnuweeb.org>
To: Jens Axboe <axboe@kernel.dk>
Cc: Ammar Faizi <ammarfaizi2@gnuweeb.org>,
Alviro Iskandar Setiawan <alviro.iskandar@gnuweeb.org>,
GNU/Weeb Mailing List <gwml@vger.gnuweeb.org>,
Pavel Begunkov <asml.silence@gmail.com>,
io-uring Mailing List <io-uring@vger.kernel.org>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: [PATCH liburing v1 1/2] man/io_uring_for_each_cqe: Fix return value, title, and typo
Date: Fri, 9 Jun 2023 08:54:02 +0700 [thread overview]
Message-ID: <20230609015403.3523811-2-ammarfaizi2@gnuweeb.org> (raw)
In-Reply-To: <20230609015403.3523811-1-ammarfaizi2@gnuweeb.org>
1) Fix the return value. io_uring_for_each_cqe() doesn't return an int.
2) Fix the title, it was io_uring_wait_cqes(), it should be
io_uring_for_each_cqe().
3) Fix typo: s/io_uring_for_each_cqes/io_uring_for_each_cqe/
Fixes: 16d74b1c76043e6 ("man: add man page for io_uring_for_each_cqe()")
Reported-by: Alviro Iskandar Setiawan <alviro.iskandar@gnuweeb.org>
Signed-off-by: Ammar Faizi <ammarfaizi2@gnuweeb.org>
---
man/io_uring_for_each_cqe.3 | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/man/io_uring_for_each_cqe.3 b/man/io_uring_for_each_cqe.3
index 9230d147515c78fb..8445fd605d0b02a6 100644
--- a/man/io_uring_for_each_cqe.3
+++ b/man/io_uring_for_each_cqe.3
@@ -2,16 +2,16 @@
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
-.TH io_uring_wait_cqes 3 "June 04, 2023" "liburing-2.4" "liburing Manual"
+.TH io_uring_for_each_cqe 3 "June 04, 2023" "liburing-2.4" "liburing Manual"
.SH NAME
io_uring_for_each_cqe \- iterate pending completion events
.SH SYNOPSIS
.nf
.B #include <liburing.h>
.PP
-.BI "int io_uring_for_each_cqes(struct io_uring *" ring ","
-.BI " unsigned " head ","
-.BI " struct io_uring_cqe *" cqe ");
+.BI "io_uring_for_each_cqe(struct io_uring *" ring ","
+.BI " unsigned " head ","
+.BI " struct io_uring_cqe *" cqe ") { }
.fi
.SH DESCRIPTION
.PP
--
Ammar Faizi
next prev parent reply other threads:[~2023-06-09 1:54 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-09 1:54 [PATCH liburing v1 0/2] Fixes for io_uring_for_each_cqe Ammar Faizi
2023-06-09 1:54 ` Ammar Faizi [this message]
2023-06-09 1:54 ` [PATCH liburing v1 2/2] man/io_uring_for_each_cqe: Explicitly tell it's a macro and add an example Ammar Faizi
2023-06-09 3:02 ` [PATCH liburing v1 0/2] Fixes for io_uring_for_each_cqe Jens Axboe
2023-06-09 3:02 ` Jens Axboe
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=20230609015403.3523811-2-ammarfaizi2@gnuweeb.org \
--to=ammarfaizi2@gnuweeb.org \
--cc=alviro.iskandar@gnuweeb.org \
--cc=asml.silence@gmail.com \
--cc=axboe@kernel.dk \
--cc=gwml@vger.gnuweeb.org \
--cc=io-uring@vger.kernel.org \
--cc=linux-kernel@vger.kernel.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