From: "Jonathan Neuschäfer" <j.neuschaefer@gmx•net>
To: Jonathan Corbet <corbet@lwn•net>
Cc: "Jonathan Neuschäfer" <j.neuschaefer@gmx•net>,
linux-doc@vger•kernel.org,
"David S. Miller" <davem@davemloft•net>,
"Alexei Starovoitov" <ast@kernel•org>,
"Daniel Borkmann" <daniel@iogearbox•net>,
"Jakub Kicinski" <jakub.kicinski@netronome•com>,
"Jesper Dangaard Brouer" <hawk@kernel•org>,
"John Fastabend" <john.fastabend@gmail•com>,
netdev@vger•kernel.org, xdp-newbies@vger•kernel.org,
bpf@vger•kernel.org, linux-kernel@vger•kernel.org
Subject: Re: [PATCH] Documentation/networking/af_xdp: Inhibit reference to struct socket
Date: Sun, 11 Aug 2019 13:32:25 +0200 [thread overview]
Message-ID: <20190811113225.GD1966@latitude> (raw)
In-Reply-To: <20190810085821.11cee8b0@lwn.net>
[-- Attachment #1: Type: text/plain, Size: 971 bytes --]
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
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
prev parent reply other threads:[~2019-08-11 11:33 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-10 12:17 [PATCH] Documentation/networking/af_xdp: Inhibit reference to struct socket Jonathan Neuschäfer
2019-08-10 14:58 ` Jonathan Corbet
2019-08-11 11:32 ` Jonathan Neuschäfer [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190811113225.GD1966@latitude \
--to=j.neuschaefer@gmx$(echo .)net \
--cc=ast@kernel$(echo .)org \
--cc=bpf@vger$(echo .)kernel.org \
--cc=corbet@lwn$(echo .)net \
--cc=daniel@iogearbox$(echo .)net \
--cc=davem@davemloft$(echo .)net \
--cc=hawk@kernel$(echo .)org \
--cc=jakub.kicinski@netronome$(echo .)com \
--cc=john.fastabend@gmail$(echo .)com \
--cc=linux-doc@vger$(echo .)kernel.org \
--cc=linux-kernel@vger$(echo .)kernel.org \
--cc=netdev@vger$(echo .)kernel.org \
--cc=xdp-newbies@vger$(echo .)kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox