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

Message ID 20200630133345.2232932-4-lee.jones@linaro.org
State New
Headers show
Series
  • Clean GPIO of W=1 warnings
Related show

Commit Message

Lee Jones June 30, 2020, 1:33 p.m.
'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 <andy@kernel.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/gpio/gpio-ml-ioh.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

-- 
2.25.1

Comments

Andy Shevchenko June 30, 2020, 2:01 p.m. | #1
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 <andy@kernel.org>

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

> ---

>  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

Patch

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.