[LTP] [PATCH v1] Add documentation for tst_parse_* helpers functions
Cyril Hrubis
chrubis@suse.cz
Tue Dec 7 19:56:27 CET 2021
Hi!
> Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
> ---
> doc/c-test-api.txt | 6 ++++--
> 1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/doc/c-test-api.txt b/doc/c-test-api.txt
> index 64d0630ce..b03124ed3 100644
> --- a/doc/c-test-api.txt
> +++ b/doc/c-test-api.txt
> @@ -457,15 +457,17 @@ NOTE: The test parameters must not collide with common test parameters defined
> [source,c]
> -------------------------------------------------------------------------------
> int tst_parse_int(const char *str, int *val, int min, int max);
> +int tst_parse_long(const char *str, long *val, long min, long max);
> int tst_parse_float(const char *str, float *val, float min, float max);
> +int tst_parse_filesize(const char *str, long long *val, long long min, long long max);
> -------------------------------------------------------------------------------
>
> Helpers for parsing the strings returned in the 'struct tst_option'.
>
> -Both return zero on success and 'errno', mostly 'EINVAL' or 'ERANGE', on
> +Helpers return zero on success and 'errno', mostly 'EINVAL' or 'ERANGE', on
> failure.
>
> -Both functions are no-op if 'str' is 'NULL'.
> +Helpers functions are no-op if 'str' is 'NULL'.
>
> The valid range for result includes both 'min' and 'max'.
Maybe we should list what are the valid units for the tst_parse_filesize
here as well, otherwise it looks good.
--
Cyril Hrubis
chrubis@suse.cz
More information about the ltp
mailing list