[tor-commits] [tor/master] Comment possible values of was_router_added_t.

[nickm at torproject.org]

commit f9d73eea9c2a17638ca55fc6fcc3a125c85c2619
Author: rl1987 <rl1987 at sdf.lonestar.org>
Date:   Tue Nov 11 20:37:39 2014 +0200

    Comment possible values of was_router_added_t.
---
 src/or/or.h |   16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/or/or.h b/src/or/or.h
index b95bfb1..371ca4f 100644
--- a/src/or/or.h
+++ b/src/or/or.h
@@ -4999,14 +4999,30 @@ typedef enum {
 
 /** Return value for router_add_to_routerlist() and dirserv_add_descriptor() */
 typedef enum was_router_added_t {
+  /* Router was added successfully. */
   ROUTER_ADDED_SUCCESSFULLY = 1,
+  /* Router descriptor was added with warnings to submitter. */
   ROUTER_ADDED_NOTIFY_GENERATOR = 0,
+  /* Extrainfo document was rejected because no corresponding router
+   * descriptor was found OR router descriptor was rejected because
+   * it was incompatible with its extrainfo document. */
   ROUTER_BAD_EI = -1,
+  /* Router descriptor was rejected because it is already known. */
   ROUTER_WAS_NOT_NEW = -2,
+  /* General purpose router was rejected, because it was not listed
+   * in consensus. */
   ROUTER_NOT_IN_CONSENSUS = -3,
+  /* Router was neither in directory consensus nor in any of
+   * networkstatus documents. Caching it to access later.
+   * (Applies to fetched descriptors only.) */
   ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS = -4,
+  /* Router was rejected by directory authority. */
   ROUTER_AUTHDIR_REJECTS = -5,
+  /* Bridge descriptor was rejected because such bridge was not one
+   * of the bridges we have listed in our configuration. */
   ROUTER_WAS_NOT_WANTED = -6,
+  /* Router descriptor was rejected because it was older than
+   * OLD_ROUTER_DESC_MAX_AGE. */
   ROUTER_WAS_TOO_OLD = -7,
 } was_router_added_t;