leandrof/u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

env: Fix documentation for env_get_f()

Browse Source 
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 <marek.behun@nic.cz>
Reviewed-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Marek Behún 2021-10-17 17:36:26 +02:00 committed by Simon Glass
parent 3610970872
commit 6dc1e2f10c
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/env.h
View File

@ -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);