strbuf: describe the return value of strbuf_read_file

diff --git a/strbuf.h b/strbuf.h
index 1883494ca3ad4931640c2a295c94800e287c1664..773719eafb582aeb135ba17d6886a3b0999715db 100644 (file)
--- a/strbuf.h
+++ b/strbuf.h
@@ -363,8 +363,10 @@ 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 int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
+extern ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
 
 /**
  * Read the target of a symbolic link, specified by its path.  The third