From: Lennart Poettering <lennart@poettering.net>
Date: Wed, 27 Jun 2012 22:24:36 +0000 (+0200)
Subject: man: extend watchdog docs a bit
X-Git-Tag: v186~47
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=dac051ad6893dcf3e1a69d40eea02682220e71d4

man: extend watchdog docs a bit
---

diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index eb449555c..a91c1bb4b 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -156,12 +156,19 @@
                                 <term>WATCHDOG=1</term>
 
                                 <listitem><para>Tells systemd to
-                                update the watchdog timestamp.
-                                Services using this feature should do
-                                this in regular intervals. A watchdog
-                                framework can use the timestamps to
-                                detect failed
-                                services.</para></listitem>
+                                update the watchdog timestamp. This is
+                                the keep-alive ping that services need
+                                to issue in regular intervals if
+                                <varname>WatchdogSec=</varname> is
+                                enabled for it. See
+                                <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                                for details. It is recommended to send
+                                this message if the
+                                <varname>WATCHDOG_USEC=</varname>
+                                environment variable has been set for
+                                the service process, in every half the
+                                time interval that is specified in the
+                                variable.</para></listitem>
                         </varlistentry>
                 </variablelist>
 
diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index 233807d2b..c57bce0ec 100644
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -482,26 +482,29 @@
                                 is activated when the start-up is
                                 completed. The service must call
                                 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
-                                regularly with "WATCHDOG=1". If the
-                                time between two such calls is larger
-                                than the configured time then the
-                                service is placed in a failure
-                                state. By setting
-                                <varname>Restart=</varname>
-                                to <option>on-failure</option> or
+                                regularly with "WATCHDOG=1" (i.e. the
+                                "keep-alive ping"). If the time
+                                between two such calls is larger than
+                                the configured time then the service
+                                is placed in a failure state. By
+                                setting <varname>Restart=</varname> to
+                                <option>on-failure</option> or
                                 <option>always</option> the service
                                 will be automatically restarted. The
                                 time configured here will be passed to
                                 the executed service process in the
                                 <varname>WATCHDOG_USEC=</varname>
-                                environment variable. If
+                                environment variable. This allows
+                                daemons to automatically enable the
+                                keep-alive pinging logic if watchdog
+                                support is enabled for the service. If
                                 this option is used
                                 <varname>NotifyAccess=</varname> (see
                                 below) should be set to open access to
                                 the notification socket provided by
                                 systemd. If
-                                <varname>NotifyAccess=</varname> is not
-                                set, it will be implicitly set to
+                                <varname>NotifyAccess=</varname> is
+                                not set, it will be implicitly set to
                                 <option>main</option>. Defaults to 0,
                                 which disables this
                                 feature.</para></listitem>