On 8/17/21 10:12 PM, Claudiu.Beznea@xxxxxxxxxxxxx wrote:
Hi Randy, On 10.08.2021 03:54, Randy Dunlap wrote:EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe Fix multiple kernel-doc warnings in sama7g5.c. There are several enums and structs that were not identified as such. There are also several anonymous structs (that scripts/kernel-doc has problems with), so add struct names to them. Fixes the following warnings: drivers/clk/at91/sama7g5.c:39: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * PLL clocks identifiers drivers/clk/at91/sama7g5.c:60: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * PLL type identifiers drivers/clk/at91/sama7g5.c:122: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * PLL clocks description drivers/clk/at91/sama7g5.c:289: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Master clock (MCK[1..4]) description drivers/clk/at91/sama7g5.c:341: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * System clock description drivers/clk/at91/sama7g5.c:365: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Peripheral clock description drivers/clk/at91/sama7g5.c:453: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Generic clock description drivers/clk/at91/sama7g5.c:339: warning: Function parameter or member 'ep_chg_id' not described in 'master_clock' Some kernel-doc warnings are still printed, but they are all due to problems in the kernel-doc script (if anyone is interested in playing with some Perl :). These warnings are: sama7g5.c:287: warning: Function parameter or member '{' not described in 'sama7g5_plls' sama7g5.c:287: warning: Function parameter or member '' not described in 'sama7g5_plls' sama7g5.c:287: warning: Function parameter or member '}' not described in 'sama7g5_plls' sama7g5.c:339: warning: Function parameter or member 'sama7g5_mckx' not described in 'master_clock' sama7g5.c:339: warning: Function parameter or member '}' not described in 'master_clock' sama7g5.c:360: warning: Function parameter or member 'sama7g5_systemck' not described in 'system_clock' sama7g5.c:451: warning: Function parameter or member 'sama7g5_periphck' not described in 'periph_clock' sama7g5.c:451: warning: Function parameter or member '' not described in 'periph_clock' sama7g5.c:451: warning: Function parameter or member '}' not described in 'periph_clock' sama7g5.c:841: warning: Function parameter or member 'sama7g5_gck' not described in 'generic_clock' sama7g5.c:841: warning: Function parameter or member '}' not described in 'generic_clock'What about keeping only one '*' instead of '**' where necessary as these data structures are only local to sama7g5.c file (according to Documentation/doc-guide/kernel-doc.rst "Functions and data structures in header files which are intended to be used by modules should also have kernel-doc comments."). This way all the warnings will be gone.
Sure, that works too. I'll send an updated patch. thanks. -- ~Randy
