diff mbox series

mmc: sdhci-omap: don't misuse kernel-doc marker

Message ID 20231206055855.21092-1-rdunlap@infradead.org
State New
Headers
Series mmc: sdhci-omap: don't misuse kernel-doc marker |

Commit Message

Randy Dunlap Dec. 6, 2023, 5:58 a.m. UTC 
  Use "/*" instead of "/**" for common C comments to prevent warnings
from scripts/kernel-doc.

sdhci-omap.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
sdhci-omap.c:3: warning: missing initial short description on line:
 * SDHCI Controller driver for TI's OMAP SoCs

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Link: https://lore.kernel.org/oe-kbuild-all/202311201117.lFxgJTK6-lkp@intel.com/
Cc: Vignesh Raghavendra <vigneshr@ti.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Ulf Hansson <ulf.hansson@linaro.org>
Cc: linux-mmc@vger.kernel.org
---
This does not Close the report since there are also some warnings for
missing-prototypes.

 drivers/mmc/host/sdhci-omap.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Ulf Hansson Dec. 7, 2023, 2:16 p.m. UTC | #1 
On Wed, 6 Dec 2023 at 06:58, Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Use "/*" instead of "/**" for common C comments to prevent warnings
> from scripts/kernel-doc.
>
> sdhci-omap.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> sdhci-omap.c:3: warning: missing initial short description on line:
>  * SDHCI Controller driver for TI's OMAP SoCs
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Link: https://lore.kernel.org/oe-kbuild-all/202311201117.lFxgJTK6-lkp@intel.com/
> Cc: Vignesh Raghavendra <vigneshr@ti.com>
> Cc: Adrian Hunter <adrian.hunter@intel.com>
> Cc: Ulf Hansson <ulf.hansson@linaro.org>
> Cc: linux-mmc@vger.kernel.org

Applied for next, thanks!

Kind regards
Uffe


> ---
> This does not Close the report since there are also some warnings for
> missing-prototypes.
>
>  drivers/mmc/host/sdhci-omap.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/drivers/mmc/host/sdhci-omap.c b/drivers/mmc/host/sdhci-omap.c
> --- a/drivers/mmc/host/sdhci-omap.c
> +++ b/drivers/mmc/host/sdhci-omap.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * SDHCI Controller driver for TI's OMAP SoCs
>   *
>   * Copyright (C) 2017 Texas Instruments
diff mbox series

Patch

diff -- a/drivers/mmc/host/sdhci-omap.c b/drivers/mmc/host/sdhci-omap.c
--- a/drivers/mmc/host/sdhci-omap.c
+++ b/drivers/mmc/host/sdhci-omap.c
@@ -1,5 +1,5 @@ 
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * SDHCI Controller driver for TI's OMAP SoCs
  *
  * Copyright (C) 2017 Texas Instruments