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>
This commit is contained in:
parent
11fec009d9
commit
82bf829b69
1 changed files with 2 additions and 1 deletions
|
@ -26,7 +26,8 @@ RE_function = re.compile(r'([\w_][\w\d_]+\(\))')
|
|||
# just don't even try with these names.
|
||||
#
|
||||
Skipfuncs = [ 'open', 'close', 'read', 'write', 'fcntl', 'mmap',
|
||||
'select', 'poll', 'fork', 'execve', 'clone', 'ioctl']
|
||||
'select', 'poll', 'fork', 'execve', 'clone', 'ioctl',
|
||||
'socket' ]
|
||||
|
||||
#
|
||||
# Find all occurrences of function() and try to replace them with
|
||||
|
|
Loading…
Reference in a new issue