[PATCH v2 2/2] Documentation: sphinx: Don't parse socket() as identifier reference

From: Jonathan NeuschÃfer
Date: Mon Aug 12 2019 - 12:08:01 EST

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

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

Signed-off-by: Jonathan NeuschÃfer <j.neuschaefer@xxxxxxx>

- block socket() in Documentation/sphinx/automarkup.py, as suggested by
Jonathan Corbet

- https://lore.kernel.org/lkml/20190810121738.19587-1-j.neuschaefer@xxxxxxx/
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