From: Nick Mathewson <nickm@torproject.org>
Date: Fri, 24 Aug 2012 16:31:09 +0000 (-0400)
Subject: Clarify docs on get_configured_bridge_by_*_digest
X-Git-Tag: tor-0.2.4.1-alpha~42
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=03ca9c63c8c04f455eee7aee8adf0554e9bc9952;p=thirdparty%2Ftor.git

Clarify docs on get_configured_bridge_by_*_digest
---

diff --git a/src/or/circuitbuild.c b/src/or/circuitbuild.c
index 9f10190c9b..b4e79ed746 100644
--- a/src/or/circuitbuild.c
+++ b/src/or/circuitbuild.c
@@ -5126,9 +5126,10 @@ bridge_free(bridge_info_t *bridge)
   tor_free(bridge);
 }
 
-/** Return a bridge pointer if either <b>digest</b>, if possible, or
- * any of the tor_addr_port_t's in <b>orports</b>, if necessary,
- * matches any of our known bridges.  Else return NULL. */
+/** If we have a bridge configured whose digest matches <b>digest</b>, or a
+ * bridge with no known digest whose address matches any of the
+ * tor_addr_port_t's in <b>orports</b>, return that bridge.  Else return
+ * NULL. */
 static bridge_info_t *
 get_configured_bridge_by_orports_digest(const char *digest,
                                         const smartlist_t *orports)
@@ -5153,9 +5154,9 @@ get_configured_bridge_by_orports_digest(const char *digest,
   return NULL;
 }
 
-/** Return a bridge pointer if <b>digest</b>, if possible, or
- * <b>addr</b> and <b>port</b>, if necessary, matches any of our known
- * bridges.  Else return NULL. */
+/** If we have a bridge configured whose digest matches <b>digest</b>, or a
+ * bridge with no known digest whose address matches <b>addr</b>:<b>/port</b>,
+ * return that bridge.  Else return NULL. */
 static bridge_info_t *
 get_configured_bridge_by_addr_port_digest(const tor_addr_t *addr,
                                           uint16_t port,