[PATCH] fs: correct kernel-doc inconsistency

[PATCH] fs: correct kernel-doc inconsistency

[Colton Lewis]

Silence documentation build warning by correcting kernel-doc comment
for file_sample_sub_err function.

./include/linux/fs.h:2839: warning: Function parameter or member 'file' not described in 'file_sample_sb_err'
./include/linux/fs.h:2839: warning: Excess function parameter 'mapping' description in 'file_sample_sb_err'

Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
 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 3f881a892ea7..15f430c800dc 100644
--- a/include/linux/fs.h
+++ b/include/linux/fs.h
@@ -2827,7 +2827,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 to be sampled
  *
  * Grab the most current superblock-level errseq_t value for the given
  * struct file.
-- 
2.26.2

Re: [PATCH] fs: correct kernel-doc inconsistency

[Randy Dunlap]

On 7/6/20 9:42 PM, Colton Lewis wrote:
> Silence documentation build warning by correcting kernel-doc comment
> for file_sample_sub_err function.
> 
> ./include/linux/fs.h:2839: warning: Function parameter or member 'file' not described in 'file_sample_sb_err'
> ./include/linux/fs.h:2839: warning: Excess function parameter 'mapping' description in 'file_sample_sb_err'
> 
> Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>

Hi,
This is already fixed in linux-next.
You should check linux-next for anything that could already have patches
available but that have not been merged into mainline yet.

> ---
>  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 3f881a892ea7..15f430c800dc 100644
> --- a/include/linux/fs.h
> +++ b/include/linux/fs.h
> @@ -2827,7 +2827,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 to be sampled
>   *
>   * Grab the most current superblock-level errseq_t value for the given
>   * struct file.
> 


thanks.
-- 
~Randy