[tor-bugs] #30726 [Core Tor/Tor]: Missing relay keys in bandwidth file spec

[Tor Bug Tracker & Wiki]

#30726: Missing relay keys in bandwidth file spec
-------------------------------------+-----------------------------------
 Reporter:  teor                     |          Owner:  (none)
     Type:  defect                   |         Status:  needs_review
 Priority:  High                     |      Milestone:  sbws: 1.1.x-final
Component:  Core Tor/Tor             |        Version:
 Severity:  Major                    |     Resolution:
 Keywords:  sbws-spec, sbws-roadmap  |  Actual Points:
Parent ID:  #33121                   |         Points:  6
 Reviewer:  ahf, gk                  |        Sponsor:
-------------------------------------+-----------------------------------

Comment (by gk):

 Replying to [comment:4 juga]:
 > putting this ticket to needs review because i've some questions.
 >
 > i realized that there are keys in the spec like `desc_bw_average`, that
 was never named like that in sbws, it was named `desc_bw_avg`, that's why
 the last one is missing in the spec, it was a mistake when writing the
 spec.
 >
 > Should we leave them as they are for version 1.2 and add the correct
 names in version 1.5? ,and remove `desc_bw_average` from the sbws examples
 in the Annexes?
 >
 > and the keys that were missing, should we also say that we add them in
 version 1.5 even if they were in sbws time ago?

 So, all of those examples look to me like spec bugs: the right thing
 happened in the code, but the spec does not reflect that and thus needs to
 get updated. If that's the case we should just fix the spec without the
 need for bumping the version. That goes both for missing as well as
 wrongly spelled keys. The missing ones, too, should get added to the spec
 with the first version in which they appeared (as all the other ones that
 we did not forget).

 Re: the examples. Yes, if we change `desc_bw_average` to `desc_bw_avg`
 (and do not say the bug is actually `desc_bw_avg` in the code which should
 be `desc_bw_average` as it is written in the spec) then we should fix up
 the examples as well in the Annexes (I don't know where those are but even
 without looking at them in detail it makes sense to fix the examples :)).

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