diff mbox series

[RESEND] input: cpcap-pwrbutton: remove initial kernel-doc notation

Message ID 20230703230005.14877-1-rdunlap@infradead.org
State New
Headers
Series [RESEND] input: cpcap-pwrbutton: remove initial kernel-doc notation |

Commit Message

Randy Dunlap July 3, 2023, 11 p.m. UTC 
  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@infradead.org>
Cc: Sebastian Reichel <sre@kernel.org>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: linux-input@vger.kernel.org
---
 drivers/input/misc/cpcap-pwrbutton.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Sebastian Reichel July 4, 2023, 12:08 a.m. UTC | #1 
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 <rdunlap@infradead.org>
> Cc: Sebastian Reichel <sre@kernel.org>
> Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
> Cc: linux-input@vger.kernel.org
> ---

Reviewed-by: Sebastian Reichel <sebastian.reichel@collabora.com>

-- 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 <sre@kernel.org>
Dmitry Torokhov July 5, 2023, 7:28 p.m. UTC | #2 
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 <rdunlap@infradead.org>
> > Cc: Sebastian Reichel <sre@kernel.org>
> > Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
> > Cc: linux-input@vger.kernel.org
> > ---
> 
> Reviewed-by: Sebastian Reichel <sebastian.reichel@collabora.com>

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!
Sebastian Reichel July 5, 2023, 9:28 p.m. UTC | #3 
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 <rdunlap@infradead.org>
> > > Cc: Sebastian Reichel <sre@kernel.org>
> > > Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
> > > Cc: linux-input@vger.kernel.org
> > > ---
> > 
> > Reviewed-by: Sebastian Reichel <sebastian.reichel@collabora.com>
> 
> 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/20230705212231.631525-1-sre@kernel.org/

-- Sebastian
Dmitry Torokhov July 5, 2023, 9:51 p.m. UTC | #4 
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 <rdunlap@infradead.org>
> > > > Cc: Sebastian Reichel <sre@kernel.org>
> > > > Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
> > > > Cc: linux-input@vger.kernel.org
> > > > ---
> > > 
> > > Reviewed-by: Sebastian Reichel <sebastian.reichel@collabora.com>
> > 
> > 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/20230705212231.631525-1-sre@kernel.org/

Thank you, much appreciated.
diff mbox series

Patch

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@kernel.org>