* [PATCH -next] ksmbd: Add kernel-doc for ksmbd_extract_sharename() function
@ 2024-02-02 8:13 Yang Li
2024-02-02 16:15 ` Randy Dunlap
2024-02-02 22:57 ` Namjae Jeon
0 siblings, 2 replies; 3+ messages in thread
From: Yang Li @ 2024-02-02 8:13 UTC (permalink / raw)
To: linkinjeon, sfrench; +Cc: senozhatsky, tom, linux-cifs, linux-kernel, Yang Li
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>
---
fs/smb/server/misc.c | 1 +
1 file changed, 1 insertion(+)
diff --git a/fs/smb/server/misc.c b/fs/smb/server/misc.c
index 9e8afaa686e3..1a5faa6f6e7b 100644
--- a/fs/smb/server/misc.c
+++ b/fs/smb/server/misc.c
@@ -261,6 +261,7 @@ char *ksmbd_casefold_sharename(struct unicode_map *um, const char *name)
/**
* 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
--
2.20.1.7.g153144c
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH -next] ksmbd: Add kernel-doc for ksmbd_extract_sharename() function
2024-02-02 8:13 [PATCH -next] ksmbd: Add kernel-doc for ksmbd_extract_sharename() function Yang Li
@ 2024-02-02 16:15 ` Randy Dunlap
2024-02-02 22:57 ` Namjae Jeon
1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2024-02-02 16:15 UTC (permalink / raw)
To: Yang Li, linkinjeon, sfrench; +Cc: senozhatsky, tom, linux-cifs, linux-kernel
On 2/2/24 00:13, Yang Li wrote:
> 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>
Thanks.
> ---
> fs/smb/server/misc.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/fs/smb/server/misc.c b/fs/smb/server/misc.c
> index 9e8afaa686e3..1a5faa6f6e7b 100644
> --- a/fs/smb/server/misc.c
> +++ b/fs/smb/server/misc.c
> @@ -261,6 +261,7 @@ char *ksmbd_casefold_sharename(struct unicode_map *um, const char *name)
>
> /**
> * 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
--
#Randy
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH -next] ksmbd: Add kernel-doc for ksmbd_extract_sharename() function
2024-02-02 8:13 [PATCH -next] ksmbd: Add kernel-doc for ksmbd_extract_sharename() function Yang Li
2024-02-02 16:15 ` Randy Dunlap
@ 2024-02-02 22:57 ` Namjae Jeon
1 sibling, 0 replies; 3+ messages in thread
From: Namjae Jeon @ 2024-02-02 22:57 UTC (permalink / raw)
To: Yang Li; +Cc: sfrench, senozhatsky, tom, linux-cifs, linux-kernel
2024-02-02 17:13 GMT+09:00, Yang Li <yang.lee@linux.alibaba.com>:
> 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>
Applied it with Randy's acked-by tag to #ksmbd-for-next-next.
Thanks for your patch.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2024-02-02 22:57 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-02-02 8:13 [PATCH -next] ksmbd: Add kernel-doc for ksmbd_extract_sharename() function Yang Li
2024-02-02 16:15 ` Randy Dunlap
2024-02-02 22:57 ` Namjae Jeon
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®