Messages in this thread Patch in this message | | | From | Jonathan Neuschäfer <> | Subject | [PATCH v2 2/2] Documentation: sphinx: Don't parse socket() as identifier reference | Date | Mon, 12 Aug 2019 18:07:05 +0200 |
| |
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> ---
v2: - block socket() in Documentation/sphinx/automarkup.py, as suggested by Jonathan Corbet
v1: - https://lore.kernel.org/lkml/20190810121738.19587-1-j.neuschaefer@gmx.net/ --- Documentation/sphinx/automarkup.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/sphinx/automarkup.py b/Documentation/sphinx/automarkup.py index a8798369e8f7..5b6119ff69f4 100644 --- a/Documentation/sphinx/automarkup.py +++ b/Documentation/sphinx/automarkup.py @@ -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 -- 2.20.1
| |