| Message ID | 20210120214547.89770-2-andriy.shevchenko@linux.intel.com |
|---|---|
| State | New |
| Headers | show |
| Series | [v2,1/5] lib/cmdline_kunit: add a new test case for get_options() | expand |
On Wed, Jan 20, 2021 at 10:45 PM Andy Shevchenko <andriy.shevchenko@linux.intel.com> wrote: > > 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: Andy Shevchenko <andriy.shevchenko@linux.intel.com> > --- > lib/cmdline.c | 7 ++++++- > 1 file changed, 6 insertions(+), 1 deletion(-) > > diff --git a/lib/cmdline.c b/lib/cmdline.c > index b390dd03363b..2a9ae2143e42 100644 > --- a/lib/cmdline.c > +++ b/lib/cmdline.c > @@ -83,7 +83,7 @@ EXPORT_SYMBOL(get_option); > * get_options - Parse a string into a list of integers > * @str: String to be parsed > * @nints: size of integer array > - * @ints: integer array > + * @ints: integer array (must have a room for at least one element) > * > * This function parses a string containing a comma-separated > * list of integers, a hyphen-separated range of _positive_ integers, > @@ -91,6 +91,11 @@ EXPORT_SYMBOL(get_option); > * full, or when no more numbers can be retrieved from the > * string. > * > + * Returns: > + * > + * The first element is filled by the amount of the collected numbers > + * in the range. The rest is what was parsed from the @str. > + * > * Return value is the character in the string which caused > * the parse to end (typically a null terminator, if @str is > * completely parseable). > -- > 2.29.2 > Reviewed-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
diff --git a/lib/cmdline.c b/lib/cmdline.c index b390dd03363b..2a9ae2143e42 100644 --- a/lib/cmdline.c +++ b/lib/cmdline.c @@ -83,7 +83,7 @@ EXPORT_SYMBOL(get_option); * get_options - Parse a string into a list of integers * @str: String to be parsed * @nints: size of integer array - * @ints: integer array + * @ints: integer array (must have a room for at least one element) * * This function parses a string containing a comma-separated * list of integers, a hyphen-separated range of _positive_ integers, @@ -91,6 +91,11 @@ EXPORT_SYMBOL(get_option); * full, or when no more numbers can be retrieved from the * string. * + * Returns: + * + * The first element is filled by the amount of the collected numbers + * in the range. The rest is what was parsed from the @str. + * * Return value is the character in the string which caused * the parse to end (typically a null terminator, if @str is * completely parseable).
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: Andy Shevchenko <andriy.shevchenko@linux.intel.com> --- lib/cmdline.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)