linux-kernel - [PATCH 2/2] HID: uclogic: add missing function name in uclogic_params_hid

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20220528091403.160169-3-bagasdotme@gmail.com>
Date:   Sat, 28 May 2022 16:14:03 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     linux-doc@...r.kernel.org
Cc:     Bagas Sanjaya <bagasdotme@...il.com>,
        Nikolai Kondrashov <spbnick@...il.com>,
        Jiri Kosina <jikos@...nel.org>,
        Benjamin Tissoires <benjamin.tissoires@...hat.com>,
        José Expósito <jose.exposito89@...il.com>,
        llvm@...ts.linux.dev, linux-input@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: [PATCH 2/2] HID: uclogic: add missing function name in uclogic_params_hid_dbg() kernel-doc comment

uclogic_params_hid_dbg() is public void function. The comment for
kernel-doc, however, lack its function name on short description, thus
triggers "missing initial short description" warning.

Add the function name to fix the warning.

Fixes: a228809fa6f39c ("HID: uclogic: Move param printing to a function")
Cc: Nikolai Kondrashov <spbnick@...il.com>
Cc: Jiri Kosina <jikos@...nel.org>
Cc: Benjamin Tissoires <benjamin.tissoires@...hat.com>
Cc: "José Expósito" <jose.exposito89@...il.com>
Cc: llvm@...ts.linux.dev
Cc: linux-input@...r.kernel.org
Cc: linux-kernel@...r.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
 drivers/hid/hid-uclogic-params.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c
index 71501453de12e4..0319e3f1527f1d 100644
--- a/drivers/hid/hid-uclogic-params.c
+++ b/drivers/hid/hid-uclogic-params.c
@@ -102,7 +102,7 @@ static void uclogic_params_frame_hid_dbg(
 }
 
 /**
- * Dump tablet interface parameters with hid_dbg().
+ * uclogic_params_hid_dbg - Dump tablet interface parameters with hid_dbg().
  *
  * @hdev:	The HID device the parameters describe.
  * @params:	The parameters to dump.
-- 
An old man doll... just what I always wanted! - Clara