[tor-commits] [tor/master] document minimum heartbeatperiod; bug 15638.

[nickm at torproject.org]

commit b9596b8fdf5006d650bba0109e5614b5a387dbdf
Author: Nick Mathewson <nickm at torproject.org>
Date:   Tue Dec 22 11:10:37 2015 -0500

    document minimum heartbeatperiod; bug 15638.
---
 changes/bug15638 |    2 ++
 doc/tor.1.txt    |    3 ++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/changes/bug15638 b/changes/bug15638
new file mode 100644
index 0000000..cf5d469
--- /dev/null
+++ b/changes/bug15638
@@ -0,0 +1,2 @@
+  o Documentation:
+    - Document the minimum HeartbeatPeriod value. Closes ticket 15638.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 021353d..3514c4d 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -1750,7 +1750,8 @@ is non-zero):
     Log a heartbeat message every **HeartbeatPeriod** seconds. This is
     a log level __notice__ message, designed to let you know your Tor
     server is still alive and doing useful things. Settings this
-    to 0 will disable the heartbeat. (Default: 6 hours)
+    to 0 will disable the heartbeat. Otherwise, it must be at least 30
+    minutes. (Default: 6 hours)
 
 [[AccountingMax]] **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**|**TBytes**::
     Limits the max number of bytes sent and received within a set time period