btrfs: block-group: fix a doc warning in block-group.c
PATCH 1/1 btrfs: block-group: fix a doc warning in block-group.c
Fix following warning caused by mismatch bewteen function parameters
and comments.fs/btrfs/block-group.c:1649: warning: Function parameter or member 'fs_info' not described in 'btrfs_rmap_block'
--- fs/btrfs/block-group.c | 1 + 1 file changed, 1 insertion(+)
fs/btrfs/block-group.c +1 -0
@@ -1633,6 +1633,7 @@ static void set_avail_alloc_bits(struct btrfs_fs_info *fs_info, u64 flags)/** * btrfs_rmap_block - Map a physical disk address to a list of logical addresses +* @fs_info: the fs_info for our fs * @chunk_start: logical address of block group * @physical: physical address to map to logical addresses * @logical: return array of logical addresses which map to @physical
Signature · 1 line
2.8.1
Quoted 3 lines · Xiaofei Tan
Fix following warning caused by mismatch bewteen function parameters
and comments.fs/btrfs/block-group.c:1649: warning: Function parameter or member 'fs_info' not described in 'btrfs_rmap_block'
IIRC there are way more formatting errors for the kernel-doc, so I'd rather fix them in one patch. Also for static functions or internal helpers the proper formatting is not that important as it's read by people and the acual parameters are what matters.
Hi David,
Quoted 10 lines · David Sterba
Quoted 3 lines · Xiaofei Tan
Fix following warning caused by mismatch bewteen function parameters
and comments.fs/btrfs/block-group.c:1649: warning: Function parameter or member 'fs_info' not described in 'btrfs_rmap_block'IIRC there are way more formatting errors for the kernel-doc, so I'd rather fix them in one patch. Also for static functions or internal helpers the proper formatting is not that important as it's read by people and the acual parameters are what matters.
Sure, there are many warnings in the other files from dir fs/btrfs/. If fix them in one patch, it could be huge :)
Quoted 2 lines
.
Signature · 2 lines
thanks tanxiaofei