Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
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
Message-Id: <20230609015403.3523811-2-ammarfaizi2@gnuweeb.org>
In-Reply-To: <20230609015403.3523811-1-ammarfaizi2@gnuweeb.org>
References: <20230609015403.3523811-1-ammarfaizi2@gnuweeb.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

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