[tor-commits] [tor/master] Clarify the RelayBandwidth* options in man file

[nickm@xxxxxxxxxxxxxx]

commit 5f4e9d50799ff5bd01408a439405671db28598ce
Author: Fernando Fernandez Mancera <ffernandezmancera@xxxxxxxxx>
Date:   Mon Nov 20 17:13:16 2017 +0100

    Clarify the RelayBandwidth* options in man file
    
    Added clarifying information in man file about RelayBandwidthRate and
    RelayBandwidthBurst options that exclude directory fetches by relays.
    
    Fixes #24318
    
    Signed-off-by: Fernando Fernandez Mancera <ffernandezmancera@xxxxxxxxx>
---
 doc/tor.1.txt | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index e1c3cdaf9..6d0b80918 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -231,12 +231,15 @@ GENERAL OPTIONS
     usage for \_relayed traffic_ on this node to the specified number of bytes
     per second, and the average outgoing bandwidth usage to that same value.
     Relayed traffic currently is calculated to include answers to directory
-    requests, but that may change in future versions. (Default: 0)
+    requests, but that may change in future versions. They do not include directory
+    fetches by the relay (from authority or other relays), because that is considered
+    "client" activity.  (Default: 0)
 
 [[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
     If not 0, limit the maximum token bucket size (also known as the burst) for
     \_relayed traffic_ to the given number of bytes in each direction.
-    (Default: 0)
+    They do not include directory fetches by the relay (from authority 
+    or other relays), because that is considered "client" activity. (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.



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits