Update docstring for read_file_to_str() on stripping of CR characters.

See: https://bugs.torproject.org/tpo/core/tor/33781
This commit is contained in:
Alexander Færøy 2020-07-14 17:34:38 +00:00
parent abe7196c53
commit 623af0155e

View File

@ -607,6 +607,9 @@ read_file_to_str_until_eof(int fd, size_t max_bytes_to_read, size_t *sz_out)
* If <b>flags</b> &amp; RFTS_BIN, open the file in binary mode.
* If <b>flags</b> &amp; RFTS_IGNORE_MISSING, don't warn if the file
* doesn't exist.
*
* Unless the RFTS_BIN flag is set in <b>flags</b>, this function will strip
* any CR characters in the return value on all platforms.
*/
/*
* This function <em>may</em> return an erroneous result if the file