Commit f1f405c3 authored by Andy Shevchenko's avatar Andy Shevchenko Committed by Bartosz Golaszewski

lib/cmdline: Update documentation to reflect behaviour

get_options() API has some tricks to optimize that may be not so obvious
to the caller. Update documentation to reflect current behaviour.
Signed-off-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: default avatarBartosz Golaszewski <bgolaszewski@baylibre.com>
Reviewed-by: default avatarGeert Uytterhoeven <geert+renesas@glider.be>
parent d3c7cfc6
...@@ -83,7 +83,7 @@ EXPORT_SYMBOL(get_option); ...@@ -83,7 +83,7 @@ EXPORT_SYMBOL(get_option);
* get_options - Parse a string into a list of integers * get_options - Parse a string into a list of integers
* @str: String to be parsed * @str: String to be parsed
* @nints: size of integer array * @nints: size of integer array
* @ints: integer array * @ints: integer array (must have room for at least one element)
* *
* This function parses a string containing a comma-separated * This function parses a string containing a comma-separated
* list of integers, a hyphen-separated range of _positive_ integers, * list of integers, a hyphen-separated range of _positive_ integers,
...@@ -91,6 +91,11 @@ EXPORT_SYMBOL(get_option); ...@@ -91,6 +91,11 @@ EXPORT_SYMBOL(get_option);
* full, or when no more numbers can be retrieved from the * full, or when no more numbers can be retrieved from the
* string. * string.
* *
* Returns:
*
* The first element is filled by the number of collected integers
* in the range. The rest is what was parsed from the @str.
*
* Return value is the character in the string which caused * Return value is the character in the string which caused
* the parse to end (typically a null terminator, if @str is * the parse to end (typically a null terminator, if @str is
* completely parseable). * completely parseable).
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment