Re: [PATCH] Documentation/networking/af_xdp: Inhibit reference to struct socket

From
Jonathan Corbet <corbet@lwn.net>
Date
2019-08-10 14:58:26
Also in
bpf, lkml, netdev
Reply to
Jonathan Neuschäfer, 2019-08-10
On Sat, 10 Aug 2019 14:17:37 +0200
Jonathan Neuschäfer [off-list ref] wrote:
With the recent change to auto-detect function names, Sphinx parses
socket() as a reference to the in-kernel definition of socket. It then
decides that struct socket is a good match, which was obviously not
intended in this case, because the text speaks about the syscall with
the same name.

Prevent socket() from being misinterpreted by wrapping it in ``inline
literal`` quotes.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Thanks for looking at that.  The better fix, though, would be to add
socket() to the Skipfuncs array in Documentation/sphinx/automarkup.py.
Then it will do the right thing everywhere without the need to add markup
to the RST files.

Thanks,

jon
Thread (3 messages) 3 messages, 2 authors, last reply 2019-08-11
Keyboard shortcuts
hback out one level
jnext message in thread / next series-diff position
kprevious message in thread / previous series-diff position
ldrill in
Escclose help / fold thread tree
?toggle this help