[tor-bugs] #26541 [Core Tor/Tor]: Fix minor mistakes in the bandwidth-file dir-spec entry

[Tor Bug Tracker & Wiki]

#26541: Fix minor mistakes in the bandwidth-file dir-spec entry
---------------------------------+------------------------------------
 Reporter:  teor                 |          Owner:  juga
     Type:  defect               |         Status:  needs_revision
 Priority:  Medium               |      Milestone:  Tor: 0.3.5.x-final
Component:  Core Tor/Tor         |        Version:
 Severity:  Normal               |     Resolution:
 Keywords:  tor-bwauth, torspec  |  Actual Points:
Parent ID:  #3723                |         Points:
 Reviewer:                       |        Sponsor:
---------------------------------+------------------------------------
Changes (by teor):

 * status:  merge_ready => needs_revision


Comment:

 Replying to [ticket:26541 teor]:
 > The bandwidth-file line appears:
 > {{{
 > [At most once for votes; does not occur in consensuses.]
 > }}}

 The patch has slightly different words. Please use the standard text here,
 so people can search for it:
 {{{
 [At most once for votes; does not occur in consensuses.
 }}}

 > He also suggested that we could change the name to bandwidth-file-
 headers or bandwidth-headers if we want. I don't mind what we call it, but
 it has to match #3723.

 I am happy with whatever you want to call it, but since the spec is
 bandwidth-file-spec.txt, bandwidth-file-headers is a good choice.

 > I also noticed that the definition of Value is wrong, it should be:
 > {{{
 > Value ::= ArgumentCharValue+
 > ArgumentCharValue ::= any printing ASCII character except NL and SP.
 > }}}

 The definition is missing ArgumentCharValue, which does not appear
 anywhere else in dir-spec.txt:
 {{{
 ArgumentCharValue ::= any printing ASCII character except NL and SP.
 }}}

 > We should also add the new file_created and latest_bandwidth header
 keywords from bandwidth-file-spec.
 >
 > Edit: file_created and latest_bandwidth were added in #26155 and it has
 been merged 3 now to master
 > Edit: previous line is about adding them to dir-spec

 In bandwidth-file-spec, the definitions of Timestamp and latest_bandwidth
 use exactly the same words:
 {{{
 of the most recent generator bandwidth result.
 }}}
 Can we use the same words in dir-spec, to avoid confusion?

 People might wonder why timestamp= and latest_bandwidth= are the same.
 So let's also include this part of the bandwidth-file-spec in dir-spec:
 {{{
     This time MUST be identical to the timestamp.
     This duplicate value is included to make the format easier for people
     to read.
 }}}

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