Make spec docs reference RFC2119

Now people will have no excuse for not knowing what "MUST" and "MAY"
mean.  Fixes bug 1310.

diff --git a/doc/spec/control-spec.txt b/doc/spec/control-spec.txt
index b60baba052aacd73a6558bb09f6f2dc73f1c52e1..1eb699c8b658846810b5a7b4e6e09835e35f168d 100644 (file)
--- a/doc/spec/control-spec.txt
+++ b/doc/spec/control-spec.txt
@@ -15,6 +15,11 @@
   versions 0.1.0.x; the protocol in this document only works with Tor
   versions in the 0.1.1.x series and later.)
 
+      The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
+      NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and
+      "OPTIONAL" in this document are to be interpreted as described in
+      RFC 2119.
+
 1. Protocol outline
 
   TC is a bidirectional message-based protocol.  It assumes an underlying

diff --git a/doc/spec/dir-spec.txt b/doc/spec/dir-spec.txt
index b88e838f3696cc4a8d582dc7541adf92330d43a2..57bcdab799dfb6807ee47db8f5616c0310c8e174 100644 (file)
--- a/doc/spec/dir-spec.txt
+++ b/doc/spec/dir-spec.txt
@@ -18,13 +18,15 @@
        103  Splitting identity key from regularly used signing key
        104  Long and Short Router Descriptors
 
-   AS OF 14 JUNE 2007, THIS SPECIFICATION HAS NOT YET BEEN COMPLETELY
-   IMPLEMENTED, OR COMPLETELY COMPLETED.
-
    XXX when to download certificates.
    XXX timeline
    XXX fill in XXXXs
 
+      The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
+      NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and
+      "OPTIONAL" in this document are to be interpreted as described in
+      RFC 2119.
+
 0.1. History
 
    The earliest versions of Onion Routing shipped with a list of known

diff --git a/doc/spec/path-spec.txt b/doc/spec/path-spec.txt
index 8a85718a089d7d8529a1f78d650d51fa37904dc5..b137eca89b5f562152ead01fd3c6d080b621b5c3 100644 (file)
--- a/doc/spec/path-spec.txt
+++ b/doc/spec/path-spec.txt
@@ -14,6 +14,11 @@ of their choices.
 
                     THIS SPEC ISN'T DONE YET.
 
+      The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
+      NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and
+      "OPTIONAL" in this document are to be interpreted as described in
+      RFC 2119.
+
 1. General operation
 
    Tor begins building circuits as soon as it has enough directory

diff --git a/doc/spec/rend-spec.txt b/doc/spec/rend-spec.txt
index f03009267963678de6dac4ccdb512895c747dac6..e5bc18e8364e3e49b3773972038a559890bdfee9 100644 (file)
--- a/doc/spec/rend-spec.txt
+++ b/doc/spec/rend-spec.txt
@@ -3,6 +3,11 @@
 
 0. Overview and preliminaries
 
+      The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
+      NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and
+      "OPTIONAL" in this document are to be interpreted as described in
+      RFC 2119.
+
    Read
    https://www.torproject.org/doc/design-paper/tor-design.html#sec:rendezvous
    before you read this specification. It will make more sense.

diff --git a/doc/spec/tor-spec.txt b/doc/spec/tor-spec.txt
index e94ac7faaa31e237fa6b0d94e179bd47886af951..f448f6da2c8e36b325dd9a0a055951b6ec686aba 100644 (file)
--- a/doc/spec/tor-spec.txt
+++ b/doc/spec/tor-spec.txt
@@ -16,6 +16,11 @@ see tor-design.pdf.
 
 0. Preliminaries
 
+      The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
+      NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and
+      "OPTIONAL" in this document are to be interpreted as described in
+      RFC 2119.
+
 0.1.  Notation and encoding
 
    PK -- a public key.