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

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

diff --git a/src/lib/fs/files.c b/src/lib/fs/files.c
index 55d5f1bf8c51de8631a83400f9b2d45b181f33d0..ec7dbca0e91929974bec9e13a812ae48bb639cb2 100644 (file)
--- 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