Skip to contentSkip to conversation

btrfs: compression: update the comment for alloc_compressed_bio()

PATCH Applied Qu Wenruo 2 participants 2 messages Oct 5, 2021 Btrfs file system

lore
Share & tools
lore

Qu Wenruo

author
#0 lore raw

PATCH 1/1 btrfs: compression: update the comment for alloc_compressed_bio()

This comment will include all parameters, not only the new @next_stripe_start.

---
 fs/btrfs/compression.c | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)
fs/btrfs/compression.c +12 -2
index 69a19d51fa35..cba82fdae7e5 100644
@@ -438,9 +438,19 @@ static blk_status_t submit_compressed_bio(struct btrfs_fs_info *fs_info,
 }
 
 /*
- * To allocate a compressed_bio, which will be used to read/write on-disk data.
+ * To allocate a compressed_bio, which will be used to read/write on-disk
+ * (aka, compressed) data.
  *
- * @next_stripe_start:	Disk bytenr of next stripe start
+ * @cb:		The compressed_bio structure, which records all the needed
+ * 		info to bind the compressed data to the uncompressed page cache.
+ * @disk_byten:	The logical bytenr where the compressed data will be read from
+ * 		or written to.
+ * @endio_func:	The endio function to call after the IO for compressed data is
+ * 		finished.
+ * @next_stripe_start:
+ * 		The Return value of Logical bytenr of where next stripe start.
+ * 		To inform the caller to only fill the bio up to the stripe
+ * 		boundary.
  */
 static struct bio *alloc_compressed_bio(struct compressed_bio *cb, u64 disk_bytenr,
 					unsigned int opf, bio_end_io_t endio_func,
Signature · 1 line
2.33.0
Applied
#1 lore raw
Quoted 4 lines · Qu Wenruo

This comment will include all parameters, not only the new @next_stripe_start.

Merged to the commit introducing the parameter, thanks.