[tor-commits] [tor/master] Fix the documentation for GuardLifetime.

[dgoulet at torproject.org]

commit 6581f3e2faf412357212b2ee2cec0db5410d3761
Author: Nick Mathewson <nickm at torproject.org>
Date:   Mon Sep 30 14:50:57 2019 -0400

    Fix the documentation for GuardLifetime.
---
 changes/ticket31189 | 3 +++
 doc/tor.1.txt       | 7 +++----
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/changes/ticket31189 b/changes/ticket31189
new file mode 100644
index 000000000..318941c79
--- /dev/null
+++ b/changes/ticket31189
@@ -0,0 +1,3 @@
+  o Documentation:
+    - Correct the description of "GuardLifetime". Fixes bug 31189; bugfix on
+      0.3.0.1-alpha.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 21b482802..98ef7c733 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -1395,10 +1395,9 @@ The following options are useful only for clients (that is, if
     default to 3 if the consensus parameter isn't set.  (Default: 0)
 
 [[GuardLifetime]] **GuardLifetime**  __N__ **days**|**weeks**|**months**::
-    If nonzero, and UseEntryGuards is set, minimum time to keep a guard before
-    picking a new one. If zero, we use the GuardLifetime parameter from the
-    consensus directory.  No value here may  be less than 1 month or greater
-    than 5 years; out-of-range values are clamped. (Default: 0)
+    If UseEntryGuards is set, minimum time to keep a guard on our guard list
+    before  picking a new one.  If less than one day, we use defaults from the
+    consensus directory.  (Default: 0)
 
 [[SafeSocks]] **SafeSocks** **0**|**1**::
     When this option is enabled, Tor will reject application connections that