On Mon, Jan 08, 2024 at 03:58:08PM +0100, Pankaj Raghav (Samsung) wrote: > On Thu, Jan 04, 2024 at 04:36:51PM +0000, Matthew Wilcox (Oracle) wrote: > > The extra indentation confused the kernel-doc parser, so remove it. > > Fix some other wording while I'm here, and advise the user they need to > > call brelse() on this buffer. > > > It looks like __bread_gfp has the same problem: I'm happy to incorporate this patch, but I'll need your S-o-B on it. > diff --git a/fs/buffer.c b/fs/buffer.c > index 967f34b70aa8..cfdf45cc290a 100644 > --- a/fs/buffer.c > +++ b/fs/buffer.c > @@ -1446,16 +1446,18 @@ void __breadahead(struct block_device *bdev, sector_t block, unsigned size) > EXPORT_SYMBOL(__breadahead); > > /** > - * __bread_gfp() - reads a specified block and returns the bh > - * @bdev: the block_device to read from > - * @block: number of block > - * @size: size (in bytes) to read > - * @gfp: page allocation flag > + * __bread_gfp() - Read a block. > + * @bdev: The block device to read from. > + * @block: Block number in units of block size. > + * @size: Block size in bytes. > * > - * Reads a specified block, and returns buffer head that contains it. > - * The page cache can be allocated from non-movable area > - * not to prevent page migration if you set gfp to zero. > - * It returns NULL if the block was unreadable. > + * Read a specified block, and return the buffer head that refers to it. > + * The memory can be allocated from a non-movable area to not to prevent > + * page migration if you set gfp to zero. The buffer head has its > + * refcount elevated and the caller should call brelse() when it has > + * finished with the buffer. > + * > + * Return: NULL if the block was unreadable. > */ > struct buffer_head * > __bread_gfp(struct block_device *bdev, sector_t block, > (END) > > Another option is to just change this in __bread_gfp() and add a See > __bread_gfp() in __bread()?
