[PATCH -next 1/3] fs: Add kernel-doc comments to nilfs_do_roll_forward()

[PATCH -next 1/3] fs: Add kernel-doc comments to nilfs_do_roll_forward()

[Yang Li]

This commit adds kernel-doc style comments with complete parameter
descriptions for the function nilfs_do_roll_forward.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 fs/nilfs2/recovery.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/fs/nilfs2/recovery.c b/fs/nilfs2/recovery.c
index 49a70c68bf3c..e48372618ac4 100644
--- a/fs/nilfs2/recovery.c
+++ b/fs/nilfs2/recovery.c
@@ -563,6 +563,7 @@ static int nilfs_recover_dsync_blocks(struct the_nilfs *nilfs,
  * checkpoint
  * @nilfs: nilfs object
  * @sb: super block instance
+ * @root: NILFS root instance
  * @ri: pointer to a nilfs_recovery_info
  */
 static int nilfs_do_roll_forward(struct the_nilfs *nilfs,
-- 
2.20.1.7.g153144c

[PATCH -next 2/3] fs: Add kernel-doc comments to nilfs_btree_convert_and_insert()

[Yang Li]

This commit adds kernel-doc style comments with complete parameter
descriptions for the function nilfs_btree_convert_and_insert.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 fs/nilfs2/btree.c | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/fs/nilfs2/btree.c b/fs/nilfs2/btree.c
index 65659fa0372e..de38012fd87c 100644
--- a/fs/nilfs2/btree.c
+++ b/fs/nilfs2/btree.c
@@ -1857,13 +1857,21 @@ nilfs_btree_commit_convert_and_insert(struct nilfs_bmap *btree,
 }
 
 /**
- * nilfs_btree_convert_and_insert -
- * @bmap:
- * @key:
- * @ptr:
- * @keys:
- * @ptrs:
- * @n:
+ * nilfs_btree_convert_and_insert - Convert and insert entries into a B-tree
+ * @btree: NILFS B-tree structure
+ * @key: Key of the new entry to be inserted
+ * @ptr: Pointer (block number) associated with the key to be inserted
+ * @keys: Array of keys to be inserted in addition to @key
+ * @ptrs: Array of pointers associated with @keys
+ * @n: Number of keys and pointers in @keys and @ptrs
+ *
+ * This function is used to insert a new entry specified by @key and @ptr, along
+ * with additional entries specified by @keys and @ptrs arrays, into a NILFS B-tree.
+ * It prepares the necessary changes by allocating the required blocks and any
+ * necessary intermediate nodes. This function handles the conversion of a B-tree
+ * node when it is necessary to split it due to the size constraint.
+ *
+ * Return: 0 on success or a negative error code on failure.
  */
 int nilfs_btree_convert_and_insert(struct nilfs_bmap *btree,
 				   __u64 key, __u64 ptr,
-- 
2.20.1.7.g153144c

[PATCH -next 3/3] fs: Add kernel-doc comments to nilfs_remove_all_gcinodes()

[Yang Li]

This commit adds kernel-doc style comments with complete parameter
descriptions for the function nilfs_remove_all_gcinodes.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 fs/nilfs2/gcinode.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/fs/nilfs2/gcinode.c b/fs/nilfs2/gcinode.c
index bf9a11d58817..1c9ae36a03ab 100644
--- a/fs/nilfs2/gcinode.c
+++ b/fs/nilfs2/gcinode.c
@@ -175,6 +175,7 @@ int nilfs_init_gcinode(struct inode *inode)
 
 /**
  * nilfs_remove_all_gcinodes() - remove all unprocessed gc inodes
+ * @nilfs: NILFS filesystem instance
  */
 void nilfs_remove_all_gcinodes(struct the_nilfs *nilfs)
 {
-- 
2.20.1.7.g153144c

Re: [PATCH -next 2/3] fs: Add kernel-doc comments to nilfs_btree_convert_and_insert()

[Ryusuke Konishi]

On Fri, Mar 22, 2024 at 4:32 PM Yang Li wrote:
>
> This commit adds kernel-doc style comments with complete parameter
> descriptions for the function nilfs_btree_convert_and_insert.
>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
>  fs/nilfs2/btree.c | 22 +++++++++++++++-------
>  1 file changed, 15 insertions(+), 7 deletions(-)
>
> diff --git a/fs/nilfs2/btree.c b/fs/nilfs2/btree.c
> index 65659fa0372e..de38012fd87c 100644
> --- a/fs/nilfs2/btree.c
> +++ b/fs/nilfs2/btree.c
> @@ -1857,13 +1857,21 @@ nilfs_btree_commit_convert_and_insert(struct nilfs_bmap *btree,
>  }
>
>  /**
> - * nilfs_btree_convert_and_insert -
> - * @bmap:
> - * @key:
> - * @ptr:
> - * @keys:
> - * @ptrs:
> - * @n:
> + * nilfs_btree_convert_and_insert - Convert and insert entries into a B-tree
> + * @btree: NILFS B-tree structure
> + * @key: Key of the new entry to be inserted
> + * @ptr: Pointer (block number) associated with the key to be inserted
> + * @keys: Array of keys to be inserted in addition to @key
> + * @ptrs: Array of pointers associated with @keys
> + * @n: Number of keys and pointers in @keys and @ptrs
> + *
> + * This function is used to insert a new entry specified by @key and @ptr, along
> + * with additional entries specified by @keys and @ptrs arrays, into a NILFS B-tree.
> + * It prepares the necessary changes by allocating the required blocks and any
> + * necessary intermediate nodes. This function handles the conversion of a B-tree
> + * node when it is necessary to split it due to the size constraint.
> + *
> + * Return: 0 on success or a negative error code on failure.
>   */
>  int nilfs_btree_convert_and_insert(struct nilfs_bmap *btree,
>                                    __u64 key, __u64 ptr,
> --
> 2.20.1.7.g153144c
>

Hi,

First of all, thank you for posting these patches.
These three kernel-doc comment completions are necessary.

One thing I would like to point out is that the last part of the
descriptive comment for this patch is not accurate.
nilfs_btree_convert_and_insert() is used to convert configurations
from other forms of block mapping (the one that currently exists is
direct mapping) to a B-tree, and is not intended to split a B-tree
node block on excess of the number of entries.

So, I'd like to slightly adjust the description for this patch and
send all three to upstream.
Or, if you want to fix it yourself, please send me the revised version.

Thanks,
Ryusuke Konishi