Thread (12 messages) 12 messages, 2 authors, 2021-01-22

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

From: Geert Uytterhoeven <geert@linux-m68k.org>
Date: 2021-01-22 13:11:55

Hi Andriy,

On Fri, Jan 22, 2021 at 1:39 PM Andy Shevchenko
[off-list ref] 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 <redacted>
Thanks for your patch!
quoted hunk ↗ jump to hunk
--- 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
quoted hunk ↗ jump to hunk
  *
  *     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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help