2023-07-03 23:06:52

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH RESEND] 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-07-04 00:16:18

by Sebastian Reichel

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

Hi,

On Mon, Jul 03, 2023 at 04:00:05PM -0700, Randy Dunlap 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: Sebastian Reichel <[email protected]>

-- Sebastian

> 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]>


Attachments:
(No filename) (1.08 kB)
signature.asc (849.00 B)
Download all attachments

2023-07-05 19:45:33

by Dmitry Torokhov

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

On Tue, Jul 04, 2023 at 02:08:21AM +0200, Sebastian Reichel wrote:
> Hi,
>
> On Mon, Jul 03, 2023 at 04:00:05PM -0700, Randy Dunlap 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: Sebastian Reichel <[email protected]>

Applied, thank you.

BTW, the driver is missing SPDX annotation, Sebastian I wonder if you
could send a patch addressing this (given you are the author it is
better coming from you).

Thanks!

--
Dmitry

2023-07-05 21:43:46

by Sebastian Reichel

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

Hi,

On Wed, Jul 05, 2023 at 12:28:50PM -0700, Dmitry Torokhov wrote:
> On Tue, Jul 04, 2023 at 02:08:21AM +0200, Sebastian Reichel wrote:
> > Hi,
> >
> > On Mon, Jul 03, 2023 at 04:00:05PM -0700, Randy Dunlap 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: Sebastian Reichel <[email protected]>
>
> Applied, thank you.
>
> BTW, the driver is missing SPDX annotation, Sebastian I wonder if you
> could send a patch addressing this (given you are the author it is
> better coming from you).

DONE: https://lore.kernel.org/all/[email protected]/

-- Sebastian


Attachments:
(No filename) (1.14 kB)
signature.asc (849.00 B)
Download all attachments

2023-07-05 21:59:06

by Dmitry Torokhov

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

On Wed, Jul 05, 2023 at 11:28:45PM +0200, Sebastian Reichel wrote:
> Hi,
>
> On Wed, Jul 05, 2023 at 12:28:50PM -0700, Dmitry Torokhov wrote:
> > On Tue, Jul 04, 2023 at 02:08:21AM +0200, Sebastian Reichel wrote:
> > > Hi,
> > >
> > > On Mon, Jul 03, 2023 at 04:00:05PM -0700, Randy Dunlap 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: Sebastian Reichel <[email protected]>
> >
> > Applied, thank you.
> >
> > BTW, the driver is missing SPDX annotation, Sebastian I wonder if you
> > could send a patch addressing this (given you are the author it is
> > better coming from you).
>
> DONE: https://lore.kernel.org/all/[email protected]/

Thank you, much appreciated.

--
Dmitry