Man tor - Refactoring - Creation of a new `BANDWIDTH MANAGEMENT OPTIONS` section
A total of 11 options (see the list below) should go in a new section named BANDWIDTH MANAGEMENT OPTIONS
. This would reduce the amount of time spent scrolling around in the man tor page and make finding options more intuitive instead of having to remember the spreaded locations were bandwidth options are sometimes located.\
We could also take this opportunity to change the location of the warning about how bandwidth-limiting options are managed. This warning is located at the end of the description of the option BandwidthRate
. We could move the warning to the description of the newly created BANDWIDTH MANAGEMENT OPTIONS
section, or at least, in the THE CONFIGURATION FILE FORMAT
section.\
Also, like it is said in description of the option AccountingMax
:\
Note that (as also described in the Bandwidth section) Tor uses powers of two [...]
This "Bandwidth section" does not really exist, but now it will if this issue is approuved. The non-existing "Bandwidth section" seems to refer to the description of the option BandwidthRate
.\
I will make the neccessary changes in the man tor page and only show you the final result. You will just need to accept it or tell me what need more tweaking.\
List of options that will need to move to the newly created one:\
GENERAL OPTIONS:\
- BandwidthBurst
- BandwidthRate
- CountPrivateBandwidth
- MaxAdvertisedBandwidth
- PerConnBWBurst
- PerConnBWRate
- RelayBandwidthBurst
- RelayBandwidthRate\
SERVER OPTIONS:\
- AccountingMax
- AccountingRule
- AccountingStart
The newly created section will look something like that:\
BANDWIDTH MANAGEMENT OPTIONS
Description : The end of the description of the options BandwidthRate
about size unit format.\
- AccountingMax
- AccountingRule
- AccountingStart
- BandwidthBurst
- BandwidthRate
- CountPrivateBandwidth
- MaxAdvertisedBandwidth
- PerConnBWBurst
- PerConnBWRate
- RelayBandwidthBurst
- RelayBandwidthRate
\
On an unrelated note to this issue:
I try to use the functionalities of GitLab Flavord Markdown
in my previous 2 issues, but that did not really goes has I expected, so sorry for the ugly formating of all my previous issues. I'm learning. I hope this issue look a bit better :)