Skip to content

Commit 8a815e6

Browse files
committed
tracing: Have the document reflect that the trace file keeps tracing enabled
Now that reading the trace file does not temporarly stop tracing while it is open, update the document to reflect this fact. Link: http://lkml.kernel.org/r/[email protected] Signed-off-by: Steven Rostedt (VMware) <[email protected]>
1 parent c9b7a4a commit 8a815e6

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

Documentation/trace/ftrace.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,13 @@ of ftrace. Here is a list of some of the key files:
125125
trace:
126126

127127
This file holds the output of the trace in a human
128-
readable format (described below). Note, tracing is temporarily
129-
disabled when the file is open for reading. Once all readers
130-
are closed, tracing is re-enabled. Opening this file for
128+
readable format (described below). Opening this file for
131129
writing with the O_TRUNC flag clears the ring buffer content.
130+
Note, this file is not a consumer. If tracing is off
131+
(no tracer running, or tracing_on is zero), it will produce
132+
the same output each time it is read. When tracing is on,
133+
it may produce inconsistent results as it tries to read
134+
the entire buffer without consuming it.
132135

133136
trace_pipe:
134137

@@ -142,9 +145,7 @@ of ftrace. Here is a list of some of the key files:
142145
will not be read again with a sequential read. The
143146
"trace" file is static, and if the tracer is not
144147
adding more data, it will display the same
145-
information every time it is read. Unlike the
146-
"trace" file, opening this file for reading will not
147-
temporarily disable tracing.
148+
information every time it is read.
148149

149150
trace_options:
150151

0 commit comments

Comments
 (0)