Mention the return value of the slurp function and the implications

Signed-off-by: Olivier Gayot <olivier.gayot@sigexec.com>

1 files changed, 3 insertions, 0 deletions

diff --git a/src/general.c b/src/general.c
index ca6884b..e3d4f96 100644
--- a/src/general.c
+++ b/src/general.c
@@ -14,6 +14,9 @@
 /*
  * Reads size bytes into the destination buffer from filename.
  *
+ * On success, true is returned. Otherwise, false is returned and the content
+ * of destination is left untouched.
+ *
  */
 bool slurp(const char *filename, char *destination, int size) {
     int fd;