| Message ID | 20240202081317.128980-1-yang.lee@linux.alibaba.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [-next] ksmbd: Add kernel-doc for ksmbd_extract_sharename() function | expand |
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
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.
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
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(+)