From ed008d7bb957ccfbe32c95aad74ee78e0e31de16 Mon Sep 17 00:00:00 2001 From: Pranit Bauva Date: Tue, 14 Jun 2016 11:44:11 +0530 Subject: strbuf: describe the return value of strbuf_read_file Mentored-by: Lars Schneider Mentored-by: Christian Couder Signed-off-by: Pranit Bauva Signed-off-by: Junio C Hamano diff --git a/strbuf.h b/strbuf.h index 1ea9d0b..773719e 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); -- cgit v0.10.2-6-g49f6