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 for Android: free password hash cracker in your pocket

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

Message-Id: <20250912100339.d9456de2783cdc67b01cfec7@kernel.org>
Date: Fri, 12 Sep 2025 10:03:39 +0900
From: Masami Hiramatsu (Google) <mhiramat@...nel.org>
To: Bagas Sanjaya <bagasdotme@...il.com>
Cc: 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>, Steven Rostedt <rostedt@...dmis.org>,
 Masami Hiramatsu <mhiramat@...nel.org>, Mathieu Desnoyers
 <mathieu.desnoyers@...icios.com>, Jonathan Corbet <corbet@....net>, Tom
 Zanussi <zanussi@...nel.org>
Subject: Re: [PATCH 4/5] Documentation: trace: histogram-design: Wrap
 introductory note in note:: directive

On Thu, 11 Sep 2025 11:25:26 +0700
Bagas Sanjaya <bagasdotme@...il.com> wrote:

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

Looks good change ;)

Reviewed-by: Masami Hiramatsu (Google) <mhiramat@...nel.org>

Thank you!

> 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
>  ==============================
> -- 
> An old man doll... just what I always wanted! - Clara
> 


-- 
Masami Hiramatsu (Google) <mhiramat@...nel.org>