linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Yanteng Si <siyanteng01@gmail.com>, mhiramat@kernel.org
Cc: rostedt@goodmis.org, linux-doc@vger.kernel.org,
	siyanteng01@gmail.com, Yanteng Si <siyanteng@loongson.cn>
Subject: Re: [PATCH] docs/trace: fix a label of boottime-trace
Date: Thu, 09 Dec 2021 07:50:07 -0700	[thread overview]
Message-ID: <87y24tvnmo.fsf@meer.lwn.net> (raw)
In-Reply-To: <20211209091133.558744-1-siyanteng@loongson.cn>

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?

Thanks,

jon

  parent reply	other threads:[~2021-12-09 14:50 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-09  9:11 [PATCH] docs/trace: fix a label of boottime-trace Yanteng Si
2021-12-09 14:34 ` Steven Rostedt
2021-12-09 14:37 ` Akira Yokosawa
2021-12-09 14:54   ` Steven Rostedt
2021-12-09 14:50 ` Jonathan Corbet [this message]
2021-12-09 16:17   ` Masami Hiramatsu
2021-12-09 16:59     ` Jonathan Corbet
2021-12-10  0:08       ` Masami Hiramatsu
2021-12-10  1:51         ` yanteng si

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87y24tvnmo.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=mhiramat@kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=siyanteng01@gmail.com \
    --cc=siyanteng@loongson.cn \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).