From: Daniel Borkmann <daniel@iogearbox.net>
To: Bagas Sanjaya <bagasdotme@gmail.com>,
Linux BPF <bpf@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Cc: Alexei Starovoitov <ast@kernel.org>,
Andrii Nakryiko <andrii@kernel.org>,
Martin KaFai Lau <martin.lau@linux.dev>,
Song Liu <song@kernel.org>, Yonghong Song <yhs@fb.com>,
John Fastabend <john.fastabend@gmail.com>,
KP Singh <kpsingh@kernel.org>,
Stanislav Fomichev <sdf@google.com>, Hao Luo <haoluo@google.com>,
Jiri Olsa <jolsa@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
Alan Maguire <alan.maguire@oracle.com>,
Ross Zwisler <zwisler@google.com>
Subject: Re: [PATCH v2] Documentation: bpf: Fix link to BTF doc
Date: Mon, 27 Feb 2023 22:11:52 +0100 [thread overview]
Message-ID: <7cd545a2-4a5c-1961-1cf7-cd0f24e41df8@iogearbox.net> (raw)
In-Reply-To: <20230222083530.26136-1-bagasdotme@gmail.com>
On 2/22/23 9:35 AM, Bagas Sanjaya wrote:
> Ross reported broken link to BTF documentation
> (Documentation/bpf/btf.rst) in Documentation/bpf/bpf_devel_QA.rst. The
> link in question is written using external link syntax, with the target
> refers to BTF doc in reST source (btf.rst), which doesn't exist in
> resulting HTML output.
>
> Fix the link by replacing external link syntax with simply writing out
> the target doc, which the link will be generated to the correct HTML doc
> target.
>
> Link: https://lore.kernel.org/linux-doc/Y++09LKx25dtR4Ow@google.com/
> Fixes: 6736aa793c2b5f ("selftests/bpf: Add general instructions for test execution")
> Reported-by: Ross Zwisler <zwisler@google.com>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
> Changes since v1 [1]:
>
> * Reword patch description (I don't see external link semantics on
> Sphinx documentation [2] when I submit v1).
> * Drop the corresponding orphan target definition.
> * Rebase on top of current bpf tree.
>
> Ross, do you want to give a Reviewed-by or Acked-by?
>
> [1]: https://lore.kernel.org/linux-doc/20230219030956.22662-1-bagasdotme@gmail.com/
> [2]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#external-links
>
> Documentation/bpf/bpf_devel_QA.rst | 3 +--
> 1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
> index 03d4993eda6f05..715f7321020f27 100644
> --- a/Documentation/bpf/bpf_devel_QA.rst
> +++ b/Documentation/bpf/bpf_devel_QA.rst
> @@ -469,7 +469,7 @@ under test should match the config file fragment in
> tools/testing/selftests/bpf as closely as possible.
>
> Finally to ensure support for latest BPF Type Format features -
> -discussed in `Documentation/bpf/btf.rst`_ - pahole version 1.16
> +discussed in Documentation/bpf/btf.rst - pahole version 1.16
> is required for kernels built with CONFIG_DEBUG_INFO_BTF=y.
> pahole is delivered in the dwarves package or can be built
> from source at
> @@ -690,6 +690,5 @@ when:
> https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/
> .. _Documentation/dev-tools/kselftest.rst:
> https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
> -.. _Documentation/bpf/btf.rst: btf.rst
Applied, thanks! Looks like kselftest.rst has a similar issue, could you
send a fix for this too?
> Happy BPF hacking!
>
> base-commit: 345d24a91c79f408e355c8b7e873ccde0f097eea
>
next prev parent reply other threads:[~2023-02-27 21:12 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-22 8:35 [PATCH v2] Documentation: bpf: Fix link to BTF doc Bagas Sanjaya
2023-02-22 18:55 ` Ross Zwisler
2023-02-23 1:58 ` Bagas Sanjaya
2023-02-27 21:11 ` Daniel Borkmann [this message]
2023-02-28 7:48 ` Bagas Sanjaya
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=7cd545a2-4a5c-1961-1cf7-cd0f24e41df8@iogearbox.net \
--to=daniel@iogearbox.net \
--cc=alan.maguire@oracle.com \
--cc=andrii@kernel.org \
--cc=ast@kernel.org \
--cc=bagasdotme@gmail.com \
--cc=bpf@vger.kernel.org \
--cc=corbet@lwn.net \
--cc=haoluo@google.com \
--cc=john.fastabend@gmail.com \
--cc=jolsa@kernel.org \
--cc=kpsingh@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=martin.lau@linux.dev \
--cc=sdf@google.com \
--cc=song@kernel.org \
--cc=yhs@fb.com \
--cc=zwisler@google.com \
/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).