[tor-commits] [bridgedb/master] Clarify how we parse bridge descriptors

[isis at torproject.org]

commit 3a636411f34754c5e5c68bb79ae4765598106116
Author: Matthew Finkel <Matthew.Finkel at gmail.com>
Date:   Thu Aug 15 03:56:11 2013 +0000

    Clarify how we parse bridge descriptors
    
    Bring the description inline with how the the implementation
    handles the descriptors and bridges.
---
 bridge-db-spec.txt |   11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/bridge-db-spec.txt b/bridge-db-spec.txt
index 0e07dcc..aa8af20 100644
--- a/bridge-db-spec.txt
+++ b/bridge-db-spec.txt
@@ -70,11 +70,12 @@
       "@purpose" SP purpose NL
       "router" SP nickname SP IP SP ORPort SP SOCKSPort SP DirPort NL
       ["opt" SP] "fingerprint" SP fingerprint NL
+      "router-signature" NL Signature NL
 
-   BridgeDB parses the purpose, IP, ORPort, and fingerprint from these
-   lines.
+   BridgeDB parses the purpose, IP, ORPort, nickname, and fingerprint
+   from these lines.
    BridgeDB skips bridge descriptors if the fingerprint is not contained
-   in the bridge network status parsed before or if the bridge does not
+   in the bridge network status parsed earlier or if the bridge does not
    have the Running flag.
    BridgeDB discards bridge descriptors which have a different purpose
    than "bridge".  BridgeDB can be configured to only accept descriptors
@@ -86,8 +87,8 @@
    BridgeDB memorizes the IP address and OR port of the most recently
    parsed bridge descriptor.
    If BridgeDB does not find a bridge descriptor for a bridge contained in
-   the bridge network status parsed before, it removes that bridge from
-   the set of bridges to be given out to bridge users.
+   the bridge network status parsed before, it does not add that bridge
+   to the set of bridges to be given out to bridge users.
 
 1.3. Parsing extra-info documents