Let the reader directly know that it's not a function, but a macro.
Also, give a simple example of its usage.
Co-authored-by: Alviro Iskandar Setiawan <alviro.iskandar@xxxxxxxxxxx>
Signed-off-by: Alviro Iskandar Setiawan <alviro.iskandar@xxxxxxxxxxx>
Signed-off-by: Ammar Faizi <ammarfaizi2@xxxxxxxxxxx>
---
man/io_uring_for_each_cqe.3 | 20 +++++++++++++++++++-
1 file changed, 19 insertions(+), 1 deletion(-)
diff --git a/man/io_uring_for_each_cqe.3 b/man/io_uring_for_each_cqe.3
index 8445fd605d0b02a6..78d8f6fc168d12e3 100644
--- a/man/io_uring_for_each_cqe.3
+++ b/man/io_uring_for_each_cqe.3
@@ -17,7 +17,7 @@ io_uring_for_each_cqe \- iterate pending completion events
.PP
The
.BR io_uring_for_each_cqe (3)
-helper iterates completion events belonging to the
+is a macro helper that iterates completion events belonging to the
.I ring
using
.I head
@@ -35,6 +35,24 @@ calling
.BR io_uring_cqe_seen (3)
for each of them.
+.SH EXAMPLE
+.EX
+void handle_cqes(struct io_uring *ring)
+{
+ struct io_uring_cqe *cqe;
+ unsigned head;
+ unsigned i = 0;
+
+ io_uring_for_each_cqe(ring, head, cqe) {
+ /* handle completion */
+ printf("cqe: %d\\n", cqe->res);
+ i++;
+ }
+
+ io_uring_cq_advance(ring, i);
+}
+.EE
+
.SH RETURN VALUE
None
.SH SEE ALSO
--
Ammar Faizi
