[tor-commits] [tor/master] Clarify some documentation and comments wrt resetting OR token buckets

[nickm at torproject.org]

commit d38030381b04263f76ce7f8ed2d6ceefc4ce363f
Author: Nick Mathewson <nickm at torproject.org>
Date:   Fri Mar 25 17:21:16 2011 -0400

    Clarify some documentation and comments wrt resetting OR token buckets
---
 src/or/connection_or.c |    6 +++++-
 src/or/networkstatus.c |    3 ++-
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/src/or/connection_or.c b/src/or/connection_or.c
index ff863fd..4b932ec 100644
--- a/src/or/connection_or.c
+++ b/src/or/connection_or.c
@@ -353,6 +353,9 @@ connection_or_digest_is_known_relay(const char *id_digest)
  * per-conn limits that are big enough they'll never matter. But if it's
  * not a known relay, first check if we set PerConnBwRate/Burst, then
  * check if the consensus sets them, else default to 'big enough'.
+ *
+ * If <b>reset</b> is true, set the bucket to be full.  Otherwise, just
+ * clip the bucket if it happens to be <em>too</em> full.
  */
 static void
 connection_or_update_token_buckets_helper(or_connection_t *conn, int reset,
@@ -392,7 +395,8 @@ connection_or_update_token_buckets_helper(or_connection_t *conn, int reset,
 }
 
 /** Either our set of relays or our per-conn rate limits have changed.
- * Go through all the OR connections and update their token buckets. */
+ * Go through all the OR connections and update their token buckets to make
+ * sure they don't exceed their maximum values. */
 void
 connection_or_update_token_buckets(smartlist_t *conns, or_options_t *options)
 {
diff --git a/src/or/networkstatus.c b/src/or/networkstatus.c
index 18cb477..4f6fe15 100644
--- a/src/or/networkstatus.c
+++ b/src/or/networkstatus.c
@@ -1747,7 +1747,8 @@ networkstatus_set_current_consensus(const char *consensus,
     routerstatus_list_update_named_server_map();
     cell_ewma_set_scale_factor(options, current_consensus);
 
-    /* XXX022 where is the right place to put this call? */
+    /* XXXX023 this call might be unnecessary here: can changing the
+     * current consensus really alter our view of any OR's rate limits? */
     connection_or_update_token_buckets(get_connection_array(), options);
 
     circuit_build_times_new_consensus_params(&circ_times, current_consensus);