[tor-commits] [tor/master] Clean whitespace, add missing documentation

[nickm@xxxxxxxxxxxxxx]

commit e402cddefeaabc6d65a5efe6f1e0e958d40aa013
Author: Nick Mathewson <nickm@xxxxxxxxxxxxxx>
Date:   Fri Aug 26 13:09:26 2016 -0400

    Clean whitespace, add missing documentation
---
 src/or/protover.c        |  4 +++-
 src/or/protover.h        | 25 ++++++++++++++++---------
 src/test/test_protover.c |  2 --
 3 files changed, 19 insertions(+), 12 deletions(-)

diff --git a/src/or/protover.c b/src/or/protover.c
index 66d20c5..d29cdba 100644
--- a/src/or/protover.c
+++ b/src/or/protover.c
@@ -620,7 +620,6 @@ protover_all_supported(const char *s, char **missing_out)
     smartlist_add(missing, (void*) ent);
   } SMARTLIST_FOREACH_END(ent);
 
-
   if (missing_out && !all_supported) {
     tor_assert(0 != smartlist_len(missing));
     *missing_out = encode_protocol_list(missing);
@@ -633,6 +632,8 @@ protover_all_supported(const char *s, char **missing_out)
   return all_supported;
 }
 
+/** Helper: Given a list of proto_entry_t, return true iff
+ * <b>pr</b>=<b>ver</b> is included in that list. */
 static int
 protocol_list_contains(const smartlist_t *protos,
                        protocol_type_t pr, uint32_t ver)
@@ -697,3 +698,4 @@ protover_free_all(void)
     supported_protocol_list = NULL;
   }
 }
+
diff --git a/src/or/protover.h b/src/or/protover.h
index 352fa7c..520db37 100644
--- a/src/or/protover.h
+++ b/src/or/protover.h
@@ -4,9 +4,13 @@
 
 #include "container.h"
 
+/** The first version of Tor that included "proto" entries in its
+ * descriptors.  Authorities should use this to decide whether to
+ * guess proto lines. */
 /* This is a guess. */
 #define FIRST_TOR_VERSION_TO_ADVERTISE_PROTOCOLS "0.2.9.3-alpha"
 
+/** List of recognized subprotocols. */
 typedef enum protocol_type_t {
   PRT_LINK,
   PRT_LINKAUTH,
@@ -19,19 +23,12 @@ typedef enum protocol_type_t {
   PRT_CONS,
 } protocol_type_t;
 
-/*
-const protover_set_t *protover_get_supported(void);
-protover_set_t *protover_set_parse(const char *s);
-int protover_is_supported_here_str(const char *name, uint32_t ver);
-int protover_is_supported_by(protocol_type_t pr, uint32_t ver);
-*/
-
 int protover_all_supported(const char *s, char **missing);
 int protover_is_supported_here(protocol_type_t pr, uint32_t ver);
 const char *get_supported_protocols(void);
 
-char * compute_protover_vote(const smartlist_t *list_of_proto_strings,
-                             int threshold);
+char *compute_protover_vote(const smartlist_t *list_of_proto_strings,
+                            int threshold);
 const char *protover_compute_for_old_tor(const char *version);
 int protocol_list_supports_protocol(const char *list, protocol_type_t tp,
                                     uint32_t version);
@@ -39,13 +36,22 @@ int protocol_list_supports_protocol(const char *list, protocol_type_t tp,
 void protover_free_all(void);
 
 #ifdef PROTOVER_PRIVATE
+/** Represents a range of subprotocols of a given type. All subprotocols
+ * between <b>low</b> and <b>high</b> inclusive are included. */
 typedef struct proto_range_t {
   uint32_t low;
   uint32_t high;
 } proto_range_t;
 
+/** Represents a set of ranges of subprotocols of a given type. */
 typedef struct proto_entry_t {
+  /** The name of the protocol.
+   *
+   * (This needs to handle voting on protocols which
+   * we don't recognize yet, so it's a char* rather than a protocol_type_t.)
+   */
   char *name;
+  /** Smartlist of proto_range_t */
   smartlist_t *ranges;
 } proto_entry_t;
 
@@ -57,3 +63,4 @@ STATIC int str_to_protocol_type(const char *s, protocol_type_t *pr_out);
 #endif
 
 #endif
+
diff --git a/src/test/test_protover.c b/src/test/test_protover.c
index c86c3b2..eacbbcb 100644
--- a/src/test/test_protover.c
+++ b/src/test/test_protover.c
@@ -114,7 +114,6 @@ test_protover_parse_fail(void *arg)
   ;
 }
 
-
 static void
 test_protover_vote(void *arg)
 {
@@ -183,7 +182,6 @@ test_protover_all_supported(void *arg)
   tor_free(msg);
 }
 
-
 #define PV_TEST(name, flags)                       \
   { #name, test_protover_ ##name, (flags), NULL, NULL }
 



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits