ext4: fix return-value types in several function comments

The documentation comments for ext4_read_block_bitmap_nowait and
ext4_read_inode_bitmap describe them as returning NULL on error, but
they return an ERR_PTR on error; update the documentation to match.

The documentation comment for ext4_wait_block_bitmap describes it as
returning 1 on error, but it returns -errno on error; update the
documentation to match.

Signed-off-by: Josh Triplett <josh@joshtriplett.org>
Reviewed-by: Ritesh Harani <riteshh@linux.ibm.com>
Link: https://lore.kernel.org/r/60a3f4996f4932c45515aaa6b75ca42f2a78ec9b.1585512514.git.josh@joshtriplett.org
Signed-off-by: Theodore Ts'o <tytso@mit.edu>
This commit is contained in:
Josh Triplett 2020-03-29 13:21:41 -07:00 committed by Theodore Ts'o
parent d87f639258
commit 9033783c8c
2 changed files with 3 additions and 3 deletions

View File

@ -410,7 +410,7 @@ static int ext4_validate_block_bitmap(struct super_block *sb,
* Read the bitmap for a given block_group,and validate the * Read the bitmap for a given block_group,and validate the
* bits for block/inode/inode tables are set in the bitmaps * bits for block/inode/inode tables are set in the bitmaps
* *
* Return buffer_head on success or NULL in case of failure. * Return buffer_head on success or an ERR_PTR in case of failure.
*/ */
struct buffer_head * struct buffer_head *
ext4_read_block_bitmap_nowait(struct super_block *sb, ext4_group_t block_group) ext4_read_block_bitmap_nowait(struct super_block *sb, ext4_group_t block_group)
@ -502,7 +502,7 @@ ext4_read_block_bitmap_nowait(struct super_block *sb, ext4_group_t block_group)
return ERR_PTR(err); return ERR_PTR(err);
} }
/* Returns 0 on success, 1 on error */ /* Returns 0 on success, -errno on error */
int ext4_wait_block_bitmap(struct super_block *sb, ext4_group_t block_group, int ext4_wait_block_bitmap(struct super_block *sb, ext4_group_t block_group,
struct buffer_head *bh) struct buffer_head *bh)
{ {

View File

@ -113,7 +113,7 @@ static int ext4_validate_inode_bitmap(struct super_block *sb,
* Read the inode allocation bitmap for a given block_group, reading * Read the inode allocation bitmap for a given block_group, reading
* into the specified slot in the superblock's bitmap cache. * into the specified slot in the superblock's bitmap cache.
* *
* Return buffer_head of bitmap on success or NULL. * Return buffer_head of bitmap on success, or an ERR_PTR on error.
*/ */
static struct buffer_head * static struct buffer_head *
ext4_read_inode_bitmap(struct super_block *sb, ext4_group_t block_group) ext4_read_inode_bitmap(struct super_block *sb, ext4_group_t block_group)