[PATCH 2/2] btrfs: Fix kernel-doc

[PATCH 2/2] btrfs: Fix kernel-doc

[Jiapeng Chong]

Fix the following W=1 kernel warnings:

fs/btrfs/space-info.c:1601: warning: This comment starts with '/**', but
isn't a kernel-doc comment. Refer
Documentation/doc-guide/kernel-doc.rst.

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Jiapeng Chong <jiapeng.chong@linux.alibaba.com>
---
 fs/btrfs/space-info.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/btrfs/space-info.c b/fs/btrfs/space-info.c
index 2dd8754cb990..bd9ac89c9d6e 100644
--- a/fs/btrfs/space-info.c
+++ b/fs/btrfs/space-info.c
@@ -1598,7 +1598,7 @@ static int __reserve_bytes(struct btrfs_fs_info *fs_info,
 }
 
 /**
- * Trye to reserve metadata bytes from the block_rsv's space
+ * btrfs_reserve_metadata_bytes() - Trye to reserve metadata bytes from the block_rsv's space
  *
  * @fs_info:    the filesystem
  * @block_rsv:  block_rsv we're allocating for
-- 
2.20.1.7.g153144c

[PATCH 1/2] btrfs: kernel-doc fixes

[Jiapeng Chong]

Fix the following W=1 kernel warnings:

fs/btrfs/block-group.c:1731: warning: This comment starts with '/**',
but isn't a kernel-doc comment. Refer
Documentation/doc-guide/kernel-doc.rst.

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Jiapeng Chong <jiapeng.chong@linux.alibaba.com>
---
 fs/btrfs/block-group.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/btrfs/block-group.c b/fs/btrfs/block-group.c
index 7bf10afab89c..9ab1a82aa600 100644
--- a/fs/btrfs/block-group.c
+++ b/fs/btrfs/block-group.c
@@ -1728,7 +1728,7 @@ static void set_avail_alloc_bits(struct btrfs_fs_info *fs_info, u64 flags)
 }
 
 /**
- * Map a physical disk address to a list of logical addresses
+ * btrfs_rmap_block() - Map a physical disk address to a list of logical addresses
  *
  * @fs_info:       the filesystem
  * @chunk_start:   logical address of block group
-- 
2.20.1.7.g153144c

Re: [PATCH 2/2] btrfs: Fix kernel-doc

[David Sterba]

On Thu, Oct 27, 2022 at 02:20:13PM +0800, Jiapeng Chong wrote:
> No functional modification involved.
> 
> fs/btrfs/ordered-data.c:169: warning: expecting prototype for Add an ordered extent to the per(). Prototype was for btrfs_add_ordered_extent() instead.

Thanks, I've sent patch that fixes all the kdoc formatting so we don't
get any more warnings.

[PATCH 2/2] btrfs: Fix kernel-doc

[Jiapeng Chong]

No functional modification involved.

fs/btrfs/ordered-data.c:169: warning: expecting prototype for Add an ordered extent to the per(). Prototype was for btrfs_add_ordered_extent() instead.

Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=2603
Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Jiapeng Chong <jiapeng.chong@linux.alibaba.com>
---
 fs/btrfs/ordered-data.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/btrfs/ordered-data.c b/fs/btrfs/ordered-data.c
index 1cbaacdc50da..461ecbe75e0f 100644
--- a/fs/btrfs/ordered-data.c
+++ b/fs/btrfs/ordered-data.c
@@ -145,7 +145,7 @@ static inline struct rb_node *tree_search(struct btrfs_ordered_inode_tree *tree,
 }
 
 /**
- * Add an ordered extent to the per-inode tree.
+ * btrfs_add_ordered_extent - Add an ordered extent to the per-inode tree.
  *
  * @inode:           Inode that this extent is for.
  * @file_offset:     Logical offset in file where the extent starts.
-- 
2.20.1.7.g153144c