undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'pb/strbuf-read-file-doc' into maint

Browse Source 
Minor doc update.

* pb/strbuf-read-file-doc:
  strbuf: describe the return value of strbuf_read_file
This commit is contained in:
Junio C Hamano 2016-07-06 13:06:45 -07:00
commit f7927316cf
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
strbuf.h
View File

@ -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 * 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. * 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); extern ssize_t strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);