lib: parser: update documentation for match_NUMBER functions

commit 67222c4ba8 ("lib: parser: optimize match_NUMBER apis to use local
array") removed -ENOMEM as a possible return value, so update the comments
accordingly.

Link: https://lkml.kernel.org/r/20230224042618.9092-1-ebiggers@kernel.org
Fixes: 67222c4ba8 ("lib: parser: optimize match_NUMBER apis to use local array")
Signed-off-by: Eric Biggers <ebiggers@google.com>
Cc: Li Lingfeng <lilingfeng3@huawei.com>
Cc: Tejun Heo <tj@kernel.org>
Cc: Yu Kuai <yukuai1@huaweicloud.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
This commit is contained in:
Eric Biggers 2023-02-23 20:26:18 -08:00 committed by Andrew Morton
parent 4ec4190be4
commit 359d62559f
1 changed files with 7 additions and 7 deletions

View File

@ -133,7 +133,7 @@ EXPORT_SYMBOL(match_token);
* as a number in that base. * as a number in that base.
* *
* Return: On success, sets @result to the integer represented by the * Return: On success, sets @result to the integer represented by the
* string and returns 0. Returns -ENOMEM, -EINVAL, or -ERANGE on failure. * string and returns 0. Returns -EINVAL or -ERANGE on failure.
*/ */
static int match_number(substring_t *s, int *result, int base) static int match_number(substring_t *s, int *result, int base)
{ {
@ -165,7 +165,7 @@ static int match_number(substring_t *s, int *result, int base)
* as a number in that base. * as a number in that base.
* *
* Return: On success, sets @result to the integer represented by the * Return: On success, sets @result to the integer represented by the
* string and returns 0. Returns -ENOMEM, -EINVAL, or -ERANGE on failure. * string and returns 0. Returns -EINVAL or -ERANGE on failure.
*/ */
static int match_u64int(substring_t *s, u64 *result, int base) static int match_u64int(substring_t *s, u64 *result, int base)
{ {
@ -189,7 +189,7 @@ static int match_u64int(substring_t *s, u64 *result, int base)
* Description: Attempts to parse the &substring_t @s as a decimal integer. * Description: Attempts to parse the &substring_t @s as a decimal integer.
* *
* Return: On success, sets @result to the integer represented by the string * Return: On success, sets @result to the integer represented by the string
* and returns 0. Returns -ENOMEM, -EINVAL, or -ERANGE on failure. * and returns 0. Returns -EINVAL or -ERANGE on failure.
*/ */
int match_int(substring_t *s, int *result) int match_int(substring_t *s, int *result)
{ {
@ -205,7 +205,7 @@ EXPORT_SYMBOL(match_int);
* Description: Attempts to parse the &substring_t @s as a decimal integer. * Description: Attempts to parse the &substring_t @s as a decimal integer.
* *
* Return: On success, sets @result to the integer represented by the string * Return: On success, sets @result to the integer represented by the string
* and returns 0. Returns -ENOMEM, -EINVAL, or -ERANGE on failure. * and returns 0. Returns -EINVAL or -ERANGE on failure.
*/ */
int match_uint(substring_t *s, unsigned int *result) int match_uint(substring_t *s, unsigned int *result)
{ {
@ -228,7 +228,7 @@ EXPORT_SYMBOL(match_uint);
* integer. * integer.
* *
* Return: On success, sets @result to the integer represented by the string * Return: On success, sets @result to the integer represented by the string
* and returns 0. Returns -ENOMEM, -EINVAL, or -ERANGE on failure. * and returns 0. Returns -EINVAL or -ERANGE on failure.
*/ */
int match_u64(substring_t *s, u64 *result) int match_u64(substring_t *s, u64 *result)
{ {
@ -244,7 +244,7 @@ EXPORT_SYMBOL(match_u64);
* Description: Attempts to parse the &substring_t @s as an octal integer. * Description: Attempts to parse the &substring_t @s as an octal integer.
* *
* Return: On success, sets @result to the integer represented by the string * Return: On success, sets @result to the integer represented by the string
* and returns 0. Returns -ENOMEM, -EINVAL, or -ERANGE on failure. * and returns 0. Returns -EINVAL or -ERANGE on failure.
*/ */
int match_octal(substring_t *s, int *result) int match_octal(substring_t *s, int *result)
{ {
@ -260,7 +260,7 @@ EXPORT_SYMBOL(match_octal);
* Description: Attempts to parse the &substring_t @s as a hexadecimal integer. * Description: Attempts to parse the &substring_t @s as a hexadecimal integer.
* *
* Return: On success, sets @result to the integer represented by the string * Return: On success, sets @result to the integer represented by the string
* and returns 0. Returns -ENOMEM, -EINVAL, or -ERANGE on failure. * and returns 0. Returns -EINVAL or -ERANGE on failure.
*/ */
int match_hex(substring_t *s, int *result) int match_hex(substring_t *s, int *result)
{ {