[PATCH v2] docs/trace: fix a label of boottime-trace

[PATCH v2] docs/trace: fix a label of boottime-trace

[Yanteng Si]

Since 559789539255 ("Documentation: tracing: Add histogram syntax to boot-time tracing") which
introduced a warning:

linux/Documentation/trace/boottime-trace.rst:136: WARNING: undefined label: histogram (if the link has no caption the label must precede a section header)

Replace with: (path)

Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
---
 Documentation/trace/boottime-trace.rst | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/Documentation/trace/boottime-trace.rst b/Documentation/trace/boottime-trace.rst
index 6dcfbc64014d..d594597201fd 100644
--- a/Documentation/trace/boottime-trace.rst
+++ b/Documentation/trace/boottime-trace.rst
@@ -131,9 +131,7 @@ Ftrace Histogram Options
 Since it is too long to write a histogram action as a string for per-event
 action option, there are tree-style options under per-event 'hist' subkey
 for the histogram actions. For the detail of the each parameter,
-please read the event histogram document [3]_.
-
-.. [3] See :ref:`Documentation/trace/histogram.rst <histogram>`
+please read the event histogram document (Documentation/trace/histogram.rst)
 
 ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]keys = KEY1[, KEY2[...]]
   Set histogram key parameters. (Mandatory)
-- 
2.27.0

Re: [PATCH v2] docs/trace: fix a label of boottime-trace

[Masami Hiramatsu]

On Fri, 10 Dec 2021 12:15:36 +0800
Yanteng Si <siyanteng01@gmail.com> wrote:

> Since 559789539255 ("Documentation: tracing: Add histogram syntax to boot-time tracing") which
> introduced a warning:
> 
> linux/Documentation/trace/boottime-trace.rst:136: WARNING: undefined label: histogram (if the link has no caption the label must precede a section header)
> 
> Replace with: (path)
> 

Looks good to me.

Acked-by: Masami Hiramatsu <mhiramat@kernel.org>
Fixes: 559789539255 ("Documentation: tracing: Add histogram syntax to boot-time tracing")

Thank you,

> Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
> ---
>  Documentation/trace/boottime-trace.rst | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/Documentation/trace/boottime-trace.rst b/Documentation/trace/boottime-trace.rst
> index 6dcfbc64014d..d594597201fd 100644
> --- a/Documentation/trace/boottime-trace.rst
> +++ b/Documentation/trace/boottime-trace.rst
> @@ -131,9 +131,7 @@ Ftrace Histogram Options
>  Since it is too long to write a histogram action as a string for per-event
>  action option, there are tree-style options under per-event 'hist' subkey
>  for the histogram actions. For the detail of the each parameter,
> -please read the event histogram document [3]_.
> -
> -.. [3] See :ref:`Documentation/trace/histogram.rst <histogram>`
> +please read the event histogram document (Documentation/trace/histogram.rst)
>  
>  ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist.[N.]keys = KEY1[, KEY2[...]]
>    Set histogram key parameters. (Mandatory)
> -- 
> 2.27.0
> 


-- 
Masami Hiramatsu <mhiramat@kernel.org>

Re: [PATCH v2] docs/trace: fix a label of boottime-trace

[Steven Rostedt]

On Fri, 10 Dec 2021 14:19:36 +0900
Masami Hiramatsu <mhiramat@kernel.org> wrote:

> On Fri, 10 Dec 2021 12:15:36 +0800
> Yanteng Si <siyanteng01@gmail.com> wrote:
> 
> > Since 559789539255 ("Documentation: tracing: Add histogram syntax to boot-time tracing") which
> > introduced a warning:
> > 
> > linux/Documentation/trace/boottime-trace.rst:136: WARNING: undefined label: histogram (if the link has no caption the label must precede a section header)
> > 
> > Replace with: (path)
> >   
> 
> Looks good to me.
> 
> Acked-by: Masami Hiramatsu <mhiramat@kernel.org>
> Fixes: 559789539255 ("Documentation: tracing: Add histogram syntax to boot-time tracing")

Acked-by: Steven Rostedt (VMware) <rostedt@goodmis.org>

Jon, care to take this through your tree?

Thanks!

-- Steve

Re: [PATCH v2] docs/trace: fix a label of boottime-trace

[Jonathan Corbet]

Steven Rostedt <rostedt@goodmis.org> writes:

> On Fri, 10 Dec 2021 14:19:36 +0900
> Masami Hiramatsu <mhiramat@kernel.org> wrote:
>
>> On Fri, 10 Dec 2021 12:15:36 +0800
>> Yanteng Si <siyanteng01@gmail.com> wrote:
>> 
>> > Since 559789539255 ("Documentation: tracing: Add histogram syntax to boot-time tracing") which
>> > introduced a warning:
>> > 
>> > linux/Documentation/trace/boottime-trace.rst:136: WARNING: undefined label: histogram (if the link has no caption the label must precede a section header)
>> > 
>> > Replace with: (path)
>> >   
>> 
>> Looks good to me.
>> 
>> Acked-by: Masami Hiramatsu <mhiramat@kernel.org>
>> Fixes: 559789539255 ("Documentation: tracing: Add histogram syntax to boot-time tracing")
>
> Acked-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
>
> Jon, care to take this through your tree?

Applied, thanks.

jon