Tweak the documentation for BridgeDistribution

Note that it will have no effect yet; note that the default is
"any".

diff --git a/changes/feature18329 b/changes/feature18329
index 7fdb659e8280247ef1c9932726f4f2e725da3b27..f534c76145e50c680c8db32063f3f27b3a23e577 100644 (file)
--- a/changes/feature18329
+++ b/changes/feature18329
@@ -2,5 +2,8 @@
     - Bridge relays can now set the BridgeDistribution config option to
       add a "bridge-distribution-request" line to their bridge descriptor,
       which tells BridgeDB how they'd like their bridge address to be
-      given out. Implements tickets 18329.
+      given out. (Note that as of Oct 2017, BridgeDB does not yet implement
+      this feature.) As a side benefit, this feature provides a way
+      to distinguish bridge descriptors from non-bridge descriptors.
+      Implements tickets 18329.
 

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 7da5ba3fe1ac4d53ed2b9bcd62ce8de309ed82dc..52e81860bb4d5e4a55a51a22d8e0e1b43f994608 100644 (file)
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -1651,7 +1651,12 @@ is non-zero):
     If set along with BridgeRelay, Tor will include a new line in its
     bridge descriptor which indicates to the BridgeDB service how it
     would like its bridge address to be given out. Set it to "none" if
-    you want BridgeDB to avoid distributing your bridge address.
+    you want BridgeDB to avoid distributing your bridge address, or "any" to
+    let BridgeDB decide. (Default: any)
+ +
+    Note: as of Oct 2017, the BridgeDB part of this option is not yet
+    implemented.  Until BridgeDB is updated to obey this option, your
+    bridge will make this request, but it will not (yet) be obeyed.
 
 [[ContactInfo]] **ContactInfo** __email_address__::
     Administrative contact information for this relay or bridge. This line