[tor-commits] [tor/master] Clarify documentation of connection_finished_flushing

[nickm at torproject.org]

commit 690ea9e8cf3b9c047484a6aea30fa94650fb66c8
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Jan 30 17:07:32 2013 -0500

    Clarify documentation of connection_finished_flushing
---
 src/or/connection.c |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/or/connection.c b/src/or/connection.c
index 3e6341b..10fee12 100644
--- a/src/or/connection.c
+++ b/src/or/connection.c
@@ -3872,8 +3872,9 @@ connection_flushed_some(connection_t *conn)
   return r;
 }
 
-/** We just finished flushing bytes from conn-\>outbuf, and there
- * are no more bytes remaining.
+/** We just finished flushing bytes to the appropriately low network layer,
+ * and there are no more bytes remaining in conn-\>outbuf, conn-\>bev, or
+ * conn-\>tls to be flushed.
  *
  * This function just passes conn to the connection-specific
  * connection_*_finished_flushing() function.