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

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

[Randy Dunlap]

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@infradead.org>
Cc: Sebastian Reichel <sre@kernel.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
  */

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

[Sebastian Reichel]

On Tue, 20 Feb 2024 22:41:12 -0800, Randy Dunlap wrote:
> 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'
> 
> [...]

Applied, thanks!

[1/1] HSI: ssi_protocol: fix struct members kernel-doc warnings
      commit: 3693760295e8c8a1a88cb3da5b178959b3cc7c75

Best regards,
-- 
Sebastian Reichel <sebastian.reichel@collabora.com>