linux-kernel - Re: [PATCH] input: cpcap-pwrbutton: remove initial kernel-doc notation

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]

Message-ID: <875ycw2ri4.fsf@baylibre.com>
Date:   Tue, 24 Jan 2023 10:47:47 +0100
From:   Mattijs Korpershoek <mkorpershoek@...libre.com>
To:     Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        Sebastian Reichel <sre@...nel.org>,
        Dmitry Torokhov <dmitry.torokhov@...il.com>,
        linux-input@...r.kernel.org
Subject: Re: [PATCH] input: cpcap-pwrbutton: remove initial kernel-doc notation

On Thu, Jan 12, 2023 at 22:38, Randy Dunlap <rdunlap@...radead.org> wrote:

> Change the beginning "/**" in the file to "/*" since it is not a
> kernel-doc comment. This prevents a kernel-doc warning:
>
> drivers/input/misc/cpcap-pwrbutton.c:2: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * CPCAP Power Button Input Driver
>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Sebastian Reichel <sre@...nel.org>
> Cc: Dmitry Torokhov <dmitry.torokhov@...il.com>
> Cc: linux-input@...r.kernel.org

Reviewed-by: Mattijs Korpershoek <mkorpershoek@...libre.com>

> ---
>  drivers/input/misc/cpcap-pwrbutton.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/drivers/input/misc/cpcap-pwrbutton.c b/drivers/input/misc/cpcap-pwrbutton.c
> --- a/drivers/input/misc/cpcap-pwrbutton.c
> +++ b/drivers/input/misc/cpcap-pwrbutton.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * CPCAP Power Button Input Driver
>   *
>   * Copyright (C) 2017 Sebastian Reichel <sre@...nel.org>