[03/25] pinctrl: bcm: pinctrl-bcm281xx: Demote obvious misuse of kerneldoc to standard comment blocks

Message ID 20200713144930.1034632-4-lee.jones@linaro.org
State Accepted
Commit 1294754e1c1f72809e1bf9a6ecd209f472c5adb7
Headers show
Series
  • Rid W=1 warnings in Pinctrl
Related show

Commit Message

Lee Jones July 13, 2020, 2:49 p.m.
There has been little to no attempt to document any of the demoted
structures here.  These are obviously not kerneldoc headers.

Fixes the following W=1 kernel build warning(s):

 drivers/pinctrl/bcm/pinctrl-bcm281xx.c:65: warning: cannot understand function prototype: 'enum bcm281xx_pin_type '
 drivers/pinctrl/bcm/pinctrl-bcm281xx.c:79: warning: cannot understand function prototype: 'struct bcm281xx_pin_function '
 drivers/pinctrl/bcm/pinctrl-bcm281xx.c:89: warning: cannot understand function prototype: 'struct bcm281xx_pinctrl_data '

Cc: Florian Fainelli <f.fainelli@gmail.com>
Cc: Ray Jui <rjui@broadcom.com>
Cc: Scott Branden <sbranden@broadcom.com>
Cc: bcm-kernel-feedback-list@broadcom.com
Cc: YueHaibing <yuehaibing@huawei.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/pinctrl/bcm/pinctrl-bcm281xx.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

-- 
2.25.1

Comments

Scott Branden July 13, 2020, 5:59 p.m. | #1
thanks.

On 2020-07-13 7:49 a.m., Lee Jones wrote:
> There has been little to no attempt to document any of the demoted

> structures here.  These are obviously not kerneldoc headers.

>

> Fixes the following W=1 kernel build warning(s):

>

>   drivers/pinctrl/bcm/pinctrl-bcm281xx.c:65: warning: cannot understand function prototype: 'enum bcm281xx_pin_type '

>   drivers/pinctrl/bcm/pinctrl-bcm281xx.c:79: warning: cannot understand function prototype: 'struct bcm281xx_pin_function '

>   drivers/pinctrl/bcm/pinctrl-bcm281xx.c:89: warning: cannot understand function prototype: 'struct bcm281xx_pinctrl_data '

>

> Cc: Florian Fainelli <f.fainelli@gmail.com>

> Cc: Ray Jui <rjui@broadcom.com>

> Cc: Scott Branden <sbranden@broadcom.com>

> Cc: bcm-kernel-feedback-list@broadcom.com

> Cc: YueHaibing <yuehaibing@huawei.com>

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

Acked-by: Scott Branden <scott.branden@broadcom.com>

> ---

>   drivers/pinctrl/bcm/pinctrl-bcm281xx.c | 6 +++---

>   1 file changed, 3 insertions(+), 3 deletions(-)

>

> diff --git a/drivers/pinctrl/bcm/pinctrl-bcm281xx.c b/drivers/pinctrl/bcm/pinctrl-bcm281xx.c

> index 71e6661783006..9ab1f427286a7 100644

> --- a/drivers/pinctrl/bcm/pinctrl-bcm281xx.c

> +++ b/drivers/pinctrl/bcm/pinctrl-bcm281xx.c

> @@ -59,7 +59,7 @@

>   #define BCM281XX_HDMI_PIN_REG_MODE_MASK		0x0010

>   #define BCM281XX_HDMI_PIN_REG_MODE_SHIFT	4

>   

> -/**

> +/*

>    * bcm281xx_pin_type - types of pin register

>    */

>   enum bcm281xx_pin_type {

> @@ -73,7 +73,7 @@ static enum bcm281xx_pin_type std_pin = BCM281XX_PIN_TYPE_STD;

>   static enum bcm281xx_pin_type i2c_pin = BCM281XX_PIN_TYPE_I2C;

>   static enum bcm281xx_pin_type hdmi_pin = BCM281XX_PIN_TYPE_HDMI;

>   

> -/**

> +/*

>    * bcm281xx_pin_function- define pin function

>    */

>   struct bcm281xx_pin_function {

> @@ -82,7 +82,7 @@ struct bcm281xx_pin_function {

>   	const unsigned ngroups;

>   };

>   

> -/**

> +/*

>    * bcm281xx_pinctrl_data - Broadcom-specific pinctrl data

>    * @reg_base - base of pinctrl registers

>    */

Patch

diff --git a/drivers/pinctrl/bcm/pinctrl-bcm281xx.c b/drivers/pinctrl/bcm/pinctrl-bcm281xx.c
index 71e6661783006..9ab1f427286a7 100644
--- a/drivers/pinctrl/bcm/pinctrl-bcm281xx.c
+++ b/drivers/pinctrl/bcm/pinctrl-bcm281xx.c
@@ -59,7 +59,7 @@ 
 #define BCM281XX_HDMI_PIN_REG_MODE_MASK		0x0010
 #define BCM281XX_HDMI_PIN_REG_MODE_SHIFT	4
 
-/**
+/*
  * bcm281xx_pin_type - types of pin register
  */
 enum bcm281xx_pin_type {
@@ -73,7 +73,7 @@  static enum bcm281xx_pin_type std_pin = BCM281XX_PIN_TYPE_STD;
 static enum bcm281xx_pin_type i2c_pin = BCM281XX_PIN_TYPE_I2C;
 static enum bcm281xx_pin_type hdmi_pin = BCM281XX_PIN_TYPE_HDMI;
 
-/**
+/*
  * bcm281xx_pin_function- define pin function
  */
 struct bcm281xx_pin_function {
@@ -82,7 +82,7 @@  struct bcm281xx_pin_function {
 	const unsigned ngroups;
 };
 
-/**
+/*
  * bcm281xx_pinctrl_data - Broadcom-specific pinctrl data
  * @reg_base - base of pinctrl registers
  */