| Message ID | 20190810121738.19587-1-j.neuschaefer@gmx.net |
|---|---|
| State | Changes Requested |
| Delegated to: | David Miller |
| Headers | show |
| Series | Documentation/networking/af_xdp: Inhibit reference to struct socket | expand |
On Sat, 10 Aug 2019 14:17:37 +0200 Jonathan Neuschäfer <j.neuschaefer@gmx.net> 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
On Sat, Aug 10, 2019 at 08:58:21AM -0600, Jonathan Corbet wrote: > On Sat, 10 Aug 2019 14:17:37 +0200 > Jonathan Neuschäfer <j.neuschaefer@gmx.net> 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. Alright, I'll do that for v2. Thanks, Jonathan Neuschäfer
diff --git a/Documentation/networking/af_xdp.rst b/Documentation/networking/af_xdp.rst index eeedc2e826aa..54f179ee6c33 100644 --- a/Documentation/networking/af_xdp.rst +++ b/Documentation/networking/af_xdp.rst @@ -20,7 +20,7 @@ bpf_redirect_map() function. AF_XDP sockets enable the possibility for XDP programs to redirect frames to a memory buffer in a user-space application. -An AF_XDP socket (XSK) is created with the normal socket() +An AF_XDP socket (XSK) is created with the normal ``socket()`` syscall. Associated with each XSK are two rings: the RX ring and the TX ring. A socket can receive packets on the RX ring and it can send packets on the TX ring. These rings are registered and sized with the
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> --- Documentation/networking/af_xdp.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) -- 2.20.1