Skip to contentSkip to conversation

fs: Fix jbd2_journal_try_to_free_buffers() kernel-doc comment

PATCH Applied Yang Li 3 participants 3 messages May 12, 2022 – Jun 16, 2022 Journalling layer for block devices (JBD2)

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 fs: Fix jbd2_journal_try_to_free_buffers() kernel-doc comment

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'

---
 fs/jbd2/transaction.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
fs/jbd2/transaction.c +1 -1
index e49bb0938376..e9c308ae475f 100644
@@ -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
Signature · 1 line
2.20.1.7.g153144c
#1 lore raw
Quoted 11 lines · 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'

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

Honza

Quoted 20 lines
---
 fs/jbd2/transaction.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
fs/jbd2/transaction.c +1 -1
index e49bb0938376..e9c308ae475f 100644
@@ -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
Signature · 1 line
2.20.1.7.g153144c
Signature · 2 lines
Jan Kara <[email protected]>
SUSE Labs, CR
maintainer Applied
#2 lore raw
In reply to Yang Li
Quoted 10 lines · 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'

[...]

Applied, thanks!

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

      commit: 4f5bf12732fd78e225fc62b7c5c84d9032f8048a

Best regards,

Signature · 1 line
Theodore Ts'o <[email protected]>