man: fix sd_watchdog_enabled() prototype in man page

[elogind.git] / man / sd_watchdog_enabled.xml

diff --git a/man/sd_watchdog_enabled.xml b/man/sd_watchdog_enabled.xml
index 5b0d7e21cb2b4fc2f303de33f5274b5069e66d51..41640276405080abeb041d31cbb13ca536ee06c9 100644 (file)
--- a/man/sd_watchdog_enabled.xml
+++ b/man/sd_watchdog_enabled.xml
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="sd_watchdog_enabled">
+<refentry id="sd_watchdog_enabled"
+        xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>sd_watchdog_enabled</title>
@@ -54,7 +55,7 @@
                         <funcprototype>
                                 <funcdef>int <function>sd_watchdog_enabled</function></funcdef>
                                 <paramdef>int <parameter>unset_environment</parameter></paramdef>
-                                <paramdef>const uint64_t *<parameter>usec</parameter></paramdef>
+                                <paramdef>uint64_t *<parameter>usec</parameter></paramdef>
                         </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
@@ -80,7 +81,7 @@
                 inherited by child processes.</para>
 
                 <para>If the <parameter>usec</parameter> parameter is
-                non-NULL <function>sd_watchdog_enabled()</function>
+                non-NULL, <function>sd_watchdog_enabled()</function>
                 will return the timeout in µs for the watchdog
                 logic. The service manager will usually terminate a
                 service when it did not get a notification message
@@ -94,7 +95,7 @@
                 <literal>WATCHDOG=1</literal>.</para>
 
                 <para>To enable service supervision with the watchdog
-                logic use <varname>WatchdogSec=</varname> in service
+                logic, use <varname>WatchdogSec=</varname> in service
                 files. See
                 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 for details.</para>
@@ -107,7 +108,7 @@
                 errno-style error code. If the service manager expects
                 watchdog keep-alive notification messages to be sent,
                 &gt; 0 is returned, otherwise 0 is returned. Only if
-                the return value is &gt; 0 the
+                the return value is &gt; 0, the
                 <parameter>usec</parameter> parameter is valid after
                 the call.</para>
         </refsect1>
@@ -115,13 +116,7 @@
         <refsect1>
                 <title>Notes</title>
 
-                <para>This function is provided by the reference
-                implementation of APIs for new-style daemons and
-                distributed with the systemd package. The algorithm
-                it implements is simple, and can easily be
-                reimplemented in daemons if it is important to support
-                this interface without using the reference
-                implementation.</para>
+                <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
 
                 <para>Internally, this functions parses the
                 <varname>$WATCHDOG_PID</varname> and
@@ -129,32 +124,9 @@
                 variable. The call will ignore these variables if
                 <varname>$WATCHDOG_PID</varname> does containe the PID
                 of the current process, under the assumption that in
-                that case the variables were set for a different
+                that case, the variables were set for a different
                 process further up the process tree.</para>
 
-                <para>For details about the algorithm check the
-                liberally licensed reference implementation sources:
-                <ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/libsystemd-daemon/sd-daemon.c"/>
-                and <ulink
-                url="http://cgit.freedesktop.org/systemd/systemd/plain/src/systemd/sd-daemon.h"/></para>
-
-                <para><function>sd_watchdog_enabled()</function> is
-                implemented in the reference implementation's
-                <filename>sd-daemon.c</filename> and
-                <filename>sd-daemon.h</filename> files. These
-                interfaces are available as a shared library, which can
-                be compiled and linked to with the
-                <constant>libsystemd-daemon</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-                file. Alternatively, applications consuming these APIs
-                may copy the implementation into their source
-                tree. For more details about the reference
-                implementation see
-                <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
-
-                <para>If the reference implementation is used as
-                drop-in files and -DDISABLE_SYSTEMD is set during
-                compilation, these functions will always return 0 and
-                otherwise become a NOP.</para>
         </refsect1>
 
         <refsect1>