summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorOlivier Gayot <olivier.gayot@sigexec.com>2019-09-19 15:36:00 +0200
committerOlivier Gayot <olivier.gayot@sigexec.com>2019-09-19 15:48:59 +0200
commit49cf3d7edb0b53f83ffd9c137901a05446cfcad4 (patch)
tree6da767c8658b652c4177af87d41574d0ae72c634 /src
parent4cf8bebf716cad62f75251370a5909a748dd744a (diff)
Mention the return value of the slurp function and the implications
Signed-off-by: Olivier Gayot <olivier.gayot@sigexec.com>
Diffstat (limited to 'src')
-rw-r--r--src/general.c3
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;