[tor-commits] [tor/master] Fix documentation of torrc search order

[nickm at torproject.org]

commit a68e6ea9c0288d82ea10076c551f48d63b3813fc
Author: Nick Mathewson <nickm at torproject.org>
Date:   Thu Mar 27 14:58:46 2014 -0400

    Fix documentation of torrc search order
    
    We are searching @CONFDIR@ before $HOME, but the documentation
    implied otherwise.
    
    I screwed this up in f5e86bcd6c06d43ff3af5acd8135bd8b577bc3, when I
    first documented the $HOME/.torrc possibility.
    
    Fix for bug 9213; bugfix on 0.2.3.18-rc.
---
 changes/bug9213_doc |    5 +++++
 doc/tor.1.txt       |    5 ++++-
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/changes/bug9213_doc b/changes/bug9213_doc
new file mode 100644
index 0000000..2f959dd
--- /dev/null
+++ b/changes/bug9213_doc
@@ -0,0 +1,5 @@
+  o Documentation:
+    - Correctly document that we search for a system torrc file before
+      looking in ~/.torrc. Fixes documentation side of 9213; bugfix
+      on 0.2.3.18-rc.
+
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 3f8f6da..eb9ad67 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -37,7 +37,7 @@ COMMAND-LINE OPTIONS
 
 [[opt-f]] **-f** __FILE__::
     Specify a new configuration file to contain further Tor configuration
-    options. (Default: $HOME/.torrc, or @CONFDIR@/torrc if that file is not
+    options. (Default: @CONFDIR@/torrc, or $HOME/.torrc if that file is not
     found)
 
 [[opt-defaults-torrc]] **--defaults-torrc** __FILE__::
@@ -2103,6 +2103,9 @@ FILES
 **@CONFDIR@/torrc**::
     The configuration file, which contains "option value" pairs.
 
+**$HOME/.torrc**::
+    Fallback location for torrc, if @CONFDIR@/torrc is not found.
+
 **@LOCALSTATEDIR@/lib/tor/**::
     The tor process stores keys and other data here.