nagai/kernel
3
0
Fork 0
forked from mirrors/linux
Code Pull requests Activity

bpf, docs: Fix link to netdev-FAQ target

Browse source 
The BPF devel Q&A documentation page makes frequent reference to the
netdev-QA page via the netdev-FAQ rst link. This link is currently
broken, as is evidenced by the build output when making BPF docs:

./Documentation/bpf/bpf_devel_QA.rst:150: WARNING: undefined label: 'netdev-faq'
./Documentation/bpf/bpf_devel_QA.rst:206: WARNING: undefined label: 'netdev-faq'
./Documentation/bpf/bpf_devel_QA.rst:231: WARNING: undefined label: 'netdev-faq'
./Documentation/bpf/bpf_devel_QA.rst:396: WARNING: undefined label: 'netdev-faq'
./Documentation/bpf/bpf_devel_QA.rst:412: WARNING: undefined label: 'netdev-faq'

Fix the links to point to the actual netdev-faq page.

Signed-off-by: David Vernet <void@manifault.com>
Link: https://lore.kernel.org/r/20230302183918.54190-1-void@manifault.com
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
This commit is contained in:
David Vernet 2023-03-02 12:39:17 -06:00 committed by Alexei Starovoitov
parent c45eac537b
commit d56b0c461d
1 changed files with 7 additions and 7 deletions
repo.diff.show_diff_stats Download patch file Download diff file Expand all files Collapse all files

14
Documentation/bpf/bpf_devel_QA.rst
View file

@ -128,7 +128,7 @@ into the bpf-next tree will make their way into net-next tree. net and
net-next are both run by David S. Miller. From there, they will go net-next are both run by David S. Miller. From there, they will go
into the kernel mainline tree run by Linus Torvalds. To read up on the into the kernel mainline tree run by Linus Torvalds. To read up on the
process of net and net-next being merged into the mainline tree, see process of net and net-next being merged into the mainline tree, see
the :ref:`netdev-FAQ` the `netdev-FAQ`_.
@ -147,7 +147,7 @@ request)::
Q: How do I indicate which tree (bpf vs. bpf-next) my patch should be applied to? Q: How do I indicate which tree (bpf vs. bpf-next) my patch should be applied to?
--------------------------------------------------------------------------------- ---------------------------------------------------------------------------------
A: The process is the very same as described in the :ref:`netdev-FAQ`, A: The process is the very same as described in the `netdev-FAQ`_,
so please read up on it. The subject line must indicate whether the so please read up on it. The subject line must indicate whether the
patch is a fix or rather "next-like" content in order to let the patch is a fix or rather "next-like" content in order to let the
maintainers know whether it is targeted at bpf or bpf-next. maintainers know whether it is targeted at bpf or bpf-next.
@ -206,7 +206,7 @@ ii) run extensive BPF test suite and
Once the BPF pull request was accepted by David S. Miller, then Once the BPF pull request was accepted by David S. Miller, then
the patches end up in net or net-next tree, respectively, and the patches end up in net or net-next tree, respectively, and
make their way from there further into mainline. Again, see the make their way from there further into mainline. Again, see the
:ref:`netdev-FAQ` for additional information e.g. on how often they are `netdev-FAQ`_ for additional information e.g. on how often they are
merged to mainline. merged to mainline.
Q: How long do I need to wait for feedback on my BPF patches? Q: How long do I need to wait for feedback on my BPF patches?
@ -230,7 +230,7 @@ Q: Are patches applied to bpf-next when the merge window is open?
----------------------------------------------------------------- -----------------------------------------------------------------
A: For the time when the merge window is open, bpf-next will not be A: For the time when the merge window is open, bpf-next will not be
processed. This is roughly analogous to net-next patch processing, processed. This is roughly analogous to net-next patch processing,
so feel free to read up on the :ref:`netdev-FAQ` about further details. so feel free to read up on the `netdev-FAQ`_ about further details.
During those two weeks of merge window, we might ask you to resend During those two weeks of merge window, we might ask you to resend
your patch series once bpf-next is open again. Once Linus released your patch series once bpf-next is open again. Once Linus released
@ -394,7 +394,7 @@ netdev kernel mailing list in Cc and ask for the fix to be queued up:
netdev@vger.kernel.org netdev@vger.kernel.org
The process in general is the same as on netdev itself, see also the The process in general is the same as on netdev itself, see also the
:ref:`netdev-FAQ`. `netdev-FAQ`_.
Q: Do you also backport to kernels not currently maintained as stable? Q: Do you also backport to kernels not currently maintained as stable?
---------------------------------------------------------------------- ----------------------------------------------------------------------
@ -410,7 +410,7 @@ Q: The BPF patch I am about to submit needs to go to stable as well
What should I do? What should I do?
A: The same rules apply as with netdev patch submissions in general, see A: The same rules apply as with netdev patch submissions in general, see
the :ref:`netdev-FAQ`. the `netdev-FAQ`_.
Never add "``Cc: stable@vger.kernel.org``" to the patch description, but Never add "``Cc: stable@vger.kernel.org``" to the patch description, but
ask the BPF maintainers to queue the patches instead. This can be done ask the BPF maintainers to queue the patches instead. This can be done
@ -685,7 +685,7 @@ when:
.. Links .. Links
.. _Documentation/process/: https://www.kernel.org/doc/html/latest/process/ .. _Documentation/process/: https://www.kernel.org/doc/html/latest/process/
.. _netdev-FAQ: Documentation/process/maintainer-netdev.rst .. _netdev-FAQ: https://www.kernel.org/doc/html/latest/process/maintainer-netdev.html
.. _selftests: .. _selftests:
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/ https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/
.. _Documentation/dev-tools/kselftest.rst: .. _Documentation/dev-tools/kselftest.rst: