aboutsummaryrefslogtreecommitdiff
path: root/spec/dir-spec/outline.md
diff options
context:
space:
mode:
Diffstat (limited to 'spec/dir-spec/outline.md')
-rw-r--r--spec/dir-spec/outline.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/spec/dir-spec/outline.md b/spec/dir-spec/outline.md
index 0a5c81d..55deb49 100644
--- a/spec/dir-spec/outline.md
+++ b/spec/dir-spec/outline.md
@@ -1,4 +1,5 @@
<a id="dir-spec.txt-1"></a>
+
# Outline
There is a small set (say, around 5-10) of semi-trusted directory
@@ -44,6 +45,7 @@ clients by giving them descriptors nobody else uses.
All directory information is uploaded and downloaded with HTTP.
<a id="dir-spec.txt-1.1"></a>
+
## What's different from version 2?
Clients used to download multiple network status documents,
@@ -58,6 +60,7 @@ All of the information in extra-info documents used to be kept in the
main descriptors.
<a id="dir-spec.txt-1.2"></a>
+
## Document meta-format
Server descriptors, directories, and running-routers documents all obey the
@@ -81,7 +84,7 @@ More formally:
NL = The ascii LF character (hex value 0x0a).
Document ::= (Item | NL)+
Item ::= KeywordLine Object?
-KeywordLine ::= Keyword (WS Argument)* NL
+KeywordLine ::= Keyword (WS Argument)*NL
Keyword = KeywordStart KeywordChar*
KeywordStart ::= 'A' ... 'Z' | 'a' ... 'z' | '0' ... '9'
KeywordChar ::= KeywordStart | '-'
@@ -89,7 +92,7 @@ Argument := ArgumentChar+
ArgumentChar ::= any graphical printing ASCII character.
WS = (SP | TAB)+
Object ::= BeginLine Base64-encoded-data EndLine
-BeginLine ::= "-----BEGIN " Keyword (" " Keyword)* "-----" NL
+BeginLine ::= "-----BEGIN " Keyword (" " Keyword)*"-----" NL
EndLine ::= "-----END " Keyword (" " Keyword)* "-----" NL
A Keyword may not be "-----BEGIN".
@@ -156,6 +159,7 @@ Whenever an item DOES NOT allow extra arguments, we will tag it with
"no extra arguments".
<a id="dir-spec.txt-1.3"></a>
+
## Signing documents
Every signable document below is signed in a similar manner, using a
@@ -183,6 +187,7 @@ The "Digest" of a document, unless stated otherwise, is its digest *as
signed by this signature scheme*.
<a id="dir-spec.txt-1.4"></a>
+
## Voting timeline
Every consensus document has a "valid-after" (VA) time, a "fresh-until"
@@ -246,4 +251,3 @@ VU + 24 hours: Clients will no longer use the consensus at all.
VoteSeconds and DistSeconds MUST each be at least 20 seconds; FU-VA and
VU-FU MUST each be at least 5 minutes.
-