Commit a07484c0 authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Daniel Borkmann
Browse files

bpf, docs: Fix link to BTF doc 



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.

Fixes: 6736aa79 ("selftests/bpf: Add general instructions for test execution")
Reported-by: default avatarRoss Zwisler <zwisler@google.com>
Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
Acked-by: default avatarRoss Zwisler <zwisler@google.com>
Link: https://lore.kernel.org/linux-doc/Y++09LKx25dtR4Ow@google.com/
Link: https://lore.kernel.org/bpf/20230222083530.26136-1-bagasdotme@gmail.com
parent 580f98cc

Documentation/bpf/bpf_devel_QA.rst

+1 −2
Original line number Diff line number Diff line
@@ -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



Happy BPF hacking!