ksmbd: fix documentation for 2 functions

ematsumiya · smfrench · commit 1018bf24550f · 2021-09-28T20:51:32.000-05:00
ksmbd_kthread_fn() and create_socket() returns 0 or error code, and not
task_struct/ERR_PTR.

Signed-off-by: Enzo Matsumiya &lt;ematsumiya@suse.de&gt;
Acked-by: Namjae Jeon &lt;linkinjeon@kernel.org&gt;
Signed-off-by: Steve French &lt;stfrench@microsoft.com&gt;
diff --git a/fs/ksmbd/transport_tcp.c b/fs/ksmbd/transport_tcp.c
@@ -215,7 +215,7 @@ static int ksmbd_tcp_new_connection(struct socket *client_sk)
  * ksmbd_kthread_fn() - listen to new SMB connections and callback server
  * @p:		arguments to forker thread
  *
- * Return:	Returns a task_struct or ERR_PTR
+ * Return:	0 on success, error number otherwise
  */
 static int ksmbd_kthread_fn(void *p)
 {
@@ -387,7 +387,7 @@ static void tcp_destroy_socket(struct socket *ksmbd_socket)
 /**
  * create_socket - create socket for ksmbd/0
  *
- * Return:	Returns a task_struct or ERR_PTR
+ * Return:	0 on success, error number otherwise
  */
 static int create_socket(struct interface *iface)
 {

Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@ static int ksmbd_tcp_new_connection(struct socket *client_sk)`
`215`	`215`	`* ksmbd_kthread_fn() - listen to new SMB connections and callback server`
`216`	`216`	`* @p: arguments to forker thread`
`217`	`217`	`*`
`218`		`- * Return: Returns a task_struct or ERR_PTR`
	`218`	`+ * Return: 0 on success, error number otherwise`
`219`	`219`	`*/`
`220`	`220`	`static int ksmbd_kthread_fn(void *p)`
`221`	`221`	`{`
`@@ -387,7 +387,7 @@ static void tcp_destroy_socket(struct socket *ksmbd_socket)`
`387`	`387`	`/**`
`388`	`388`	`* create_socket - create socket for ksmbd/0`
`389`	`389`	`*`
`390`		`- * Return: Returns a task_struct or ERR_PTR`
	`390`	`+ * Return: 0 on success, error number otherwise`
`391`	`391`	`*/`
`392`	`392`	`static int create_socket(struct interface *iface)`
`393`	`393`	`{`