smb: Fix some kernel-doc comments
authorYang Li <yang.lee@linux.alibaba.com>
Fri, 19 Jan 2024 09:57:07 +0000 (17:57 +0800)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Sat, 25 May 2024 14:22:45 +0000 (16:22 +0200)
[ Upstream commit 72b0cbf6b81003c01d63c60180b335f7692d170e ]

Fix some kernel-doc comments to silence the warnings:
fs/smb/server/transport_tcp.c:374: warning: Function parameter or struct member 'max_retries' not described in 'ksmbd_tcp_read'
fs/smb/server/transport_tcp.c:423: warning: Function parameter or struct member 'iface' not described in 'create_socket'

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Acked-by: Namjae Jeon <linkinjeon@kernel.org>
Signed-off-by: Steve French <stfrench@microsoft.com>
Signed-off-by: Sasha Levin <sashal@kernel.org>
fs/smb/server/transport_tcp.c

index 0012919309f11fee335b09253dd9fb456984e512..6633fa78e9b96bbbcd323aced36dadc35c19850b 100644 (file)
@@ -365,6 +365,7 @@ static int ksmbd_tcp_readv(struct tcp_transport *t, struct kvec *iov_orig,
  * @t:         TCP transport instance
  * @buf:       buffer to store read data from socket
  * @to_read:   number of bytes to read from socket
+ * @max_retries: number of retries if reading from socket fails
  *
  * Return:     on success return number of bytes read from socket,
  *             otherwise return error number
@@ -416,6 +417,7 @@ static void tcp_destroy_socket(struct socket *ksmbd_socket)
 
 /**
  * create_socket - create socket for ksmbd/0
+ * @iface:      interface to bind the created socket to
  *
  * Return:     0 on success, error number otherwise
  */