scripts: kernel-doc: Report excess struct member descriptions
PATCH 1/1 scripts: kernel-doc: Report excess struct member descriptions
While missing descriptions were already be reported, missing struct members were not. For example, previously this output was empty, but now produces:
$ ./scripts/kernel-doc -none ./drivers/leds/leds-mlxreg.c ./drivers/leds/leds-mlxreg.c:42: warning: Excess struct member 'led_data' description in 'mlxreg_led_data'
--- scripts/kernel-doc | 12 ++++++++++++ 1 file changed, 12 insertions(+)
scripts/kernel-doc +12 -0
@@ -1265,6 +1265,18 @@ sub dump_struct($$) { $declaration .= "\t" . $clause . "\n"; $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/)); } + + my %_members; + $_members{$_}++ for (@parameterlist); + + while (my ($k, $v) = each %parameterdescs) { + if (!exists($_members{$k})) { + if (show_warnings("struct", $declaration_name)) { + emit_warning("${file}:$.", "Excess struct member '$k' description in '$declaration_name'\n"); + } + } + } + output_declaration($declaration_name, 'struct', {'struct' => $declaration_name,
Signature · 1 line
2.34.1
Randy Dunlap
reviewerHi Kees,
Quoted 6 lines · Kees Cook
While missing descriptions were already be reported, missing struct members were not. For example, previously this output was empty, but now produces:
$ ./scripts/kernel-doc -none ./drivers/leds/leds-mlxreg.c ./drivers/leds/leds-mlxreg.c:42: warning: Excess struct member 'led_data' description in 'mlxreg_led_data'
I just made a patch with similar functionality last night:
https://lore.kernel.org/linux-doc/[email protected]/
Quoted 31 lines
Cc Jonathan Corbet <[email protected]>Signed-off-by Kees Cook <[email protected]>--- scripts/kernel-doc | 12 ++++++++++++ 1 file changed, 12 insertions(+)scripts/kernel-doc +12
-0@@ -1265,6 +1265,18 @@ sub dump_struct($$) { $declaration .= "\t" . $clause . "\n"; $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/)); } + + my %_members; + $_members{$_}++ for (@parameterlist); + + while (my ($k, $v) = each %parameterdescs) { + if (!exists($_members{$k})) { + if (show_warnings("struct", $declaration_name)) { + emit_warning("${file}:$.", "Excess struct member '$k' description in '$declaration_name'\n"); + } + } + } + output_declaration($declaration_name, 'struct', {'struct' => $declaration_name,
Signature · 3 lines
#Randy https://people.kernel.org/tglx/notes-about-netiquette https://subspace.kernel.org/etiquette.html
Quoted 7 lines · Randy Dunlap
Hi Kees,
Quoted 4 lines · Kees Cook
While missing descriptions were already be reported, missing struct members were not. For example, previously this output was empty, but now produces:
Quoted 6 lines
Quoted 2 lines
$ ./scripts/kernel-doc -none ./drivers/leds/leds-mlxreg.c ./drivers/leds/leds-mlxreg.c:42: warning: Excess struct member 'led_data' description in 'mlxreg_led_data'I just made a patch with similar functionality last night:
Ah-ha! So you're as confused as me about where the robot was getting warnings from! Your patch is better.
-Kees
Signature · 1 line
Kees Cook