aboutsummaryrefslogtreecommitdiff
path: root/spec/dir-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/dir-spec
parent4ebef6db0a7c4acddba4192f836592cfe8f421ee (diff)
downloadtorspec-646fef090ac364bd16701a6f00da0670bd7045ed.tar.gz
torspec-646fef090ac364bd16701a6f00da0670bd7045ed.zip
Enforce the rule that every md has a toplevel (\#) section.
Diffstat (limited to 'spec/dir-spec')
-rw-r--r--spec/dir-spec/accepting-relay-documents.md2
-rw-r--r--spec/dir-spec/assigning-flags-vote.md2
-rw-r--r--spec/dir-spec/computing-consensus.md18
-rw-r--r--spec/dir-spec/computing-microdescriptors.md2
-rw-r--r--spec/dir-spec/consensus-formats.md2
-rw-r--r--spec/dir-spec/creating-key-certificates.md2
-rw-r--r--spec/dir-spec/exchanging-detached-signatures.md2
-rw-r--r--spec/dir-spec/exchanging-votes.md2
-rw-r--r--spec/dir-spec/extra-info-document-format.md2
-rw-r--r--spec/dir-spec/nonterminals-server-descriptors.md2
-rw-r--r--spec/dir-spec/server-descriptor-format.md2
-rw-r--r--spec/dir-spec/serving-bandwidth-list-files.md2
-rw-r--r--spec/dir-spec/uploading-relay-documents.md2
13 files changed, 21 insertions, 21 deletions
diff --git a/spec/dir-spec/accepting-relay-documents.md b/spec/dir-spec/accepting-relay-documents.md
index b507b9c..ffcf7c7 100644
--- a/spec/dir-spec/accepting-relay-documents.md
+++ b/spec/dir-spec/accepting-relay-documents.md
@@ -1,6 +1,6 @@
<a id="dir-spec.txt-3.2"></a>
-## Accepting server descriptor and extra-info document uploads
+# Accepting server descriptor and extra-info document uploads
When a router posts a signed descriptor to a directory authority, the
authority first checks whether it is well-formed and correctly
diff --git a/spec/dir-spec/assigning-flags-vote.md b/spec/dir-spec/assigning-flags-vote.md
index 7b7a59e..7eb3849 100644
--- a/spec/dir-spec/assigning-flags-vote.md
+++ b/spec/dir-spec/assigning-flags-vote.md
@@ -1,6 +1,6 @@
<a id="dir-spec.txt-3.4.2"></a>
-### Assigning flags in a vote
+# Assigning flags in a vote
(This section describes how directory authorities choose which status
flags to apply to routers. Later directory authorities MAY do things
diff --git a/spec/dir-spec/computing-consensus.md b/spec/dir-spec/computing-consensus.md
index 1236e7e..39d6e5f 100644
--- a/spec/dir-spec/computing-consensus.md
+++ b/spec/dir-spec/computing-consensus.md
@@ -1,5 +1,5 @@
-## Computing a consensus from a set of votes { #computing-consensus }
+# Computing a consensus from a set of votes { #computing-consensus }
Given a set of votes, authorities compute the contents of the consensus.
@@ -233,7 +233,7 @@ earlier item.
<a id="dir-spec.txt-3.8.0.1"></a>
-### Deciding which Ids to include { #choosing-relay-ids }
+## Deciding which Ids to include { #choosing-relay-ids }
This sorting algorithm is used for consensus-method 22 and later.
@@ -260,7 +260,7 @@ This sorting algorithm is used for consensus-method 22 and later.
<a id="dir-spec.txt-3.8.0.2"></a>
-#### Deciding which descriptors to include { #choosing-relay-descs }
+### Deciding which descriptors to include { #choosing-relay-descs }
Deciding which descriptors to include.
@@ -279,7 +279,7 @@ published, and then in favor of the smaller server descriptor digest.
<a id="dir-spec.txt-3.8.1"></a>
-### Forward compatibility { #consensus-method-list }
+## Forward compatibility { #consensus-method-list }
Future versions of Tor will need to include new information in the
consensus documents, but it is important that all authorities (or at least
@@ -354,7 +354,7 @@ NOT advertise support for them:
<a id="dir-spec.txt-3.8.2"></a>
-### Encoding port lists
+## Encoding port lists
Whether the summary shows the list of accepted ports or the list of
rejected ports depends on which list is shorter (has a shorter string
@@ -376,7 +376,7 @@ possible within these 1000 bytes. \[XXXX be more specific.\]
<a id="dir-spec.txt-3.8.3"></a>
-### Computing Bandwidth Weights
+## Computing Bandwidth Weights
Let weight_scale = 10000, or the value of the "bwweightscale" parameter.
(Before consensus method 31 there was a bug in parsing bwweightscale, so
@@ -559,7 +559,7 @@ Wgm=Wgg, Wem=Wee, Weg=Wed
<a id="dir-spec.txt-3.9"></a>
-### Computing consensus flavors
+## Computing consensus flavors
Consensus flavors are variants of the consensus that clients can choose
to download and use instead of the unflavored consensus. The purpose
@@ -601,7 +601,7 @@ is a string consisting of alphanumeric characters and dashes:
<a id="dir-spec.txt-3.9.1"></a>
-#### ns consensus
+### ns consensus
The ns consensus flavor is equivalent to the unflavored consensus.
When the flavor is omitted from the "network-status-version" line,
@@ -611,7 +611,7 @@ accept consensuses where the flavor is omitted.
<a id="dir-spec.txt-3.9.2"></a>
-#### Microdescriptor consensus
+### Microdescriptor consensus
The microdescriptor consensus is a consensus flavor that contains
microdescriptor hashes instead of descriptor hashes and that omits
diff --git a/spec/dir-spec/computing-microdescriptors.md b/spec/dir-spec/computing-microdescriptors.md
index 5270ffa..bca4eb1 100644
--- a/spec/dir-spec/computing-microdescriptors.md
+++ b/spec/dir-spec/computing-microdescriptors.md
@@ -1,6 +1,6 @@
<a id="dir-spec.txt-3.3"></a>
-## Computing microdescriptors
+# Computing microdescriptors
Microdescriptors are a stripped-down version of server descriptors
generated by the directory authorities which may additionally contain
diff --git a/spec/dir-spec/consensus-formats.md b/spec/dir-spec/consensus-formats.md
index 6fe5637..7a6cd46 100644
--- a/spec/dir-spec/consensus-formats.md
+++ b/spec/dir-spec/consensus-formats.md
@@ -1,6 +1,6 @@
<a id="dir-spec.txt-3.4.1"></a>
-### Vote and consensus status document formats
+# Vote and consensus status document formats
Votes and consensuses are more strictly formatted than other documents
in this specification, since different authorities must be able to
diff --git a/spec/dir-spec/creating-key-certificates.md b/spec/dir-spec/creating-key-certificates.md
index ebe3e2f..fc3326f 100644
--- a/spec/dir-spec/creating-key-certificates.md
+++ b/spec/dir-spec/creating-key-certificates.md
@@ -1,6 +1,6 @@
<a id="dir-spec.txt-3.1"></a>
-## Creating key certificates
+# Creating key certificates
Key certificates consist of the following items:
diff --git a/spec/dir-spec/exchanging-detached-signatures.md b/spec/dir-spec/exchanging-detached-signatures.md
index c076e1c..7a8495e 100644
--- a/spec/dir-spec/exchanging-detached-signatures.md
+++ b/spec/dir-spec/exchanging-detached-signatures.md
@@ -1,4 +1,4 @@
-## Exchanging detached signatures
+# Exchanging detached signatures
Once an authority has computed and signed a consensus network status, it
should send its detached signature to each other authority in an HTTP POST
diff --git a/spec/dir-spec/exchanging-votes.md b/spec/dir-spec/exchanging-votes.md
index 066f825..924aa67 100644
--- a/spec/dir-spec/exchanging-votes.md
+++ b/spec/dir-spec/exchanging-votes.md
@@ -1,6 +1,6 @@
<a id="dir-spec.txt-3.4"></a>
-## Exchanging votes
+# Exchanging votes
Authorities divide time into Intervals. Authority administrators SHOULD
try to all pick the same interval length, and SHOULD pick intervals that
diff --git a/spec/dir-spec/extra-info-document-format.md b/spec/dir-spec/extra-info-document-format.md
index 24d6a03..e743ff3 100644
--- a/spec/dir-spec/extra-info-document-format.md
+++ b/spec/dir-spec/extra-info-document-format.md
@@ -1,6 +1,6 @@
<a id="dir-spec.txt-2.1.2"></a>
-### Extra-info document format
+# Extra-info document format
Extra-info documents consist of the following items:
diff --git a/spec/dir-spec/nonterminals-server-descriptors.md b/spec/dir-spec/nonterminals-server-descriptors.md
index 4991e9e..e2240ae 100644
--- a/spec/dir-spec/nonterminals-server-descriptors.md
+++ b/spec/dir-spec/nonterminals-server-descriptors.md
@@ -1,6 +1,6 @@
<a id="dir-spec.txt-2.1.3"></a>
-### Nonterminals in server descriptors
+# Nonterminals in server descriptors
```text
nickname ::= between 1 and 19 alphanumeric characters ([A-Za-z0-9]),
diff --git a/spec/dir-spec/server-descriptor-format.md b/spec/dir-spec/server-descriptor-format.md
index 49820fc..9a0c175 100644
--- a/spec/dir-spec/server-descriptor-format.md
+++ b/spec/dir-spec/server-descriptor-format.md
@@ -1,6 +1,6 @@
<a id="dir-spec.txt-2.1.1"></a>
-### Server descriptor format
+# Server descriptor format
Server descriptors consist of the following items.
diff --git a/spec/dir-spec/serving-bandwidth-list-files.md b/spec/dir-spec/serving-bandwidth-list-files.md
index 2680eb8..6860a6b 100644
--- a/spec/dir-spec/serving-bandwidth-list-files.md
+++ b/spec/dir-spec/serving-bandwidth-list-files.md
@@ -1,6 +1,6 @@
<a id="dir-spec.txt-3.4.3"></a>
-### Serving bandwidth list files { #serving-bwlist }
+# Serving bandwidth list files { #serving-bwlist }
If an authority has used a bandwidth list file to generate a vote
document it SHOULD make it available at
diff --git a/spec/dir-spec/uploading-relay-documents.md b/spec/dir-spec/uploading-relay-documents.md
index d354068..da34943 100644
--- a/spec/dir-spec/uploading-relay-documents.md
+++ b/spec/dir-spec/uploading-relay-documents.md
@@ -1,6 +1,6 @@
<a id="dir-spec.txt-2.1"></a>
-## Uploading server descriptors and extra-info documents
+# Uploading server descriptors and extra-info documents
ORs SHOULD generate a new server descriptor and a new extra-info
document whenever any of the following events have occurred: