[tor-commits] [tor/master] Document compat_getdelim_.

[nickm at torproject.org]

commit c90961a9233e7287605886585503ee94d13a4592
Author: Nick Mathewson <nickm at torproject.org>
Date:   Tue Jul 10 20:18:20 2018 -0400

    Document compat_getdelim_.
---
 src/lib/fs/files.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/lib/fs/files.h b/src/lib/fs/files.h
index d219e3cf0..2ee1b2014 100644
--- a/src/lib/fs/files.h
+++ b/src/lib/fs/files.h
@@ -104,6 +104,9 @@ char *read_file_to_str_until_eof(int fd, size_t max_bytes_to_read,
   ATTR_MALLOC;
 
 #if !defined(HAVE_GETDELIM) || defined(TOR_UNIT_TESTS)
+/** Internal back-end function to implement getdelim(): only exists when
+ * Tor is built for unit tests, or when Tor is built on an operating system
+ * without its own getdelim(). */
 ssize_t compat_getdelim_(char **lineptr, size_t *n, int delim, FILE *stream);
 #endif
 
@@ -112,6 +115,8 @@ ssize_t compat_getdelim_(char **lineptr, size_t *n, int delim, FILE *stream);
  * Cross-platform wrapper for getdelim(): behaves as the POSIX-standard
  * getdelim() function.
  *
+ * See `getdelim(3)` for more information.
+ *
  * Note that this function will use the libc memory allocator -- so any memory
  * passed to this function must come from raw_malloc(), and must be freed by
  * raw_free() -- don't use tor_malloc() and tor_free() with this.