Skip to contentSkip to conversation

vfs: fs_context: Fix some kernel-doc comments

PATCH New Yang Li 1 participant 1 message Apr 2, 2022 VFS

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 vfs: fs_context: Fix some kernel-doc comments

Remove some warnings found by running scripts/kernel-doc, which is caused by using 'make W=1'.

fs/fs_context.c:202: warning: Function parameter or member 'fc' not described in 'generic_parse_monolithic'
fs/fs_context.c:202: warning: Excess function parameter 'ctx' description in 'generic_parse_monolithic' fs/fs_context.c:340: warning: expecting prototype for vfs_dup_fc_config(). Prototype was for vfs_dup_fs_context() instead fs/fs_context.c:386: warning: Function parameter or member 'log' not described in 'logfc'
fs/fs_context.c:386: warning: Function parameter or member 'prefix' not described in 'logfc'
fs/fs_context.c:386: warning: Function parameter or member 'level' not described in 'logfc'
fs/fs_context.c:386: warning: Excess function parameter 'fc' description in 'logfc'

---
 fs/fs_context.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
fs/fs_context.c +6 -3
index 24ce12f0db32..be2bce5fe66d 100644
@@ -189,7 +189,8 @@ EXPORT_SYMBOL(vfs_parse_fs_string);
 
 /**
  * generic_parse_monolithic - Parse key[=val][,key[=val]]* mount data
- * @ctx: The superblock configuration to fill in.
+ * @fc: Filesystem context for holding the parameters used in the creation or
+ *	reconfiguration of a superblock.
  * @data: The data to parse
  *
  * Parse a blob of data that's in key[=val][,key[=val]]* form.  This can be
@@ -333,7 +334,7 @@ void fc_drop_locked(struct fs_context *fc)
 static void legacy_fs_context_free(struct fs_context *fc);
 
 /**
- * vfs_dup_fc_config: Duplicate a filesystem context.
+ * vfs_dup_fs_context: Duplicate a filesystem context.
  * @src_fc: The context to copy.
  */
 struct fs_context *vfs_dup_fs_context(struct fs_context *src_fc)
@@ -379,7 +380,9 @@ EXPORT_SYMBOL(vfs_dup_fs_context);
 
 /**
  * logfc - Log a message to a filesystem context
- * @fc: The filesystem context to log to.
+ * @log: The filesystem context to log to.
+ * @prefix: The log prefix.
+ * @level: The log level.
  * @fmt: The format of the buffer.
  */
 void logfc(struct fc_log *log, const char *prefix, char level, const char *fmt, ...)
Signature · 1 line
2.20.1.7.g153144c