tor

commit 623af0155e0664f46adb1fcc218bc193a9d15916
parent abe7196c53f23186f06e1c56a406ec4c9a75a4f7
Author: Alexander Færøy <ahf@torproject.org>
Date:   Tue, 14 Jul 2020 17:34:38 +0000

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

See: https://bugs.torproject.org/tpo/core/tor/33781

Diffstat:
M
src/lib/fs/files.c
 | 
3
+++

1 file changed, 3 insertions(+), 0 deletions(-)
diff --git a/src/lib/fs/files.c b/src/lib/fs/files.c
@@ -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