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

[Jonathan Corbet]

On Sat, 10 Aug 2019 14:17:37 +0200
Jonathan NeuschÃfer <j.neuschaefer@xxxxxxx> 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@xxxxxxx>

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