From 49cf3d7edb0b53f83ffd9c137901a05446cfcad4 Mon Sep 17 00:00:00 2001
From: Olivier Gayot <olivier.gayot@sigexec.com>
Date: Thu, 19 Sep 2019 15:36:00 +0200
Subject: Mention the return value of the slurp function and the implications
Signed-off-by: Olivier Gayot <olivier.gayot@sigexec.com>
---
src/general.c | 3 +++
1 file changed, 3 insertions(+)
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;
--
cgit v1.2.3