There exist some errors "404 Not Found" when I click the link
of "MAINTAINERS" [1], "samples/bpf/" [2] and "selftests" [3]
in the documentation "HOWTO interact with BPF subsystem" [4].
As Alexei Starovoitov suggested, just remove "MAINTAINERS" and
"samples/bpf/" links and use correct link of "selftests".
[1] https://www.kernel.org/doc/html/MAINTAINERS
[2] https://www.kernel.org/doc/html/samples/bpf/
[3] https://www.kernel.org/doc/html/tools/testing/selftests/bpf/
[4] https://www.kernel.org/doc/html/latest/bpf/bpf_devel_QA.html
Fixes: 542228384888 ("bpf, doc: convert bpf_devel_QA.rst to use RST formatting")
Signed-off-by: Tiezhu Yang <[email protected]>
---
v3: Remove "MAINTAINERS" and "samples/bpf/" links and
use correct link of "selftests"
v2: Add Fixes: tag
Documentation/bpf/bpf_devel_QA.rst | 17 ++++++++---------
1 file changed, 8 insertions(+), 9 deletions(-)
diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
index 2ed89ab..d05e67e 100644
--- a/Documentation/bpf/bpf_devel_QA.rst
+++ b/Documentation/bpf/bpf_devel_QA.rst
@@ -29,7 +29,7 @@ list:
This may also include issues related to XDP, BPF tracing, etc.
Given netdev has a high volume of traffic, please also add the BPF
-maintainers to Cc (from kernel MAINTAINERS_ file):
+maintainers to Cc (from kernel ``MAINTAINERS`` file):
* Alexei Starovoitov <[email protected]>
* Daniel Borkmann <[email protected]>
@@ -234,11 +234,11 @@ be subject to change.
Q: samples/bpf preference vs selftests?
---------------------------------------
-Q: When should I add code to `samples/bpf/`_ and when to BPF kernel
-selftests_ ?
+Q: When should I add code to ``samples/bpf/`` and when to BPF kernel
+selftests_?
A: In general, we prefer additions to BPF kernel selftests_ rather than
-`samples/bpf/`_. The rationale is very simple: kernel selftests are
+``samples/bpf/``. The rationale is very simple: kernel selftests are
regularly run by various bots to test for kernel regressions.
The more test cases we add to BPF selftests, the better the coverage
@@ -246,9 +246,9 @@ and the less likely it is that those could accidentally break. It is
not that BPF kernel selftests cannot demo how a specific feature can
be used.
-That said, `samples/bpf/`_ may be a good place for people to get started,
+That said, ``samples/bpf/`` may be a good place for people to get started,
so it might be advisable that simple demos of features could go into
-`samples/bpf/`_, but advanced functional and corner-case testing rather
+``samples/bpf/``, but advanced functional and corner-case testing rather
into kernel selftests.
If your sample looks like a test case, then go for BPF kernel selftests
@@ -645,10 +645,9 @@ when:
.. Links
.. _Documentation/process/: https://www.kernel.org/doc/html/latest/process/
-.. _MAINTAINERS: ../../MAINTAINERS
.. _netdev-FAQ: ../networking/netdev-FAQ.rst
-.. _samples/bpf/: ../../samples/bpf/
-.. _selftests: ../../tools/testing/selftests/bpf/
+.. _selftests:
+ 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
--
2.1.0
On Thu, 22 Apr 2021 11:36:00 +0800
Tiezhu Yang <[email protected]> wrote:
> There exist some errors "404 Not Found" when I click the link
> of "MAINTAINERS" [1], "samples/bpf/" [2] and "selftests" [3]
> in the documentation "HOWTO interact with BPF subsystem" [4].
The links work if you are browsing the document via GitHub:
https://github.com/torvalds/linux/blob/master/Documentation/bpf/bpf_devel_QA.rst
But I'm fine with removing those links as the official doc is here:
https://www.kernel.org/doc/html/latest/bpf/bpf_devel_QA.html
> As Alexei Starovoitov suggested, just remove "MAINTAINERS" and
> "samples/bpf/" links and use correct link of "selftests".
>
> [1] https://www.kernel.org/doc/html/MAINTAINERS
> [2] https://www.kernel.org/doc/html/samples/bpf/
> [3] https://www.kernel.org/doc/html/tools/testing/selftests/bpf/
> [4] https://www.kernel.org/doc/html/latest/bpf/bpf_devel_QA.html
>
> Fixes: 542228384888 ("bpf, doc: convert bpf_devel_QA.rst to use RST formatting")
> Signed-off-by: Tiezhu Yang <[email protected]>
> ---
>
> v3: Remove "MAINTAINERS" and "samples/bpf/" links and
> use correct link of "selftests"
>
> v2: Add Fixes: tag
>
> Documentation/bpf/bpf_devel_QA.rst | 17 ++++++++---------
> 1 file changed, 8 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
> index 2ed89ab..d05e67e 100644
> --- a/Documentation/bpf/bpf_devel_QA.rst
> +++ b/Documentation/bpf/bpf_devel_QA.rst
> @@ -29,7 +29,7 @@ list:
> This may also include issues related to XDP, BPF tracing, etc.
>
> Given netdev has a high volume of traffic, please also add the BPF
> -maintainers to Cc (from kernel MAINTAINERS_ file):
> +maintainers to Cc (from kernel ``MAINTAINERS`` file):
>
> * Alexei Starovoitov <[email protected]>
> * Daniel Borkmann <[email protected]>
> @@ -234,11 +234,11 @@ be subject to change.
>
> Q: samples/bpf preference vs selftests?
> ---------------------------------------
> -Q: When should I add code to `samples/bpf/`_ and when to BPF kernel
> -selftests_ ?
> +Q: When should I add code to ``samples/bpf/`` and when to BPF kernel
> +selftests_?
>
> A: In general, we prefer additions to BPF kernel selftests_ rather than
> -`samples/bpf/`_. The rationale is very simple: kernel selftests are
> +``samples/bpf/``. The rationale is very simple: kernel selftests are
> regularly run by various bots to test for kernel regressions.
>
> The more test cases we add to BPF selftests, the better the coverage
> @@ -246,9 +246,9 @@ and the less likely it is that those could accidentally break. It is
> not that BPF kernel selftests cannot demo how a specific feature can
> be used.
>
> -That said, `samples/bpf/`_ may be a good place for people to get started,
> +That said, ``samples/bpf/`` may be a good place for people to get started,
> so it might be advisable that simple demos of features could go into
> -`samples/bpf/`_, but advanced functional and corner-case testing rather
> +``samples/bpf/``, but advanced functional and corner-case testing rather
> into kernel selftests.
>
> If your sample looks like a test case, then go for BPF kernel selftests
> @@ -645,10 +645,9 @@ when:
>
> .. Links
> .. _Documentation/process/: https://www.kernel.org/doc/html/latest/process/
> -.. _MAINTAINERS: ../../MAINTAINERS
> .. _netdev-FAQ: ../networking/netdev-FAQ.rst
> -.. _samples/bpf/: ../../samples/bpf/
> -.. _selftests: ../../tools/testing/selftests/bpf/
> +.. _selftests:
> + 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
--
Best regards,
Jesper Dangaard Brouer
MSc.CS, Principal Kernel Engineer at Red Hat
LinkedIn: http://www.linkedin.com/in/brouer
On Thu, 22 Apr 2021 11:15:40 +0200
Jesper Dangaard Brouer <[email protected]> wrote:
> On Thu, 22 Apr 2021 11:36:00 +0800
> Tiezhu Yang <[email protected]> wrote:
>
> > There exist some errors "404 Not Found" when I click the link
> > of "MAINTAINERS" [1], "samples/bpf/" [2] and "selftests" [3]
> > in the documentation "HOWTO interact with BPF subsystem" [4].
>
> The links work if you are browsing the document via GitHub:
> https://github.com/torvalds/linux/blob/master/Documentation/bpf/bpf_devel_QA.rst
>
> But I'm fine with removing those links as the official doc is here:
> https://www.kernel.org/doc/html/latest/bpf/bpf_devel_QA.html
IMHO a V4 was not needed. Let me make it clear by ACKing this patch.
Acked-by: Jesper Dangaard Brouer <[email protected]>
--
Best regards,
Jesper Dangaard Brouer
MSc.CS, Principal Kernel Engineer at Red Hat
LinkedIn: http://www.linkedin.com/in/brouer
Hello:
This patch was applied to bpf/bpf-next.git (refs/heads/master):
On Thu, 22 Apr 2021 11:36:00 +0800 you wrote:
> There exist some errors "404 Not Found" when I click the link
> of "MAINTAINERS" [1], "samples/bpf/" [2] and "selftests" [3]
> in the documentation "HOWTO interact with BPF subsystem" [4].
>
> As Alexei Starovoitov suggested, just remove "MAINTAINERS" and
> "samples/bpf/" links and use correct link of "selftests".
>
> [...]
Here is the summary with links:
- [bpf-next,v3] bpf: Fix some invalid links in bpf_devel_QA.rst
https://git.kernel.org/bpf/bpf-next/c/64ef3ddfa95e
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html