2023-01-13 07:34:15

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] input: cpcap-pwrbutton: remove initial kernel-doc notation

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 <[email protected]>
Cc: Sebastian Reichel <[email protected]>
Cc: Dmitry Torokhov <[email protected]>
Cc: [email protected]
---
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 <[email protected]>


2023-01-24 09:48:02

by Mattijs Korpershoek

[permalink] [raw]
Subject: Re: [PATCH] input: cpcap-pwrbutton: remove initial kernel-doc notation

On Thu, Jan 12, 2023 at 22:38, Randy Dunlap <[email protected]> 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 <[email protected]>
> Cc: Sebastian Reichel <[email protected]>
> Cc: Dmitry Torokhov <[email protected]>
> Cc: [email protected]

Reviewed-by: Mattijs Korpershoek <[email protected]>

> ---
> 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 <[email protected]>