ext3: Update kernel-doc comments
PATCH 1/1 ext3: Update kernel-doc comments
Update missing/broken argument descriptions and fix formatting.
Signed-off-by Namhyung Kim <[email protected]>
--- fs/ext3/balloc.c | 13 ++++++++----- fs/ext3/inode.c | 19 ++++++++++++------- 2 files changed, 20 insertions(+), 12 deletions(-)
fs/ext3/balloc.c +8 -5
@@ -810,8 +810,9 @@ find_next_usable_block(ext3_grpblk_t start, struct buffer_head *bh,/** * claim_block() +* @lock: the spin lock for this block group * @block: the free block (group relative) to allocate -* @bh: the bufferhead containts the block group bitmap +* @bh: the buffer_head contains the block group bitmap * * We think we can allocate this block in this bitmap. Try to set the bit. * If that succeeds then check that nobody has allocated and then freed the
@@ -956,9 +957,11 @@ fail_access:* but we will shift to the place where start_block is, * then start from there, when looking for a reservable space. * -* @size: the target new reservation window size +* @my_rsv: the reservation window * -* @group_first_block: the first block we consider to start +* @sb: the super block +* +* @start_block: the first block we consider to start * the real search from * * @last_block:
@@ -1084,7 +1087,7 @@ static int find_next_reservable_window(* * failed: we failed to find a reservation window in this group * -* @rsv: the reservation +* @my_rsv: the reservation window * * @grp_goal: The goal (group-relative). It is where the search for a * free reservable space should start from.
@@ -1273,8 +1276,8 @@ static void try_to_extend_reservation(struct ext3_reserve_window_node *my_rsv,* @group: given allocation block group * @bitmap_bh: bufferhead holds the block bitmap * @grp_goal: given target block within the group -* @count: target number of blocks to allocate * @my_rsv: reservation window +* @count: target number of blocks to allocate * @errp: pointer to store the error code * * This is the main function used to allocate a new block and its reservation
fs/ext3/inode.c +12 -7
@@ -498,7 +498,7 @@ static ext3_fsblk_t ext3_find_goal(struct inode *inode, long block, }/** -* ext3_blks_to_allocate: Look up the block map and count the number +* ext3_blks_to_allocate - Look up the block map and count the number * of direct blocks need to be allocated for the given branch. * * @branch: chain of indirect blocks
@@ -536,14 +536,18 @@ static int ext3_blks_to_allocate(Indirect *branch, int k, unsigned long blks, }/** -* ext3_alloc_blocks: multiple allocate blocks needed for a branch +* ext3_alloc_blocks - multiple allocate blocks needed for a branch +* @handle: handle for this transaction +* @inode: owner +* @goal: preferred place for allocation * @indirect_blks: the number of blocks need to allocate for indirect * blocks -* +* @blks: number of blocks need to allocated for direct blocks * @new_blocks: on return it will store the new block numbers for * the indirect blocks(if needed) and the first direct block, -* @blks: on return it will store the total number of allocated -* direct blocks +* @err: here we store the error value +* +* return the number of direct blocks allocated */ static int ext3_alloc_blocks(handle_t *handle, struct inode *inode, ext3_fsblk_t goal, int indirect_blks, int blks,
@@ -598,9 +602,11 @@ failed_out:/** * ext3_alloc_branch - allocate and set up a chain of blocks. +* @handle: handle for this transaction * @inode: owner * @indirect_blks: number of allocated indirect blocks * @blks: number of allocated direct blocks +* @goal: preferred place for allocation * @offsets: offsets (in the blocks) to store the pointers to next. * @branch: place to store the chain in. *
@@ -700,10 +706,9 @@ failed:/** * ext3_splice_branch - splice the allocated branch onto inode. +* @handle: handle for this transaction * @inode: owner * @block: (logical) number of block we are adding -* @chain: chain of indirect blocks (with a missing link - see -* ext3_alloc_branch) * @where: location of missing link * @num: number of indirect blocks we are adding * @blks: number of direct blocks we are adding
Signature · 1 line
1.7.0.4
Quoted 1 line · Namhyung Kim
Update missing/broken argument descriptions and fix formatting.
Thanks. Merged.
Honza
Quoted 117 lines
Signed-off-by Namhyung Kim <[email protected]>--- fs/ext3/balloc.c | 13 ++++++++----- fs/ext3/inode.c | 19 ++++++++++++------- 2 files changed, 20 insertions(+), 12 deletions(-)fs/ext3/balloc.c +8
-5@@ -810,8 +810,9 @@ find_next_usable_block(ext3_grpblk_t start, struct buffer_head *bh,/** * claim_block() +* @lock: the spin lock for this block group * @block: the free block (group relative) to allocate -* @bh: the bufferhead containts the block group bitmap +* @bh: the buffer_head contains the block group bitmap * * We think we can allocate this block in this bitmap. Try to set the bit. * If that succeeds then check that nobody has allocated and then freed the @@ -956,9 +957,11 @@ fail_access:* but we will shift to the place where start_block is, * then start from there, when looking for a reservable space. * -* @size: the target new reservation window size +* @my_rsv: the reservation window * -* @group_first_block: the first block we consider to start +* @sb: the super block +* +* @start_block: the first block we consider to start * the real search from * * @last_block: @@ -1084,7 +1087,7 @@ static int find_next_reservable_window(* * failed: we failed to find a reservation window in this group * -* @rsv: the reservation +* @my_rsv: the reservation window * * @grp_goal: The goal (group-relative). It is where the search for a * free reservable space should start from. @@ -1273,8 +1276,8 @@ static void try_to_extend_reservation(struct ext3_reserve_window_node *my_rsv,* @group: given allocation block group * @bitmap_bh: bufferhead holds the block bitmap * @grp_goal: given target block within the group -* @count: target number of blocks to allocate * @my_rsv: reservation window +* @count: target number of blocks to allocate * @errp: pointer to store the error code * * This is the main function used to allocate a new block and its reservation fs/ext3/inode.c +12
-7@@ -498,7 +498,7 @@ static ext3_fsblk_t ext3_find_goal(struct inode *inode, long block, }/** -* ext3_blks_to_allocate: Look up the block map and count the number +* ext3_blks_to_allocate - Look up the block map and count the number * of direct blocks need to be allocated for the given branch. * * @branch: chain of indirect blocks @@ -536,14 +536,18 @@ static int ext3_blks_to_allocate(Indirect *branch, int k, unsigned long blks, }/** -* ext3_alloc_blocks: multiple allocate blocks needed for a branch +* ext3_alloc_blocks - multiple allocate blocks needed for a branch +* @handle: handle for this transaction +* @inode: owner +* @goal: preferred place for allocation * @indirect_blks: the number of blocks need to allocate for indirect * blocks -* +* @blks: number of blocks need to allocated for direct blocks * @new_blocks: on return it will store the new block numbers for * the indirect blocks(if needed) and the first direct block, -* @blks: on return it will store the total number of allocated -* direct blocks +* @err: here we store the error value +* +* return the number of direct blocks allocated */ static int ext3_alloc_blocks(handle_t *handle, struct inode *inode, ext3_fsblk_t goal, int indirect_blks, int blks,@@ -598,9 +602,11 @@ failed_out:/** * ext3_alloc_branch - allocate and set up a chain of blocks. +* @handle: handle for this transaction * @inode: owner * @indirect_blks: number of allocated indirect blocks * @blks: number of allocated direct blocks +* @goal: preferred place for allocation * @offsets: offsets (in the blocks) to store the pointers to next. * @branch: place to store the chain in. * @@ -700,10 +706,9 @@ failed:/** * ext3_splice_branch - splice the allocated branch onto inode. +* @handle: handle for this transaction * @inode: owner * @block: (logical) number of block we are adding -* @chain: chain of indirect blocks (with a missing link - see -* ext3_alloc_branch) * @where: location of missing link * @num: number of indirect blocks we are adding * @blks: number of direct blocks we are adding Signature · 1 line
1.7.0.4
Signature · 2 lines
Jan Kara <[email protected]> SUSE Labs, CR