summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorAndy Shevchenko <andriy.shevchenko@linux.intel.com>2021-01-22 15:38:49 +0300
committerBartosz Golaszewski <bgolaszewski@baylibre.com>2021-02-15 13:43:31 +0300
commitf1f405c35ec217e4f68f9e25cd83d003f8a6d03e (patch)
tree59fb2c03ef44769b20b24dfbcddf91d9e1d318c2 /lib
parentd3c7cfc6d3dc315ca58b516303ccb0ac8b005600 (diff)
downloadlinux-f1f405c35ec217e4f68f9e25cd83d003f8a6d03e.tar.xz
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: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Reviewed-by: Bartosz Golaszewski <bgolaszewski@baylibre.com> Reviewed-by: Geert Uytterhoeven <geert+renesas@glider.be>
Diffstat (limited to 'lib')
-rw-r--r--lib/cmdline.c7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/cmdline.c b/lib/cmdline.c
index b390dd03363b..f33882f1cd52 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 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 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
* the parse to end (typically a null terminator, if @str is
* completely parseable).