linux-kernel - Re: [PATCH -next] 9p: Fix some kernel-doc comments

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: <YqlL22D6l7XErRoo@codewreck.org>
Date:   Wed, 15 Jun 2022 12:02:51 +0900
From:   asmadeus@...ewreck.org
To:     Yang Li <yang.lee@...ux.alibaba.com>
Cc:     ericvh@...il.com, lucho@...kov.net, linux_oss@...debyte.com,
        v9fs-developer@...ts.sourceforge.net, linux-kernel@...r.kernel.org,
        Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH -next] 9p: Fix some kernel-doc comments

Yang Li wrote on Wed, Jun 15, 2022 at 09:20:39AM +0800:
> Remove warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.

ugh, I was told W=1 would become the default for net,
but I guess it isn't question about that yet for fs...

Do you know how to make W=1 the default for part of the subtree?

> fs/9p/fid.c:35: warning: Function parameter or member 'pfid' not described in 'v9fs_fid_add'
> fs/9p/fid.c:35: warning: Excess function parameter 'fid' description in 'v9fs_fid_add'
> fs/9p/fid.c:80: warning: Function parameter or member 'pfid' not described in 'v9fs_open_fid_add'
> fs/9p/fid.c:80: warning: Excess function parameter 'fid' description in 'v9fs_open_fid_add'
> 
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>

Will apply and add a note that it is NULLed out, thanks.

> ---
>  fs/9p/fid.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/fs/9p/fid.c b/fs/9p/fid.c
> index 289a85eae2ae..3a0f5963b8bd 100644
> --- a/fs/9p/fid.c
> +++ b/fs/9p/fid.c
> @@ -28,7 +28,7 @@ static inline void __add_fid(struct dentry *dentry, struct p9_fid *fid)
>  /**
>   * v9fs_fid_add - add a fid to a dentry
>   * @dentry: dentry that the fid is being added to
> - * @fid: fid to add
> + * @pfid: fid to add
>   *
>   */
>  void v9fs_fid_add(struct dentry *dentry, struct p9_fid **pfid)
> @@ -72,7 +72,7 @@ static struct p9_fid *v9fs_fid_find_inode(struct inode *inode, kuid_t uid)
>  /**
>   * v9fs_open_fid_add - add an open fid to an inode
>   * @inode: inode that the fid is being added to
> - * @fid: fid to add
> + * @pfid: fid to add
>   *
>   */
>