[or-cvs] r10725: dir-spec.txt clarifications suggested by Lee Fisher. (in tor/trunk: . doc/spec)

[nickm@xxxxxxxx]

Author: nickm
Date: 2007-07-02 15:53:57 -0400 (Mon, 02 Jul 2007)
New Revision: 10725

Modified:
   tor/trunk/
   tor/trunk/doc/spec/dir-spec.txt
Log:
 r13594@catbus:  nickm | 2007-07-02 15:53:35 -0400
 dir-spec.txt clarifications suggested by Lee Fisher.



Property changes on: tor/trunk
___________________________________________________________________
 svk:merge ticket from /tor/trunk [r13594] on 8246c3cf-6607-4228-993b-4d95d33730f1

Modified: tor/trunk/doc/spec/dir-spec.txt
===================================================================
--- tor/trunk/doc/spec/dir-spec.txt	2007-07-02 19:45:44 UTC (rev 10724)
+++ tor/trunk/doc/spec/dir-spec.txt	2007-07-02 19:53:57 UTC (rev 10725)
@@ -324,20 +324,24 @@
    descriptor.
 
    In lines that take multiple arguments, extra arguments SHOULD be
-   accepted and ignored.
+   accepted and ignored.  Many of the nonterminals below are defined in
+   section 2.3.
 
      "router" nickname address ORPort SOCKSPort DirPort NL
 
        [At start, exactly once.]
 
-       Indicates the beginning of a router descriptor.  "address" must be an
-       IPv4 address in dotted-quad format. The last three numbers indicate
-       the TCP ports at which this OR exposes functionality. ORPort is a port
-       at which this OR accepts TLS connections for the main OR protocol;
+       Indicates the beginning of a router descriptor.  "nickname" must be a
+       valid router nickname as specified in 2.3.  "address" must be an IPv4
+       address in dotted-quad format.  The last three numbers indicate the
+       TCP ports at which this OR exposes functionality. ORPort is a port at
+       which this OR accepts TLS connections for the main OR protocol;
        SOCKSPort is deprecated and should always be 0; and DirPort is the
        port at which this OR accepts directory-related HTTP connections.  If
        any port is not supported, the value 0 is given instead of a port
-       number.
+       number.  (At least one of DirPort and ORPort SHOULD be set;
+       authorities MAY reject any descriptor with both DirPort and ORPort of
+       0.)
 
     "bandwidth" bandwidth-avg bandwidth-burst bandwidth-observed NL
 
@@ -471,14 +475,14 @@
         [At most once]
 
         Declare whether this version of Tor is using the newer enhanced
-        dns logic.  Versions of Tor without eventdns SHOULD NOT be used for
-        reverse hostname lookups.
+        dns logic.  Versions of Tor with this field set to false SHOULD NOT
+        be used for reverse hostname lookups.
 
         [All versions of Tor before 0.1.2.2-alpha should be assumed to have
          this option set to 0 if it is not present.  All Tor versions at
          0.1.2.2-alpha or later should be assumed to have this option set to
          1 if it is not present.  Until 0.1.2.1-alpha-dev, this option was
-         not generated, even when eventdns was in use.  Versions of Tor
+         not generated, even when the new DNS code was in use.  Versions of Tor
          before 0.1.2.1-alpha-dev did not parse this option, so it should be
          marked "opt".  The dnsworker logic has been removed, so this option
          should not be used by new server code.  However, it can still be