From: Rainer Jung <rjung@apache.org>
Date: Tue, 21 Jun 2022 10:19:26 +0000 (+0000)
Subject: *) mod_heartmonitor: Document interaction between
X-Git-Tag: 2.5.0-alpha2-ci-test-only~282
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a122180ce63ea38d6cd7051097e0c2d6b32c6ee1;p=thirdparty%2Fapache%2Fhttpd.git

*) mod_heartmonitor: Document interaction between
   HeartbeatStorage and HeartbeatMaxServers.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1902132 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/mod/mod_heartmonitor.xml b/docs/manual/mod/mod_heartmonitor.xml
index c6ee2dfde29..1163aa9a9a2 100644
--- a/docs/manual/mod/mod_heartmonitor.xml
+++ b/docs/manual/mod/mod_heartmonitor.xml
@@ -76,7 +76,7 @@ use <module>mod_slotmem_shm</module>.</p>
 
 <directivesynopsis>
 <name>HeartbeatStorage</name>
-<description>Path to store heartbeat data</description>
+<description>Path to store heartbeat data when using flat-file storage</description>
 <syntax>HeartbeatStorage <var>file-path</var></syntax>
 <default>HeartbeatStorage logs/hb.dat</default>
 <contextlist><context>server config</context></contextlist>
@@ -84,7 +84,8 @@ use <module>mod_slotmem_shm</module>.</p>
 <usage>
     <p>The <directive>HeartbeatStorage</directive> directive specifies the
     path to store heartbeat data.  This flat-file is used only when
-    <module>mod_slotmem_shm</module> is not loaded.</p>
+    <module>mod_slotmem_shm</module> is not loaded and
+    <directive>HeartbeatMaxServers</directive> is set to 0.</p>
 </usage>
 </directivesynopsis>
 
@@ -101,6 +102,8 @@ heartbeat requests to this server</description>
     maximum number of servers that will be sending requests to this monitor
     server.  It is used to control the size of the shared memory allocated
     to store the heartbeat info when <module>mod_slotmem_shm</module> is in use.</p>
+    <p>For using flat-file storage (without loading <module>mod_slotmem_shm</module>),
+    this mus be set to 0. The value must be either 0, or bigger or equals 10.</p>
 </usage>
 </directivesynopsis>
 </modulesynopsis>