diff options
author | Randy Dunlap <rdunlap@infradead.org> | 2018-10-17 21:07:27 -0700 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2018-10-18 12:20:35 -0600 |
commit | cf419d542f1d3de80034ebb0462d9ed9b1ae9277 (patch) | |
tree | 2cee430e2355e51601584832079956360fcc6b32 /scripts/kernel-doc | |
parent | 418ca3de75cd5e4130a6f2d5bd76ccb8e3f6e461 (diff) | |
download | lwn-cf419d542f1d3de80034ebb0462d9ed9b1ae9277.tar.gz lwn-cf419d542f1d3de80034ebb0462d9ed9b1ae9277.zip |
kernel-doc: fix declaration type determination
Make declaration type determination more robust.
When scripts/kernel-doc is deciding if some kernel-doc notation
contains an enum, a struct, a union, a typedef, or a function,
it does a pattern match on the beginning of the string, looking
for a match with one of "struct", "union", "enum", or "typedef",
and otherwise defaults to a function declaration type.
However, if a function or a function-like macro has a name that
begins with "struct" (e.g., struct_size()), then kernel-doc
incorrectly decides that this is a struct declaration.
Fix this by looking for the declaration type keywords having an
ending word boundary (\b), so that "struct_size" will not match
a struct declaration.
I compared lots of html before/after output from core-api, driver-api,
and networking. There were no differences in any of the files that
I checked.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Jani Nikula <jani.nikula@intel.com>
Tested-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts/kernel-doc')
-rwxr-xr-x | scripts/kernel-doc | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 8f0f508a78e9..ffbe901a37b5 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -1904,13 +1904,13 @@ sub process_name($$) { ++$warnings; } - if ($identifier =~ m/^struct/) { + if ($identifier =~ m/^struct\b/) { $decl_type = 'struct'; - } elsif ($identifier =~ m/^union/) { + } elsif ($identifier =~ m/^union\b/) { $decl_type = 'union'; - } elsif ($identifier =~ m/^enum/) { + } elsif ($identifier =~ m/^enum\b/) { $decl_type = 'enum'; - } elsif ($identifier =~ m/^typedef/) { + } elsif ($identifier =~ m/^typedef\b/) { $decl_type = 'typedef'; } else { $decl_type = 'function'; |