diff mbox series

[v3,2/6] lib/cmdline: Update documentation to reflect behaviour

Message ID 20210122123853.75162-2-andriy.shevchenko@linux.intel.com
State New
Headers show
Series [v3,1/6] lib/cmdline_kunit: add a new test case for get_options() | expand

Commit Message

Andy Shevchenko Jan. 22, 2021, 12:38 p.m. UTC
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>
Reviewed-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
---
v3: added Rb tag (Bart)
 lib/cmdline.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

Comments

Geert Uytterhoeven Jan. 22, 2021, 1:10 p.m. UTC | #1
Hi Andriy,

On Fri, Jan 22, 2021 at 1:39 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>
> Reviewed-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

Thanks for your patch!

> --- 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)

must have room

>   *
>   *     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

the number of collected integers?

Yes, the lack of articles in RU can be a disadvantage...

> + *     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).

With the above fixed:
Reviewed-by: Geert Uytterhoeven <geert+renesas@glider.be>

Gr{oetje,eeting}s,

                        Geert
Andy Shevchenko Jan. 22, 2021, 1:47 p.m. UTC | #2
On Fri, Jan 22, 2021 at 02:10:17PM +0100, Geert Uytterhoeven wrote:
> On Fri, Jan 22, 2021 at 1:39 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>
> > Reviewed-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
> 
> Thanks for your patch!

Thanks for review.
I'll fix this in my repo w/o sending a v4.

> > --- 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)
> 
> must have room
> 
> >   *
> >   *     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
> 
> the number of collected integers?
> 
> Yes, the lack of articles in RU can be a disadvantage...

:-)

> 
> > + *     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).
> 
> With the above fixed:
> Reviewed-by: Geert Uytterhoeven <geert+renesas@glider.be>
> 
> Gr{oetje,eeting}s,
> 
>                         Geert
> 
> -- 
> Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org
> 
> In personal conversations with technical people, I call myself a hacker. But
> when I'm talking to journalists I just say "programmer" or something like that.
>                                 -- Linus Torvalds
diff mbox series

Patch

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).