commit 6eddf6d1d53b41e4efae35c877e0c3dc0897a407 Author: juga0 juga@riseup.net Date: Wed Nov 7 16:30:40 2018 +0000
Change order of KeyValues
As suggested by teor --- bandwidth-file-spec.txt | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-)
diff --git a/bandwidth-file-spec.txt b/bandwidth-file-spec.txt index 62bee23..84429b8 100644 --- a/bandwidth-file-spec.txt +++ b/bandwidth-file-spec.txt @@ -208,16 +208,12 @@ It consists of:
This Line has been added in version 1.1.0 of this specification.
- "percent_eligible_relays=" Int NL + "number_eligible_relays=" Int NL
[Zero or one time.]
- The number of eligible relays, as a percentage of the number - of relays in the consensus. - - This line SHOULD be equal to: - (number_eligible_relays * 100.0) / number_consensus_relays - to the number of relays in the consensus to include in this file. + The number of relays that have enough measurements to be + included in the bandwidth file.
Implementations SHOULD include this KeyValue when "minimum_percent_eligible_relays" is minor than @@ -225,14 +221,17 @@ It consists of:
This Line has been added in version 1.2.0 of this specification.
- "minimum_number_eligible_relays=" Int NL + "minimum_percent_eligible_relays=" Int NL
[Zero or one time.]
- The minimum number of relays to include in the bandwidth file. + The percentage of relays in the consensus that SHOULD be + included in every generated bandwidth file. If there are not + enough eligible relays, the bandwidth file SHOULD contain a + header, but no relays.
- This line SHOULD be equal to: - number_consensus_relays * (minimum_percent_eligible_relays / 100.0) + The minimum percentage is 60% in Torflow, so sbws uses + 60% as the default.
Implementations SHOULD include this KeyValue when "minimum_percent_eligible_relays" is minor than @@ -252,12 +251,16 @@ It consists of:
This Line has been added in version 1.2.0 of this specification.
- "number_eligible_relays=" Int NL + "percent_eligible_relays=" Int NL
[Zero or one time.]
- The number of relays that have enough measurements to be - included in the bandwidth file. + The number of eligible relays, as a percentage of the number + of relays in the consensus. + + This line SHOULD be equal to: + (number_eligible_relays * 100.0) / number_consensus_relays + to the number of relays in the consensus to include in this file.
Implementations SHOULD include this KeyValue when "minimum_percent_eligible_relays" is minor than @@ -265,18 +268,15 @@ It consists of:
This Line has been added in version 1.2.0 of this specification.
- "minimum_percent_eligible_relays=" Int NL + "minimum_number_eligible_relays=" Int NL
[Zero or one time.]
- The percentage of relays in the consensus that SHOULD be - included in every generated bandwidth file. If there are not - enough eligible relays, the bandwidth file SHOULD contain a - header, but no relays. - - The minimum percentage is 60% in Torflow, so sbws uses - 60% as the default. - + The minimum number of relays to include in the bandwidth file. + + This line SHOULD be equal to: + number_consensus_relays * (minimum_percent_eligible_relays / 100.0) + Implementations SHOULD include this KeyValue when "minimum_percent_eligible_relays" is minor than "percent_eligible_relays" and MAY not include any RelayLine.