linux-kernel - [PATCH] fs: fs_context: make it be kernel-doc clean

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, 20 Mar 2021 23:16:18 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     linux-kernel@...r.kernel.org
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        Alexander Viro <viro@...iv.linux.org.uk>,
        David Howells <dhowells@...hat.com>,
        linux-fsdevel@...r.kernel.org
Subject: [PATCH] fs: fs_context: make it be kernel-doc clean

Modify fs/fs_context.c to be kernel-doc clean.
Use "Return:" notation for function return values.
Add or modify function parameter descriptions as needed.

Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Cc: Alexander Viro <viro@...iv.linux.org.uk>
Cc: David Howells <dhowells@...hat.com>
Cc: linux-fsdevel@...r.kernel.org
---
 fs/fs_context.c |   16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

--- linux-next-20210319.orig/fs/fs_context.c
+++ linux-next-20210319/fs/fs_context.c
@@ -92,7 +92,7 @@ static int vfs_parse_sb_flag(struct fs_c
  *
  * This may be called multiple times for a context.
  *
- * Returns 0 on success and a negative error code on failure.  In the event of
+ * Return: %0 on success and a negative error code on failure.  In the event of
  * failure, supplementary error information may have been set.
  */
 int vfs_parse_fs_param(struct fs_context *fc, struct fs_parameter *param)
@@ -139,6 +139,10 @@ EXPORT_SYMBOL(vfs_parse_fs_param);
 
 /**
  * vfs_parse_fs_string - Convenience function to just parse a string.
+ * @fc: The filesystem context for this config option
+ * @key: The string option's name
+ * @value: The string option's value (optional)
+ * @v_size: Length of the @value string
  */
 int vfs_parse_fs_string(struct fs_context *fc, const char *key,
 			const char *value, size_t v_size)
@@ -166,13 +170,13 @@ EXPORT_SYMBOL(vfs_parse_fs_string);
 
 /**
  * generic_parse_monolithic - Parse key[=val][,key[=val]]* mount data
- * @ctx: The superblock configuration to fill in.
+ * @fc: The superblock configuration to fill in.
  * @data: The data to parse
  *
  * Parse a blob of data that's in key[=val][,key[=val]]* form.  This can be
  * called from the ->monolithic_mount_data() fs_context operation.
  *
- * Returns 0 on success or the error returned by the ->parse_option() fs_context
+ * Return: %0 on success or the error returned by the ->parse_option() fs_context
  * operation on failure.
  */
 int generic_parse_monolithic(struct fs_context *fc, void *data)
@@ -310,7 +314,7 @@ void fc_drop_locked(struct fs_context *f
 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)
@@ -356,7 +360,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: message prefix
+ * @level: kernel log message level
  * @fmt: The format of the buffer.
  */
 void logfc(struct fc_log *log, const char *prefix, char level, const char *fmt, ...)