[01/10] mfd: cros_ec_dev: Fix cros_feature_to_{name,cells} struct descriptions
diff mbox series

Message ID 20200625163127.4000462-2-lee.jones@linaro.org
State Accepted
Commit 5ae3d1bcea485e3f0056c508d2e12d1a95c453ee
Headers show
Series
  • Fix a yet more W=1 warnings in MFD
Related show

Commit Message

Lee Jones June 25, 2020, 4:31 p.m. UTC
Kerneldoc expects kernel structures to be prefixed with 'struct'.

Fixes the following W=1 level warnings:

 drivers/mfd/cros_ec_dev.c:32: warning: cannot understand function prototype: 'struct cros_feature_to_name '
 drivers/mfd/cros_ec_dev.c:44: warning: cannot understand function prototype: 'struct cros_feature_to_cells '

Cc: Benson Leung <bleung@chromium.org>
Cc: Enric Balletbo i Serra <enric.balletbo@collabora.com>
Cc: Guenter Roeck <groeck@chromium.org>
Cc: Bill Richardson <wfrichar@chromium.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/mfd/cros_ec_dev.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Enric Balletbo i Serra June 25, 2020, 4:35 p.m. UTC | #1
Hi Lee,

Thank you for fixing this.

On 25/6/20 18:31, Lee Jones wrote:
> Kerneldoc expects kernel structures to be prefixed with 'struct'.
> 
> Fixes the following W=1 level warnings:
> 
>  drivers/mfd/cros_ec_dev.c:32: warning: cannot understand function prototype: 'struct cros_feature_to_name '
>  drivers/mfd/cros_ec_dev.c:44: warning: cannot understand function prototype: 'struct cros_feature_to_cells '
> 
> Cc: Benson Leung <bleung@chromium.org>
> Cc: Enric Balletbo i Serra <enric.balletbo@collabora.com>
> Cc: Guenter Roeck <groeck@chromium.org>
> Cc: Bill Richardson <wfrichar@chromium.org>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>

Acked-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>

> ---
>  drivers/mfd/cros_ec_dev.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/mfd/cros_ec_dev.c b/drivers/mfd/cros_ec_dev.c
> index 32c2b912b58b2..d07b43d7c761a 100644
> --- a/drivers/mfd/cros_ec_dev.c
> +++ b/drivers/mfd/cros_ec_dev.c
> @@ -24,7 +24,7 @@ static struct class cros_class = {
>  };
>  
>  /**
> - * cros_feature_to_name - CrOS feature id to name/short description.
> + * struct cros_feature_to_name - CrOS feature id to name/short description.
>   * @id: The feature identifier.
>   * @name: Device name associated with the feature id.
>   * @desc: Short name that will be displayed.
> @@ -36,7 +36,7 @@ struct cros_feature_to_name {
>  };
>  
>  /**
> - * cros_feature_to_cells - CrOS feature id to mfd cells association.
> + * struct cros_feature_to_cells - CrOS feature id to mfd cells association.
>   * @id: The feature identifier.
>   * @mfd_cells: Pointer to the array of mfd cells that needs to be added.
>   * @num_cells: Number of mfd cells into the array.
>

Patch
diff mbox series

diff --git a/drivers/mfd/cros_ec_dev.c b/drivers/mfd/cros_ec_dev.c
index 32c2b912b58b2..d07b43d7c761a 100644
--- a/drivers/mfd/cros_ec_dev.c
+++ b/drivers/mfd/cros_ec_dev.c
@@ -24,7 +24,7 @@  static struct class cros_class = {
 };
 
 /**
- * cros_feature_to_name - CrOS feature id to name/short description.
+ * struct cros_feature_to_name - CrOS feature id to name/short description.
  * @id: The feature identifier.
  * @name: Device name associated with the feature id.
  * @desc: Short name that will be displayed.
@@ -36,7 +36,7 @@  struct cros_feature_to_name {
 };
 
 /**
- * cros_feature_to_cells - CrOS feature id to mfd cells association.
+ * struct cros_feature_to_cells - CrOS feature id to mfd cells association.
  * @id: The feature identifier.
  * @mfd_cells: Pointer to the array of mfd cells that needs to be added.
  * @num_cells: Number of mfd cells into the array.