linux-kernel - [PATCH -next] vfs: fs_context: Fix some kernel-doc comments

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Date:   Sat,  2 Apr 2022 16:22:22 +0800
From:   Yang Li <yang.lee@...ux.alibaba.com>
To:     viro@...iv.linux.org.uk
Cc:     linux-fsdevel@...r.kernel.org, linux-kernel@...r.kernel.org,
        Yang Li <yang.lee@...ux.alibaba.com>,
        Abaci Robot <abaci@...ux.alibaba.com>
Subject: [PATCH -next] 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'

Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
---
 fs/fs_context.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/fs/fs_context.c b/fs/fs_context.c
index 24ce12f0db32..be2bce5fe66d 100644
--- a/fs/fs_context.c
+++ b/fs/fs_context.c
@@ -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, ...)
-- 
2.20.1.7.g153144c