Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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/20240410075629.3441-3-konishi.ryusuke@gmail.com
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Signed-off-by: Ryusuke Konishi <konishi.ryusuke@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
authored by
Yang Li
and committed by
Andrew Morton
3da9b965
27258440
+16
-7
+16
-7
fs/nilfs2/btree.c
+16
-7
fs/nilfs2/btree.c
···
1857
1857
}
1858
1858
1859
1859
/**
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.
1867
1876
*/
1868
1877
int nilfs_btree_convert_and_insert(struct nilfs_bmap *btree,
1869
1878
__u64 key, __u64 ptr,