fs: Add kernel-doc comments to nilfs_btree_convert_and_insert()
PATCH v2 2/3 fs: Add kernel-doc comments to nilfs_btree_convert_and_insert()
This commit adds kernel-doc style comments with complete parameter descriptions for the function nilfs_btree_convert_and_insert.
Signed-off-by Yang Li <[email protected]>
--- fs/nilfs2/btree.c | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-)
fs/nilfs2/btree.c +15 -7
@@ -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. It converts configurations from other forms of block +* mapping (the one that currently exists is direct mapping) to a B-tree. +* +* 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,
Signature · 1 line
2.20.1.7.g153144c
Ryusuke Konishi
maintainerQuoted 43 lines · 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 <[email protected]>--- fs/nilfs2/btree.c | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-)fs/nilfs2/btree.c +15
-8@@ -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. It converts configurations from other forms of block +* mapping (the one that currently exists is direct mapping) to a B-tree. +* +* 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, --
Quoted 2 lines
2.20.1.7.g153144c
Thank you for the revised version. I'll take this one.
Ryusuke Konishi