Skip to content

Commit 0f10f64

Browse files
bagasmeborkmann
authored andcommitted
bpf, docs: Use internal linking for link to netdev subsystem doc
Commit d56b0c4 ("bpf, docs: Fix link to netdev-FAQ target") attempts to fix linking problem to undefined "netdev-FAQ" label introduced in 287f4fa ("docs: Update references to netdev-FAQ") by changing internal cross reference to netdev subsystem documentation (Documentation/process/maintainer-netdev.rst) to external one at docs.kernel.org. However, the linking problem is still not resolved, as the generated link points to non-existent netdev-FAQ section of the external doc, which when clicked, will instead going to the top of the doc. Revert back to internal linking by simply mention the doc path while massaging the leading text to the link, since the netdev subsystem doc contains no FAQs but rather general information about the subsystem. Fixes: d56b0c4 ("bpf, docs: Fix link to netdev-FAQ target") Fixes: 287f4fa ("docs: Update references to netdev-FAQ") Signed-off-by: Bagas Sanjaya <[email protected]> Signed-off-by: Daniel Borkmann <[email protected]> Link: https://lore.kernel.org/bpf/[email protected]
1 parent bd5314f commit 0f10f64

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

Documentation/bpf/bpf_devel_QA.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,8 @@ into the bpf-next tree will make their way into net-next tree. net and
128128
net-next are both run by David S. Miller. From there, they will go
129129
into the kernel mainline tree run by Linus Torvalds. To read up on the
130130
process of net and net-next being merged into the mainline tree, see
131-
the `netdev-FAQ`_.
131+
the documentation on netdev subsystem at
132+
Documentation/process/maintainer-netdev.rst.
132133

133134

134135

@@ -147,7 +148,8 @@ request)::
147148
Q: How do I indicate which tree (bpf vs. bpf-next) my patch should be applied to?
148149
---------------------------------------------------------------------------------
149150

150-
A: The process is the very same as described in the `netdev-FAQ`_,
151+
A: The process is the very same as described in the netdev subsystem
152+
documentation at Documentation/process/maintainer-netdev.rst,
151153
so please read up on it. The subject line must indicate whether the
152154
patch is a fix or rather "next-like" content in order to let the
153155
maintainers know whether it is targeted at bpf or bpf-next.
@@ -206,8 +208,9 @@ ii) run extensive BPF test suite and
206208
Once the BPF pull request was accepted by David S. Miller, then
207209
the patches end up in net or net-next tree, respectively, and
208210
make their way from there further into mainline. Again, see the
209-
`netdev-FAQ`_ for additional information e.g. on how often they are
210-
merged to mainline.
211+
documentation for netdev subsystem at
212+
Documentation/process/maintainer-netdev.rst for additional information
213+
e.g. on how often they are merged to mainline.
211214

212215
Q: How long do I need to wait for feedback on my BPF patches?
213216
-------------------------------------------------------------
@@ -230,7 +233,8 @@ Q: Are patches applied to bpf-next when the merge window is open?
230233
-----------------------------------------------------------------
231234
A: For the time when the merge window is open, bpf-next will not be
232235
processed. This is roughly analogous to net-next patch processing,
233-
so feel free to read up on the `netdev-FAQ`_ about further details.
236+
so feel free to read up on the netdev docs at
237+
Documentation/process/maintainer-netdev.rst about further details.
234238

235239
During those two weeks of merge window, we might ask you to resend
236240
your patch series once bpf-next is open again. Once Linus released
@@ -394,7 +398,8 @@ netdev kernel mailing list in Cc and ask for the fix to be queued up:
394398
395399

396400
The process in general is the same as on netdev itself, see also the
397-
`netdev-FAQ`_.
401+
the documentation on networking subsystem at
402+
Documentation/process/maintainer-netdev.rst.
398403

399404
Q: Do you also backport to kernels not currently maintained as stable?
400405
----------------------------------------------------------------------
@@ -410,7 +415,7 @@ Q: The BPF patch I am about to submit needs to go to stable as well
410415
What should I do?
411416

412417
A: The same rules apply as with netdev patch submissions in general, see
413-
the `netdev-FAQ`_.
418+
the netdev docs at Documentation/process/maintainer-netdev.rst.
414419

415420
Never add "``Cc: [email protected]``" to the patch description, but
416421
ask the BPF maintainers to queue the patches instead. This can be done
@@ -685,7 +690,6 @@ when:
685690

686691
.. Links
687692
.. _Documentation/process/: https://www.kernel.org/doc/html/latest/process/
688-
.. _netdev-FAQ: https://www.kernel.org/doc/html/latest/process/maintainer-netdev.html
689693
.. _selftests:
690694
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/
691695
.. _Documentation/dev-tools/kselftest.rst:

0 commit comments

Comments
 (0)