r15422@catbus: nickm | 2007-09-27 16:42:35 -0400

 Use descriptor annotations to record the source, download t time, and purpose of every descriptor we add to the store.  The remaining to-do item is to stop setting do_not_cache on bridges.


svn:r11680

2 files changed, 15 insertions, 7 deletions

diff --git a/doc/TODO b/doc/TODO
index 798d65f89a..d165f9f72f 100644
--- a/doc/TODO
+++ b/doc/TODO
@@ -132,7 +132,7 @@ R     - drop 'authority' queries if they're to our own identity key; accept
       o be more robust to bridges being marked as down and leaving us
         stranded without any known "running" bridges.
 N     . Cache for bridge descriptors
-        . Annotated router store
+        o Annotated router store
           o Accept annotations before routers
           o Preserve and ignore unexpected annotations
           o Mechanism to add annotations when we first add a descriptor
@@ -141,11 +141,15 @@ N     . Cache for bridge descriptors
           o Name the router store something different: cached-descriptors?
             o But load from cached-routers if no cached-descriptors is
               found.
-            - Document this.
-        - Use annotations to denote router purpose
-          - Learn purpose from annotations
-          - Set annotations based on purpose
-          - Preserve routers with unrecognized purpose.
+            o Document this.
+          o Add a few example annotations to make sure this works: source
+            and downloaded/uploaded-at seem like a good start
+            - Drop this later as needed.
+        o Use annotations to denote router purpose
+          o Learn purpose from annotations
+          o Set annotations based on purpose
+          o Preserve routers with unrecognized purpose.
+R       - Stop setting the do-not-cache flag based on purpose.
     - Bridges operators (rudimentary version)
       - Ability to act as dir cache without a dir port.
       o Bridges publish to bridge authorities
diff --git a/doc/tor.1.in b/doc/tor.1.in
index f00b7e5244..ead667ea3a 100644
--- a/doc/tor.1.in
+++ b/doc/tor.1.in
@@ -1169,8 +1169,12 @@ The tor process stores keys and other data here.
 The most recently downloaded network status document for each authority.  Each file holds one such document; the filenames are the hexadecimal identity key fingerprints of the directory authorities.
 .LP
 .TP
+.B \fIDataDirectory\fB/cached-descriptors\fR and \fBcached-descriptors.new\fR
+These files hold downloaded router statuses.  Some routers may appear more than once; if so, the most recently published descriptor is used.    Lines beginning with @-signs are annotations that contain more information about a given router.  The ".new" file is an append-only journal; when it gets too large, all entries are merged into a new cached-routers file.
+.LP
+.TP
 .B \fIDataDirectory\fB/cached-routers\fR and \fBcached-routers.new\fR
-These files hold downloaded router statuses.  Some routers may appear more than once; if so, the most recently published descriptor is used.  The ".new" file is an append-only journal; when it gets too large, all entries are merged into a new cached-routers file.
+Obsolete versions of cached-descriptors and cached-descriptors.new.  When Tor can't find the newer files, it looks here instead.
 .LP
 .TP
 .B \fIDataDirectory\fP/state