From: Marek Behún Date: Sun, 17 Oct 2021 15:36:26 +0000 (+0200) Subject: env: Fix documentation for env_get_f() X-Git-Tag: v2022.01~79^2~12 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6dc1e2f10c7ca8ba7caf5444efeb5bb015837829;p=platform%2Fkernel%2Fu-boot.git env: Fix documentation for env_get_f() This function actually returns: - the number of bytes written into @buf excluding the terminating NULL-byte, if there was enough space in @buf - the number of bytes written into @buf including the terminating NULL-byte, if there wasn't enough space in @buf - -1 if the variable is not found Signed-off-by: Marek Behún Reviewed-by: Simon Glass --- diff --git a/include/env.h b/include/env.h index d5e2bcb..b1a4003 100644 --- a/include/env.h +++ b/include/env.h @@ -131,7 +131,10 @@ char *from_env(const char *envvar); * support reading the value (slowly) and some will not. * * @varname: Variable to look up - * @return value of variable, or NULL if not found + * @return number of bytes written into @buf, excluding the terminating + * NULL-byte if there was enough space in @buf, and including the + * terminating NULL-byte if there wasn't enough space, or -1 if the + * variable is not found */ int env_get_f(const char *name, char *buf, unsigned int len);