linux-kernel - Re: [PATCH] vfs: fs_context: Modify mismatched function name

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <c270337a-7be2-e53d-d4e8-81a934907205@infradead.org>
Date:   Wed, 19 Oct 2022 20:53:03 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Jiapeng Chong <jiapeng.chong@...ux.alibaba.com>,
        viro@...iv.linux.org.uk
Cc:     linux-fsdevel@...r.kernel.org, linux-kernel@...r.kernel.org,
        Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH] vfs: fs_context: Modify mismatched function name

Hi--

On 10/19/22 20:40, Jiapeng Chong wrote:
> No functional modification involved.
> 
> fs/fs_context.c:347: warning: expecting prototype for vfs_dup_fc_config(). Prototype was for vfs_dup_fs_context() instead.
> 
> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=2456
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Jiapeng Chong <jiapeng.chong@...ux.alibaba.com>
> ---
>  fs/fs_context.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/fs/fs_context.c b/fs/fs_context.c
> index df04e5fc6d66..be45701cd998 100644
> --- a/fs/fs_context.c
> +++ b/fs/fs_context.c
> @@ -340,7 +340,7 @@ void fc_drop_locked(struct fs_context *fc)
>  static void legacy_fs_context_free(struct fs_context *fc);
>  
>  /**
> - * vfs_dup_fc_config: Duplicate a filesystem context.
> + * vfs_dup_fs_context: Duplicate a filesystem context.

That is still not the correct kernel-doc format (or syntax).
The ':' should be a '-' instead.

Also, I see scripts/kernel-doc reporting 16 kernel-doc format
problems in this file. How about fixing more than just one of them, please.

fs_context.c:95: warning: No description found for return value of 'vfs_parse_fs
_param_source'
fs_context.c:128: warning: No description found for return value of 'vfs_parse_f
s_param'
fs_context.c:168: warning: Function parameter or member 'fc' not described in 'v
fs_parse_fs_string'
fs_context.c:168: warning: Function parameter or member 'key' not described in '
vfs_parse_fs_string'
fs_context.c:168: warning: Function parameter or member 'value' not described in
 'vfs_parse_fs_string'
fs_context.c:168: warning: Function parameter or member 'v_size' not described i
n 'vfs_parse_fs_string'
fs_context.c:168: warning: No description found for return value of 'vfs_parse_f
s_string'
fs_context.c:202: warning: Function parameter or member 'fc' not described in 'g
eneric_parse_monolithic'
fs_context.c:202: warning: Excess function parameter 'ctx' description in 'gener
ic_parse_monolithic'
fs_context.c:202: warning: No description found for return value of 'generic_par
se_monolithic'
fs_context.c:252: warning: No description found for return value of 'alloc_fs_co
ntext'
fs_context.c:340: warning: No description found for return value of 'vfs_dup_fs_
context'
fs_context.c:386: warning: Function parameter or member 'log' not described in '
logfc'
fs_context.c:386: warning: Function parameter or member 'prefix' not described i
n 'logfc'
fs_context.c:386: warning: Function parameter or member 'level' not described in
 'logfc'
fs_context.c:386: warning: Excess function parameter 'fc' description in 'logfc'
16 warnings


>   * @src_fc: The context to copy.
>   */
>  struct fs_context *vfs_dup_fs_context(struct fs_context *src_fc)

-- 
~Randy