[PATCH 2/2] Modify the pipe(2) manpage for notification queues
From: David Howells
Date: Fri Aug 07 2020 - 11:06:35 EST
Modify the pipe(2) manual page to cover support for notification queues
Signed-off-by: David Howells <dhowells@xxxxxxxxxx>
---
man2/pipe.2 | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/man2/pipe.2 b/man2/pipe.2
index 117f8950c..c50b38530 100644
--- a/man2/pipe.2
+++ b/man2/pipe.2
@@ -146,6 +146,13 @@ referred to by the new file descriptors.
Using this flag saves extra calls to
.BR fcntl (2)
to achieve the same result.
+.TP
+.B O_NOTIFICATION_PIPE
+This enables use of the pipe as a notification transport (see
+.BR watch_queue (7)
+for more information). When a pipe is in this mode, it may not be spliced as
+the insertion of notification messages into the pipe buffer can happen
+asynchronously and may cause splice to malfunction.
.SH RETURN VALUE
On success, zero is returned.
On error, \-1 is returned,
@@ -292,4 +299,5 @@ main(int argc, char *argv[])
.BR vmsplice (2),
.BR write (2),
.BR popen (3),
-.BR pipe (7)
+.BR pipe (7),
+.BR watch_queue (7)