Skip to content

Commit a07484c

Browse files
bagasmeborkmann
authored andcommitted
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: 6736aa7 ("selftests/bpf: Add general instructions for test execution") Reported-by: Ross Zwisler <zwisler@google.com> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Daniel Borkmann <daniel@iogearbox.net> Acked-by: Ross 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
1 parent 580f98c commit a07484c

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

Documentation/bpf/bpf_devel_QA.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ under test should match the config file fragment in
469469
tools/testing/selftests/bpf as closely as possible.
470470

471471
Finally to ensure support for latest BPF Type Format features -
472-
discussed in `Documentation/bpf/btf.rst`_ - pahole version 1.16
472+
discussed in Documentation/bpf/btf.rst - pahole version 1.16
473473
is required for kernels built with CONFIG_DEBUG_INFO_BTF=y.
474474
pahole is delivered in the dwarves package or can be built
475475
from source at
@@ -690,6 +690,5 @@ when:
690690
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/
691691
.. _Documentation/dev-tools/kselftest.rst:
692692
https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
693-
.. _Documentation/bpf/btf.rst: btf.rst
694693

695694
Happy BPF hacking!

0 commit comments

Comments
 (0)