summaryrefslogtreecommitdiff
path: root/nuttx/binfmt/libelf/libelf_read.c
diff options
context:
space:
mode:
Diffstat (limited to 'nuttx/binfmt/libelf/libelf_read.c')
-rw-r--r--nuttx/binfmt/libelf/libelf_read.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/nuttx/binfmt/libelf/libelf_read.c b/nuttx/binfmt/libelf/libelf_read.c
index da41212f2..f4b725183 100644
--- a/nuttx/binfmt/libelf/libelf_read.c
+++ b/nuttx/binfmt/libelf/libelf_read.c
@@ -98,7 +98,11 @@ static inline void elf_dumpreaddata(char *buffer, int buflen)
* Name: elf_read
*
* Description:
- * Read 'readsize' bytes from the object file at 'offset'
+ * Read 'readsize' bytes from the object file at 'offset'. The data is
+ * read into 'buffer.' If 'buffer' is part of the ELF address environment,
+ * then the caller is responsibile for assuring that that address
+ * environment is in place before calling this function (i.e., that
+ * elf_addrenv_select() has been called if CONFIG_ADDRENV=y).
*
* Returned Value:
* 0 (OK) is returned on success and a negated errno is returned on