Commit e913de1b authored by trinity-1686a's avatar trinity-1686a
Browse files

make read_file_to_str_until_eof doc more explicit 

the sz_out param is set to what was read (i.e not including the final
NULL the function adds for convenience), but could be understood to
be set to what was read+1 (including the NULL terminator)
parent b0b943a1

src/lib/fs/files.c

+4 −3
Original line number Diff line number Diff line
@@ -572,9 +572,10 @@ write_bytes_to_new_file(const char *fname, const char *str, size_t len, 
/**

 * Read the contents of the open file <b>fd</b> presuming it is a FIFO

 * (or similar) file descriptor for which the size of the file isn't

 * known ahead of time. Return NULL on failure, and a NUL-terminated

 * string on success.  On success, set <b>sz_out</b> to the number of

 * bytes read.

 * known ahead of time.

 * Return NULL on failure, and a NUL-terminated string on success.

 * On success, set <b>sz_out</b> to the number of  bytes read (not including

 * the final NULL, which wasn't read from <b>fd</fd>).

 */

char *

read_file_to_str_until_eof(int fd, size_t max_bytes_to_read, size_t *sz_out)