summaryrefslogtreecommitdiff
path: root/man/sd_event_set_watchdog.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2019-03-21 14:53:00 +0100
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2019-03-21 14:53:00 +0100
commitb1de39dec8e9acd875e2038e418d7193fb380b41 (patch)
treea044b2ad47d393f4f0439462122e5a9ba129b5b1 /man/sd_event_set_watchdog.xml
parent6d99c5d1d9832a2a85c77f8d90767028651f3f35 (diff)
downloadsystemd-b1de39dec8e9acd875e2038e418d7193fb380b41.tar.gz
man: make separate "Errors" sections subsection of "Return value"
Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
Diffstat (limited to 'man/sd_event_set_watchdog.xml')
-rw-r--r--man/sd_event_set_watchdog.xml40
1 files changed, 18 insertions, 22 deletions
diff --git a/man/sd_event_set_watchdog.xml b/man/sd_event_set_watchdog.xml
index 27bbd66682..faaaad39d9 100644
--- a/man/sd_event_set_watchdog.xml
+++ b/man/sd_event_set_watchdog.xml
@@ -93,36 +93,32 @@
<title>Return Value</title>
<para>On success, <function>sd_event_set_watchdog()</function> and
- <function>sd_event_get_watchdog()</function> return a non-zero
- positive integer if the service manager requested watchdog support
- and watchdog support was successfully enabled. They return zero if
- the service manager did not request watchdog support, or if
- watchdog support was explicitly disabled with a false
- <parameter>b</parameter> parameter. On failure, they return a
- negative errno-style error
- code.</para>
- </refsect1>
+ <function>sd_event_get_watchdog()</function> return a non-zero positive integer if the service manager
+ requested watchdog support and watchdog support was successfully enabled. They return zero if the service
+ manager did not request watchdog support, or if watchdog support was explicitly disabled with a false
+ <parameter>b</parameter> parameter. On failure, they return a negative errno-style error code.</para>
- <refsect1>
- <title>Errors</title>
+ <refsect2>
+ <title>Errors</title>
- <para>Returned errors may indicate the following problems:</para>
+ <para>Returned errors may indicate the following problems:</para>
- <variablelist>
+ <variablelist>
- <varlistentry>
- <term><constant>-ECHILD</constant></term>
+ <varlistentry>
+ <term><constant>-ECHILD</constant></term>
- <listitem><para>The event loop has been created in a different process.</para></listitem>
- </varlistentry>
+ <listitem><para>The event loop has been created in a different process.</para></listitem>
+ </varlistentry>
- <varlistentry>
- <term><constant>-EINVAL</constant></term>
+ <varlistentry>
+ <term><constant>-EINVAL</constant></term>
- <listitem><para>The passed event loop object was invalid.</para></listitem>
- </varlistentry>
+ <listitem><para>The passed event loop object was invalid.</para></listitem>
+ </varlistentry>
- </variablelist>
+ </variablelist>
+ </refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />