libtracefs: Fix documentation of tracefs_trace_pipe_stream() flags
PATCH 1/1 libtracefs: Fix documentation of tracefs_trace_pipe_stream() flags
From: "Steven Rostedt (Google)" <[email protected]>
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) <[email protected]>
--- Documentation/libtracefs-stream.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/libtracefs-stream.txt +3 -2
@@ -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.
Signature · 1 line
2.39.2