Subject: Re: [PATCH v2] Documentation: bpf: Fix link to BTF doc
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>
References: <20230222083530.26136-1-bagasdotme@gmail.com>
From:   Daniel Borkmann <daniel@iogearbox.net>
Message-ID: <7cd545a2-4a5c-1961-1cf7-cd0f24e41df8@iogearbox.net>
Date:   Mon, 27 Feb 2023 22:11:52 +0100
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101
 Thunderbird/60.7.2
MIME-Version: 1.0
In-Reply-To: <20230222083530.26136-1-bagasdotme@gmail.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Precedence: bulk

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
>