linux/Documentation/sphinx
Jonathan Neuschäfer 82bf829b69 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>
2019-08-12 14:55:30 -06:00
..
automarkup.py Documentation: sphinx: Don't parse socket() as identifier reference 2019-08-12 14:55:30 -06:00
cdomain.py docs: cdomain.py: get rid of a warning since version 1.8 2019-05-29 15:47:32 -06:00
kernel_include.py
kerneldoc.py doc: Cope with the deprecation of AutoReporter 2019-05-23 09:23:11 -06:00
kernellog.py doc: Cope with Sphinx logging deprecations 2019-05-23 09:22:00 -06:00
kfigure.py doc: Cope with Sphinx logging deprecations 2019-05-23 09:22:00 -06:00
load_config.py docs: load_config.py: ensure subdirs end with "/" 2019-07-19 08:49:27 -03:00
parse-headers.pl doc:sphinx: fix parse-header description 2018-06-26 09:07:57 -06:00
requirements.txt docs: requirements.txt: recommend Sphinx 1.7.9 2019-05-30 10:42:05 -06:00
rstFlatTable.py Documentation: rstFlatTable.py: fix a broken reference 2018-06-15 18:10:01 -03:00