Skip to content

Commit

Permalink
kernel-doc: fix declaration type determination
Browse files Browse the repository at this point in the history
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 <[email protected]>
Acked-by: Jani Nikula <[email protected]>
Tested-by: Kees Cook <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
  • Loading branch information
rddunlap authored and Jonathan Corbet committed Oct 18, 2018
1 parent 418ca3d commit cf419d5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions scripts/kernel-doc
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down

0 comments on commit cf419d5

Please sign in to comment.