[tor-commits] [tor/master] Add more docs about the HSv3 stat collection period.

[dgoulet at torproject.org]

commit 0812ecd517af406aa82e5a5deddbbe799e9d8b49
Author: George Kadianakis <desnacked at riseup.net>
Date:   Tue Nov 3 19:19:02 2020 +0200

    Add more docs about the HSv3 stat collection period.
---
 src/feature/stats/rephist.c | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/feature/stats/rephist.c b/src/feature/stats/rephist.c
index e0d8669cba..1501e46b14 100644
--- a/src/feature/stats/rephist.c
+++ b/src/feature/stats/rephist.c
@@ -1868,8 +1868,11 @@ rep_hist_reset_hs_v3_stats(time_t now)
 /** Return true if it's a good time to collect v3 stats.
  *
  *  v3 stats have a strict stats collection period (from 12:00UTC to 12:00UTC
- *  on the real network) and hence we don't want to collect statistics if it's
- *  not yet the time to do so.
+ *  on the real network). We don't want to collect statistics if (for example)
+ *  we just booted and it's 03:00UTC; we will wait until 12:00UTC before we
+ *  start collecting statistics to make sure that the final result represents
+ *  the whole collection period. This behavior is controlled by
+ *  rep_hist_hs_stats_init().
  */
 MOCK_IMPL(STATIC bool,
 should_collect_v3_stats,(void))