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

[Masami Hiramatsu <mhiramat@kernel.org>]

On Thu, 09 Dec 2021 07:50:07 -0700
Jonathan Corbet <corbet@lwn.net> wrote:

> Yanteng Si <siyanteng01@gmail.com> writes:
> 
> > 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:
> >               :xxx: path
> >
> > Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
> > ---
> >  Documentation/trace/boottime-trace.rst | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/trace/boottime-trace.rst b/Documentation/trace/boottime-trace.rst
> > index 6dcfbc64014d..efb75ec5bf48 100644
> > --- a/Documentation/trace/boottime-trace.rst
> > +++ b/Documentation/trace/boottime-trace.rst
> > @@ -133,7 +133,7 @@ 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>`
> > +.. [3] See :histogram: Documentation/trace/histogram.rst
> 
> I don't see that this is going to work either.  Is there any reason not
> to just make the text read:
> 
>    please read the event histogram document Documentation/trace/histogram.rst
> 
> and let automarkup link it in?

Hmm, I think we need the following change instead of this.
(the label is not in this document, but in the target document.)

diff --git a/Documentation/trace/histogram.rst b/Documentation/trace/histogram.rst
index 859fd1b76c63..ea722eae2810 100644
--- a/Documentation/trace/histogram.rst
+++ b/Documentation/trace/histogram.rst
@@ -1,3 +1,5 @@
+.. _histogram:
+
 ================
 Event Histograms
 ================

-- 
Masami Hiramatsu <mhiramat@kernel.org>