diff options
| author |   Jonathan Neuschäfer <j.neuschaefer@gmx.net> | 2019-08-12 18:07:05 +0200 |
|---|---|---|
| committer |   Jonathan Corbet <corbet@lwn.net> | 2019-08-12 14:55:30 -0600 |
| commit | 82bf829b692d6bc9c44cd43ddd75a9b04f1bfa8d (patch) | |
| tree | 06d6ff7f9ae14c9d67b4817bcb2630eff692eb15 /Documentation/sphinx | |
| parent | Documentation: sphinx: Add missing comma to list of strings (diff) | |
| download | linux-dev-82bf829b692d6bc9c44cd43ddd75a9b04f1bfa8d.tar.xz linux-dev-82bf829b692d6bc9c44cd43ddd75a9b04f1bfa8d.zip | |
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>
Diffstat (limited to 'Documentation/sphinx')
| -rw-r--r-- | Documentation/sphinx/automarkup.py | 3 |
1 files changed, 2 insertions, 1 deletions
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 |