2024-03-22 06:37:38

by Yang Li

[permalink] [raw]
Subject: [PATCH -next] fs: Add kernel-doc comments to ocfs2_prepare_orphan_dir()

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

Signed-off-by: Yang Li <[email protected]>
---
fs/ocfs2/namei.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/fs/ocfs2/namei.c b/fs/ocfs2/namei.c
index 9221a33f917b..8a61c5f94533 100644
--- a/fs/ocfs2/namei.c
+++ b/fs/ocfs2/namei.c
@@ -2187,8 +2187,10 @@ static int __ocfs2_prepare_orphan_dir(struct inode *orphan_dir_inode,
* @osb: ocfs2 file system
* @ret_orphan_dir: Orphan dir inode - returned locked!
* @blkno: Actual block number of the inode to be inserted into orphan dir.
+ * @name: Buffer to store the name of the orphan.
* @lookup: dir lookup result, to be passed back into functions like
* ocfs2_orphan_add
+ * @dio: Flag indicating if direct IO is being used or not.
*
* Returns zero on success and the ret_orphan_dir, name and lookup
* fields will be populated.
--
2.20.1.7.g153144c



2024-03-22 12:46:59

by Joseph Qi

[permalink] [raw]
Subject: Re: [PATCH -next] fs: Add kernel-doc comments to ocfs2_prepare_orphan_dir()



On 3/22/24 2:37 PM, Yang Li wrote:
> This commit adds kernel-doc style comments with complete parameter
> descriptions for the function ocfs2_prepare_orphan_dir.
>
> Signed-off-by: Yang Li <[email protected]>

Acked-by: Joseph Qi <[email protected]>
> ---
> fs/ocfs2/namei.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/fs/ocfs2/namei.c b/fs/ocfs2/namei.c
> index 9221a33f917b..8a61c5f94533 100644
> --- a/fs/ocfs2/namei.c
> +++ b/fs/ocfs2/namei.c
> @@ -2187,8 +2187,10 @@ static int __ocfs2_prepare_orphan_dir(struct inode *orphan_dir_inode,
> * @osb: ocfs2 file system
> * @ret_orphan_dir: Orphan dir inode - returned locked!
> * @blkno: Actual block number of the inode to be inserted into orphan dir.
> + * @name: Buffer to store the name of the orphan.
> * @lookup: dir lookup result, to be passed back into functions like
> * ocfs2_orphan_add
> + * @dio: Flag indicating if direct IO is being used or not.
> *
> * Returns zero on success and the ret_orphan_dir, name and lookup
> * fields will be populated.