[11/15] mmc: host: sdhci-of-arasan: Correct formatting and provide missing function arg(s)
diff mbox series

Message ID 20200701124702.908713-12-lee.jones@linaro.org
State In Next
Commit 253030e2a0be5293b12fa6fce3136b9aeed8788b
Headers show
Series
  • Clean-up MMC's W=1 build warnings
Related show

Commit Message

Lee Jones July 1, 2020, 12:46 p.m. UTC
Kerneldoc expects arg descriptions to be in the format '@.*: '.  If either
the '@' or the ':' is omitted then kerneldoc complains that the description
is missing.  Add the missing ':' here and provide a new description for
'value'.

Fixes the following kernel build W=1 warnings:

 drivers/mmc/host/sdhci-of-arasan.c:1394: warning: Function parameter or member 'host' not described in 'sdhci_arasan_update_support64b'
 drivers/mmc/host/sdhci-of-arasan.c:1394: warning: Function parameter or member 'value' not described in 'sdhci_arasan_update_support64b'
 drivers/mmc/host/sdhci-msm.c:1887:6: warning: no previous prototype for ‘sdhci_msm_dump_vendor_regs’ [-Wmissing-prototypes]

Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Michal Simek <michal.simek@xilinx.com>
Cc: Xiaobo Xie <X.Xie@freescale.com>
Cc: Anton Vorontsov <avorontsov@ru.mvista.com>
Cc: Soeren Brinkmann <soren.brinkmann@xilinx.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/mmc/host/sdhci-of-arasan.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Michal Simek July 8, 2020, 7:53 a.m. UTC | #1
On 01. 07. 20 14:46, Lee Jones wrote:
> Kerneldoc expects arg descriptions to be in the format '@.*: '.  If either
> the '@' or the ':' is omitted then kerneldoc complains that the description
> is missing.  Add the missing ':' here and provide a new description for
> 'value'.
> 
> Fixes the following kernel build W=1 warnings:
> 
>  drivers/mmc/host/sdhci-of-arasan.c:1394: warning: Function parameter or member 'host' not described in 'sdhci_arasan_update_support64b'
>  drivers/mmc/host/sdhci-of-arasan.c:1394: warning: Function parameter or member 'value' not described in 'sdhci_arasan_update_support64b'
>  drivers/mmc/host/sdhci-msm.c:1887:6: warning: no previous prototype for ‘sdhci_msm_dump_vendor_regs’ [-Wmissing-prototypes]
> 
> Cc: Adrian Hunter <adrian.hunter@intel.com>
> Cc: Michal Simek <michal.simek@xilinx.com>
> Cc: Xiaobo Xie <X.Xie@freescale.com>
> Cc: Anton Vorontsov <avorontsov@ru.mvista.com>
> Cc: Soeren Brinkmann <soren.brinkmann@xilinx.com>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
>  drivers/mmc/host/sdhci-of-arasan.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/mmc/host/sdhci-of-arasan.c b/drivers/mmc/host/sdhci-of-arasan.c
> index db9b544465cda..260e06e238f7e 100644
> --- a/drivers/mmc/host/sdhci-of-arasan.c
> +++ b/drivers/mmc/host/sdhci-of-arasan.c
> @@ -1388,7 +1388,8 @@ static void sdhci_arasan_unregister_sdclk(struct device *dev)
>   * - For Keem Bay, it is required to clear this bit. Its default value is 1'b1.
>   *   Keem Bay does not support 64-bit access.
>   *
> - * @host		The sdhci_host
> + * @host:		The sdhci_host
> + * @value:		The value to write
>   */
>  static void sdhci_arasan_update_support64b(struct sdhci_host *host, u32 value)
>  {
> 

Acked-by: Michal Simek <michal.simek@xilinx.com>

Thanks,
Michal

Patch
diff mbox series

diff --git a/drivers/mmc/host/sdhci-of-arasan.c b/drivers/mmc/host/sdhci-of-arasan.c
index db9b544465cda..260e06e238f7e 100644
--- a/drivers/mmc/host/sdhci-of-arasan.c
+++ b/drivers/mmc/host/sdhci-of-arasan.c
@@ -1388,7 +1388,8 @@  static void sdhci_arasan_unregister_sdclk(struct device *dev)
  * - For Keem Bay, it is required to clear this bit. Its default value is 1'b1.
  *   Keem Bay does not support 64-bit access.
  *
- * @host		The sdhci_host
+ * @host:		The sdhci_host
+ * @value:		The value to write
  */
 static void sdhci_arasan_update_support64b(struct sdhci_host *host, u32 value)
 {