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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Thu, 7 Dec 2023 15:16:42 +0100
From:   Ulf Hansson <ulf.hansson@...aro.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org, kernel test robot <lkp@...el.com>,
        Vignesh Raghavendra <vigneshr@...com>,
        Adrian Hunter <adrian.hunter@...el.com>,
        linux-mmc@...r.kernel.org
Subject: Re: [PATCH] mmc: sdhci-omap: don't misuse kernel-doc marker

On Wed, 6 Dec 2023 at 06:58, Randy Dunlap <rdunlap@...radead.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@...radead.org>
> Reported-by: kernel test robot <lkp@...el.com>
> Link: https://lore.kernel.org/oe-kbuild-all/202311201117.lFxgJTK6-lkp@intel.com/
> Cc: Vignesh Raghavendra <vigneshr@...com>
> Cc: Adrian Hunter <adrian.hunter@...el.com>
> Cc: Ulf Hansson <ulf.hansson@...aro.org>
> Cc: linux-mmc@...r.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