[tor-commits] [tor/release-0.2.3] Document consensus and microdesc files

[arma at torproject.org]

commit 774979ca4584036d17dd96071ec565955d9f04a7
Author: Nick Mathewson <nickm at torproject.org>
Date:   Fri Aug 31 11:35:47 2012 -0400

    Document consensus and microdesc files
    
    Bugfix for #6732.
---
 changes/bug6732 |    3 +++
 doc/tor.1.txt   |   11 ++++++++++-
 2 files changed, 13 insertions(+), 1 deletions(-)

diff --git a/changes/bug6732 b/changes/bug6732
new file mode 100644
index 0000000..7a744e0
--- /dev/null
+++ b/changes/bug6732
@@ -0,0 +1,3 @@
+  o Documentation:
+    - Add missing documentation for consensus and microdesc files. Fix for
+      bug 6732.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index e7ba848..971a0ef 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -1876,7 +1876,10 @@ FILES
 __DataDirectory__**/cached-status/**::
     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.
+    identity key fingerprints of the directory authorities.  Mostly obsolete.
+
+__DataDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
+    The most recent consensus network status document we've downloaded.
 
 __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
     These files hold downloaded router statuses. Some routers may appear more
@@ -1885,6 +1888,12 @@ __DataDirectory__**/cached-descriptors** and **cached-descriptors.new**::
     a given router. The ".new" file is an append-only journal; when it gets
     too large, all entries are merged into a new cached-descriptors file.
 
+__DataDirectory__**/cached-microdescs** and **cached-microdescs.new**::
+    These files hold downloaded microdescriptors.  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-microdescs file.
+
 __DataDirectory__**/cached-routers** and **cached-routers.new**::
     Obsolete versions of cached-descriptors and cached-descriptors.new. When
     Tor can't find the newer files, it looks here instead.