linux-kernel - Re: [PATCH 4/5] Documentation: trace: histogram-design: Wrap introductory note in note:: directive

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <4639f5c311f6db8efe620bd9c7eae56dc15c5f8d.camel@kernel.org>
Date: Mon, 15 Sep 2025 10:11:21 -0500
From: Tom Zanussi <zanussi@...nel.org>
To: Bagas Sanjaya <bagasdotme@...il.com>, Linux Kernel Mailing List
 <linux-kernel@...r.kernel.org>, Linux Documentation
 <linux-doc@...r.kernel.org>,  Linux Kernel Tracing
 <linux-trace-kernel@...r.kernel.org>
Cc: Steven Rostedt <rostedt@...dmis.org>, Masami Hiramatsu
 <mhiramat@...nel.org>,  Mathieu Desnoyers <mathieu.desnoyers@...icios.com>,
 Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH 4/5] Documentation: trace: histogram-design: Wrap
 introductory note in note:: directive

On Thu, 2025-09-11 at 11:25 +0700, Bagas Sanjaya wrote:
> 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@...nel.org>

> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.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
>  ==============================