All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux Kernel Tracing <linux-trace-kernel@vger.kernel.org>
Cc: Steven Rostedt <rostedt@goodmis.org>,
	Masami Hiramatsu <mhiramat@kernel.org>,
	Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
	Jonathan Corbet <corbet@lwn.net>,
	Tom Zanussi <zanussi@kernel.org>,
	Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH 4/5] Documentation: trace: histogram-design: Wrap introductory note in note:: directive
Date: Thu, 11 Sep 2025 11:25:26 +0700	[thread overview]
Message-ID: <20250911042527.22573-5-bagasdotme@gmail.com> (raw)
In-Reply-To: <20250911042527.22573-1-bagasdotme@gmail.com>

Use Sphinx note:: directive for the introductory note at the beginning
of docs, instead of aligned-text paragraph that renders as definition
list.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/trace/histogram-design.rst | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/Documentation/trace/histogram-design.rst b/Documentation/trace/histogram-design.rst
index 4faff1669b77bd..ae71b5bf97c6c7 100644
--- a/Documentation/trace/histogram-design.rst
+++ b/Documentation/trace/histogram-design.rst
@@ -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
 ==============================
-- 
An old man doll... just what I always wanted! - Clara


  parent reply	other threads:[~2025-09-11  4:25 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-11  4:25 [PATCH 0/5] histogram docs formatting cleanup Bagas Sanjaya
2025-09-11  4:25 ` [PATCH 1/5] Documentation: trace: histogram: Fix histogram trigger subsection number order Bagas Sanjaya
2025-09-12  0:59   ` Masami Hiramatsu
2025-09-15 15:07   ` Tom Zanussi
2025-09-11  4:25 ` [PATCH 2/5] Documentation: trace: histogram-design: Trim trailing vertices in diagram explanation text Bagas Sanjaya
2025-09-12  1:01   ` Masami Hiramatsu
2025-09-15 15:09   ` Tom Zanussi
2025-09-11  4:25 ` [PATCH 3/5] Documentation: trace: historgram-design: Separate sched_waking histogram section heading and the following diagram Bagas Sanjaya
2025-09-12  1:03   ` Masami Hiramatsu
2025-09-15 15:10   ` Tom Zanussi
2025-09-11  4:25 ` Bagas Sanjaya [this message]
2025-09-12  1:03   ` [PATCH 4/5] Documentation: trace: histogram-design: Wrap introductory note in note:: directive Masami Hiramatsu
2025-09-15 15:11   ` Tom Zanussi
2025-09-11  4:25 ` [PATCH 5/5] Documentation: trace: histogram: Link to ftrace docs Bagas Sanjaya
2025-09-12  0:58   ` Masami Hiramatsu
2025-09-12  2:55     ` Bagas Sanjaya
2025-09-15 15:11   ` Tom Zanussi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250911042527.22573-5-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-trace-kernel@vger.kernel.org \
    --cc=mathieu.desnoyers@efficios.com \
    --cc=mhiramat@kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=zanussi@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.