summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJens Axboe <axboe@kernel.dk>2021-11-17 19:51:42 -0700
committerJens Axboe <axboe@kernel.dk>2021-11-17 19:51:42 -0700
commit469b5e80ce42be53ec748ddea8523a3c16ea5465 (patch)
tree106daf05a9ef4351b6f0ebc729df0418c03fd8ef
parent2a4091133858c659fb1cb7f42642ebcb44032e86 (diff)
downloadliburing-469b5e80ce42be53ec748ddea8523a3c16ea5465.tar.gz
liburing-469b5e80ce42be53ec748ddea8523a3c16ea5465.tar.bz2
man/io_uring_get_sqe.3: use "submission queue entry"
Event isn't quite appropriate on the submission side. Signed-off-by: Jens Axboe <axboe@kernel.dk>
-rw-r--r--man/io_uring_get_sqe.311
1 files changed, 6 insertions, 5 deletions
diff --git a/man/io_uring_get_sqe.3 b/man/io_uring_get_sqe.3
index 24834f3..12ae545 100644
--- a/man/io_uring_get_sqe.3
+++ b/man/io_uring_get_sqe.3
@@ -5,7 +5,8 @@
.\"
.TH io_uring_get_sqe 3 "July 10, 2020" "liburing-0.7" "liburing Manual"
.SH NAME
-io_uring_get_sqe - get the next vacant event from the submission queue
+io_uring_get_sqe - get the next available submission queue entry from the
+submission queue
.SH SYNOPSIS
.nf
.BR "#include <liburing.h>"
@@ -15,15 +16,15 @@ io_uring_get_sqe - get the next vacant event from the submission queue
.PP
.SH DESCRIPTION
.PP
-The io_uring_get_sqe() function gets the next vacant event from the submission
-queue belonging to the
+The io_uring_get_sqe() function gets the next available submission queue entry
+from the submission queue belonging to the
.I ring
param.
-On success io_uring_get_sqe() returns a pointer to the submission queue event.
+On success io_uring_get_sqe() returns a pointer to the submission queue entry.
On failure NULL is returned.
-If a submission queue event is returned, it should be filled out via one of the
+If a submission queue entry is returned, it should be filled out via one of the
prep functions such as
.BR io_uring_prep_read (3)
and submitted via