[or-cvs] r11128: Correct GETINFO guard-nodes spec based on comments from pei (in tor/trunk: . doc/spec)

[nickm at seul.org]

Author: nickm
Date: 2007-08-15 16:47:42 -0400 (Wed, 15 Aug 2007)
New Revision: 11128

Modified:
   tor/trunk/
   tor/trunk/doc/spec/control-spec.txt
Log:
 r14581 at catbus:  nickm | 2007-08-15 16:46:42 -0400
 Correct GETINFO guard-nodes spec based on comments from pei hanru.



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

Modified: tor/trunk/doc/spec/control-spec.txt
===================================================================
--- tor/trunk/doc/spec/control-spec.txt	2007-08-15 19:56:01 UTC (rev 11127)
+++ tor/trunk/doc/spec/control-spec.txt	2007-08-15 20:47:42 UTC (rev 11128)
@@ -431,15 +431,25 @@
     "entry-guards"
       A series of lines listing the currently chosen entry guards, if any.
       Each is of the form:
-         ServerID  SP (Status-with-time / Status) CRLF
+         ServerID2 SP Status [SP ISOTime] CRLF
 
-         Status-with-time = ("down" / "unlisted") SP ISOTime
-         Status = ("up" / "never-connected")
+         Status-with-time = ("unlisted") SP ISOTime
+         Status = ("up" / "never-connected" / "down" /
+                      "unusable" / "unlisted" )
 
+         ServerID2 = Nickname / 40*HEXDIG
+
       [From 0.1.1.4-alpha to 0.1.1.10-alpha, this was called "helper-nodes".
        Tor still supports calling it that for now, but support will be
        removed in 0.1.3.x.]
 
+      [Older versions of Tor (before 0.1.2.x-final) generated 'down' instead
+       of unlisted/unusable.  Current Tors never generate 'down'.]
+
+      [XXXX ServerID2 differs from ServerID in not prefixing fingerprints
+       with a $.  This is an implementation error.  It would be nice to add
+       the $ back in if we can do so without breaking compatibility.]
+
     "accounting/enabled"
     "accounting/hibernating"
     "accounting/bytes"