Re: [PATCH v2] mailbox: sti: fix struct description warnings

Lee Jones
2020-09-09T06:24:31Z

On Wed, 09 Sep 2020, Alain Volmat wrote:

> Fix formating of struct description to avoid warning highlighted
> by W=1 compilation.

Apologies for not mentioning this before, but it would be nice to have
the warning quoted in the commit message.

> Signed-off-by: Alain Volmat <avolmat@me.com>
> ---
> v2: fixes tag removed
>
> drivers/mailbox/mailbox-sti.c | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)

The patch itself looks fine however:

Reviewed-by: Lee Jones <lee.jones@linaro.org>

> diff --git a/drivers/mailbox/mailbox-sti.c b/drivers/mailbox/mailbox-sti.c
> index 2baf69a0b81c..0f2bc09c364d 100644
> --- a/drivers/mailbox/mailbox-sti.c
> +++ b/drivers/mailbox/mailbox-sti.c
> @@ -36,7 +36,7 @@
> #define MBOX_BASE(mdev, inst) ((mdev)->base + ((inst) * 4))
>
> /**
> - * STi Mailbox device data
> + * struct sti_mbox_device - STi Mailbox device data
> *
> * An IP Mailbox is currently composed of 4 instances
> * Each instance is currently composed of 32 channels
> @@ -60,7 +60,7 @@ struct sti_mbox_device {
> };
>
> /**
> - * STi Mailbox platform specific configuration
> + * struct sti_mbox_pdata - STi Mailbox platform specific configuration
> *
> * @num_inst: Maximum number of instances in one HW Mailbox
> * @num_chan: Maximum number of channel per instance
> @@ -71,7 +71,7 @@ struct sti_mbox_pdata {
> };
>
> /**
> - * STi Mailbox allocated channel information
> + * struct sti_channel - STi Mailbox allocated channel information
> *
> * @mdev: Pointer to parent Mailbox device
> * @instance: Instance number channel resides in

--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog