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_source_get_pending.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_source_get_pending.xml')
| -rw-r--r-- | man/sd_event_source_get_pending.xml | 66 |
1 files changed, 31 insertions, 35 deletions
diff --git a/man/sd_event_source_get_pending.xml b/man/sd_event_source_get_pending.xml index dd07a46942..603d4ad377 100644 --- a/man/sd_event_source_get_pending.xml +++ b/man/sd_event_source_get_pending.xml @@ -69,56 +69,52 @@ <refsect1> <title>Return Value</title> - <para>On success, - <function>sd_event_source_get_pending()</function> returns an - integer greater than zero when the event source is marked pending, - and zero when the event source is not marked pending. On failure, - it returns a negative errno-style error code.</para> - </refsect1> + <para>On success, <function>sd_event_source_get_pending()</function> returns an integer greater than zero + when the event source is marked pending, and zero when the event source is not marked pending. On + failure, it returns 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> - <varlistentry> - <term><constant>-EINVAL</constant></term> + <variablelist> + <varlistentry> + <term><constant>-EINVAL</constant></term> - <listitem><para><parameter>source</parameter> is not a valid - pointer to an <structname>sd_event_source</structname> - object.</para></listitem> - </varlistentry> + <listitem><para><parameter>source</parameter> is not a valid pointer to an + <structname>sd_event_source</structname> object.</para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-EDOM</constant></term> + <varlistentry> + <term><constant>-EDOM</constant></term> - <listitem><para><parameter>source</parameter> refers to an - event source object created with - <citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem> - </varlistentry> + <listitem><para><parameter>source</parameter> refers to an event source object created with + <citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-ENOMEM</constant></term> + <varlistentry> + <term><constant>-ENOMEM</constant></term> - <listitem><para>Not enough memory.</para></listitem> - </varlistentry> + <listitem><para>Not enough memory.</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> + </refsect2> </refsect1> <xi:include href="libsystemd-pkgconfig.xml" /> |