threads / patch / 42599

v2strbuf: describe the return value of strbuf_read_file

Subject: [PATCH v2] strbuf: describe the return value of strbuf_read_file

## tl;dr

One message between Jun 16, 2016 and Jun 16, 2016. Diffs are folded; open one to read it.

replies: 0people: 1as markdown or json

Pranit Bauva· Jun 14, 2016, 06:14 UTC · lore
Mentored-by: Lars Schneider <larsxschneider@gmail.com>
Mentored-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Pranit Bauva <pranit.bauva@gmail.com>
---
 strbuf.h | 2 ++
 1 file changed, 2 insertions(+)
Show changes to strbuf.h +2 −0
diff --git a/strbuf.h b/strbuf.h
index 7987405..83c5c98 100644
--- a/strbuf.h
+++ b/strbuf.h
@@ -377,6 +377,8 @@ extern ssize_t strbuf_read_once(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);
 
-- 
2.8.4

← back to recent threads