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_wait.xml | |
| parent | 6d99c5d1d9832a2a85c77f8d90767028651f3f35 (diff) | |
| download | systemd-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_wait.xml')
| -rw-r--r-- | man/sd_event_wait.xml | 67 |
1 files changed, 31 insertions, 36 deletions
diff --git a/man/sd_event_wait.xml b/man/sd_event_wait.xml index 8e287e6a9f..210a0c948d 100644 --- a/man/sd_event_wait.xml +++ b/man/sd_event_wait.xml @@ -254,56 +254,51 @@ <refsect1> <title>Return Value</title> - <para>On success, these functions return 0 or a positive integer. - On failure, they return a negative errno-style error code. In case - of <function>sd_event_prepare()</function> and - <function>sd_event_wait()</function>, a positive, non-zero return - code indicates that events are ready to be processed and zero - indicates that no events are ready. In case of - <function>sd_event_dispatch()</function>, a positive, non-zero - return code indicates that the event loop returned to its initial - state and zero indicates the event loop has - exited. <function>sd_event_get_state()</function> returns a - positive or zero state on success.</para> - </refsect1> + <para>On success, these functions return 0 or a positive integer. On failure, they return a negative + errno-style error code. In case of <function>sd_event_prepare()</function> and + <function>sd_event_wait()</function>, a positive, non-zero return code indicates that events are ready to + be processed and zero indicates that no events are ready. In case of + <function>sd_event_dispatch()</function>, a positive, non-zero return code indicates that the event loop + returned to its initial state and zero indicates the event loop has + exited. <function>sd_event_get_state()</function> returns a positive or zero state on success.</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> - <varlistentry> - <term><constant>-EINVAL</constant></term> + <variablelist> + <varlistentry> + <term><constant>-EINVAL</constant></term> - <listitem><para>The <parameter>event</parameter> parameter is - invalid or <constant>NULL</constant>.</para></listitem> - </varlistentry> + <listitem><para>The <parameter>event</parameter> parameter is invalid or <constant>NULL</constant>. + </para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-EBUSY</constant></term> + <varlistentry> + <term><constant>-EBUSY</constant></term> - <listitem><para>The event loop object is not in the right - state.</para></listitem> - </varlistentry> + <listitem><para>The event loop object is not in the right state.</para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-ESTALE</constant></term> + <varlistentry> + <term><constant>-ESTALE</constant></term> - <listitem><para>The event loop is already terminated.</para></listitem> + <listitem><para>The event loop is already terminated.</para></listitem> - </varlistentry> + </varlistentry> - <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> + <listitem><para>The event loop has been created in a different process.</para></listitem> - </varlistentry> + </varlistentry> - </variablelist> + </variablelist> - <para>Other errors are possible, too.</para> + <para>Other errors are possible, too.</para> + </refsect2> </refsect1> <xi:include href="libsystemd-pkgconfig.xml" /> |