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_new.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_new.xml')
| -rw-r--r-- | man/sd_event_new.xml | 50 |
1 files changed, 23 insertions, 27 deletions
diff --git a/man/sd_event_new.xml b/man/sd_event_new.xml index b37aeca7b2..3db39c9d06 100644 --- a/man/sd_event_new.xml +++ b/man/sd_event_new.xml @@ -158,44 +158,40 @@ <refsect1> <title>Return Value</title> - <para>On success, <function>sd_event_new()</function>, - <function>sd_event_default()</function> and - <function>sd_event_get_tid()</function> return 0 or a positive - integer. On failure, they return a negative errno-style error - code. <function>sd_event_ref()</function> always returns a pointer - to the event loop object passed - in. <function>sd_event_unref()</function> always returns + <para>On success, <function>sd_event_new()</function>, <function>sd_event_default()</function> and + <function>sd_event_get_tid()</function> return 0 or a positive integer. On failure, they return a + negative errno-style error code. <function>sd_event_ref()</function> always returns a pointer to the + event loop object passed in. <function>sd_event_unref()</function> always returns <constant>NULL</constant>.</para> - </refsect1> - <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>-ENOMEM</constant></term> + <variablelist> + <varlistentry> + <term><constant>-ENOMEM</constant></term> - <listitem><para>Not enough memory to allocate the object.</para></listitem> - </varlistentry> + <listitem><para>Not enough memory to allocate the object.</para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-EMFILE</constant></term> + <varlistentry> + <term><constant>-EMFILE</constant></term> - <listitem><para>The maximum number of event loops has been allocated.</para></listitem> + <listitem><para>The maximum number of event loops has been allocated.</para></listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><constant>-ENXIO</constant></term> + <varlistentry> + <term><constant>-ENXIO</constant></term> - <listitem><para><function>sd_event_get_tid()</function> was - invoked on an event loop object that was not allocated with - <function>sd_event_default()</function>.</para></listitem> - </varlistentry> + <listitem><para><function>sd_event_get_tid()</function> was invoked on an event loop object that + was not allocated with <function>sd_event_default()</function>.</para></listitem> + </varlistentry> - </variablelist> + </variablelist> + </refsect2> </refsect1> <xi:include href="libsystemd-pkgconfig.xml" /> |