[tor-commits] [tor/master] Add a comment about bto_update_best.

[nickm at torproject.org]

commit 9d29abb34e005f4e836976a4c00115a1e8977071
Author: Taylor Yu <catalyst at torproject.org>
Date:   Fri Dec 21 11:38:58 2018 -0600

    Add a comment about bto_update_best.
---
 src/feature/control/btrack_orconn.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/feature/control/btrack_orconn.c b/src/feature/control/btrack_orconn.c
index 69344569b..28f8509fe 100644
--- a/src/feature/control/btrack_orconn.c
+++ b/src/feature/control/btrack_orconn.c
@@ -62,6 +62,9 @@ bto_update_best(const bt_orconn_t *bto, bto_best_t *best, const char *type)
 {
   if (bto->state < best->state)
     return false;
+  /* Update even if we won't change best->state, because it's more
+   * recent information that a particular connection transitioned to
+   * that state. */
   best->gid = bto->gid;
   if (bto->state > best->state) {
     log_info(LD_BTRACK, "ORCONN BEST_%s state %d->%d gid=%"PRIu64, type,