]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
Documentation: trace: histogram-design: Wrap introductory note in note:: directive
authorBagas Sanjaya <bagasdotme@gmail.com>
Tue, 16 Sep 2025 05:42:02 +0000 (12:42 +0700)
committerJonathan Corbet <corbet@lwn.net>
Thu, 18 Sep 2025 17:49:26 +0000 (11:49 -0600)
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>

Documentation/trace/histogram-design.rst

index 4faff1669b77bd708adaa6f1a1a9f0acfd8337da..ae71b5bf97c6c7ce94f4d409d8e09d609c33ac66 100644 (file)
@@ -11,13 +11,14 @@ histograms work and how the individual pieces map to the data
 structures used to implement them in trace_events_hist.c and
 tracing_map.c.
 
-Note: All the ftrace histogram command examples assume the working
-      directory is the ftrace /tracing directory. For example::
+.. note::
+   All the ftrace histogram command examples assume the working
+   directory is the ftrace /tracing directory. For example::
 
        # cd /sys/kernel/tracing
 
-Also, the histogram output displayed for those commands will be
-generally be truncated - only enough to make the point is displayed.
+   Also, the histogram output displayed for those commands will be
+   generally be truncated - only enough to make the point is displayed.
 
 'hist_debug' trace event files
 ==============================