Browse Source

document minimum heartbeatperiod; bug 15638.

Nick Mathewson 8 years ago
parent
commit
b9596b8fdf
2 changed files with 4 additions and 1 deletions
  1. 2 0
      changes/bug15638
  2. 2 1
      doc/tor.1.txt

+ 2 - 0
changes/bug15638

@@ -0,0 +1,2 @@
+  o Documentation:
+    - Document the minimum HeartbeatPeriod value. Closes ticket 15638.

+ 2 - 1
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