From: Pranit Bauva <pranit.bauva@gmail.com>
Date: Tue, 14 Jun 2016 06:14:11 +0000 (+0530)
Subject: strbuf: describe the return value of strbuf_read_file
X-Git-Tag: v2.9.1~19^2
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/ed008d7bb957ccfbe32c95aad74ee78e0e31de16?ds=inline;hp=--cc

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>
---

ed008d7bb957ccfbe32c95aad74ee78e0e31de16
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);