Merge branch 'document-read-until-eof' into 'main'

make read_file_to_str_until_eof doc more explicit

Closes #40852

See merge request tpo/core/tor!799
This commit is contained in:
Alexander Færøy
2024-02-28 16:56:24 +00:00
+4 -3
View File
@@ -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)