Document consensus and microdesc files

Bugfix for #6732.
This commit is contained in:
Nick Mathewson 2012-08-31 11:35:47 -04:00
parent 88859b2ff1
commit 774979ca45
2 changed files with 13 additions and 1 deletions

3
changes/bug6732 Normal file
View File

@ -0,0 +1,3 @@
o Documentation:
- Add missing documentation for consensus and microdesc files. Fix for
bug 6732.

View File

@ -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.