kernel-doc: fix declaration type determination
authorRandy Dunlap <rdunlap@infradead.org>
Thu, 18 Oct 2018 04:07:27 +0000 (21:07 -0700)
committerJonathan Corbet <corbet@lwn.net>
Thu, 18 Oct 2018 18:20:35 +0000 (12:20 -0600)
commitcf419d542f1d3de80034ebb0462d9ed9b1ae9277
tree2cee430e2355e51601584832079956360fcc6b32
parent418ca3de75cd5e4130a6f2d5bd76ccb8e3f6e461
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>
scripts/kernel-doc