diff options
| author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2019-03-21 14:53:00 +0100 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2019-03-21 14:53:00 +0100 |
| commit | b1de39dec8e9acd875e2038e418d7193fb380b41 (patch) | |
| tree | a044b2ad47d393f4f0439462122e5a9ba129b5b1 /man/sd_event_exit.xml | |
| parent | man: document error values for sd_id128_get_*() (diff) | |
| download | systemd-b1de39dec8e9acd875e2038e418d7193fb380b41.tar.xz systemd-b1de39dec8e9acd875e2038e418d7193fb380b41.zip | |
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_exit.xml')
| -rw-r--r-- | man/sd_event_exit.xml | 51 |
1 files changed, 25 insertions, 26 deletions
diff --git a/man/sd_event_exit.xml b/man/sd_event_exit.xml index 17cb9d2f53..a02897af0b 100644 --- a/man/sd_event_exit.xml +++ b/man/sd_event_exit.xml @@ -79,45 +79,44 @@ <refsect1> <title>Return Value</title> - <para>On success, <function>sd_event_exit()</function> and - <function>sd_event_get_exit_code()</function> return 0 or a positive - integer. On failure, they return a negative errno-style error - code.</para> - </refsect1> + <para>On success, <function>sd_event_exit()</function> and <function>sd_event_get_exit_code()</function> + return 0 or a positive integer. 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>-EINVAL</constant></term> + <varlistentry> + <term><constant>-EINVAL</constant></term> - <listitem><para>The event loop object or error code pointer are invalid.</para></listitem> + <listitem><para>The event loop object or error code pointer are invalid.</para></listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><constant>-ECHILD</constant></term> + <varlistentry> + <term><constant>-ECHILD</constant></term> - <listitem><para>The event loop was created in a different process.</para></listitem> - </varlistentry> + <listitem><para>The event loop was created in a different process.</para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-ESTALE</constant></term> + <varlistentry> + <term><constant>-ESTALE</constant></term> - <listitem><para>The event loop has exited already and all exit handlers are already processed.</para></listitem> - </varlistentry> + <listitem><para>The event loop has exited already and all exit handlers are already processed. + </para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-ENODATA</constant></term> + <varlistentry> + <term><constant>-ENODATA</constant></term> - <listitem><para>The event loop has not been requested to exit yet.</para></listitem> - </varlistentry> + <listitem><para>The event loop has not been requested to exit yet.</para></listitem> + </varlistentry> - </variablelist> + </variablelist> + </refsect2> </refsect1> <xi:include href="libsystemd-pkgconfig.xml" /> |