2024-02-02 08:19:02

by Yang Li

Subject: [PATCH -next] 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 <[email protected]>
---
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

2024-02-02 20:25:22

by Randy Dunlap

Subject: Re: [PATCH -next] ksmbd: Add kernel-doc for ksmbd_extract_sharename() function

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 <[email protected]>

Acked-by: Randy Dunlap <[email protected]>

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

2024-02-02 22:58:08

by Namjae Jeon

Subject: Re: [PATCH -next] ksmbd: Add kernel-doc for ksmbd_extract_sharename() function

2024-02-02 17:13 GMT+09:00, Yang Li <[email protected]>:
> 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 <[email protected]>
Applied it with Randy's acked-by tag to #ksmbd-for-next-next.
Thanks for your patch.