linux-kernel - Re: [PATCH] gpio: max730x: don't use kernel-doc marker for regular comment

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 09:24:33 +0100
From:   Bartosz Golaszewski <brgl@...ev.pl>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org,
        Linus Walleij <linus.walleij@...aro.org>,
        Andy Shevchenko <andy@...nel.org>, linux-gpio@...r.kernel.org
Subject: Re: [PATCH] gpio: max730x: don't use kernel-doc marker for regular comment

On Wed, Dec 6, 2023 at 4:05 AM Randy Dunlap <rdunlap@...radead.org> wrote:
>
> Use a common C comment (/*) instead of kernel-doc notation to prevent
> warnings from scripts/kernel-doc.
>
> gpio-max730x.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> gpio-max730x.c:3: warning: missing initial short description on line:
>  * Copyright (C) 2006 Juergen Beisert, Pengutronix
>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> ---
>  drivers/gpio/gpio-max730x.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/drivers/gpio/gpio-max730x.c b/drivers/gpio/gpio-max730x.c
> --- a/drivers/gpio/gpio-max730x.c
> +++ b/drivers/gpio/gpio-max730x.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * Copyright (C) 2006 Juergen Beisert, Pengutronix
>   * Copyright (C) 2008 Guennadi Liakhovetski, Pengutronix
>   * Copyright (C) 2009 Wolfram Sang, Pengutronix

Applied, thanks!

Bart