[PATCH] Input: twl4030-pwrbutton - fix kernel-doc warning

[PATCH] Input: twl4030-pwrbutton - fix kernel-doc warning

[Dmitry Torokhov]

Do not use kernel-doc style for comment describing contents of the
source file, as it trips the script:

  scripts/kernel-doc -none   drivers/input/misc/twl4030-pwrbutton.c
drivers/input/misc/twl4030-pwrbutton.c:2: info: Scanning doc for function twl4030
drivers/input/misc/twl4030-pwrbutton.c:33: warning: expecting prototype for twl4030(). Prototype was for PWR_PWRON_IRQ() instead
1 warnings

Also remove file name from the same comment - it it not the best idea
to have it as they tend to get stale when sources get moved or renamed.

Reported-by: Mirsad Todorovac <mtodorovac69@gmail.com>
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
---
 drivers/input/misc/twl4030-pwrbutton.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/input/misc/twl4030-pwrbutton.c b/drivers/input/misc/twl4030-pwrbutton.c
index e3ee0638ffba..f85cc289c053 100644
--- a/drivers/input/misc/twl4030-pwrbutton.c
+++ b/drivers/input/misc/twl4030-pwrbutton.c
@@ -1,5 +1,5 @@
-/**
- * twl4030-pwrbutton.c - TWL4030 Power Button Input Driver
+/*
+ * TWL4030 Power Button Input Driver
  *
  * Copyright (C) 2008-2009 Nokia Corporation
  *
-- 
2.45.2.803.g4e1b14247a-goog


-- 
Dmitry

Re: [PATCH] Input: twl4030-pwrbutton - fix kernel-doc warning

[Mirsad Todorovac]

On 7/10/24 02:04, Dmitry Torokhov wrote:
> Do not use kernel-doc style for comment describing contents of the
> source file, as it trips the script:
> 
>   scripts/kernel-doc -none   drivers/input/misc/twl4030-pwrbutton.c
> drivers/input/misc/twl4030-pwrbutton.c:2: info: Scanning doc for function twl4030
> drivers/input/misc/twl4030-pwrbutton.c:33: warning: expecting prototype for twl4030(). Prototype was for PWR_PWRON_IRQ() instead
> 1 warnings
> 
> Also remove file name from the same comment - it it not the best idea
> to have it as they tend to get stale when sources get moved or renamed.
> 
> Reported-by: Mirsad Todorovac <mtodorovac69@gmail.com>
> Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
> ---
>  drivers/input/misc/twl4030-pwrbutton.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/input/misc/twl4030-pwrbutton.c b/drivers/input/misc/twl4030-pwrbutton.c
> index e3ee0638ffba..f85cc289c053 100644
> --- a/drivers/input/misc/twl4030-pwrbutton.c
> +++ b/drivers/input/misc/twl4030-pwrbutton.c
> @@ -1,5 +1,5 @@
> -/**
> - * twl4030-pwrbutton.c - TWL4030 Power Button Input Driver
> +/*
> + * TWL4030 Power Button Input Driver
>   *
>   * Copyright (C) 2008-2009 Nokia Corporation
>   *

Tested, finally:

  CC      drivers/input/misc/tps65219-pwrbutton.o
  CC      drivers/input/misc/twl4030-pwrbutton.o
  CC      drivers/hwmon/pmbus/max15301.o

Compiled w/o warnings.

Thanks!

Tested-by: Mirsad Todorovac <mtodorovac69@gmail.com>

Best regards,
Mirsad Todorovac