Skip to content

Commit e3d35ea

Browse files
committed
man/io_uring_cancelation.7: various cleanups
Spell cancelation consistently, and don't explicitly mention doing cancelations for ring exit manually upfront. Still mentioned later on in case it's useful, but it should not be a headline thing. Signed-off-by: Jens Axboe <axboe@kernel.dk>
1 parent 3a59094 commit e3d35ea

1 file changed

Lines changed: 5 additions & 8 deletions

File tree

man/io_uring_cancelation.7

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ io_uring_cancelation \- io_uring request cancelation overview
77
.SH DESCRIPTION
88
io_uring provides mechanisms to cancel in-flight requests before they
99
complete naturally. This is useful for implementing timeouts, handling
10-
connection drops, application shutdown, or when a request is no longer
11-
needed.
10+
connection drops, closing connections that go away, or when a request is no
11+
longer needed.
1212
.SS Why cancel requests?
1313
Common scenarios requiring cancelation:
1414
.IP \(bu 2
@@ -18,9 +18,6 @@ Cancel a read or accept that has been pending too long
1818
.B Connection management:
1919
Cancel pending operations when a connection is closed
2020
.IP \(bu
21-
.B Application shutdown:
22-
Clean up all pending I/O before exiting
23-
.IP \(bu
2421
.B Resource cleanup:
2522
Cancel operations on a file descriptor being closed
2623
.IP \(bu
@@ -49,7 +46,7 @@ io_uring_prep_cancel64(sqe, 1234, 0);
4946
io_uring_submit(ring);
5047
.EE
5148
.in
52-
.SS Cancellation results
49+
.SS Cancelation results
5350
When a cancelation is submitted, two CQEs are generated:
5451
.PP
5552
.B The canceled request's CQE:
@@ -86,7 +83,7 @@ if the request was found but already completing
8683
.PP
8784
The order of these CQEs is not guaranteed. The application may receive
8885
the cancel CQE before or after the canceled request's CQE.
89-
.SS Cancellation flags
86+
.SS Cancelation flags
9087
Various flags modify cancelation behavior:
9188
.PP
9289
.B IORING_ASYNC_CANCEL_ALL
@@ -139,7 +136,7 @@ io_uring_prep_cancel(sqe, NULL,
139136
.EE
140137
.in
141138
.SS Race conditions
142-
Cancellation is inherently racy. Between submitting the cancel request
139+
Cancelation is inherently racy. Between submitting the cancel request
143140
and the kernel processing it:
144141
.IP \(bu 2
145142
The target request may complete successfully

0 commit comments

Comments
 (0)