2020-06-30 13:53:22

by Lee Jones

Subject: [PATCH 03/10] gpio: gpio-ml-ioh: Fix missing ':' in 'struct ioh_gpio_reg_data

'struct ioh_gpio_reg_data's 'ien_reg' property is missing a ':'
which confuses the kerneldoc tooling/parsers/validators.

Replacing it squashes the following W=1 warning:

drivers/gpio/gpio-ml-ioh.c:63: warning: Function parameter or member 'ien_reg' not described in 'ioh_gpio_reg_data'

Cc: Andy Shevchenko <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
drivers/gpio/gpio-ml-ioh.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpio/gpio-ml-ioh.c b/drivers/gpio/gpio-ml-ioh.c
index 92b6e958cfed5..53d4abefa6ff2 100644
--- a/drivers/gpio/gpio-ml-ioh.c
+++ b/drivers/gpio/gpio-ml-ioh.c
@@ -44,7 +44,7 @@ struct ioh_regs {

/**
* struct ioh_gpio_reg_data - The register store data.
- * @ien_reg To store contents of interrupt enable register.
+ * @ien_reg: To store contents of interrupt enable register.
* @imask_reg: To store contents of interrupt mask regist
* @po_reg: To store contents of PO register.
* @pm_reg: To store contents of PM register.
--
2.25.1

2020-06-30 14:03:30

by Andy Shevchenko

Subject: Re: [PATCH 03/10] gpio: gpio-ml-ioh: Fix missing ':' in 'struct ioh_gpio_reg_data

On Tue, Jun 30, 2020 at 02:33:38PM +0100, Lee Jones wrote:
> 'struct ioh_gpio_reg_data's 'ien_reg' property is missing a ':'
> which confuses the kerneldoc tooling/parsers/validators.
>
> Replacing it squashes the following W=1 warning:
>
> drivers/gpio/gpio-ml-ioh.c:63: warning: Function parameter or member 'ien_reg' not described in 'ioh_gpio_reg_data'

Applied, thanks!

>
> Cc: Andy Shevchenko <[email protected]>
> Signed-off-by: Lee Jones <[email protected]>
> ---
> drivers/gpio/gpio-ml-ioh.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpio/gpio-ml-ioh.c b/drivers/gpio/gpio-ml-ioh.c
> index 92b6e958cfed5..53d4abefa6ff2 100644
> --- a/drivers/gpio/gpio-ml-ioh.c
> +++ b/drivers/gpio/gpio-ml-ioh.c
> @@ -44,7 +44,7 @@ struct ioh_regs {
>
> /**
> * struct ioh_gpio_reg_data - The register store data.
> - * @ien_reg To store contents of interrupt enable register.
> + * @ien_reg: To store contents of interrupt enable register.
> * @imask_reg: To store contents of interrupt mask regist
> * @po_reg: To store contents of PO register.
> * @pm_reg: To store contents of PM register.
> --
> 2.25.1
>

--
With Best Regards,
Andy Shevchenko