diff mbox series

mailbox: zynqmp-ipi: fix an Excess struct member kernel-doc warning

Message ID 20231216004156.26967-1-rdunlap@infradead.org
State New
Headers
Series mailbox: zynqmp-ipi: fix an Excess struct member kernel-doc warning |

Commit Message

Randy Dunlap Dec. 16, 2023, 12:41 a.m. UTC 
  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 <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202312150705.glrQ4ypv-lkp@intel.com/
Cc: Jassi Brar <jassisinghbrar@gmail.com>
Cc: Michal Simek <michal.simek@amd.com>
Cc: linux-arm-kernel@lists.infradead.org
---
 drivers/mailbox/zynqmp-ipi-mailbox.c |    1 -
 1 file changed, 1 deletion(-)

Comments

Michal Simek Dec. 18, 2023, 7:04 a.m. UTC | #1 
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 <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202312150705.glrQ4ypv-lkp@intel.com/
> Cc: Jassi Brar <jassisinghbrar@gmail.com>
> Cc: Michal Simek <michal.simek@amd.com>
> Cc: linux-arm-kernel@lists.infradead.org
> ---
>   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 <michal.simek@amd.com>

Thanks,
Michal
diff mbox series

Patch

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;