public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Yang Li <yang.lee@linux.alibaba.com>
To: hch@infradead.org
Cc: linux-kernel@vger.kernel.org,
	Yang Li <yang.lee@linux.alibaba.com>,
	Abaci Robot <abaci@linux.alibaba.com>
Subject: [PATCH -next] freevxfs: Fix some kernel-doc comments
Date: Wed, 24 May 2023 13:37:53 +0800	[thread overview]
Message-ID: <20230524053753.3573-1-yang.lee@linux.alibaba.com> (raw)

Remove the description of @retp and @filler, and add the description
of @ctx, to silence the warnings:

fs/freevxfs/vxfs_lookup.c:192: warning: Function parameter or member 'ctx' not described in 'vxfs_readdir'
fs/freevxfs/vxfs_lookup.c:192: warning: Excess function parameter 'retp' description in 'vxfs_readdir'
fs/freevxfs/vxfs_lookup.c:192: warning: Excess function parameter 'filler' description in 'vxfs_readdir'

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=5301
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 fs/freevxfs/vxfs_lookup.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/fs/freevxfs/vxfs_lookup.c b/fs/freevxfs/vxfs_lookup.c
index f04ba2ed1e1a..8dfcd5f1013a 100644
--- a/fs/freevxfs/vxfs_lookup.c
+++ b/fs/freevxfs/vxfs_lookup.c
@@ -176,9 +176,8 @@ 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
+ * @fp:    the directory to read
+ * @ctx:   actor to feed the entries to
  *
  * Description:
  *   vxfs_readdir fills @retp with directory entries from @fp
-- 
2.20.1.7.g153144c


             reply	other threads:[~2023-05-24  5:38 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-24  5:37 Yang Li [this message]
2023-05-24  5:42 ` [PATCH -next] freevxfs: Fix some kernel-doc comments Christoph Hellwig

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230524053753.3573-1-yang.lee@linux.alibaba.com \
    --to=yang.lee@linux.alibaba.com \
    --cc=abaci@linux.alibaba.com \
    --cc=hch@infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox