aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-10-13 18:15:32 -0400
committerNick Mathewson <nickm@torproject.org>2023-10-13 18:15:32 -0400
commitd4b9bcc71565e1c3b7b74ddfcd44730697c10c6b (patch)
tree57ce1c73a1e4f859908731085f346e011fd1b453
parent7a370ea5302b7c36eb8586fbda603419fb74ec2e (diff)
downloadtorspec-d4b9bcc71565e1c3b7b74ddfcd44730697c10c6b.tar.gz
torspec-d4b9bcc71565e1c3b7b74ddfcd44730697c10c6b.zip
Several more warnings from markdownlint.
-rw-r--r--spec/bandwidth-file-spec/sample-data.md12
-rw-r--r--spec/control-spec/implementation-notes.md2
-rw-r--r--spec/dir-spec/directory-cache-operation.md2
-rw-r--r--spec/dir-spec/extra-info-document-format.md2
-rw-r--r--spec/dir-spec/scope-preliminaries.md14
-rw-r--r--spec/dir-spec/serving-bandwidth-list-files.md4
-rw-r--r--spec/guard-spec/algorithm.md22
-rw-r--r--spec/path-spec/guard-nodes.md2
-rw-r--r--spec/pt-spec/pluggable-transport-naming.md2
9 files changed, 36 insertions, 26 deletions
diff --git a/spec/bandwidth-file-spec/sample-data.md b/spec/bandwidth-file-spec/sample-data.md
index e05ca47..f9b05de 100644
--- a/spec/bandwidth-file-spec/sample-data.md
+++ b/spec/bandwidth-file-spec/sample-data.md
@@ -10,14 +10,17 @@ The following has not been obtained from any real measurement.
This an example version 1.0.0 document:
+```text
1523911758
node_id=$68A483E05A2ABDCA6DA5A3EF8DB5177638A27F80 bw=760 nick=Test measured_at=1523911725 updated_at=1523911725 pid_error=4.11374090719 pid_error_sum=4.11374090719 pid_bw=57136645 pid_delta=2.12168374577 circ_fail=0.2 scanner=/filepath
node_id=$96C15995F30895689291F455587BD94CA427B6FC bw=189 nick=Test2 measured_at=1523911623 updated_at=1523911623 pid_error=3.96703337994 pid_error_sum=3.96703337994 pid_bw=47422125 pid_delta=2.65469736988 circ_fail=0.0 scanner=/filepath
+```
<a id="bandwidth-file-spec.txt-A.2"></a>
## Generated by sbws version 0.1.0
+```text
1523911758
version=1.1.0
software=sbws
@@ -30,11 +33,13 @@ earliest_bandwidth=2018-04-16T15:13:26
bw=380 error_circ=0 error_misc=0 error_stream=1 master_key_ed25519=YaqV4vbvPYKucElk297eVdNArDz9HtIwUoIeo0+cVIpQ nick=Test node_id=$68A483E05A2ABDCA6DA5A3EF8DB5177638A27F80 rtt=380 success=1 time=2018-05-08T16:13:26
bw=189 error_circ=0 error_misc=0 error_stream=0 master_key_ed25519=a6a+dZadrQBtfSbmQkP7j2ardCmLnm5NJ4ZzkvDxbo0I nick=Test2 node_id=$96C15995F30895689291F455587BD94CA427B6FC rtt=378 success=1 time=2018-05-08T16:13:36
+```
<a id="bandwidth-file-spec.txt-A.3"></a>
## Generated by sbws version 1.0.3
+```text
1523911758
version=1.2.0
latest_bandwidth=2018-04-16T20:49:18
@@ -52,11 +57,13 @@ software_version=1.0.3
bw=38000 bw_mean=1127824 bw_median=1180062 desc_bw_avg=1073741824 desc_bw_obs_last=17230879 desc_bw_obs_mean=14732306 error_circ=0 error_misc=0 error_stream=1 master_key_ed25519=YaqV4vbvPYKucElk297eVdNArDz9HtIwUoIeo0+cVIpQ nick=Test node_id=$68A483E05A2ABDCA6DA5A3EF8DB5177638A27F80 rtt=380 success=1 time=2018-05-08T16:13:26
bw=1 bw_mean=199162 bw_median=185675 desc_bw_avg=409600 desc_bw_obs_last=836165 desc_bw_obs_mean=858030 error_circ=0 error_misc=0 error_stream=0 master_key_ed25519=a6a+dZadrQBtfSbmQkP7j2ardCmLnm5NJ4ZzkvDxbo0I nick=Test2 node_id=$96C15995F30895689291F455587BD94CA427B6FC rtt=378 success=1 time=2018-05-08T16:13:36
+``
<a id="bandwidth-file-spec.txt-A.3.1"></a>
### When there are not enough eligible measured relays
+```text
1540496079
version=1.2.0
earliest_bandwidth=2018-10-20T19:35:52
@@ -71,11 +78,13 @@ percent_eligible_relays=46
software=sbws
software_version=1.0.3
=====
+```
<a id="bandwidth-file-spec.txt-A.4"></a>
## Headers generated by sbws version 1.0.4
+```text
1523911758
version=1.2.0
latest_bandwidth=2018-04-16T20:49:18
@@ -92,11 +101,13 @@ scanner_country=SN
software=sbws
software_version=1.0.4
=====
+```
<a id="bandwidth-file-spec.txt-A.5"></a>
## Generated by sbws version 1.1.0
+```text
1523911758
version=1.4.0
latest_bandwidth=2018-04-16T20:49:18
@@ -125,3 +136,4 @@ time_to_report_half_network=57273
bw=1 error_circ=1 error_destination=0 error_misc=0 error_second_relay=0 error_stream=0 master_key_ed25519=J3HQ24kOQWac3L1xlFLp7gY91qkb5NuKxjj1BhDi+m8 nick=snap269 node_id=$DC4D609F95A52614D1E69C752168AF1FCAE0B05F relay_recent_measurement_attempt_count=3 relay_recent_measurements_excluded_error_count=1 relay_recent_measurements_excluded_near_count=3 relay_recent_consensus_count=3 relay_recent_priority_list_count=3 success=3 time=2019-03-16T18:20:57 unmeasured=1 vote=0
bw=1 error_circ=0 error_destination=0 error_misc=0 error_second_relay=0 error_stream=2 master_key_ed25519=h6ZB1E1yBFWIMloUm9IWwjgaPXEpL5cUbuoQDgdSDKg nick=relay node_id=$C4544F9E209A9A9B99591D548B3E2822236C0503 relay_recent_measurement_attempt_count=3 relay_recent_measurements_excluded_error_count=2 relay_recent_measurements_excluded_few_count=1 relay_recent_consensus_count=3 relay_recent_priority_list_count=3 success=1 time=2019-03-17T06:50:58 unmeasured=1 vote=0
+```
diff --git a/spec/control-spec/implementation-notes.md b/spec/control-spec/implementation-notes.md
index b93f5d6..e69f755 100644
--- a/spec/control-spec/implementation-notes.md
+++ b/spec/control-spec/implementation-notes.md
@@ -53,7 +53,7 @@ This is then encoded in hexadecimal, prefixed by the indicator sequence
You can generate the salt of a password by calling
-```
+```text
'tor --hash-password <password>'
```
diff --git a/spec/dir-spec/directory-cache-operation.md b/spec/dir-spec/directory-cache-operation.md
index 1aa3f4b..8b3bfce 100644
--- a/spec/dir-spec/directory-cache-operation.md
+++ b/spec/dir-spec/directory-cache-operation.md
@@ -151,7 +151,7 @@ send that diff instead of the specified consensus.
Caches also serve diffs from the URIs:
-```
+```text
/tor/status-vote/current/consensus/diff/<HASH>/<FPRLIST>.z
/tor/status-vote/current/consensus-<FLAVOR>/diff/<HASH>/<FPRLIST>.z
```
diff --git a/spec/dir-spec/extra-info-document-format.md b/spec/dir-spec/extra-info-document-format.md
index 7307885..1c7dffe 100644
--- a/spec/dir-spec/extra-info-document-format.md
+++ b/spec/dir-spec/extra-info-document-format.md
@@ -136,7 +136,7 @@ transport, we use the reserved pluggable transport name
("`<OR>`" and "`<??>`" are reserved because normal pluggable
transport names MUST match the following regular expression:
-"[a-zA-Z_][a-zA-Z0-9_]*" )
+"`[a-zA-Z_][a-zA-Z0-9_]*`" )
The pluggable transport name list is sorted into lexically
ascending order.
diff --git a/spec/dir-spec/scope-preliminaries.md b/spec/dir-spec/scope-preliminaries.md
index 61d2ff7..1025c04 100644
--- a/spec/dir-spec/scope-preliminaries.md
+++ b/spec/dir-spec/scope-preliminaries.md
@@ -9,9 +9,9 @@ used by the 0.1.1.x and 0.1.2.x series.
This document merges and supersedes the following proposals:
-101 Voting on the Tor Directory System
-103 Splitting identity key from regularly used signing key
-104 Long and Short Router Descriptors
+- 101 Voting on the Tor Directory System
+- 103 Splitting identity key from regularly used signing key
+- 104 Long and Short Router Descriptors
XXX timeline
XXX fill in XXXXs
@@ -29,8 +29,7 @@ The earliest versions of Onion Routing shipped with a list of known
routers and their keys. When the set of routers changed, users needed to
fetch a new list.
-The Version 1 Directory protocol
---------------------------------
+### The Version 1 Directory protocol
Early versions of Tor (0.0.2) introduced "Directory authorities": servers
that served signed "directory" documents containing a list of signed
@@ -50,8 +49,7 @@ routers on the network, rather than a complete list of all the
descriptors. Clients and caches would fetch these documents far more
frequently than they would fetch full directories.
-The Version 2 Directory Protocol
---------------------------------
+### The Version 2 Directory Protocol
During the Tor 0.1.1.x series, Tor revised its handling of directory
documents in order to address two major problems:
@@ -89,7 +87,7 @@ contents were substantially changed.
<a id="dir-spec.txt-0.2"></a>
-## Goals of the version 3 protocol
+### Goals of the version 3 protocol
Version 3 of the Tor directory protocol tries to solve the following
issues:
diff --git a/spec/dir-spec/serving-bandwidth-list-files.md b/spec/dir-spec/serving-bandwidth-list-files.md
index 253f2d6..2dd5ff4 100644
--- a/spec/dir-spec/serving-bandwidth-list-files.md
+++ b/spec/dir-spec/serving-bandwidth-list-files.md
@@ -316,7 +316,7 @@ earlier item.
<a id="dir-spec.txt-3.8.0.1"></a>
-#### Deciding which Ids to include
+### Deciding which Ids to include
This sorting algorithm is used for consensus-method 22 and later.
@@ -876,7 +876,7 @@ once the voting period ends, regardless of the number of signatures.
The authorities serve another consensus of each flavor "F" from the
locations
-```
+```text
/tor/status-vote/(current|next)/consensus-F.z. and
/tor/status-vote/(current|next)/consensus-F/<FP1>+....z.
```
diff --git a/spec/guard-spec/algorithm.md b/spec/guard-spec/algorithm.md
index e1d4374..5e30782 100644
--- a/spec/guard-spec/algorithm.md
+++ b/spec/guard-spec/algorithm.md
@@ -541,21 +541,21 @@ these rules:
1. Primary guards are always usable.
2. Non-primary guards are usable _for a given circuit_ if every
-guard earlier in the preference list is either unsuitable for
-that circuit (e.g. because of family restrictions), or marked as
-Unreachable, or has been pending for at least
-`{NONPRIMARY_GUARD_CONNECT_TIMEOUT}`.
+ guard earlier in the preference list is either unsuitable for
+ that circuit (e.g. because of family restrictions), or marked as
+ Unreachable, or has been pending for at least
+ `{NONPRIMARY_GUARD_CONNECT_TIMEOUT}`.
-Non-primary guards are not usable _for a given circuit_ if some
-guard earlier in the preference list is suitable for the circuit
-_and_ Reachable.
+ Non-primary guards are not usable _for a given circuit_ if some
+ guard earlier in the preference list is suitable for the circuit
+ _and_ Reachable.
-Non-primary guards are unusable if they have not become
-usable after `{NONPRIMARY_GUARD_IDLE_TIMEOUT}` seconds.
+ Non-primary guards are unusable if they have not become
+ usable after `{NONPRIMARY_GUARD_IDLE_TIMEOUT}` seconds.
3. If a circuit's guard is not usable or unusable immediately, the
-circuit is not discarded; instead, it is kept (but not used) until the
-guard becomes usable or unusable.
+ circuit is not discarded; instead, it is kept (but not used) until the
+ guard becomes usable or unusable.
<a id="guard-spec.txt-4.10"></a>
diff --git a/spec/path-spec/guard-nodes.md b/spec/path-spec/guard-nodes.md
index 77f7fdf..553d5e3 100644
--- a/spec/path-spec/guard-nodes.md
+++ b/spec/path-spec/guard-nodes.md
@@ -31,7 +31,7 @@ If a router has been marked as both an entry guard and an exit, then we
prefer to use it more, with our preference for doing so (roughly) linearly
increasing w.r.t. the router's non-guard bandwidth and bandwidth weight
(calculated without taking the guard flag into account). From proposal
-# 236:
+236:
|
| Let Wpf denote the weight from the 'bandwidth-weights' line a
diff --git a/spec/pt-spec/pluggable-transport-naming.md b/spec/pt-spec/pluggable-transport-naming.md
index 339f89c..394b420 100644
--- a/spec/pt-spec/pluggable-transport-naming.md
+++ b/spec/pt-spec/pluggable-transport-naming.md
@@ -10,4 +10,4 @@ a letter or underscore, and the remaining characters MUST be
ASCII letters, numbers or underscores. No length limit is
imposted.
-PT names MUST satisfy the regular expression "[a-zA-Z_][a-zA-Z0-9_]*".
+PT names MUST satisfy the regular expression "`[a-zA-Z_][a-zA-Z0-9_]*`".