Skip to content

Commit fa06220

Browse files
bagasmeJonathan Corbet
authored andcommitted
Documentation: trace: histogram-design: Wrap introductory note in note:: directive
Use Sphinx note:: directive for the introductory note at the beginning of docs, instead of aligned-text paragraph that renders as definition list. Reviewed-by: Tom Zanussi <zanussi@kernel.org> Reviewed-by: Masami Hiramatsu (Google) <mhiramat@kernel.org> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250916054202.582074-6-bagasdotme@gmail.com>
1 parent 8c716e8 commit fa06220

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

Documentation/trace/histogram-design.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ histograms work and how the individual pieces map to the data
1111
structures used to implement them in trace_events_hist.c and
1212
tracing_map.c.
1313

14-
Note: All the ftrace histogram command examples assume the working
15-
directory is the ftrace /tracing directory. For example::
14+
.. note::
15+
All the ftrace histogram command examples assume the working
16+
directory is the ftrace /tracing directory. For example::
1617

1718
# cd /sys/kernel/tracing
1819

19-
Also, the histogram output displayed for those commands will be
20-
generally be truncated - only enough to make the point is displayed.
20+
Also, the histogram output displayed for those commands will be
21+
generally be truncated - only enough to make the point is displayed.
2122

2223
'hist_debug' trace event files
2324
==============================

0 commit comments

Comments
 (0)