[tor-commits] [tor/release-0.3.5] Update docstring for read_file_to_str() on stripping of CR characters.

[dgoulet at torproject.org]

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

    Update docstring for read_file_to_str() on stripping of CR characters.
    
    See: https://bugs.torproject.org/tpo/core/tor/33781
---
 src/lib/fs/files.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/lib/fs/files.c b/src/lib/fs/files.c
index 55d5f1bf8c..ec7dbca0e9 100644
--- 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> & RFTS_BIN, open the file in binary mode.
  * If <b>flags</b> & 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