aboutsummaryrefslogtreecommitdiff
path: root/bandwidth-file-spec.txt
diff options
context:
space:
mode:
authorDamian Johnson <atagar@torproject.org>2019-01-19 14:31:29 -0800
committerNick Mathewson <nickm@torproject.org>2019-03-08 10:29:14 -0500
commitf67315832d85229e52429a0e6a356d5fb6000cd7 (patch)
treeb1cc7f97ece292b35d8db9629e6fcb4f02cc3f55 /bandwidth-file-spec.txt
parent8edd7803d98c6ecbf286275aa38cd48125e1521a (diff)
downloadtorspec-f67315832d85229e52429a0e6a356d5fb6000cd7.tar.gz
torspec-f67315832d85229e52429a0e6a356d5fb6000cd7.zip
Consistently use term 'Bandwidth File'
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
Diffstat (limited to 'bandwidth-file-spec.txt')
-rw-r--r--bandwidth-file-spec.txt14
1 files changed, 7 insertions, 7 deletions
diff --git a/bandwidth-file-spec.txt b/bandwidth-file-spec.txt
index a241108..444dd2f 100644
--- a/bandwidth-file-spec.txt
+++ b/bandwidth-file-spec.txt
@@ -1,10 +1,10 @@
- Tor Bandwidth List Format
+ Tor Bandwidth File Format
juga
teor
1. Scope and preliminaries
- This document describes the format of Tor's Bandwidth List, version
+ This document describes the format of Tor's Bandwidth File, version
1.0.0 and later.
It is a new specification for the existing bandwidth file format,
@@ -12,7 +12,7 @@
1.1.0 and later, which are backwards compatible with 1.0.0 parsers.
Since Tor version 0.2.4.12-alpha, the directory authorities use
- the Bandwidth List file called "V3BandwidthsFile" generated by
+ the Bandwidth File file called "V3BandwidthsFile" generated by
Torflow [1]. The details of this format are described in Torflow's
README.spec.txt. We also summarise the format in this specification.
@@ -36,15 +36,15 @@
The Tor directory protocol (dir-spec.txt [3]) sections 3.4.1
and 3.4.2, use the term bandwidth measurements, to refer to what
- here is called Bandwidth List.
+ here is called Bandwidth File.
- A Bandwidth List file contains information on relays' bandwidth
+ A Bandwidth File contains information on relays' bandwidth
capacities and is produced by bandwidth generators, previously known
as bandwidth scanners.
1.4. Format Versions
- 1.0.0 - The legacy Bandwidth List format
+ 1.0.0 - The legacy Bandwidth File format
1.1.0 - Add a header containing information about the bandwidth
file. Document the sbws and Torflow relay line keys.
@@ -65,7 +65,7 @@
2. Format details
- The Bandwidth List MUST contain the following sections:
+ The Bandwidth File MUST contain the following sections:
- Header List (exactly once), which is a partially ordered list of
- Header Lines (one or more times), then
- Relay Lines (zero or more times), in an arbitrary order.