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_set_destroy_callback.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_source_set_destroy_callback.xml')
| -rw-r--r-- | man/sd_event_source_set_destroy_callback.xml | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/man/sd_event_source_set_destroy_callback.xml b/man/sd_event_source_set_destroy_callback.xml index f3ebf0cc3a..2ffca9ec36 100644 --- a/man/sd_event_source_set_destroy_callback.xml +++ b/man/sd_event_source_set_destroy_callback.xml @@ -69,25 +69,26 @@ <refsect1> <title>Return Value</title> - <para>On success, <function>sd_event_source_set_destroy_callback()</function> returns 0 or a positive integer. On - failure, it returns a negative errno-style error code.</para> + <para>On success, <function>sd_event_source_set_destroy_callback()</function> returns 0 or a positive + integer. On failure, it returns a negative errno-style error code.</para> - <para><function>sd_event_source_get_destroy_callback()</function> returns positive if the destroy callback function - is set, 0 if not. On failure, returns a negative errno-style error code.</para> - </refsect1> + <para><function>sd_event_source_get_destroy_callback()</function> returns positive if the destroy + callback function is set, 0 if not. On failure, 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>The <parameter>source</parameter> parameter is <constant>NULL</constant>.</para></listitem> - </varlistentry> - </variablelist> + <listitem><para>The <parameter>source</parameter> parameter is <constant>NULL</constant>. + </para></listitem> + </varlistentry> + </variablelist> + </refsect2> </refsect1> <xi:include href="libsystemd-pkgconfig.xml" /> |