summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2012-08-31 11:35:47 -0400
committerNick Mathewson <nickm@torproject.org>2012-08-31 11:35:47 -0400
commit774979ca4584036d17dd96071ec565955d9f04a7 (patch)
tree846a14ccf32a3bc4de54c9552161badb3d0ef414
parent88859b2ff1fdd4e5f4fab8ad818131ea3c2dd1c8 (diff)
downloadtor-774979ca4584036d17dd96071ec565955d9f04a7.tar.gz
tor-774979ca4584036d17dd96071ec565955d9f04a7.zip
Document consensus and microdesc files
Bugfix for #6732.
-rw-r--r--changes/bug67323
-rw-r--r--doc/tor.1.txt11
2 files changed, 13 insertions, 1 deletions
diff --git a/changes/bug6732 b/changes/bug6732
new file mode 100644
index 0000000000..7a744e014a
--- /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 e7ba8485c0..971a0efe4b 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.