[tor-commits] [tor/master] Updating manpage to describe some of the data directory files.

[nickm at torproject.org]

commit 75d2ea8a99bde84c174f132236273e228e6094f6
Author: rl1987 <rl1987 at sdf.lonestar.org>
Date:   Sun Nov 3 22:27:06 2013 +0200

    Updating manpage to describe some of the data directory files.
---
 doc/tor.1.txt |   51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 ticket9839    |    3 +++
 2 files changed, 54 insertions(+)

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index b457ee5..6dceba7 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -2238,6 +2238,10 @@ __DataDirectory__**/cached-status/**::
     Each file holds one such document; the filenames are the hexadecimal
     identity key fingerprints of the directory authorities.  Mostly obsolete.
 
+__DataDirectory__**/cached-certs**::
+    This file holds downloaded directory key certificates that are used to 
+    verify authenticity of documents Tor retrieves from directory servers.
+
 __DataDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
     The most recent consensus network status document we've downloaded.
 
@@ -2281,6 +2285,11 @@ __DataDirectory__**/control_auth_cookie**::
     control-spec.txt for details. Only used when cookie authentication is
     enabled.
 
+__DataDirectory__**/lock**::
+    This file is used to prevent two Tor instances from using same data 
+    directory. If access to this file is locked, data directory is already
+    in use by Tor.
+
 __DataDirectory__**/keys/***::
     Only used by servers. Holds identity keys and onion keys.
 
@@ -2297,11 +2306,53 @@ __DataDirectory__**/approved-routers**::
     **!invalid** then descriptors are accepted but marked in the directory as
     not valid, that is, not recommended.
 
+__DataDirectory__**/v3-status-votes**::
+    Only for authoritative directory servers. This file contains status votes 
+    from all authoritative directory servers and is used to generate network 
+    consensus document.
+
+__DataDirectory__**/unverified-consensus**::
+    Only for authoritative directory servers. This file contains not-yet-signed
+    network consensus document.
+
+__DataDirectory__**/unverified-microdesc-consensus**::
+    Only for authoritative directory servers. This file contains not-yet-signed
+    microdescriptor based network consensus document.
+
+__DataDirectory__**/unparseable-desc**::
+    Onion router descriptors that Tor was unable to parse are dumped to this 
+    file. Only used for debugging.
+
 __DataDirectory__**/router-stability**::
     Only used by authoritative directory servers. Tracks measurements for
     router mean-time-between-failures so that authorities have a good idea of
     how to set their Stable flags.
 
+__DataDirectory__**/status/dirreq-stats**::
+    Only used by servers. This file is used to collect directory request  
+    statistics.
+
+__DataDirectory__**/status/entry-stats**::
+    Only used by servers. This file is used to collect incoming connection
+    statistics by Tor entry nodes.
+
+__DataDirectory__**/status/bridge-stats**::
+    Only used by servers. This file is used to collect incoming connection
+    statistics by Tor bridges.
+
+__DataDirectory__**/status/exit-stats**::
+    Only used by servers. This file is used to collect outgoing connection
+    statistics by Tor exit routers.
+
+__DataDirectory__**/status/buffer-stats**::
+    Only used by servers. This file is used to collect buffer usage 
+    history for the purpose of assesing reputation of onion routers.
+
+__DataDirectory__**/status/conn-stats**::
+    Only used by servers. This file is used to collect approximate connection
+    history (number of active connections over time) for onion router 
+    reputation assessment.
+
 __HiddenServiceDirectory__**/hostname**::
     The <base32-encoded-fingerprint>.onion domain name for this hidden service.
     If the hidden service is restricted to authorized clients only, this file
diff --git a/ticket9839 b/ticket9839
new file mode 100644
index 0000000..a71c231
--- /dev/null
+++ b/ticket9839
@@ -0,0 +1,3 @@
+  o Documentation:
+    - Update manpage to describe some of the files one could find
+      in data directory. Fixes bug 9839.