| Message ID | 20231215001451.work.746-kees@kernel.org (mailing list archive) |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | scripts: kernel-doc: Report excess struct member descriptions | expand |
Hi Kees, On 12/14/23 16:14, Kees Cook wrote: > 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/20231214070200.24405-1-rdunlap@infradead.org/ > > Cc: Jonathan Corbet <corbet@lwn.net> > Cc: linux-doc@vger.kernel.org > Signed-off-by: Kees Cook <keescook@chromium.org> > --- > scripts/kernel-doc | 12 ++++++++++++ > 1 file changed, 12 insertions(+) > > diff --git a/scripts/kernel-doc b/scripts/kernel-doc > index 08a3e603db19..39e730ee1fef 100755 > --- a/scripts/kernel-doc > +++ b/scripts/kernel-doc > @@ -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,
On Thu, Dec 14, 2023 at 04:21:17PM -0800, Randy Dunlap wrote: > Hi Kees, > > On 12/14/23 16:14, Kees Cook wrote: > > 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/20231214070200.24405-1-rdunlap@infradead.org/ Ah-ha! So you're as confused as me about where the robot was getting warnings from! Your patch is better. -Kees
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 08a3e603db19..39e730ee1fef 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -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,
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' Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Signed-off-by: Kees Cook <keescook@chromium.org> --- scripts/kernel-doc | 12 ++++++++++++ 1 file changed, 12 insertions(+)