PerConnBW{Rate,Burst} docs: do not say consensus param is always set

Closes ticket 25296; bugfix on 0.2.2.7-alpha when these manpage
entries were introduced.
This commit is contained in:
Nick Mathewson 2018-03-19 06:14:57 -04:00
parent bc0de600b2
commit c2d93e8a7d
2 changed files with 11 additions and 6 deletions

5
changes/bug25296_032 Normal file
View File

@ -0,0 +1,5 @@
o Minor bugfixes (documentation):
- Document that the PerConnBW{Rate,Burst} options will fall back to their
corresponding consensus parameters only if those parameters are
set. Previously we had claimed that these values would always be
set in the consensus. Fixes bug 25296; bugfix on 0.2.2.7-alpha.

View File

@ -239,14 +239,14 @@ GENERAL OPTIONS
(Default: 0)
[[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
If set, do separate rate limiting for each connection from a non-relay.
You should never need to change this value, since a network-wide value is
published in the consensus and your relay will use that value. (Default: 0)
If this option is set manually, or via the "perconnbwrate" consensus
field, Tor will use it for separate rate limiting for each connection
from a non-relay. (Default: 0)
[[PerConnBWBurst]] **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
If set, do separate rate limiting for each connection from a non-relay.
You should never need to change this value, since a network-wide value is
published in the consensus and your relay will use that value. (Default: 0)
If this option is set manually, or via the "perconnbwburst" consensus
field, Tor will use it for separate rate limiting for each connection
from a non-relay. (Default: 0)
[[ClientTransportPlugin]] **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
**ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::