strbuf: describe the return value of strbuf_read_file
Mentored-by: Lars Schneider <larsxschneider@gmail.com> Mentored-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Pranit Bauva <pranit.bauva@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Pranit Bauva committed
Jun 14, 2016 at 11:44 UTC
ed008d7bb957ccfbe32c95aad74ee78e0e31de16
1 file changed
+2
strbuf.h
+2
@@ -363,6 +363,8 @@ extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
363
/**
364
* Read the contents of a file, specified by its path. The third argument
365
* can be used to give a hint about the file size, to avoid reallocs.
366
+ * Return the number of bytes read or a negative value if some error
367
+ * occurred while opening or reading the file.
368
*/
369
extern ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
370