diff mbox series

[-next] fs: Add kernel-doc comments to ocfs2_prepare_orphan_dir()

Message ID 20240322063718.88183-1-yang.lee@linux.alibaba.com (mailing list archive)
State New
Headers show
Series [-next] fs: Add kernel-doc comments to ocfs2_prepare_orphan_dir() | expand

Commit Message

Yang Li March 22, 2024, 6:37 a.m. UTC
This commit adds kernel-doc style comments with complete parameter
descriptions for the function ocfs2_prepare_orphan_dir.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 fs/ocfs2/namei.c | 2 ++
 1 file changed, 2 insertions(+)

Comments

Joseph Qi March 22, 2024, 12:41 p.m. UTC | #1
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 <yang.lee@linux.alibaba.com>

Acked-by: Joseph Qi <joseph.qi@linux.alibaba.com>
> ---
>  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.
diff mbox series

Patch

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.