diff options
Diffstat (limited to 'spec/bandwidth-file-spec')
| -rw-r--r-- | spec/bandwidth-file-spec/implementation-details.md | 6 | ||||
| -rw-r--r-- | spec/bandwidth-file-spec/relay-line-format.md | 2 | ||||
| -rw-r--r-- | spec/bandwidth-file-spec/sample-data.md | 12 | ||||
| -rw-r--r-- | spec/bandwidth-file-spec/scaling-bandwidths.md | 2 |
4 files changed, 11 insertions, 11 deletions
diff --git a/spec/bandwidth-file-spec/implementation-details.md b/spec/bandwidth-file-spec/implementation-details.md index 90f84fa..1695793 100644 --- a/spec/bandwidth-file-spec/implementation-details.md +++ b/spec/bandwidth-file-spec/implementation-details.md @@ -4,7 +4,7 @@ <a id="bandwidth-file-spec.txt-2.4.1"></a> -### Writing bandwidth files atomically +### Writing bandwidth files atomically { #write-atomically } To avoid inconsistent reads, implementations SHOULD write bandwidth files atomically. If the file is transferred from another host, it SHOULD be @@ -19,13 +19,13 @@ Torflow does not write bandwidth files atomically. <a id="bandwidth-file-spec.txt-2.4.2"></a> -### Additional KeyValue pair definitions +### Additional KeyValue pair definitions { #key-value-pairs } KeyValue pairs in RelayLines that current implementations generate. <a id="bandwidth-file-spec.txt-2.4.2.1"></a> -#### Simple Bandwidth Scanner +#### Simple Bandwidth Scanner { #sbws } sbws RelayLines contain these keys: diff --git a/spec/bandwidth-file-spec/relay-line-format.md b/spec/bandwidth-file-spec/relay-line-format.md index ec47146..275abc6 100644 --- a/spec/bandwidth-file-spec/relay-line-format.md +++ b/spec/bandwidth-file-spec/relay-line-format.md @@ -1,6 +1,6 @@ <a id="bandwidth-file-spec.txt-2.3"></a> -## Relay Line format +## Relay Line format { #relay-line } It consists of zero or more RelayLines containing relay ids and bandwidths. The relays and their KeyValues are in arbitrary order. diff --git a/spec/bandwidth-file-spec/sample-data.md b/spec/bandwidth-file-spec/sample-data.md index 45bb43f..1a689fd 100644 --- a/spec/bandwidth-file-spec/sample-data.md +++ b/spec/bandwidth-file-spec/sample-data.md @@ -6,7 +6,7 @@ The following has not been obtained from any real measurement. <a id="bandwidth-file-spec.txt-A.1"></a> -## Generated by Torflow +## Generated by Torflow { #torflow } This an example version 1.0.0 document: @@ -18,7 +18,7 @@ node_id=$96C15995F30895689291F455587BD94CA427B6FC bw=189 nick=Test2 measured_at= <a id="bandwidth-file-spec.txt-A.2"></a> -## Generated by sbws version 0.1.0 +## Generated by sbws version 0.1.0 { #sbws-010 } ```text 1523911758 @@ -37,7 +37,7 @@ bw=189 error_circ=0 error_misc=0 error_stream=0 master_key_ed25519=a6a+dZadrQBtf <a id="bandwidth-file-spec.txt-A.3"></a> -## Generated by sbws version 1.0.3 +## Generated by sbws version 1.0.3 { #sbws-103 } ````text 1523911758 @@ -61,7 +61,7 @@ bw=1 bw_mean=199162 bw_median=185675 desc_bw_avg=409600 desc_bw_obs_last=836165 <a id="bandwidth-file-spec.txt-A.3.1"></a> -### When there are not enough eligible measured relays +### When there are not enough eligible measured relays { #sbws-103-not-enough-measured } ```text 1540496079 @@ -82,7 +82,7 @@ software_version=1.0.3 <a id="bandwidth-file-spec.txt-A.4"></a> -## Headers generated by sbws version 1.0.4 +## Headers generated by sbws version 1.0.4 { #sbws-104 } ```text 1523911758 @@ -105,7 +105,7 @@ software_version=1.0.4 <a id="bandwidth-file-spec.txt-A.5"></a> -## Generated by sbws version 1.1.0 +## Generated by sbws version 1.1.0 { #sbws-110 } ```text 1523911758 diff --git a/spec/bandwidth-file-spec/scaling-bandwidths.md b/spec/bandwidth-file-spec/scaling-bandwidths.md index 8d8906e..65bb317 100644 --- a/spec/bandwidth-file-spec/scaling-bandwidths.md +++ b/spec/bandwidth-file-spec/scaling-bandwidths.md @@ -21,7 +21,7 @@ enough already. <a id="bandwidth-file-spec.txt-B.2"></a> -## A linear scaling method +## A linear scaling method { #linear-method } If scaling is required, here is a simple linear bandwidth scaling method, which ensures that all bandwidth votes contain approximately |