fs/fs_parse: Correct comments of fs_validate_description()
authorZijun Hu <quic_zijuhu@quicinc.com>
Thu, 10 Apr 2025 11:45:30 +0000 (19:45 +0800)
committerChristian Brauner <brauner@kernel.org>
Mon, 14 Apr 2025 11:05:40 +0000 (13:05 +0200)
For fs_validate_description(), its comments easily mislead reader that
the function will search array @desc for duplicated entries with name
specified by parameter @name, but @name is not used for search actually.

Fix by marking name as owner's name of these parameter specifications.

Signed-off-by: Zijun Hu <quic_zijuhu@quicinc.com>
Signed-off-by: Christian Brauner <brauner@kernel.org>
fs/fs_parser.c

index e635a81e17d965df78ffef27f6885cd70996c6dd..c5cb19788f74771a945801ceedeec69efed0e40a 100644 (file)
@@ -429,9 +429,9 @@ bool validate_constant_table(const struct constant_table *tbl, size_t tbl_size,
 }
 
 /**
- * fs_validate_description - Validate a parameter description
- * @name: The parameter name to search for.
- * @desc: The parameter description to validate.
+ * fs_validate_description - Validate a parameter specification array
+ * @name: Owner name of the parameter specification array
+ * @desc: The parameter specification array to validate.
  */
 bool fs_validate_description(const char *name,
        const struct fs_parameter_spec *desc)