Skip to contentSkip to conversation

Input: twl4030-pwrbutton - fix kernel-doc warning

PATCH In review Dmitry Torokhov 2 participants 2 messages Jul 10, 2024 – Jul 11, 2024

Subsystems (2)
lore
Share & tools
lore

Dmitry Torokhov

author maintainer
#0 lore raw

PATCH 1/1 Input: twl4030-pwrbutton - fix kernel-doc warning

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.

---
 drivers/input/misc/twl4030-pwrbutton.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/input/misc/twl4030-pwrbutton.c +2 -2
index e3ee0638ffba..f85cc289c053 100644
@@ -1,5 +1,5 @@
-/**
- * twl4030-pwrbutton.c - TWL4030 Power Button Input Driver
+/*
+ * TWL4030 Power Button Input Driver
  *
  * Copyright (C) 2008-2009 Nokia Corporation
  *
Signature · 5 lines
2.45.2.803.g4e1b14247a-goog


-- 
Dmitry
Tested-by on v1 1/1
#1 lore raw
Quoted 22 lines · 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.

---
 drivers/input/misc/twl4030-pwrbutton.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/input/misc/twl4030-pwrbutton.c +0 -0
index e3ee0638ffba..f85cc289c053 100644

drivers/input/misc/twl4030-pwrbutton.c line 5

Quoted 7 lines
drivers/input/misc/twl4030-pwrbutton.c +2 -2
@@ -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!

Best regards,
Mirsad Todorovac