man/io_uring_enter: Add doc for IORING_TIMEOUT_ETIME_SUCCESS

Signed-off-by: Constantin Pestka <constantin.pestka@c-pestka.de>
CPestka · Sep 15, 2024 · 1438d97 · 1438d97
1 parent 0184b67
commit 1438d97
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/man/io_uring_enter.2 b/man/io_uring_enter.2
@@ -607,6 +607,23 @@ instead of
 .in
 .PP
 
+.PP
+.in +7
+Since 5.16,
+.B IORING_TIMEOUT_ETIME_SUCCESS
+can be set in
+.IR timeout_flags ,
+which will result in the expiration of the timer and subsequent completion
+with
+.B -ETIME
+not being interpreted as an error. This is mostly relevant for linked SQEs, as
+subsequent requests in the chain would not get canceled by the timeout, if
+this flag is set. See
+.B IOSQE_IO_LINK
+for more details on linked SQEs.
+.in
+.PP
+
 .PP
 .in +7
 Since 6.4,