Skip to content

Commit

Permalink
man: keep the function names in their own lines
Browse files Browse the repository at this point in the history
Signed-off-by: Otto Modinos <[email protected]>
  • Loading branch information
otommod committed May 31, 2022
1 parent c7d2740 commit 4d9e52c
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
4 changes: 2 additions & 2 deletions man/io_uring_cqe_get_data.3
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ io_uring_cqe_get_data - get user data for completion event
.SH DESCRIPTION
.PP
The
.BR io_uring_cqe_get_data (3) function returns the user_data with the completion
queue entry
.BR io_uring_cqe_get_data (3)
function returns the user_data with the completion queue entry
.I cqe.

After the caller has received a completion queue entry (CQE) with
Expand Down
4 changes: 2 additions & 2 deletions man/io_uring_prep_accept.3
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ io_uring_prep_accept - prepare an accept request
.SH DESCRIPTION
.PP
The
.BR io_uring_prep_accept (3) function prepares an accept request. The submission
queue entry
.BR io_uring_prep_accept (3)
function prepares an accept request. The submission queue entry
.I sqe
is setup to use the file descriptor
.I sockfd
Expand Down
13 changes: 7 additions & 6 deletions man/io_uring_wait_cqe_timeout.3
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@ io_uring_wait_cqe_timeout - wait for one io_uring completion event with timeout
.SH DESCRIPTION
.PP
The
.BR io_uring_wait_cqe_timeout (3) function waits for one IO completion to be
available from the queue belonging to the
.BR io_uring_wait_cqe_timeout (3)
function waits for one IO completion to be available from the queue belonging
to the
.I ring
param, waiting for it if necessary or until the timeout
.I ts
expires.If an event is already available in the ring when invoked, no waiting
expires. If an event is already available in the ring when invoked, no waiting
will occur.

The
Expand All @@ -42,8 +43,8 @@ when waiting for a request.
.SH RETURN VALUE
On success
.BR io_uring_wait_cqes (3)
returns 0 and the cqe_ptr parm is filled in. On failure it returns -errno.
The return value indicates the result of waiting for a CQE, and it has no
relation to the CQE result itself.
returns 0 and the cqe_ptr parm is filled in. On failure it returns -errno. The
return value indicates the result of waiting for a CQE, and it has no relation
to the CQE result itself.
.SH SEE ALSO
.BR io_uring_submit (3), io_uring_wait_cqe_timeout (3), io_uring_wait_cqe(3).

0 comments on commit 4d9e52c

Please sign in to comment.