Document limitation of log_from_handle with partial reads

diff --git a/src/common/util.c b/src/common/util.c
index aa344bc9c6c9676139d74eb3e2803ff089b7955a..76124ef06cd7192e1b8213847e222f18992d6add 100644 (file)
--- a/src/common/util.c
+++ b/src/common/util.c
@@ -3654,6 +3654,9 @@ tor_split_lines(smartlist_t *sl, char *buf, int len)
 #ifdef MS_WINDOWS
 /** Read from stream, and send lines to log at the specified log level.
  * Returns -1 if there is a error reading, and 0 otherwise.
+ * If the generated stream is flushed more often than on new lines, or
+ * a read exceeds 256 bytes, lines will be truncated. This should be fixed,
+ * along with the corresponding problem on *nix (see bug #2045).
  */
 static int
 log_from_handle(HANDLE *pipe, int severity)