diff mbox series

btrfs: block-group: fix a doc warning in block-group.c

Message ID 1600778241-24895-1-git-send-email-tanxiaofei@huawei.com
State New, archived
Headers show
Series btrfs: block-group: fix a doc warning in block-group.c | expand

Commit Message

Xiaofei Tan Sept. 22, 2020, 12:37 p.m. UTC
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'

Signed-off-by: Xiaofei Tan <tanxiaofei@huawei.com>
---
 fs/btrfs/block-group.c | 1 +
 1 file changed, 1 insertion(+)

Comments

David Sterba Sept. 23, 2020, 9:45 a.m. UTC | #1
On Tue, Sep 22, 2020 at 08:37:21PM +0800, Xiaofei Tan wrote:
> 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.
Xiaofei Tan Sept. 25, 2020, 8:21 a.m. UTC | #2
Hi David,

On 2020/9/23 17:45, David Sterba wrote:
> On Tue, Sep 22, 2020 at 08:37:21PM +0800, Xiaofei Tan wrote:
>> 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 :)

> .
>
diff mbox series

Patch

diff --git a/fs/btrfs/block-group.c b/fs/btrfs/block-group.c
index ea8aaf36..fea6350 100644
--- a/fs/btrfs/block-group.c
+++ b/fs/btrfs/block-group.c
@@ -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