r11537@catbus: nickm | 2007-01-26 14:04:29 -0500

 More templating: give each proposal an overview and a summary of its status.


svn:r9428

9 files changed, 79 insertions, 3 deletions

diff --git a/doc/spec/proposals/000-index.txt b/doc/spec/proposals/000-index.txt
index c5deb7135..50d2b8dd0 100644
--- a/doc/spec/proposals/000-index.txt
+++ b/doc/spec/proposals/000-index.txt
@@ -5,6 +5,13 @@ Last-Modified: $Date$
 Author: Nick Mathewson
 Created: 26-Jan-2007
 
+Overview:
+
+   This document provides an index to closed and open Tor proposals.
+
+   This is an informational document.
+
+Proposals by number:
 
 000  Index of Tor Proposals
 098  Proposals that should be written
diff --git a/doc/spec/proposals/098-todo.txt b/doc/spec/proposals/098-todo.txt
index aadc008a9..46e129317 100644
--- a/doc/spec/proposals/098-todo.txt
+++ b/doc/spec/proposals/098-todo.txt
@@ -5,6 +5,16 @@ Last-Modified: $Date$
 Author: Nick Mathewson, Roger Dingledine
 Created:
 
+Overview:
+
+   This document lists ideas that various people have had for improving the
+   Tor protocol.  These should be implemented and specified if they're
+   trivial, or written up as proposals if they're not.
+
+   This is an active document, to be edited as proposals are written and as
+   we come up with new ideas for proposals.  We should take stuff out as it
+   seems irrelevant.
+
 
 For protocol version 2:
 
diff --git a/doc/spec/proposals/099-misc.txt b/doc/spec/proposals/099-misc.txt
index 62c44550e..2e41fd720 100644
--- a/doc/spec/proposals/099-misc.txt
+++ b/doc/spec/proposals/099-misc.txt
@@ -5,8 +5,13 @@ Last-Modified: $Date$
 Author: Various
 Created:
 
-                           Miscellaneous proposals
+Overview:
 
+   This document is for small proposal ideas that are about one paragraph in
+   length.  From here, ideas can be rejected outright, expanded into full
+   proposals, or specified and implemented as-is.
+
+Proposals
 
 1. Directory compression.
 
@@ -17,6 +22,8 @@ Created:
   Pre-compressing status documents in multiple formats would force us to use
   more memory to hold them.
 
+  Status: Open
+
   -- Nick Mathewson
 
 
diff --git a/doc/spec/proposals/100-tor-spec-udp.txt b/doc/spec/proposals/100-tor-spec-udp.txt
index b5b78608c..09f17cad7 100644
--- a/doc/spec/proposals/100-tor-spec-udp.txt
+++ b/doc/spec/proposals/100-tor-spec-udp.txt
@@ -5,7 +5,15 @@ Last-Modified: $Date$
 Author: Marc Liberatore
 Created:
 
+Overview:
 
+   This is a modified version of the Tor specification written by Marc
+   Liberatore to add UDP support to Tor.  For each TLS link, it adds a
+   corresponding DTLS link: control messages and TCP data flow over TLS, and
+   UDP data flows over DTLS.
+
+   This proposal is not likely to be accepted as-is; see comments at the end
+   of the document.
 
 
 Contents
diff --git a/doc/spec/proposals/101-dir-voting.txt b/doc/spec/proposals/101-dir-voting.txt
index 604b093d5..499cbed31 100644
--- a/doc/spec/proposals/101-dir-voting.txt
+++ b/doc/spec/proposals/101-dir-voting.txt
@@ -5,6 +5,16 @@ Last-Modified: $Date$
 Author: Nick Mathewson
 Created:
 
+Overview
+
+  This document describes a consensus voting scheme for Tor directories;
+  instead of publishing different network statuses, directories would vote on
+  and publish a single "consensus" network status document.
+
+  This is an open proposal.
+
+Proposal:
+
 0. Scope and preliminaries
 
   This document describes a consensus voting scheme for Tor directories.
diff --git a/doc/spec/proposals/102-drop-opt.txt b/doc/spec/proposals/102-drop-opt.txt
index 804dd23d2..a7d30132b 100644
--- a/doc/spec/proposals/102-drop-opt.txt
+++ b/doc/spec/proposals/102-drop-opt.txt
@@ -5,6 +5,14 @@ Last-Modified: $Date$
 Author: Nick Mathewson
 Created:
 
+Overview:
+
+  This document proposes a change in the format used to transmit router and
+  directory information.
+
+  This proposal has been accepted, implemented, and merged into dir-spec.txt.
+
+Proposal:
 
   The "opt" keyword in Tor's directory formats was originally intended to
   mean, "it is okay to ignore this entry if you don't understand it"; the
@@ -22,7 +30,6 @@ Created:
   lot; discard this quietly if you don't understand it." We could do that by
   adding a version field.
 
-
 Status:
 
      * We stopped requiring it as of 0.1.2.5-alpha.  We'll stop generating it
diff --git a/doc/spec/proposals/103-multilevel-keys.txt b/doc/spec/proposals/103-multilevel-keys.txt
index bdec44015..1dc2b02fe 100644
--- a/doc/spec/proposals/103-multilevel-keys.txt
+++ b/doc/spec/proposals/103-multilevel-keys.txt
@@ -5,6 +5,14 @@ Last-Modified: $Date$
 Author: Nick Mathewson
 Created:
 
+Overview:
+
+  This document proposes a change in the way identity keys are used, so that
+  highly sensitive keys can be password-protected and seldom loaded into RAM.
+
+  It presents options; it is not yet a complete proposal.
+
+Proposal:
 
   Replacing a directory authority's identity key in the event of a compromise
   would be tremendously annoying.  We'd need to tell every client to switch
diff --git a/doc/spec/proposals/104-short-descriptors.txt b/doc/spec/proposals/104-short-descriptors.txt
index 80b30e587..042833a80 100644
--- a/doc/spec/proposals/104-short-descriptors.txt
+++ b/doc/spec/proposals/104-short-descriptors.txt
@@ -5,6 +5,15 @@ Last-Modified: $Date$
 Author: Nick Mathewson
 Created:
 
+Overview:
+
+  This document proposes moving unused-by-clients information from regular
+  router descriptors into a special "long form" router descriptor.
+
+  It presents options; it is not yet a complete proposal.
+
+Proposal:
+
   Some of the costliest fields in the current directory protocol are ones
   that no client actually uses.  In particular, the "read-history" and
   "write-history" fields are used only by the authorities for monitoring the
diff --git a/doc/spec/proposals/105-handshake-revision.txt b/doc/spec/proposals/105-handshake-revision.txt
index 7872c6f58..7cb79ec63 100644
--- a/doc/spec/proposals/105-handshake-revision.txt
+++ b/doc/spec/proposals/105-handshake-revision.txt
@@ -2,9 +2,19 @@ Filename: 105-handshake-revision.txt
 Title: Version negotiation for the Tor protocol.
 Version: $Revision$
 Last-Modified: $Date$
-Author: Various
+Author: Nick Mathewson, Roger Dingledine
 Created:
 
+Overview:
+
+  This document was extracted from a modified version of tor-spec.txt that we
+  had written before the proposal system went into place.  It adds two new
+  cells types to the Tor link connection setup handshake: one used for
+  version negotiation, and another to prevent MITM attacks.
+
+  This is an open proposal.
+
+Proposal:
 
 1.0. Version numbers