Remove some warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.
fs/ksmbd/misc.c:30: warning: Function parameter or member 'str' not
described in 'match_pattern'
fs/ksmbd/misc.c:30: warning: Excess function parameter 'string'
description in 'match_pattern'
fs/ksmbd/misc.c:163: warning: Function parameter or member 'share' not
described in 'convert_to_nt_pathname'
fs/ksmbd/misc.c:163: warning: Function parameter or member 'path' not
described in 'convert_to_nt_pathname'
fs/ksmbd/misc.c:163: warning: Excess function parameter 'filename'
description in 'convert_to_nt_pathname'
fs/ksmbd/misc.c:163: warning: Excess function parameter 'sharepath'
description in 'convert_to_nt_pathname'
fs/ksmbd/misc.c:259: warning: Function parameter or member 'share' not
described in 'convert_to_unix_name'
fs/ksmbd/misc.c:259: warning: Function parameter or member 'name' not
described in 'convert_to_unix_name'
fs/ksmbd/misc.c:259: warning: Excess function parameter 'path'
description in 'convert_to_unix_name'
fs/ksmbd/misc.c:259: warning: Excess function parameter 'tid'
description in 'convert_to_unix_name'
Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
fs/ksmbd/misc.c | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/fs/ksmbd/misc.c b/fs/ksmbd/misc.c
index 1e2076a53bed..df991107ad2c 100644
--- a/fs/ksmbd/misc.c
+++ b/fs/ksmbd/misc.c
@@ -20,7 +20,7 @@
* wildcard '*' and '?'
* TODO : implement consideration about DOS_DOT, DOS_QM and DOS_STAR
*
- * @string: string to compare with a pattern
+ * @str: string to compare with a pattern
* @len: string length
* @pattern: pattern string which might include wildcard '*' and '?'
*
@@ -152,8 +152,8 @@ int parse_stream_name(char *filename, char **stream_name, int *s_type)
/**
* convert_to_nt_pathname() - extract and return windows path string
* whose share directory prefix was removed from file path
- * @filename : unix filename
- * @sharepath: share path string
+ * @share: ksmbd_share_config pointer
+ * @path: path to report
*
* Return : windows path string or error
*/
@@ -250,8 +250,8 @@ char *ksmbd_extract_sharename(char *treename)
/**
* convert_to_unix_name() - convert windows name to unix format
- * @path: name to be converted
- * @tid: tree id of mathing share
+ * @share: ksmbd_share_config pointer
+ * @name: file name that is relative to share
*
* Return: converted name on success, otherwise NULL
*/
--
2.20.1.7.g153144c
2022-05-12 16:56 GMT+09:00, Yang Li <[email protected]>:
> Remove some warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
>
> fs/ksmbd/misc.c:30: warning: Function parameter or member 'str' not
> described in 'match_pattern'
> fs/ksmbd/misc.c:30: warning: Excess function parameter 'string'
> description in 'match_pattern'
> fs/ksmbd/misc.c:163: warning: Function parameter or member 'share' not
> described in 'convert_to_nt_pathname'
> fs/ksmbd/misc.c:163: warning: Function parameter or member 'path' not
> described in 'convert_to_nt_pathname'
> fs/ksmbd/misc.c:163: warning: Excess function parameter 'filename'
> description in 'convert_to_nt_pathname'
> fs/ksmbd/misc.c:163: warning: Excess function parameter 'sharepath'
> description in 'convert_to_nt_pathname'
> fs/ksmbd/misc.c:259: warning: Function parameter or member 'share' not
> described in 'convert_to_unix_name'
> fs/ksmbd/misc.c:259: warning: Function parameter or member 'name' not
> described in 'convert_to_unix_name'
> fs/ksmbd/misc.c:259: warning: Excess function parameter 'path'
> description in 'convert_to_unix_name'
> fs/ksmbd/misc.c:259: warning: Excess function parameter 'tid'
> description in 'convert_to_unix_name'
>
> Reported-by: Abaci Robot <[email protected]>
> Signed-off-by: Yang Li <[email protected]>
Acked-by: Namjae Jeon <[email protected]>
Thanks for your patch!