linux-kernel - Re: [PATCH 07/29] fs: fs.h: fix a kernel-doc parameter description

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]

Date:   Mon, 15 Jun 2020 10:47:19 +0200
From:   Jan Kara <jack@...e.cz>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Alexander Viro <viro@...iv.linux.org.uk>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Jan Kara <jack@...e.cz>, Jeff Layton <jlayton@...nel.org>,
        Stephen Rothwell <sfr@...b.auug.org.au>,
        linux-fsdevel@...r.kernel.org
Subject: Re: [PATCH 07/29] fs: fs.h: fix a kernel-doc parameter description

On Mon 15-06-20 08:46:46, Mauro Carvalho Chehab wrote:
> Changeset 3b0311e7ca71 ("vfs: track per-sb writeback errors and report them to syncfs")
> added a variant of filemap_sample_wb_err(), but it forgot to
> rename the arguments at the kernel-doc markup. Fix it.
> 
> Fix those warnings:
> 	./include/linux/fs.h:2845: warning: Function parameter or member 'file' not described in 'file_sample_sb_err'
> 	./include/linux/fs.h:2845: warning: Excess function parameter 'mapping' description in 'file_sample_sb_err'
> 
> Fixes: 3b0311e7ca71 ("vfs: track per-sb writeback errors and report them to syncfs")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

Thanks for the fix! It looks good to me. You can add:

Reviewed-by: Jan Kara <jack@...e.cz>

								Honza

> ---
>  include/linux/fs.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/fs.h b/include/linux/fs.h
> index 6c4ab4dc1cd7..7e17ecc461d5 100644
> --- a/include/linux/fs.h
> +++ b/include/linux/fs.h
> @@ -2829,7 +2829,7 @@ static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
>  
>  /**
>   * file_sample_sb_err - sample the current errseq_t to test for later errors
> - * @mapping: mapping to be sampled
> + * @file: file pointer to be sampled
>   *
>   * Grab the most current superblock-level errseq_t value for the given
>   * struct file.
> -- 
> 2.26.2
> 
-- 
Jan Kara <jack@...e.com>
SUSE Labs, CR