[tor-commits] [tor/master] Improve docs based on Nick's review.

[nickm at torproject.org]

commit 91da032e9cc264d88802d0bfc072b0b4117c5f33
Author: George Kadianakis <desnacked at riseup.net>
Date:   Thu Jul 6 13:37:55 2017 +0300

    Improve docs based on Nick's review.
---
 src/or/hs_circuit.c |  3 +--
 src/or/or.h         | 10 ++++++----
 2 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/src/or/hs_circuit.c b/src/or/hs_circuit.c
index f8c95f7..02c9afa 100644
--- a/src/or/hs_circuit.c
+++ b/src/or/hs_circuit.c
@@ -135,8 +135,7 @@ finalize_rend_circuit(origin_circuit_t *circ, crypt_path_t *hop,
 
   /* All is well. Extend the circuit. */
   hop->state = CPATH_STATE_OPEN;
-  /* Set the windows to default. These are the windows that the client thinks
-   * the service has. */
+  /* Set the windows to default. */
   hop->package_window = circuit_initial_package_window();
   hop->deliver_window = CIRCWINDOW_START;
 
diff --git a/src/or/or.h b/src/or/or.h
index db77d08..dcda7e2 100644
--- a/src/or/or.h
+++ b/src/or/or.h
@@ -1638,8 +1638,9 @@ typedef struct edge_connection_t {
    * an exit)? */
   rend_data_t *rend_data;
 
-  /* Hidden service connection identifier that is which service is being
-   * queried? */
+  /* Hidden service connection identifier for edge connections. Used by the HS
+   * client-side code to identify client SOCKS connections and by the
+   * service-side code to match HS circuits with their streams. */
   hs_ident_edge_conn_t *hs_ident;
 
   uint32_t address_ttl; /**< TTL for address-to-addr mapping on exit
@@ -1792,8 +1793,9 @@ typedef struct dir_connection_t {
   /** What rendezvous service are we querying for? */
   rend_data_t *rend_data;
 
-  /* Hidden service connection identifier that is which service is being
-   * queried? */
+  /* Hidden service connection identifier for dir connections: Used by HS
+     client-side code to fetch HS descriptors, and by the service-side code to
+     upload descriptors. */
   hs_ident_dir_conn_t *hs_ident;
 
   /** If this is a one-hop connection, tracks the state of the directory guard