From: Nick Mathewson <nickm@torproject.org>
Date: Fri, 17 Mar 2017 15:31:21 +0000 (-0400)
Subject: Improve documentation for connection_dirserv_flushed_some.
X-Git-Tag: tor-0.3.1.1-alpha~197^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=436b975e213aaf0abe12e0fe035b7b83bcb2198a;p=thirdparty%2Ftor.git

Improve documentation for connection_dirserv_flushed_some.
---

diff --git a/src/or/dirserv.c b/src/or/dirserv.c
index bf01dce373..33d25618fa 100644
--- a/src/or/dirserv.c
+++ b/src/or/dirserv.c
@@ -3740,8 +3740,14 @@ get_signed_descriptor_by_fp(const uint8_t *fp, int extrainfo)
  * below this threshold. */
 #define DIRSERV_BUFFER_MIN 16384
 
-/** Called whenever we have flushed some directory data in state
- * SERVER_WRITING. */
+/**
+ * Called whenever we have flushed some directory data in state
+ * SERVER_WRITING, or whenever we want to fill the buffer with initial
+ * directory data (so that subsequent writes will occur, and trigger this
+ * function again.)
+ *
+ * Return 0 on success, and -1 on failure.
+ */
 int
 connection_dirserv_flushed_some(dir_connection_t *conn)
 {