2023-12-06 05:59:09

by Randy Dunlap

Subject: [PATCH] mmc: sdhci-omap: don't misuse kernel-doc marker

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 <[email protected]>
Reported-by: kernel test robot <[email protected]>
Link: https://lore.kernel.org/oe-kbuild-all/[email protected]/
Cc: Vignesh Raghavendra <[email protected]>
Cc: Adrian Hunter <[email protected]>
Cc: Ulf Hansson <[email protected]>
Cc: [email protected]
---
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

2023-12-07 14:19:41

by Ulf Hansson

Subject: Re: [PATCH] mmc: sdhci-omap: don't misuse kernel-doc marker

On Wed, 6 Dec 2023 at 06:58, Randy Dunlap <[email protected]> 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 <[email protected]>
> Reported-by: kernel test robot <[email protected]>
> Link: https://lore.kernel.org/oe-kbuild-all/[email protected]/
> Cc: Vignesh Raghavendra <[email protected]>
> Cc: Adrian Hunter <[email protected]>
> Cc: Ulf Hansson <[email protected]>
> Cc: [email protected]

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