aboutsummaryrefslogtreecommitdiff
path: root/spec/bandwidth-file-spec
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-10-14 19:14:57 -0400
committerNick Mathewson <nickm@torproject.org>2023-10-14 19:14:57 -0400
commit646fef090ac364bd16701a6f00da0670bd7045ed (patch)
tree730f921933ad2652c9349af551b07fcd42f5a5a2 /spec/bandwidth-file-spec
parent4ebef6db0a7c4acddba4192f836592cfe8f421ee (diff)
downloadtorspec-646fef090ac364bd16701a6f00da0670bd7045ed.tar.gz
torspec-646fef090ac364bd16701a6f00da0670bd7045ed.zip
Enforce the rule that every md has a toplevel (\#) section.
Diffstat (limited to 'spec/bandwidth-file-spec')
-rw-r--r--spec/bandwidth-file-spec/definitions.md2
-rw-r--r--spec/bandwidth-file-spec/header-list-format.md2
-rw-r--r--spec/bandwidth-file-spec/implementation-details.md10
-rw-r--r--spec/bandwidth-file-spec/relay-line-format.md2
4 files changed, 8 insertions, 8 deletions
diff --git a/spec/bandwidth-file-spec/definitions.md b/spec/bandwidth-file-spec/definitions.md
index 0300fb5..c01b407 100644
--- a/spec/bandwidth-file-spec/definitions.md
+++ b/spec/bandwidth-file-spec/definitions.md
@@ -1,6 +1,6 @@
<a id="bandwidth-file-spec.txt-2.1"></a>
-## Definitions
+# Definitions
The following nonterminals are defined in Tor directory protocol
sections 1.2., 2.1.1., 2.1.3.:
diff --git a/spec/bandwidth-file-spec/header-list-format.md b/spec/bandwidth-file-spec/header-list-format.md
index 075ddd6..6b7f9df 100644
--- a/spec/bandwidth-file-spec/header-list-format.md
+++ b/spec/bandwidth-file-spec/header-list-format.md
@@ -1,6 +1,6 @@
<a id="bandwidth-file-spec.txt-2.2"></a>
-## Header List format
+# Header List format
It consists of a Timestamp line and zero or more HeaderLines.
diff --git a/spec/bandwidth-file-spec/implementation-details.md b/spec/bandwidth-file-spec/implementation-details.md
index 1695793..6775e05 100644
--- a/spec/bandwidth-file-spec/implementation-details.md
+++ b/spec/bandwidth-file-spec/implementation-details.md
@@ -1,10 +1,10 @@
<a id="bandwidth-file-spec.txt-2.4"></a>
-## Implementation details
+# Implementation details
<a id="bandwidth-file-spec.txt-2.4.1"></a>
-### Writing bandwidth files atomically { #write-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 { #key-value-pairs }
+## 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 { #sbws }
+### Simple Bandwidth Scanner { #sbws }
sbws RelayLines contain these keys:
@@ -381,7 +381,7 @@ This KeyValue was added in version 1.7.0 of this specification.
<a id="bandwidth-file-spec.txt-2.4.2.2"></a>
-#### Torflow
+### Torflow
Torflow RelayLines include node_id and bw, and other KeyValue pairs \[2\].
diff --git a/spec/bandwidth-file-spec/relay-line-format.md b/spec/bandwidth-file-spec/relay-line-format.md
index 275abc6..4a73a01 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 }
+# 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.