[tor-commits] [tor/master] Tweak file documentation in tor.1.txt

[nickm at torproject.org]

commit e30fb0a160c083ceaf1bf215089ab5e1b0924f34
Author: Nick Mathewson <nickm at torproject.org>
Date:   Thu Nov 7 14:52:29 2013 -0500

    Tweak file documentation in tor.1.txt
---
 doc/tor.1.txt |   39 +++++++++++++++++++--------------------
 1 file changed, 19 insertions(+), 20 deletions(-)

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 6dceba7..c2afed8 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -46,7 +46,7 @@ COMMAND-LINE OPTIONS
     found)
 
 [[opt-allow-missing-torrc]] **--allow-missing-torrc**::
-    Do not require that configuration file specified by **-f** exist if 
+    Do not require that configuration file specified by **-f** exist if
     default torrc can be accessed.
 
 [[opt-defaults-torrc]] **--defaults-torrc** __FILE__::
@@ -455,7 +455,7 @@ GENERAL OPTIONS
 
 [[Sandbox]] **Sandbox** **0**|**1**::
     If set to 1, Tor will run securely through the use of a syscall sandbox.
-    Otherwise the sandbox will be disabled. The option is currently an 
+    Otherwise the sandbox will be disabled. The option is currently an
     experimental feature. (Default: 0)
 
 [[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]::
@@ -2239,8 +2239,8 @@ __DataDirectory__**/cached-status/**::
     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.
+    This file holds downloaded directory key certificates that are used to
+    verify authenticity of documents generated by Tor directory authorities.
 
 __DataDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**::
     The most recent consensus network status document we've downloaded.
@@ -2286,7 +2286,7 @@ __DataDirectory__**/control_auth_cookie**::
     enabled.
 
 __DataDirectory__**/lock**::
-    This file is used to prevent two Tor instances from using same data 
+    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.
 
@@ -2307,20 +2307,21 @@ __DataDirectory__**/approved-routers**::
     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.
+    Only for authoritative directory servers. This file contains status votes
+    from all the authoritative directory servers and is used to generate the
+    network consensus document.
 
 __DataDirectory__**/unverified-consensus**::
-    Only for authoritative directory servers. This file contains not-yet-signed
-    network consensus document.
+    This file contains a network consensus document that has been downloaded,
+    but which we didn't have the right certificates to check yet.
 
 __DataDirectory__**/unverified-microdesc-consensus**::
-    Only for authoritative directory servers. This file contains not-yet-signed
-    microdescriptor based network consensus document.
+    This file contains a microdescriptor-flavored network consensus document
+    that has been downloaded, but which we didn't have the right certificates
+    to check yet.
 
 __DataDirectory__**/unparseable-desc**::
-    Onion router descriptors that Tor was unable to parse are dumped to this 
+    Onion router descriptors that Tor was unable to parse are dumped to this
     file. Only used for debugging.
 
 __DataDirectory__**/router-stability**::
@@ -2329,8 +2330,8 @@ __DataDirectory__**/router-stability**::
     how to set their Stable flags.
 
 __DataDirectory__**/status/dirreq-stats**::
-    Only used by servers. This file is used to collect directory request  
-    statistics.
+    Only used by directory caches and authorities. 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
@@ -2345,13 +2346,12 @@ __DataDirectory__**/status/exit-stats**::
     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.
+    Only used by servers. This file is used to collect buffer usage
+    history.
 
 __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.
+    history (number of active connections over time).
 
 __HiddenServiceDirectory__**/hostname**::
     The <base32-encoded-fingerprint>.onion domain name for this hidden service.
@@ -2380,4 +2380,3 @@ Plenty, probably. Tor is still in development. Please report them.
 AUTHORS
 -------
 Roger Dingledine [arma at mit.edu], Nick Mathewson [nickm at alum.mit.edu].
-