Ticket #24318: 0001-Clarify-the-RelayBandwidth-options-in-man-file.patch

File 0001-Clarify-the-RelayBandwidth-options-in-man-file.patch, 1.9 KB (added by ffmancera, 19 months ago)
  • doc/tor.1.txt

    From c1d87411c690c3b5ec37ba998145e0679fe3fe21 Mon Sep 17 00:00:00 2001
    From: Fernando Fernandez Mancera <ffernandezmancera@gmail.com>
    Date: Mon, 20 Nov 2017 17:13:16 +0100
    Subject: [PATCH] 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@gmail.com>
    ---
     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 fc285ebe1..3cccd54c5 100644
    a b GENERAL OPTIONS 
    231231    usage for \_relayed traffic_ on this node to the specified number of bytes
    232232    per second, and the average outgoing bandwidth usage to that same value.
    233233    Relayed traffic currently is calculated to include answers to directory
    234     requests, but that may change in future versions. (Default: 0)
     234    requests, but that may change in future versions. They do not include directory
     235    fetches by the relay (from authority or other relays), because that is considered
     236    "client" activity.  (Default: 0)
    235237
    236238[[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
    237239    If not 0, limit the maximum token bucket size (also known as the burst) for
    238240    \_relayed traffic_ to the given number of bytes in each direction.
    239     (Default: 0)
     241    They do not include directory fetches by the relay (from authority
     242    or other relays), because that is considered "client" activity. (Default: 0)
    240243
    241244[[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
    242245    If set, do separate rate limiting for each connection from a non-relay.