freevxfs: Fix comment on vxfs_readdir

[PATCH -next] freevxfs: Fix comment on vxfs_readdir

Posted by GUO Zihua 2 years, 3 months ago

As vxfs_readdir now switches to iterate_shared interface, the parameter
of the function is changed. However, the comment of has not been
updated.

This patch updates function doc to reflect this change.

Fixes: 9b5d5a170781 ("[readdir] convert freevxfs")
Signed-off-by: GUO Zihua <guozihua@huawei.com>
---
 fs/freevxfs/vxfs_lookup.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/fs/freevxfs/vxfs_lookup.c b/fs/freevxfs/vxfs_lookup.c
index f04ba2ed1e1a..53cbb7209324 100644
--- a/fs/freevxfs/vxfs_lookup.c
+++ b/fs/freevxfs/vxfs_lookup.c
@@ -177,12 +177,11 @@ vxfs_lookup(struct inode *dip, struct dentry *dp, unsigned int flags)
 /**
  * vxfs_readdir - read a directory
  * @fp:		the directory to read
- * @retp:	return buffer
- * @filler:	filldir callback
+ * @ctx:	Dir context
  *
  * Description:
- *   vxfs_readdir fills @retp with directory entries from @fp
- *   using the VFS supplied callback @filler.
+ *   vxfs_readdir emits directory entries from @fp using the
+ *   VFS supplied @ctx.
  *
  * Returns:
  *   Zero.
-- 
2.17.1

Re: [PATCH -next] freevxfs: Fix comment on vxfs_readdir

Posted by Randy Dunlap 2 years, 3 months ago


On 8/21/23 18:40, GUO Zihua wrote:
> As vxfs_readdir now switches to iterate_shared interface, the parameter
> of the function is changed. However, the comment of has not been
> updated.
> 
> This patch updates function doc to reflect this change.
> 
> Fixes: 9b5d5a170781 ("[readdir] convert freevxfs")
> Signed-off-by: GUO Zihua <guozihua@huawei.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  fs/freevxfs/vxfs_lookup.c | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)
> 
> diff --git a/fs/freevxfs/vxfs_lookup.c b/fs/freevxfs/vxfs_lookup.c
> index f04ba2ed1e1a..53cbb7209324 100644
> --- a/fs/freevxfs/vxfs_lookup.c
> +++ b/fs/freevxfs/vxfs_lookup.c
> @@ -177,12 +177,11 @@ vxfs_lookup(struct inode *dip, struct dentry *dp, unsigned int flags)
>  /**
>   * vxfs_readdir - read a directory
>   * @fp:		the directory to read
> - * @retp:	return buffer
> - * @filler:	filldir callback
> + * @ctx:	Dir context
>   *
>   * Description:
> - *   vxfs_readdir fills @retp with directory entries from @fp
> - *   using the VFS supplied callback @filler.
> + *   vxfs_readdir emits directory entries from @fp using the
> + *   VFS supplied @ctx.
>   *
>   * Returns:
>   *   Zero.

-- 
~Randy