* [PATCH v2] docs/trace: fix a label of boottime-trace
@ 2021-12-10 4:15 Yanteng Si
2021-12-10 5:19 ` Masami Hiramatsu
0 siblings, 1 reply; 4+ messages in thread
From: Yanteng Si @ 2021-12-10 4:15 UTC (permalink / raw)
To: mhiramat; +Cc: rostedt, corbet, linux-doc, siyanteng01, akiyks, 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
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH v2] docs/trace: fix a label of boottime-trace
2021-12-10 4:15 [PATCH v2] docs/trace: fix a label of boottime-trace Yanteng Si
@ 2021-12-10 5:19 ` Masami Hiramatsu
2021-12-10 17:37 ` Steven Rostedt
0 siblings, 1 reply; 4+ messages in thread
From: Masami Hiramatsu @ 2021-12-10 5:19 UTC (permalink / raw)
To: Yanteng Si; +Cc: rostedt, corbet, linux-doc, akiyks, Yanteng Si
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>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v2] docs/trace: fix a label of boottime-trace
2021-12-10 5:19 ` Masami Hiramatsu
@ 2021-12-10 17:37 ` Steven Rostedt
2021-12-10 20:59 ` Jonathan Corbet
0 siblings, 1 reply; 4+ messages in thread
From: Steven Rostedt @ 2021-12-10 17:37 UTC (permalink / raw)
To: Masami Hiramatsu; +Cc: Yanteng Si, corbet, linux-doc, akiyks, Yanteng Si
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v2] docs/trace: fix a label of boottime-trace
2021-12-10 17:37 ` Steven Rostedt
@ 2021-12-10 20:59 ` Jonathan Corbet
0 siblings, 0 replies; 4+ messages in thread
From: Jonathan Corbet @ 2021-12-10 20:59 UTC (permalink / raw)
To: Steven Rostedt, Masami Hiramatsu
Cc: Yanteng Si, linux-doc, akiyks, Yanteng Si
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
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-12-10 20:59 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-12-10 4:15 [PATCH v2] docs/trace: fix a label of boottime-trace Yanteng Si
2021-12-10 5:19 ` Masami Hiramatsu
2021-12-10 17:37 ` Steven Rostedt
2021-12-10 20:59 ` Jonathan Corbet
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.