[or-cvs] [tor/master] Make spec docs reference RFC2119

[nickm at torproject.org]

Author: Nick Mathewson <nickm at torproject.org>
Date: Fri, 25 Jun 2010 14:58:25 -0400
Subject: Make spec docs reference RFC2119
Commit: deb9e4aff7347860d5cb41426e4c02a4efc16253

Now people will have no excuse for not knowing what "MUST" and "MAY"
mean.  Fixes bug 1310.
---
 doc/spec/control-spec.txt |    5 +++++
 doc/spec/dir-spec.txt     |    8 +++++---
 doc/spec/path-spec.txt    |    5 +++++
 doc/spec/rend-spec.txt    |    5 +++++
 doc/spec/tor-spec.txt     |    5 +++++
 5 files changed, 25 insertions(+), 3 deletions(-)

diff --git a/doc/spec/control-spec.txt b/doc/spec/control-spec.txt
index b60baba..1eb699c 100644
--- 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 b88e838..57bcdab 100644
--- 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 8a85718..b137eca 100644
--- 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 f030092..e5bc18e 100644
--- 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 e94ac7f..f448f6d 100644
--- 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.
-- 
1.7.1