Skip to content

Commit d56b0c4

Browse files
Byte-LabAlexei Starovoitov
authored andcommitted
bpf, docs: Fix link to netdev-FAQ target
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 <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Alexei Starovoitov <[email protected]>
1 parent c45eac5 commit d56b0c4

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Documentation/bpf/bpf_devel_QA.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ 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 :ref:`netdev-FAQ`
131+
the `netdev-FAQ`_.
132132

133133

134134

@@ -147,7 +147,7 @@ request)::
147147
Q: How do I indicate which tree (bpf vs. bpf-next) my patch should be applied to?
148148
---------------------------------------------------------------------------------
149149

150-
A: The process is the very same as described in the :ref:`netdev-FAQ`,
150+
A: The process is the very same as described in the `netdev-FAQ`_,
151151
so please read up on it. The subject line must indicate whether the
152152
patch is a fix or rather "next-like" content in order to let the
153153
maintainers know whether it is targeted at bpf or bpf-next.
@@ -206,7 +206,7 @@ ii) run extensive BPF test suite and
206206
Once the BPF pull request was accepted by David S. Miller, then
207207
the patches end up in net or net-next tree, respectively, and
208208
make their way from there further into mainline. Again, see the
209-
:ref:`netdev-FAQ` for additional information e.g. on how often they are
209+
`netdev-FAQ`_ for additional information e.g. on how often they are
210210
merged to mainline.
211211

212212
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?
230230
-----------------------------------------------------------------
231231
A: For the time when the merge window is open, bpf-next will not be
232232
processed. This is roughly analogous to net-next patch processing,
233-
so feel free to read up on the :ref:`netdev-FAQ` about further details.
233+
so feel free to read up on the `netdev-FAQ`_ about further details.
234234

235235
During those two weeks of merge window, we might ask you to resend
236236
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:
394394
395395

396396
The process in general is the same as on netdev itself, see also the
397-
:ref:`netdev-FAQ`.
397+
`netdev-FAQ`_.
398398

399399
Q: Do you also backport to kernels not currently maintained as stable?
400400
----------------------------------------------------------------------
@@ -410,7 +410,7 @@ Q: The BPF patch I am about to submit needs to go to stable as well
410410
What should I do?
411411

412412
A: The same rules apply as with netdev patch submissions in general, see
413-
the :ref:`netdev-FAQ`.
413+
the `netdev-FAQ`_.
414414

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

686686
.. Links
687687
.. _Documentation/process/: https://www.kernel.org/doc/html/latest/process/
688-
.. _netdev-FAQ: Documentation/process/maintainer-netdev.rst
688+
.. _netdev-FAQ: https://www.kernel.org/doc/html/latest/process/maintainer-netdev.html
689689
.. _selftests:
690690
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/
691691
.. _Documentation/dev-tools/kselftest.rst:

0 commit comments

Comments
 (0)