]> www.infradead.org Git - linux.git/commit
Input: twl4030-pwrbutton - fix kernel-doc warning
authorDmitry Torokhov <dmitry.torokhov@gmail.com>
Wed, 10 Jul 2024 00:04:35 +0000 (17:04 -0700)
committerDmitry Torokhov <dmitry.torokhov@gmail.com>
Thu, 11 Jul 2024 16:57:58 +0000 (09:57 -0700)
commitf48ecbd2ce1ca2b0c92843f67879b583b1f85cda
tree9034c49651c7036b9d3101f4fd2b2fc778b13125
parent5e91cef94426d71e3156864d52753ace4cee721a
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.

Reported-by: Mirsad Todorovac <mtodorovac69@gmail.com>
Tested-by: Mirsad Todorovac <mtodorovac69@gmail.com>
Link: https://lore.kernel.org/r/Zo3QE00GqCrA3M9b@google.com
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
drivers/input/misc/twl4030-pwrbutton.c