openharmony/third_party_liburing
1
0
Fork 0
mirror of https://github.com/openharmony/third_party_liburing.git synced 2026-07-20 22:58:41 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'pu/man-fixes' of https://github.com/guillemj/liburing

Browse Source 
* 'pu/man-fixes' of https://github.com/guillemj/liburing:
  man: Lowercase man page name in title header
  man: Add missing section numbers
  Fix typos
  Fix typos
This commit is contained in:
Jens Axboe
2022-08-23 07:18:01 -06:00
parent 72fcb7ac34 5eb7e658da
commit b095d2e5b5
25 changed files with 35 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/io_uring.7
+1 -1
View File
@@ -2,7 +2,7 @@
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH IO_URING 7 2020-07-26 "Linux" "Linux Programmer's Manual"
.TH io_uring 7 2020-07-26 "Linux" "Linux Programmer's Manual"
.SH NAME
io_uring \- Asynchronous I/O facility
.SH SYNOPSIS
man/io_uring_cq_ready.3
+2 -2
View File
@@ -2,7 +2,7 @@
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH io_uring_cq_ready "January 25, 2022" "liburing-2.1" "liburing Manual"
.TH io_uring_cq_ready 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
.SH NAME
io_uring_cq_ready \- returns number of unconsumed ready entries in the CQ ring
.SH SYNOPSIS
@@ -15,7 +15,7 @@ io_uring_cq_ready \- returns number of unconsumed ready entries in the CQ ring
.PP
The
.BR io_uring_cq_ready (3)
function retuns the number of unconsumed entries that are ready belonging to the
function returns the number of unconsumed entries that are ready belonging to the
.I ring
param.
man/io_uring_enter.2
+4 -4
View File
@@ -3,7 +3,7 @@
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH IO_URING_ENTER 2 2019-01-22 "Linux" "Linux Programmer's Manual"
.TH io_uring_enter 2 2019-01-22 "Linux" "Linux Programmer's Manual"
.SH NAME
io_uring_enter \- initiate and/or complete asynchronous I/O
.SH SYNOPSIS
@@ -34,7 +34,7 @@ specifies the number of I/Os to submit from the submission queue.
is a bitmask of the following values:
.TP
.B IORING_ENTER_GETEVENTS
If this flag is set, then the system call will wait for the specificied
If this flag is set, then the system call will wait for the specified
number of events in
.I min_complete
before returning. This flag can be set along with
@@ -1052,7 +1052,7 @@ set, and a
field matching the
.I off
value being passed in. This request type can be used to either just wake or
interrupt anyone waiting for completions on the target ring, ot it can be used
interrupt anyone waiting for completions on the target ring, or it can be used
to pass messages via the two fields. Available since 5.18.
.PP
@@ -1143,7 +1143,7 @@ linked timeout has the flag set, it's guaranteed to not post a CQE.
The semantics are chosen to accommodate several use cases. First, when all but
the last request of a normal link without linked timeouts are marked with the
flag, only one CQE per lin is posted. Additionally, it enables supression of
flag, only one CQE per lin is posted. Additionally, it enables suppression of
CQEs in cases where the side effects of a successfully executed operation is
enough for userspace to know the state of the system. One such example would
be writing to a synchronisation file.
man/io_uring_free_probe.3
+1 -1
View File
@@ -2,7 +2,7 @@
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH io_uring_free_probe "January 25, 2022" "liburing-2.1" "liburing Manual"
.TH io_uring_free_probe 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
.SH NAME
io_uring_free_probe \- free probe instance
.SH SYNOPSIS
man/io_uring_get_probe.3
+1 -1
View File
@@ -2,7 +2,7 @@
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH io_uring_get_probe "January 25, 2022" "liburing-2.1" "liburing Manual"
.TH io_uring_get_probe 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
.SH NAME
io_uring_get_probe \- get probe instance
.SH SYNOPSIS
man/io_uring_opcode_supported.3
+1 -1
View File
@@ -2,7 +2,7 @@
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH io_uring_opcode_supported "January 25, 2022" "liburing-2.1" "liburing Manual"
.TH io_uring_opcode_supported 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
.SH NAME
io_uring_opcode_supported \- is op code supported?
.SH SYNOPSIS
man/io_uring_prep_read_fixed.3
+1 -1
View File
@@ -42,7 +42,7 @@ The
.I buf
and
.I nbytes
arguments must fall within a region specificed by
arguments must fall within a region specified by
.I buf_index
in the previously registered buffer. The buffer need not be aligned with
the start of the registered buffer.
man/io_uring_prep_write_fixed.3
+1 -1
View File
@@ -42,7 +42,7 @@ The
.I buf
and
.I nbytes
arguments must fall within a region specificed by
arguments must fall within a region specified by
.I buf_index
in the previously registered buffer. The buffer need not be aligned with
the start of the registered buffer.
man/io_uring_register.2
+1 -1
View File
@@ -3,7 +3,7 @@
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH IO_URING_REGISTER 2 2019-01-17 "Linux" "Linux Programmer's Manual"
.TH io_uring_register 2 2019-01-17 "Linux" "Linux Programmer's Manual"
.SH NAME
io_uring_register \- register files or user buffers for asynchronous I/O
.SH SYNOPSIS
man/io_uring_register_buf_ring.3
+1 -1
View File
@@ -64,7 +64,7 @@ field, and the associated CQE will have
.B IORING_CQE_F_BUFFER
set in their
.I flags
member, which will also contain the specific ID of the buffer seleted. The rest
member, which will also contain the specific ID of the buffer selected. The rest
of the fields are reserved and must be cleared to zero.
The
man/io_uring_setup.2
+1 -1
View File
@@ -4,7 +4,7 @@
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH IO_URING_SETUP 2 2019-01-29 "Linux" "Linux Programmer's Manual"
.TH io_uring_setup 2 2019-01-29 "Linux" "Linux Programmer's Manual"
.SH NAME
io_uring_setup \- setup a context for performing asynchronous I/O
.SH SYNOPSIS
man/io_uring_sq_ready.3
+2 -2
View File
@@ -2,7 +2,7 @@
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH io_uring_sq_ready "January 25, 2022" "liburing-2.1" "liburing Manual"
.TH io_uring_sq_ready 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
.SH NAME
io_uring_sq_ready \- number of unconsumed or unsubmitted entries in the SQ ring
.SH SYNOPSIS
@@ -15,7 +15,7 @@ io_uring_sq_ready \- number of unconsumed or unsubmitted entries in the SQ ring
.PP
The
.BR io_uring_sq_ready (3)
function retuns the number of unconsumed (if SQPOLL) or unsubmitted entries
function returns the number of unconsumed (if SQPOLL) or unsubmitted entries
that exist in the SQ ring belonging to the
.I ring
param.
man/io_uring_sq_space_left.3
+2 -2
View File
@@ -2,7 +2,7 @@
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH io_uring_sq_space-left "January 25, 2022" "liburing-2.1" "liburing Manual"
.TH io_uring_sq_space-left 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
.SH NAME
io_uring_sq_space_left \- free space in the SQ ring
.SH SYNOPSIS
@@ -15,7 +15,7 @@ io_uring_sq_space_left \- free space in the SQ ring
.PP
The
.BR io_uring_sq_space_left (3)
function retuns how much space is left in the SQ ring belonging to the
function returns how much space is left in the SQ ring belonging to the
.I ring
param.
man/io_uring_sqe_set_flags.3
+2 -2
View File
@@ -2,7 +2,7 @@
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH io_uring_sqe_set_flags "January 25, 2022" "liburing-2.1" "liburing Manual"
.TH io_uring_sqe_set_flags 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
.SH NAME
io_uring_sqe_set_flags \- set flags for submission queue entry
.SH SYNOPSIS
@@ -65,7 +65,7 @@ one completes.
.B IOSQE_CQE_SKIP_SUCCESS
Request that no CQE be generated for this request, if it completes successfully.
This can be useful in cases where the application doesn't need to know when
a specific request completed, if it completed succesfully.
a specific request completed, if it completed successfully.
.TP
.B IOSQE_BUFFER_SELECT
If set, and if the request types supports it, select an IO buffer from the
man/io_uring_sqring_wait.3
+1 -1
View File
@@ -2,7 +2,7 @@
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH io_uring_sqring_wait "January 25, 2022" "liburing-2.1" "liburing Manual"
.TH io_uring_sqring_wait 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
.SH NAME
io_uring_sqring_wait \- wait for free space in the SQ ring
.SH SYNOPSIS
man/io_uring_wait_cqe.3
+1 -1
View File
@@ -31,7 +31,7 @@ the application can retrieve the completion with
.SH RETURN VALUE
On success
.BR io_uring_wait_cqe (3)
returns 0 and the cqe_ptr parm is filled in. On failure it returns
returns 0 and the cqe_ptr param is filled in. On failure it returns
.BR -errno .
The return value indicates the result of waiting for a CQE, and it has no
relation to the CQE result itself.
man/io_uring_wait_cqe_nr.3
+1 -1
View File
@@ -34,7 +34,7 @@ the application can retrieve the completion with
.SH RETURN VALUE
On success
.BR io_uring_wait_cqe_nr (3)
returns 0 and the cqe_ptr parm is filled in. On failure it returns
returns 0 and the cqe_ptr param is filled in. On failure it returns
.BR -errno .
The return value indicates the result of waiting for a CQE, and it has no
relation to the CQE result itself.
man/io_uring_wait_cqe_timeout.3
+1 -1
View File
@@ -43,7 +43,7 @@ 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
returns 0 and the cqe_ptr param is filled in. On failure it returns
.BR -errno .
The return value indicates the result of waiting for a CQE, and it has no
relation to the CQE result itself.
man/io_uring_wait_cqes.3
+1 -1
View File
@@ -48,7 +48,7 @@ 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
returns 0 and the cqe_ptr param is filled in. On failure it returns
.BR -errno .
.SH SEE ALSO
.BR io_uring_submit (3),
test/fixed-link.c
+1 -1
View File
@@ -28,7 +28,7 @@ int main(int argc, char *argv[])
}
if (io_uring_queue_init(32, &ring, 0) < 0) {
fprintf(stderr, "Faild to init io_uring\n");
fprintf(stderr, "Failed to init io_uring\n");
close(fd);
return T_EXIT_FAIL;
}
test/multicqes_drain.c
+1 -1
View File
@@ -117,7 +117,7 @@ __u8 generate_flags(int sqe_op)
/*
* avoid below case:
* sqe0(multishot, link)->sqe1(nop, link)->sqe2(nop)->sqe3(cancel_sqe0)
* sqe3 may excute before sqe0 so that sqe0 isn't cancelled
* sqe3 may execute before sqe0 so that sqe0 isn't cancelled
*/
if (sqe_op == multi)
flags &= ~IOSQE_IO_LINK;
test/rsrc_tags.c
+1 -1
View File
@@ -182,7 +182,7 @@ static int test_buffers_update(void)
return 1;
}
/* test that CQE is not emmited before we're done with a buffer */
/* test that CQE is not emitted before we're done with a buffer */
sqe = io_uring_get_sqe(&ring);
io_uring_prep_read_fixed(sqe, pipes[0], tmp_buf, 10, 0, 0);
sqe->user_data = 100;
test/rw_merge_test.c
+1 -1
View File
@@ -79,7 +79,7 @@ int main(int argc, char *argv[])
assert(ret == 1);
/*
* Read may stuck because of bug there request was be incorrecly
* Read may stuck because of bug there request was be incorrectly
* merged with <REQ1> request
*/
ret = io_uring_wait_cqe_timeout(&ring, &cqe, &ts);
test/single-issuer.c
+1 -1
View File
@@ -88,7 +88,7 @@ int main(int argc, char *argv[])
/* test that the creator iw allowed to submit */
ret = try_submit(&ring);
if (ret) {
fprintf(stderr, "the creater can't submit %i\n", ret);
fprintf(stderr, "the creator can't submit %i\n", ret);
return T_EXIT_FAIL;
}
test/timeout.c
+4 -4
View File
@@ -156,7 +156,7 @@ static int test_single_timeout_nr(struct io_uring *ring, int nr)
/*
* NOP commands have user_data as 1. Check that we get the
* at least 'nr' NOPs first, then the successfully removed timout.
* at least 'nr' NOPs first, then the successfully removed timeout.
*/
if (io_uring_cqe_get_data(cqe) == NULL) {
if (i < nr) {
@@ -588,7 +588,7 @@ static int test_multi_timeout(struct io_uring *ring)
}
if (cqe->user_data != user_data) {
fprintf(stderr, "%s: unexpected timeout req %d sequece\n",
fprintf(stderr, "%s: unexpected timeout req %d sequence\n",
__FUNCTION__, i+1);
goto err;
}
@@ -678,7 +678,7 @@ static int test_multi_timeout_nr(struct io_uring *ring)
case 1:
/* Should be timeout req_2 */
if (cqe->user_data != 2) {
fprintf(stderr, "%s: unexpected timeout req %d sequece\n",
fprintf(stderr, "%s: unexpected timeout req %d sequence\n",
__FUNCTION__, i+1);
goto err;
}
@@ -691,7 +691,7 @@ static int test_multi_timeout_nr(struct io_uring *ring)
case 2:
/* Should be timeout req_1 */
if (cqe->user_data != 1) {
fprintf(stderr, "%s: unexpected timeout req %d sequece\n",
fprintf(stderr, "%s: unexpected timeout req %d sequence\n",
__FUNCTION__, i+1);
goto err;
}