[PATCH -next] fs: Fix jbd2_journal_try_to_free_buffers() kernel-doc comment

[PATCH -next] fs: Fix jbd2_journal_try_to_free_buffers() kernel-doc comment

[Yang Li]

Add the description of @folio and remove @page in function kernel-doc
comment to remove warnings found by running scripts/kernel-doc, which
is caused by using 'make W=1'.

fs/jbd2/transaction.c:2149: warning: Function parameter or member
'folio' not described in 'jbd2_journal_try_to_free_buffers'
fs/jbd2/transaction.c:2149: warning: Excess function parameter 'page'
description in 'jbd2_journal_try_to_free_buffers'

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 fs/jbd2/transaction.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/jbd2/transaction.c b/fs/jbd2/transaction.c
index e49bb0938376..e9c308ae475f 100644
--- a/fs/jbd2/transaction.c
+++ b/fs/jbd2/transaction.c
@@ -2114,7 +2114,7 @@ __journal_try_to_free_buffer(journal_t *journal, struct buffer_head *bh)
 /**
  * jbd2_journal_try_to_free_buffers() - try to free page buffers.
  * @journal: journal for operation
- * @page: to try and free
+ * @folio: Folio to detach data from.
  *
  * For all the buffers on this page,
  * if they are fully written out ordered data, move them onto BUF_CLEAN
-- 
2.20.1.7.g153144c

Re: [PATCH -next] fs: Fix jbd2_journal_try_to_free_buffers() kernel-doc comment

[Jan Kara]

On Thu 12-05-22 15:54:32, Yang Li wrote:
> Add the description of @folio and remove @page in function kernel-doc
> comment to remove warnings found by running scripts/kernel-doc, which
> is caused by using 'make W=1'.
> 
> fs/jbd2/transaction.c:2149: warning: Function parameter or member
> 'folio' not described in 'jbd2_journal_try_to_free_buffers'
> fs/jbd2/transaction.c:2149: warning: Excess function parameter 'page'
> description in 'jbd2_journal_try_to_free_buffers'
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

OK, but isn't this on linux-next only? Because I don't see the 'folio'
parameter in current Linus' tree yet.

								Honza

> ---
>  fs/jbd2/transaction.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/fs/jbd2/transaction.c b/fs/jbd2/transaction.c
> index e49bb0938376..e9c308ae475f 100644
> --- a/fs/jbd2/transaction.c
> +++ b/fs/jbd2/transaction.c
> @@ -2114,7 +2114,7 @@ __journal_try_to_free_buffer(journal_t *journal, struct buffer_head *bh)
>  /**
>   * jbd2_journal_try_to_free_buffers() - try to free page buffers.
>   * @journal: journal for operation
> - * @page: to try and free
> + * @folio: Folio to detach data from.
>   *
>   * For all the buffers on this page,
>   * if they are fully written out ordered data, move them onto BUF_CLEAN
> -- 
> 2.20.1.7.g153144c
> 
-- 
Jan Kara <jack@suse.com>
SUSE Labs, CR

Re: [PATCH -next] fs: Fix jbd2_journal_try_to_free_buffers() kernel-doc comment

[Theodore Ts'o]

On Thu, 12 May 2022 15:54:32 +0800, Yang Li wrote:
> Add the description of @folio and remove @page in function kernel-doc
> comment to remove warnings found by running scripts/kernel-doc, which
> is caused by using 'make W=1'.
> 
> fs/jbd2/transaction.c:2149: warning: Function parameter or member
> 'folio' not described in 'jbd2_journal_try_to_free_buffers'
> fs/jbd2/transaction.c:2149: warning: Excess function parameter 'page'
> description in 'jbd2_journal_try_to_free_buffers'
> 
> [...]

Applied, thanks!

[1/1] fs: Fix jbd2_journal_try_to_free_buffers() kernel-doc comment
      commit: 4f5bf12732fd78e225fc62b7c5c84d9032f8048a

Best regards,
-- 
Theodore Ts'o <tytso@mit.edu>