[tor-commits] [tor/master] Describe what router_reset_descriptor_download_failures() actually does

[nickm at torproject.org]

commit eaf9c0f25a3aeb8f7a8325e99615442853dcb224
Author: teor <teor2345 at gmail.com>
Date:   Tue Oct 10 14:36:08 2017 -0400

    Describe what router_reset_descriptor_download_failures() actually does
    
    Comment-only change.
    
    Part of #23813.
---
 src/or/routerlist.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/or/routerlist.c b/src/or/routerlist.c
index c7c109253..1fa27f722 100644
--- a/src/or/routerlist.c
+++ b/src/or/routerlist.c
@@ -5358,8 +5358,10 @@ update_extrainfo_downloads(time_t now)
   smartlist_free(wanted);
 }
 
-/** Reset the descriptor download failure count on all routers, so that we
- * can retry any long-failed routers immediately.
+/** Reset the consensus and extra-info download failure count on all routers.
+ * When we get a new consensus,
+ * routers_update_status_from_consensus_networkstatus() will reset the
+ * download statuses on the descriptors in that consensus.
  */
 void
 router_reset_descriptor_download_failures(void)
@@ -5371,6 +5373,8 @@ router_reset_descriptor_download_failures(void)
   last_descriptor_download_attempted = 0;
   if (!routerlist)
     return;
+  /* We want to download *all* extra-info descriptors, not just those in
+   * the consensus we currently have (or are about to have) */
   SMARTLIST_FOREACH(routerlist->routers, routerinfo_t *, ri,
   {
     download_status_reset(&ri->cache_info.ei_dl_status);