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

Tom Zanussi
2025-09-15T15:11:23Z

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@kernel.org>

>
> 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
>  ==============================