2023-12-16 00:42:07

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] mailbox: zynqmp-ipi: fix an Excess struct member kernel-doc warning

kernel test robot reports 2 Excess struct member warnings:

zynqmp-ipi-mailbox.c:92: warning: Excess struct member 'irq' description in 'zynqmp_ipi_mbox'
zynqmp-ipi-mailbox.c:112: warning: Excess struct member 'ipi_mboxes' description in 'zynqmp_ipi_pdata'

The second one is a false positive that is caused by the
__counted_by() attribute. Kees has posted a patch for that, so just
fix the first one.

Signed-off-by: Randy Dunlap <[email protected]>
Reported-by: kernel test robot <[email protected]>
Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
Cc: Jassi Brar <[email protected]>
Cc: Michal Simek <[email protected]>
Cc: [email protected]
---
drivers/mailbox/zynqmp-ipi-mailbox.c | 1 -
1 file changed, 1 deletion(-)

diff -- a/drivers/mailbox/zynqmp-ipi-mailbox.c b/drivers/mailbox/zynqmp-ipi-mailbox.c
--- a/drivers/mailbox/zynqmp-ipi-mailbox.c
+++ b/drivers/mailbox/zynqmp-ipi-mailbox.c
@@ -81,7 +81,6 @@ struct zynqmp_ipi_mchan {
* @remote_id: remote IPI agent ID
* @mbox: mailbox Controller
* @mchans: array for channels, tx channel and rx channel.
- * @irq: IPI agent interrupt ID
*/
struct zynqmp_ipi_mbox {
struct zynqmp_ipi_pdata *pdata;


2023-12-18 07:04:52

by Michal Simek

[permalink] [raw]
Subject: Re: [PATCH] mailbox: zynqmp-ipi: fix an Excess struct member kernel-doc warning



On 12/16/23 01:41, Randy Dunlap wrote:
> kernel test robot reports 2 Excess struct member warnings:
>
> zynqmp-ipi-mailbox.c:92: warning: Excess struct member 'irq' description in 'zynqmp_ipi_mbox'
> zynqmp-ipi-mailbox.c:112: warning: Excess struct member 'ipi_mboxes' description in 'zynqmp_ipi_pdata'
>
> The second one is a false positive that is caused by the
> __counted_by() attribute. Kees has posted a patch for that, so just
> fix the first one.
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Reported-by: kernel test robot <[email protected]>
> Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
> Cc: Jassi Brar <[email protected]>
> Cc: Michal Simek <[email protected]>
> Cc: [email protected]
> ---
> drivers/mailbox/zynqmp-ipi-mailbox.c | 1 -
> 1 file changed, 1 deletion(-)
>
> diff -- a/drivers/mailbox/zynqmp-ipi-mailbox.c b/drivers/mailbox/zynqmp-ipi-mailbox.c
> --- a/drivers/mailbox/zynqmp-ipi-mailbox.c
> +++ b/drivers/mailbox/zynqmp-ipi-mailbox.c
> @@ -81,7 +81,6 @@ struct zynqmp_ipi_mchan {
> * @remote_id: remote IPI agent ID
> * @mbox: mailbox Controller
> * @mchans: array for channels, tx channel and rx channel.
> - * @irq: IPI agent interrupt ID
> */
> struct zynqmp_ipi_mbox {
> struct zynqmp_ipi_pdata *pdata;

Reviewed-by: Michal Simek <[email protected]>

Thanks,
Michal