Skip to content

Commit 3da9b96

Browse files
Yang Liakpm00
authored andcommitted
nilfs2: 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. Link: https://lkml.kernel.org/r/[email protected] Signed-off-by: Yang Li <[email protected]> Signed-off-by: Ryusuke Konishi <[email protected]> Signed-off-by: Andrew Morton <[email protected]>
1 parent 2725844 commit 3da9b96

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

fs/nilfs2/btree.c

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1857,13 +1857,22 @@ nilfs_btree_commit_convert_and_insert(struct nilfs_bmap *btree,
18571857
}
18581858

18591859
/**
1860-
* nilfs_btree_convert_and_insert -
1861-
* @bmap:
1862-
* @key:
1863-
* @ptr:
1864-
* @keys:
1865-
* @ptrs:
1866-
* @n:
1860+
* nilfs_btree_convert_and_insert - Convert and insert entries into a B-tree
1861+
* @btree: NILFS B-tree structure
1862+
* @key: Key of the new entry to be inserted
1863+
* @ptr: Pointer (block number) associated with the key to be inserted
1864+
* @keys: Array of keys to be inserted in addition to @key
1865+
* @ptrs: Array of pointers associated with @keys
1866+
* @n: Number of keys and pointers in @keys and @ptrs
1867+
*
1868+
* This function is used to insert a new entry specified by @key and @ptr,
1869+
* along with additional entries specified by @keys and @ptrs arrays, into a
1870+
* NILFS B-tree.
1871+
* It prepares the necessary changes by allocating the required blocks and any
1872+
* necessary intermediate nodes. It converts configurations from other forms of
1873+
* block mapping (the one that currently exists is direct mapping) to a B-tree.
1874+
*
1875+
* Return: 0 on success or a negative error code on failure.
18671876
*/
18681877
int nilfs_btree_convert_and_insert(struct nilfs_bmap *btree,
18691878
__u64 key, __u64 ptr,

0 commit comments

Comments
 (0)