lib/cmdline: adjust a few comments to fix kernel-doc -Wreturn warnings

Fix 'get_option()', 'memparse()' and 'parse_option_str()' comments to
match the commonly used style as suggested by kernel-doc -Wreturn.

Link: https://lore.kernel.org/[email protected]
Signed-off-by: Dmitry Antipov <[email protected]>
Suggested-by: Andy Shevchenko <[email protected]>
Reviewed-by: Andy Shevchenko <[email protected]>
Cc: Albert Ou <[email protected]>
Cc: Alexandre Ghiti <[email protected]>
Cc: Ard Biesheuvel <[email protected]>
Cc: Charlie Jenkins <[email protected]>
Cc: Palmer Dabbelt <[email protected]>
Signed-off-by: Andrew Morton <[email protected]>
This commit is contained in:
Dmitry Antipov authored and Andrew Morton committed 2026-05-28 21:24:50 -07:00
1 parent a535853b66
commit 117d2bfa0a
1 file changed
+5 -2
+5 -2
View File
@@ -43,7 +43,7 @@ static int get_range(char **str, int *pint, int n)
* When @pint is NULL the function can be used as a validator of
* the current option in the string.
*
* Return values:
* Return:
* 0 - no int in string
* 1 - int found, no subsequent comma
* 2 - int found including a subsequent comma
@@ -145,6 +145,9 @@ EXPORT_SYMBOL(get_options);
*
* Parses a string into a number. The number stored at @ptr is
* potentially suffixed with K, M, G, T, P, E.
*
* Return: The value as recognized by simple_strtoull() multiplied
* by the value as specified by suffix, if any.
*/
unsigned long long memparse(const char *ptr, char **retptr)
@@ -205,7 +208,7 @@ EXPORT_SYMBOL(memparse);
* This function parses a string containing a comma-separated list of
* strings like a=b,c.
*
* Return true if there's such option in the string, or return false.
* Return: True if there's such option in the string or false otherwise.
*/
bool parse_option_str(const char *str, const char *option)
{