[tor-bugs] #29715 [Core Tor/Stem]: Change documentation about RouterStatusEntryV3 bandwidth to specify that unit is kilobytes

[Tor Bug Tracker & Wiki]

#29715: Change documentation about RouterStatusEntryV3 bandwidth to specify that
unit is kilobytes
---------------------------+------------------------
 Reporter:  juga           |          Owner:  atagar
     Type:  defect         |         Status:  new
 Priority:  Medium         |      Milestone:
Component:  Core Tor/Stem  |        Version:
 Severity:  Normal         |     Resolution:
 Keywords:                 |  Actual Points:
Parent ID:                 |         Points:
 Reviewer:                 |        Sponsor:
---------------------------+------------------------

Comment (by teor):

 Stem is not wrong.
 But it would be more helpful if it said "arbitrary units (currently
 kilobytes per second)".

 Here are the details:

 dir-spec says that weights are in arbitrary units. And it says that the
 current design uses kilobytes per second, re-weighted by bandwidth
 measurements:
 https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt#n2381

 bandwidth-file-spec says kilobytes per second, because it specifies the
 current design:
 https://gitweb.torproject.org/torspec.git/tree/bandwidth-file-
 spec.txt#n361

 Relays' self-reported bandwidths are in bytes per second, so tor scales
 them to kilobytes per second:
 https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt#n432

 Torflow and sbws:
 * start with bytes and kilobytes per second,
 * scale everything to bytes
 * re-weight by the ratio of the node to the network average to get re-
 weighted bytes per second, and then
 * scale to re-weighted kilobytes per second.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/29715#comment:3>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online