[tor-commits] [tor/master] Update documentation for parse_bridge_line() in src/or/config.c.

[nickm at torproject.org]

commit f1d7b7b600f2388f347116a30f5bb40d9fa1ff6e
Author: Isis Lovecruft <isis at torproject.org>
Date:   Wed Sep 21 13:26:34 2016 +0000

    Update documentation for parse_bridge_line() in src/or/config.c.
    
     * FIXES #20201: https://bugs.torproject.org/20201
---
 src/or/config.c | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/src/or/config.c b/src/or/config.c
index 9c5514f..ef2dfcd 100644
--- a/src/or/config.c
+++ b/src/or/config.c
@@ -5325,10 +5325,14 @@ bridge_line_free(bridge_line_t *bridge_line)
   tor_free(bridge_line);
 }
 
-/** Read the contents of a Bridge line from <b>line</b>. Return 0
- * if the line is well-formed, and -1 if it isn't. If
- * <b>validate_only</b> is 0, and the line is well-formed, then add
- * the bridge described in the line to our internal bridge list.
+/** Parse the contents of a string, <b>line</b>, containing a Bridge line,
+ * into a bridge_line_t.
+ *
+ * Validates that the IP:PORT, fingerprint, and SOCKS arguments (given to the
+ * Pluggable Transport, if a one was specified) are well-formed.
+ *
+ * Returns NULL If the Bridge line could not be validated, and returns a
+ * bridge_line_t containing the parsed information otherwise.
  *
  * Bridge line format:
  * Bridge [transport] IP:PORT [id-fingerprint] [k=v] [k=v] ...