Skip to contentSkip to conversation

Documentation: bpf: Fix link to BTF doc

PATCH In review Bagas Sanjaya 3 participants 5 messages Feb 22, 2023 – Feb 28, 2023

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 Documentation: bpf: 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 6736aa793c2b5f ("selftests/bpf: Add general instructions for test execution")

---
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/[email protected]/
[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(-)
Documentation/bpf/bpf_devel_QA.rst +1 -2
index 03d4993eda6f05..715f7321020f27 100644
@@ -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!

base-commit: 345d24a91c79f408e355c8b7e873ccde0f097eea

Signature · 1 line
An old man doll... just what I always wanted! - Clara
Acked-by on v2 1/1
#1 lore raw
Quoted 17 lines · Bagas Sanjaya

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 6736aa793c2b5f ("selftests/bpf: Add general instructions for test execution")

---
Changes since v1 [1]:

Quoted 6 lines

* 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?

Sure, thanks for the fix:

#2 lore raw
Quoted 4 lines · Ross Zwisler
Quoted 1 line

Ross, do you want to give a Reviewed-by or Acked-by?

Sure, thanks for the fix:

OK, thanks!

Signature · 1 line
An old man doll... just what I always wanted! - Clara
maintainer
#3 lore raw
In reply to Bagas Sanjaya
Quoted 44 lines · Bagas Sanjaya

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 6736aa793c2b5f ("selftests/bpf: Add general instructions for test execution")

---
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/[email protected]/
[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(-)
Documentation/bpf/bpf_devel_QA.rst +1 -1
index 03d4993eda6f05..715f7321020f27 100644
@@ -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

Documentation/bpf/bpf_devel_QA.rst when: · line 693

Quoted 4 lines
Documentation/bpf/bpf_devel_QA.rst +0 -1
@@ -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?

Quoted 4 lines
Documentation/bpf/bpf_devel_QA.rst +0 -0
  Happy BPF hacking!
 

base-commit: 345d24a91c79f408e355c8b7e873ccde0f097eea

#4 lore raw
Quoted 3 lines · Daniel Borkmann

Applied, thanks! Looks like kselftest.rst has a similar issue, could you send a fix for this too?

The fixup is in the recently sent miniseries at [1].

[1]: https://lore.kernel.org/linux-doc/[email protected]/

Thanks!

Signature · 1 line
An old man doll... just what I always wanted! - Clara