[PATCH] btrfs: compression: update the comment for alloc_compressed_bio()

[PATCH] btrfs: compression: update the comment for alloc_compressed_bio()

[Qu Wenruo]

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

Signed-off-by: Qu Wenruo <wqu@suse.com>
---
 fs/btrfs/compression.c | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/fs/btrfs/compression.c b/fs/btrfs/compression.c
index 69a19d51fa35..cba82fdae7e5 100644
--- a/fs/btrfs/compression.c
+++ b/fs/btrfs/compression.c
@@ -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,
-- 
2.33.0

Re: [PATCH] btrfs: compression: update the comment for alloc_compressed_bio()

[David Sterba]

On Tue, Oct 05, 2021 at 02:21:44PM +0800, Qu Wenruo wrote:
> This comment will include all parameters, not only the new
> @next_stripe_start.
> 
> Signed-off-by: Qu Wenruo <wqu@suse.com>

Merged to the commit introducing the parameter, thanks.