21151: document datadir default decently.

diff --git a/changes/data_dir_default_doc b/changes/data_dir_default_doc
new file mode 100644 (file)
index 0000000..6b49bb2
--- /dev/null
+++ b/changes/data_dir_default_doc
@@ -0,0 +1,3 @@
+  o Documentation:
+    - Correct the documentation about the default DataDirectory value.
+      Closes ticket 21151.

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 2f8d7bdd09c88dc1598e392f9e3735290a42962e..568771a123b9a334210207cf53da53e17033dfc2 100644 (file)
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -394,7 +394,9 @@ GENERAL OPTIONS
 
 [[DataDirectory]] **DataDirectory** __DIR__::
     Store working data in DIR. Can not be changed while tor is running.
-    (Default: @LOCALSTATEDIR@/lib/tor)
+    (Default: ~/.tor if your home directory is not /; otherwise,
+    @LOCALSTATEDIR@/lib/tor.  On Windows, the default is
+    your ApplicationData folder.)
 
 [[DataDirectoryGroupReadable]] **DataDirectoryGroupReadable** **0**|**1**::
     If this option is set to 0, don't allow the filesystem group to read the