nilfs2: fix missing kernel-doc comments
Ryusuke Konishi
maintainercover nilfs2: fix missing kernel-doc comments
Hi Andrew,
please queue this series for the next merge cycle.
All of theses are to fill in missing kernel-doc comments or correct missing argument descriptions.
Thanks,
Ryusuke Konishi
Yang Li (3):
nilfs2: Add kernel-doc comments to nilfs_do_roll_forward()
nilfs2: Add kernel-doc comments to nilfs_btree_convert_and_insert()
nilfs2: Add kernel-doc comments to nilfs_remove_all_gcinodes()
fs/nilfs2/btree.c | 23 ++++++++++++++++------- fs/nilfs2/gcinode.c | 1 + fs/nilfs2/recovery.c | 1 + 3 files changed, 18 insertions(+), 7 deletions(-)
Signature · 1 line
2.34.1
Ryusuke Konishi
maintainerPATCH 1/3 nilfs2: Add kernel-doc comments to nilfs_do_roll_forward()
From: Yang Li <[email protected]>
This commit adds kernel-doc style comments with complete parameter descriptions for the function nilfs_do_roll_forward.
--- fs/nilfs2/recovery.c | 1 + 1 file changed, 1 insertion(+)
fs/nilfs2/recovery.c +1 -0
@@ -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,
Signature · 1 line
2.34.1
Ryusuke Konishi
maintainerPATCH 2/3 nilfs2: Add kernel-doc comments to nilfs_btree_convert_and_insert()
In reply to Ryusuke KonishiFrom: Yang Li <[email protected]>
This commit adds kernel-doc style comments with complete parameter descriptions for the function nilfs_btree_convert_and_insert.
--- fs/nilfs2/btree.c | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-)
fs/nilfs2/btree.c +16 -7
@@ -1857,13 +1857,22 @@ 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.34.1
Ryusuke Konishi
maintainerPATCH 3/3 nilfs2: Add kernel-doc comments to nilfs_remove_all_gcinodes()
In reply to Ryusuke KonishiFrom: Yang Li <[email protected]>
This commit adds kernel-doc style comments with complete parameter descriptions for the function nilfs_remove_all_gcinodes.
--- fs/nilfs2/gcinode.c | 1 + 1 file changed, 1 insertion(+)
fs/nilfs2/gcinode.c +1 -0
@@ -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) {
Signature · 1 line
2.34.1