aboutsummaryrefslogtreecommitdiff
path: root/spec/guard-spec/algorithm.md
diff options
context:
space:
mode:
Diffstat (limited to 'spec/guard-spec/algorithm.md')
-rw-r--r--spec/guard-spec/algorithm.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/spec/guard-spec/algorithm.md b/spec/guard-spec/algorithm.md
index b18803b..832814a 100644
--- a/spec/guard-spec/algorithm.md
+++ b/spec/guard-spec/algorithm.md
@@ -4,7 +4,7 @@
<a id="guard-spec.txt-4.0"></a>
-## The guards listed in the current consensus. \[Section:GUARDS\]
+## The guards listed in the current consensus. {#GUARDS}
By {set:GUARDS} we mean the set of all guards in the current
consensus that are usable for all circuits and directory
@@ -17,7 +17,7 @@ from any guard, so that all guards are usable for all circuits.
<a id="guard-spec.txt-4.1"></a>
-## The Sampled Guard Set. \[Section:SAMPLED\]
+## The Sampled Guard Set. {#SAMPLED}
We maintain a set, {set:SAMPLED_GUARDS}, that persists across
invocations of Tor. It is a subset of the nodes ordered by a sample idx that
@@ -130,7 +130,7 @@ adversary node.
<a id="guard-spec.txt-4.2"></a>
-## The Usable Sample \[Section:FILTERED\]
+## The Usable Sample {#FILTERED}
We maintain another set, {set:FILTERED_GUARDS}, that does not
persist. It is derived from:
@@ -185,7 +185,7 @@ filtering restrictions that we had in the past.
<a id="guard-spec.txt-4.3"></a>
-## The confirmed-guard list. \[Section:CONFIRMED\]
+## The confirmed-guard list. {#CONFIRMED}
\[formerly USED_GUARDS\]
@@ -247,7 +247,7 @@ traffic.
<a id="guard-spec.txt-4.4"></a>
-## The Primary guards \[Section:PRIMARY\]
+## The Primary guards {#PRIMARY}
We keep a run-time non-persistent ordered list of
{list:PRIMARY_GUARDS}. It is a subset of {FILTERED_GUARDS}. It
@@ -280,7 +280,7 @@ usable after all.
<a id="guard-spec.txt-4.5"></a>
-## Retrying guards. \[Section:RETRYING\]
+## Retrying guards. {#RETRYING}
(We run this process as frequently as needed. It can be done once
a second, or just-in-time.)
@@ -410,7 +410,7 @@ sure that it's the best guard we're getting. (see below).
<a id="guard-spec.txt-4.7"></a>
-## When a circuit fails. \[Section:ON_FAIL\]
+## When a circuit fails. {#ON_FAIL}
When a circuit fails in a way that makes us conclude that a guard
is not reachable, we take the following steps:
@@ -437,7 +437,7 @@ See \[SELECTING\] above for rationale.
<a id="guard-spec.txt-4.8"></a>
-## When a circuit succeeds \[Section:ON_SUCCESS\]
+## When a circuit succeeds {#ON_SUCCESS}
When a circuit succeeds in a way that makes us conclude that a
guard _was_ reachable, we take these steps:
@@ -476,7 +476,7 @@ See \[SELECTING\] above for rationale.
<a id="guard-spec.txt-4.9"></a>
-## Updating the list of waiting circuits \[Section:UPDATE_WAITING\]
+## Updating the list of waiting circuits {#UPDATE_WAITING}
We run this procedure whenever it's possible that a
`<waiting_for_better_guard>` circuit might be ready to be called
@@ -516,7 +516,7 @@ them after all if the `<complete>` circuit goes down before
<a id="guard-spec.txt-4.9.1"></a>
-### Without a list of waiting circuits \[Section:NO_CIRCLIST\]
+### Without a list of waiting circuits {#NO_CIRCLIST}
As an alternative to the section \[SECTION:UPDATE_WAITING\] above,
this section presents a new way to maintain guard status
@@ -559,7 +559,7 @@ these rules:
<a id="guard-spec.txt-4.10"></a>
-## Whenever we get a new consensus. \[Section:ON_CONSENSUS\]
+## Whenever we get a new consensus. {#ON_CONSENSUS}
We update {GUARDS}.