]> asedeno.scripts.mit.edu Git - linux.git/commit
Documentation: sphinx: Don't parse socket() as identifier reference
authorJonathan Neuschäfer <j.neuschaefer@gmx.net>
Mon, 12 Aug 2019 16:07:05 +0000 (18:07 +0200)
committerJonathan Corbet <corbet@lwn.net>
Mon, 12 Aug 2019 20:55:30 +0000 (14:55 -0600)
commit82bf829b692d6bc9c44cd43ddd75a9b04f1bfa8d
tree06d6ff7f9ae14c9d67b4817bcb2630eff692eb15
parent11fec009d97e5bd2329ef7d52d71e9f6763f1048
Documentation: sphinx: Don't parse socket() as identifier reference

With the introduction of Documentation/sphinx/automarkup.py, socket() is
parsed as a reference to the in-kernel definition of socket. Sphinx then
decides that struct socket is a good match, which is usually not
intended, when the syscall is meant instead. This was observed in
Documentation/networking/af_xdp.rst.

Prevent socket() from being misinterpreted by adding it to the Skipfuncs
list in automarkup.py.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/sphinx/automarkup.py