diff mbox series

libtracefs: Fix documentation of tracefs_trace_pipe_stream() flags

Message ID 20230705215351.2fe04ea0@gandalf.local.home (mailing list archive)
State Accepted
Commit 3f436fca67f5ca38671e5160f299ce15eacb0ef8
Headers show
Series libtracefs: Fix documentation of tracefs_trace_pipe_stream() flags | expand

Commit Message

Steven Rostedt July 6, 2023, 1:53 a.m. UTC 
From: "Steven Rostedt (Google)" <rostedt@goodmis.org>

The flags description in the man page of tracefs_trace_pipe_stream() is
not detailed enough. Not only does it just say "(see )" without saying
"open(2)", it needs a bit more description about how it is used, as it is
not exactly like open(2).

Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
---
 Documentation/libtracefs-stream.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/libtracefs-stream.txt b/Documentation/libtracefs-stream.txt
index 8008be810a33..7f1ff6aca4e6 100644
--- a/Documentation/libtracefs-stream.txt
+++ b/Documentation/libtracefs-stream.txt
@@ -31,8 +31,9 @@  The *tracefs_trace_pipe_stream()* function redirects the stream of trace data to
 file. The "splice" system call is used to moves the data without copying between kernel
 address space and user address space. The _fd_ is the file descriptor of the output file
 and _flags_ is a bit mask of flags to be passed to the open system call of the trace_pipe
-file (see ). If flags contain O_NONBLOCK, then that is also passed to the splice calls
-that may read the file to the output stream file descriptor.
+file (see *open(2)*). If flags contain O_NONBLOCK, then that is also passed to the splice calls
+that may read the file to the output stream file descriptor. Note, O_RDONLY is or'd to
+the _flags_ and only O_NONBLOCK is useful for this parameter.
 
 The *tracefs_trace_pipe_print()* function is similar to *tracefs_trace_pipe_stream()*, but
 the stream of trace data is redirected to stdout.