From: Yang Li <yang.lee@linux.alibaba.com>
Date: Fri, 2 Feb 2024 08:13:17 +0000 (+0800)
Subject: ksmbd: Add kernel-doc for ksmbd_extract_sharename() function
X-Git-Tag: v6.8-rc4~6^2~1
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=a12bc36032a2f7917068f9ce9eb26d869e54b31a;p=thirdparty%2Fkernel%2Flinux.git

ksmbd: Add kernel-doc for ksmbd_extract_sharename() function

The ksmbd_extract_sharename() function lacked a complete kernel-doc
comment. This patch adds parameter descriptions and detailed function
behavior to improve code readability and maintainability.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Namjae Jeon <linkinjeon@kernel.org>
Signed-off-by: Steve French <stfrench@microsoft.com>
---

diff --git a/fs/smb/server/misc.c b/fs/smb/server/misc.c
index 9e8afaa686e3a..1a5faa6f6e7bc 100644
--- a/fs/smb/server/misc.c
+++ b/fs/smb/server/misc.c
@@ -261,6 +261,7 @@ out_ascii:
 
 /**
  * ksmbd_extract_sharename() - get share name from tree connect request
+ * @um: pointer to a unicode_map structure for character encoding handling
  * @treename:	buffer containing tree name and share name
  *
  * Return:      share name on success, otherwise error