summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2005-05-02 23:41:39 +0000
committerNick Mathewson <nickm@torproject.org>2005-05-02 23:41:39 +0000
commit14bac4dad4257ac911a3e7a60806c6940ac4d372 (patch)
tree9fc548a1f7b4b01b1b11b1ecc794b9c146201a79
parentaa6bcd50ca00e8e7e61ca80dab96cb63d3643d79 (diff)
downloadtor-14bac4dad4257ac911a3e7a60806c6940ac4d372.tar.gz
tor-14bac4dad4257ac911a3e7a60806c6940ac4d372.zip
Elaborate on buf_shrink comment.
svn:r4169
-rw-r--r--src/or/buffers.c9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/or/buffers.c b/src/or/buffers.c
index 015245d84f..94de0b284a 100644
--- a/src/or/buffers.c
+++ b/src/or/buffers.c
@@ -244,10 +244,11 @@ static INLINE void buf_shrink_if_underfull(buf_t *buf) {
#define buf_shrink_if_underfull(buf) do {} while (0)
#endif
-/** Resize buf so it won't hold extra memory that we haven't
- * been using lately. Try to shrink the buf until it is the
- * largest factor of two that can contain highwater, but never
- * smaller than MIN_LAZY_SHRINK_SIZE.
+/** Resize buf so it won't hold extra memory that we haven't been
+ * using lately (that is, since the last time we called buf_shrink).
+ * Try to shrink the buf until it is the largest factor of two that
+ * can contain <b>buf</b>-&gt;highwater, but never smaller than
+ * MIN_LAZY_SHRINK_SIZE.
*/
void
buf_shrink(buf_t *buf)