linux-kernel - [PATCH] HSI: ssi_protocol: fix struct members kernel-doc warnings

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-next>] [day] [month] [year] [list]

Message-ID: <20240221064112.9155-1-rdunlap@infradead.org>
Date: Tue, 20 Feb 2024 22:41:12 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Sebastian Reichel <sre@...nel.org>
Subject: [PATCH] HSI: ssi_protocol: fix struct members kernel-doc warnings

Fix a typo in one struct member's name and add the @work struct member
to quieten kernel-doc warnings:

ssi_protocol.c:144: warning: Function parameter or struct member 'work' not described in 'ssi_protocol'
ssi_protocol.c:144: warning: Function parameter or struct member 'tx_usecnt' not described in 'ssi_protocol'
ssi_protocol.c:144: warning: Excess struct member 'tx_usecount' description in 'ssi_protocol'

Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Cc: Sebastian Reichel <sre@...nel.org>
---
 drivers/hsi/clients/ssi_protocol.c |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff -- a/drivers/hsi/clients/ssi_protocol.c b/drivers/hsi/clients/ssi_protocol.c
--- a/drivers/hsi/clients/ssi_protocol.c
+++ b/drivers/hsi/clients/ssi_protocol.c
@@ -114,9 +114,10 @@ enum {
  * @netdev: Phonet network device
  * @txqueue: TX data queue
  * @cmdqueue: Queue of free commands
+ * @work: &struct work_struct for scheduled work
  * @cl: HSI client own reference
  * @link: Link for ssip_list
- * @tx_usecount: Refcount to keep track the slaves that use the wake line
+ * @tx_usecnt: Refcount to keep track the slaves that use the wake line
  * @channel_id_cmd: HSI channel id for command stream
  * @channel_id_data: HSI channel id for data stream
  */