Skip to contentSkip to conversation

ovl: Fix some kernel-doc comments

PATCH Applied Yang Li 2 participants 2 messages Jun 1, 2022 – Jul 27, 2022 Overlay filesystem

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 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'

---
 fs/overlayfs/super.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
fs/overlayfs/super.c +3 -1
index e0a2e0468ee7..9282296dc4c9 100644
@@ -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.
Signature · 1 line
2.20.1.7.g153144c
maintainer Applied
#1 lore raw
Quoted 12 lines · Yang Li

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'

Quoted 2 lines

Applied, thanks.

Miklos