mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2026-07-22 02:17:36 -04:00
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/20260519172259.908980-6-dmantipov@yandex.ru Signed-off-by: Dmitry Antipov <dmantipov@yandex.ru> Suggested-by: Andy Shevchenko <andriy.shevchenko@intel.com> Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com> Cc: Albert Ou <aou@eecs.berkeley.edu> Cc: Alexandre Ghiti <alex@ghiti.fr> Cc: Ard Biesheuvel <ardb@kernel.org> Cc: Charlie Jenkins <thecharlesjenkins@gmail.com> Cc: Palmer Dabbelt <palmer@dabbelt.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
This commit is contained in:
committed by
Andrew Morton
parent
a535853b66
commit
117d2bfa0a
@@ -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)
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user