[sr-dev] git:master:b22a5061: keepalove: added notes in docs about how monitoring is done

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: b22a5061e00cd78288132d8d72c860ee2ca17425
URL: https://github.com/kamailio/kamailio/commit/b22a5061e00cd78288132d8d72c860ee2ca17425

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2017-06-13T15:09:04+02:00

keepalove: added notes in docs about how monitoring is done

- closes GH #1082

---

Modified: src/modules/keepalive/doc/keepalive_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/b22a5061e00cd78288132d8d72c860ee2ca17425.diff
Patch: https://github.com/kamailio/kamailio/commit/b22a5061e00cd78288132d8d72c860ee2ca17425.patch

---

diff --git a/src/modules/keepalive/doc/keepalive_admin.xml b/src/modules/keepalive/doc/keepalive_admin.xml
index d907e496b3..d65d4f6c12 100644
--- a/src/modules/keepalive/doc/keepalive_admin.xml
+++ b/src/modules/keepalive/doc/keepalive_admin.xml
@@ -10,13 +10,21 @@
 <!-- Module User's Guide -->
 
 <chapter>
-	
+
 	<title>&adminguide;</title>
-	
+
 	<section>
 		<title>Overview</title>
 		<para>
-		This module performs destinations monitoring either for itself, or on the behalf of other modules
+			This module performs destinations monitoring either for itself,
+			or on the behalf of other modules. The monitoring is done by sending
+			SIP OPTIONS requests, more or less in the same fashion as the
+			dispatcher module (which was the initial source for this module).
+		</para>
+		<para>
+			As an example of usage by other modules, see
+			<emphasis>drouting</emphasis>, which was
+			enahnced to use this module to monitor its gateways.
 		</para>
 	</section>