2024-01-19 09:57:30

by Yang Li

[permalink] [raw]
Subject: [PATCH -next] smb: Fix some kernel-doc comments

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 <[email protected]>
---
fs/smb/server/transport_tcp.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/fs/smb/server/transport_tcp.c b/fs/smb/server/transport_tcp.c
index 9d4222154dcc..002a3f0dc7c5 100644
--- a/fs/smb/server/transport_tcp.c
+++ b/fs/smb/server/transport_tcp.c
@@ -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
*/
--
2.20.1.7.g153144c



2024-01-20 03:45:03

by Namjae Jeon

[permalink] [raw]
Subject: Re: [PATCH -next] smb: Fix some kernel-doc comments

2024-01-19 18:57 GMT+09:00, Yang Li <[email protected]>:
> 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 <[email protected]>
Acked-by: Namjae Jeon <[email protected]>

Applied it to #ksmbd-for-next-next. Thanks for your patch.