Skip to contentSkip to conversation

btrfs: Fix argument list that the kdoc format and script verified.

PATCH In review Yang Li 2 participants 2 messages Dec 20, 2021 – Jan 3, 2022 Btrfs file system

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 btrfs: Fix argument list that the kdoc format and script verified.

The warnings were found by running scripts/kernel-doc, which is caused by using 'make W=1'.

fs/btrfs/extent_io.c:3210: warning: Function parameter or member 'bio_ctrl' not described in 'btrfs_bio_add_page' fs/btrfs/extent_io.c:3210: warning: Excess function parameter 'bio' description in 'btrfs_bio_add_page' fs/btrfs/extent_io.c:3210: warning: Excess function parameter 'prev_bio_flags' description in 'btrfs_bio_add_page' fs/btrfs/space-info.c:1602: warning: Excess function parameter 'root' description in 'btrfs_reserve_metadata_bytes' fs/btrfs/space-info.c:1602: warning: Function parameter or member 'fs_info' not described in 'btrfs_reserve_metadata_bytes'

---
 fs/btrfs/extent_io.c  | 5 ++---
 fs/btrfs/space-info.c | 2 +-
 2 files changed, 3 insertions(+), 4 deletions(-)
fs/btrfs/extent_io.c +2 -3
index 9234d96a7fd5..a6b4a78848dd 100644
@@ -3187,13 +3187,12 @@ struct bio *btrfs_bio_clone_partial(struct bio *orig, u64 offset, u64 size)
 /**
  * Attempt to add a page to bio
  *
- * @bio:	destination bio
+ * @bio_ctrl:	record both the bio, and its bio_flags
  * @page:	page to add to the bio
  * @disk_bytenr:  offset of the new bio or to check whether we are adding
  *                a contiguous page to the previous one
- * @pg_offset:	starting offset in the page
  * @size:	portion of page that we want to write
- * @prev_bio_flags:  flags of previous bio to see if we can merge the current one
+ * @pg_offset:	starting offset in the page
  * @bio_flags:	flags of the current bio to see if we can merge them
  *
  * Attempt to add a page to bio considering stripe alignment etc.
fs/btrfs/space-info.c +1 -1
index dbf8bfb8fcb3..618b59ff44ae 100644
@@ -1583,7 +1583,7 @@ static int __reserve_bytes(struct btrfs_fs_info *fs_info,
 /**
  * Trye to reserve metadata bytes from the block_rsv's space
  *
- * @root:       the root we're allocating for
+ * @fs_info:    the filesystem
  * @block_rsv:  block_rsv we're allocating for
  * @orig_bytes: number of bytes we want
  * @flush:      whether or not we can flush to make our reservation
Signature · 1 line
2.20.1.7.g153144c
#1 lore raw
Quoted 14 lines · Yang Li

The warnings were found by running scripts/kernel-doc, which is caused by using 'make W=1'.

fs/btrfs/extent_io.c:3210: warning: Function parameter or member 'bio_ctrl' not described in 'btrfs_bio_add_page' fs/btrfs/extent_io.c:3210: warning: Excess function parameter 'bio' description in 'btrfs_bio_add_page' fs/btrfs/extent_io.c:3210: warning: Excess function parameter 'prev_bio_flags' description in 'btrfs_bio_add_page' fs/btrfs/space-info.c:1602: warning: Excess function parameter 'root' description in 'btrfs_reserve_metadata_bytes' fs/btrfs/space-info.c:1602: warning: Function parameter or member 'fs_info' not described in 'btrfs_reserve_metadata_bytes'

Quoted 2 lines

Added to misc-next, thanks. I've added a note why it's fixing only the parameter warnings.