buffer: fix __bread and __bread_gfp kernel-doc
authorMatthew Wilcox (Oracle) <willy@infradead.org>
Tue, 16 Apr 2024 03:17:48 +0000 (04:17 +0100)
committerAndrew Morton <akpm@linux-foundation.org>
Mon, 6 May 2024 00:53:39 +0000 (17:53 -0700)
commit324ecaee46f86c1eaf083fd82eaf997335e70163
treeca89bd00f58bc1eb61f5575e8b52ca92d584aecf
parentb1888d143203589b71ab31b39d1070737287bc79
buffer: fix __bread and __bread_gfp kernel-doc

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.

__bread_gfp() isn't used directly by filesystems, but the other wrappers
for it don't have documentation, so document it accordingly.

Link: https://lkml.kernel.org/r/20240416031754.4076917-5-willy@infradead.org
Co-developed-by: Pankaj Raghav <p.raghav@samsung.com>
Signed-off-by: Pankaj Raghav <p.raghav@samsung.com>
Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
fs/buffer.c
include/linux/buffer_head.h