Skip to content

Commit b77fdd6

Browse files
rddunlapJonathan Corbet
authored andcommitted
scripts/kernel-doc: restore warning for Excess struct/union
The warning for Excess struct or union member description was removed when the $nested parameter of check_sections() was removed. This causes some kernel-doc notation warnings to be missed. Recently the kernel test robot somehow reported an Excess member. The code in kernel-doc has not issued that warning since kernel v4.16, so I don't know how the robot did it. (See the Link for the report.) drivers/net/wireless/intel/iwlwifi/fw/dbg.c:86: warning: Excess struct/union/enum/typedef member 'trans_len' description in 'iwl_fw_dump_ptrs' I patched that warning away even though I could not reproduce the warning from kernel-doc. The warning should be issued for extraneous struct member or union member description, so restore it. Fixes: 1081de2 ("scripts: kernel-doc: get rid of $nested parameter") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/all/202312060810.QT9zourt-lkp@intel.com/ Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Reviewed-by: Kees Cook <keescook@chromium.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20231214070200.24405-1-rdunlap@infradead.org
1 parent 121d0ba commit b77fdd6

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

scripts/kernel-doc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1654,6 +1654,13 @@ sub check_sections($$$$$) {
16541654
"'$sects[$sx]' " .
16551655
"description in '$decl_name'\n");
16561656
}
1657+
elsif (($decl_type eq "struct") or
1658+
($decl_type eq "union")) {
1659+
emit_warning("${file}:$.",
1660+
"Excess $decl_type member " .
1661+
"'$sects[$sx]' " .
1662+
"description in '$decl_name'\n");
1663+
}
16571664
}
16581665
}
16591666
}

0 commit comments

Comments
 (0)