2022-06-01 19:00:30

by Yang Li

Subject: [PATCH -next] ovl: Fix some kernel-doc comments

Remove warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.
fs/overlayfs/super.c:311: warning: Function parameter or member 'dentry'
not described in 'ovl_statfs'
fs/overlayfs/super.c:311: warning: Excess function parameter 'sb'
description in 'ovl_statfs'
fs/overlayfs/super.c:357: warning: Function parameter or member 'm' not
described in 'ovl_show_options'
fs/overlayfs/super.c:357: warning: Function parameter or member 'dentry'
not described in 'ovl_show_options'

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
fs/overlayfs/super.c | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/fs/overlayfs/super.c b/fs/overlayfs/super.c
index e0a2e0468ee7..9282296dc4c9 100644
--- a/fs/overlayfs/super.c
+++ b/fs/overlayfs/super.c
@@ -301,7 +301,7 @@ static int ovl_sync_fs(struct super_block *sb, int wait)

/**
* ovl_statfs
- * @sb: The overlayfs super block
+ * @dentry: The dentry to query
* @buf: The struct kstatfs to fill in with stats
*
* Get the filesystem statistics. As writes always target the upper layer
@@ -349,6 +349,8 @@ static inline int ovl_xino_def(void)

/**
* ovl_show_options
+ * @m: the seq_file handle
+ * @dentry: The dentry to query
*
* Prints the mount options for a given superblock.
* Returns zero; does not fail.
--
2.20.1.7.g153144c

2022-07-27 13:59:29

by Miklos Szeredi

Subject: Re: [PATCH -next] ovl: Fix some kernel-doc comments

On Wed, 1 Jun 2022 at 04:28, Yang Li <[email protected]> wrote:
>
> Remove warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
> fs/overlayfs/super.c:311: warning: Function parameter or member 'dentry'
> not described in 'ovl_statfs'
> fs/overlayfs/super.c:311: warning: Excess function parameter 'sb'
> description in 'ovl_statfs'
> fs/overlayfs/super.c:357: warning: Function parameter or member 'm' not
> described in 'ovl_show_options'
> fs/overlayfs/super.c:357: warning: Function parameter or member 'dentry'
> not described in 'ovl_show_options'
>
> Reported-by: Abaci Robot <[email protected]>
> Signed-off-by: Yang Li <[email protected]>

Applied, thanks.

Miklos