summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--strbuf.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/strbuf.h b/strbuf.h
index 1ea9d0bdeb..773719eafb 100644
--- a/strbuf.h
+++ b/strbuf.h
@@ -363,6 +363,8 @@ extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
/**
* Read the contents of a file, specified by its path. The third argument
* can be used to give a hint about the file size, to avoid reallocs.
+ * Return the number of bytes read or a negative value if some error
+ * occurred while opening or reading the file.
*/
extern ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);