aboutsummaryrefslogtreecommitdiff
path: root/bandwidth-file-spec.txt
AgeCommit message (Collapse)Author
2023-10-12Move all text-only specifications into the OLD_TXT directory.Nick Mathewson
2023-06-26bandwidth-file: Add ratios KeyValues in RelayLinesjuga0
and network bandwidth averages KeyValues in the Header. Closes #210
2022-10-13bandwidth-file: Remove trailing `=` defining Keysjuga0
since some of them didn't have it, other Tor specs don't have them and a KeyValue is already defined with an `=` as the separator between the Key and the Value.
2022-10-13bandwidth-file: Add XOFF KeyValues to RelayLinesjuga0
to show the number of times a relay receives these events while being measured and diagnose bottlenecks at bwauths. Closes #169.
2021-10-25Fix typos and cleanupDimitris Apostolou
2021-09-22bandwidth-file-spec: Add 'Table of contents'Oleh Franchuk
2021-03-22Clarify Torflow's aggregation stepsGeorg Koppen
Closes torspec#40.
2020-12-17bandwidth-file: Remove KeyValue recent_measurement_attempt_countjuga0
because of sbws#40020 and potentially sbws#40023. Closes: #34.
2020-12-07bandwidth-file: Tor version was added in v1.4.0juga0
bandwidth file version, not v1.5.0. Closes: #35
2020-03-30Bug 33759: Fix recent_measurements_excluded_few_count keyGeorg Koppen
2020-03-12Merge remote-tracking branch 'tor-github/pr/113'Nick Mathewson
2020-03-05bandwidth-file: Replace `Add` by `Adds`juga0
2020-03-05bandwidth-file: Remove specification version 1.3.0.juga0
since there was never a bandwidth file published by bwauths using that nor sbws ever generated that version because it was forgotten to increment it when adding country related KeyValues.
2020-03-05bandwidth-file: Add forgotten KeyValuesjuga0
Some bandwidth related KeyValues were added to the version 1.2.0, but they were forgotten when writing this specification. The same happened with some monitoring KeyValues in the version 1.4.0. They have not been added to the examples, since they don't contain all the KeyValues. Closes #30726.
2020-03-03bandwidth-file: Correct KeyValues namesjuga0
The KeyValues never appeared in a bandwidth file generated by the bwauths with those names, it was a mistake when writing this specification. The replacements done are: - s/desc_bw_average/desc_bw_avg/ - s/desc_obs_bw_last/desc_bw_obs_last/ - s/desc_obs_bw_mean/desc_bw_obs_mean/ And in the examples: - s/desc_avg_bw/desc_bw_avg/ - s/desc_obs_bw_last/desc_bw_obs_last/ - s/desc_obs_bw_mean/desc_bw_obs_mean/ Part of #30726.
2020-02-09bandwidth-file: Add tor_version headerjuga0
Part of #30196.
2019-11-26fix erroneous header numbering punctuationHans-Christoph Steiner
The clear standard is trailing "." after each numeric section. This fixes the small handful of outliers. This makes it easy to convert these headers to common markup formats, for example: http://hyperpolyglot.org/lightweight-markup
2019-11-26standardize whitespace in the titlesHans-Christoph Steiner
This is one small step towards making these a standard, parsable format.
2019-05-14Merge remote-tracking branch 'tor-github/pr/82'Nick Mathewson
2019-05-13bandwidth-file: Add HeaderLine non-terminaljuga0
To make more clear that header lines do not contain spaces and simplify parsers. This does not change the format. Closes: #30311
2019-05-12bandwidth-file: Replace KeyWord by Keyjuga0
in the nonterminals definition, so that it match implementations and does not fail with a grammar parser. Closes: #30373
2019-03-30bandwidth-file: Add time to report half network header KeyValueteor
2019-03-30bandwidth-file: Add relay line diagnostic KeyValuesteor
Make Tor directory authorities avoid voting on relay bandwidths for relays that were not successfully measured. But report diagnostics for those relays in the Bandwidth File. When there are not enough eligible relays, put all the relays in the file for diagnostic purposes. But mark them so that Tor avoids voting on their bandwidths. Closes 29813, 29853.
2019-03-30bandwidth-file: Add summaries for format version 1.3.0 and 1.4.0teor
Part of 29754.
2019-03-30bandwidth-file: Add new RelayLine monitoring KeyValuesteor
Part of 29754.
2019-03-29bandwidth-file: Remove SP from the end of KeyValuesteor
The final KeyValue isn't followed by SP. The spaces are added between KeyValues when the RelayLine is formatted.
2019-03-29bandwidth-file: Fix missing cardinalities, format versions, and headingsteor
Also fix some typos.
2019-03-29bandwidth-file: Add version 1.4.0 examplesjuga0
of header and lines generated by sbws. Closes #29754
2019-03-29bandwidth-file: Add header KeyValues to monitor relaysjuga0
Part of #29754.
2019-03-19bandwidth-file: Replace mistaken NL by SPjuga0
in some of the Bandwidth Line KeyValues. Closes #29814.
2019-03-11Merge remote-tracking branch 'tor-github/pr/59'Nick Mathewson
2019-03-08bandwidth-file: Clean up trailing spaces in the text fileteor
2019-03-08bandwidth-file: Correct part of the version 1.2.0 change descriptionteor
2019-03-08Consistently use term 'Bandwidth File'Damian Johnson
Usually the 'Bandwidth File' spec called its actual documents 'Bandwidth Lists'. Juga and teor have both said they prefer the term 'Bandwidth File'. Standardizing this so we have a consistent name for these documents... https://trac.torproject.org/projects/tor/ticket/28615#comment:9
2019-03-06fixup! bandwidth-file: Add scanner and destination countryjuga0
2019-03-01bandwidth-file: Add scanner and destination countryjuga0
Closes: #29354
2019-02-25bandwidth-file: Fix a typo, the file is not a fallback fileteor
Fixes bug 29578.
2019-02-04bandwidth-file: remove measured word from bwjuga0
since the "bw" value might be scaled.
2019-02-04bandwidth-file: add units to the bandwidth values.juga0
2019-01-23bandwidth: typos and spacingteor
2019-01-23bandwidth: Prefer a 5-character header terminatorteor
2019-01-22Spacingteor
2019-01-22Allow parsers to fail files with duplicate relay linesteor
2019-01-22Remove sbws version from relay line key value listteor
The version was out of date, and we're not tracking the versions when keys were added.
2019-01-22Clarify relay line and key value ordersteor
2019-01-22Clarify header and relay line orderteor
2019-01-14bandwidth: use consistent 2 space indents, and reflow long linesteor
2019-01-14bandwidth: minor rewording and spacingteor
2019-01-14bandwidth: reword Header/Header Lines/Relay Lines descriptionsteor
2019-01-14bandwidth: Add sbws and Tor versions where requiredteor