summaryrefslogtreecommitdiffstats
path: root/man/sd_bus_message_new_method_error.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2019-03-21 14:53:00 +0100
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2019-03-21 14:53:00 +0100
commitb1de39dec8e9acd875e2038e418d7193fb380b41 (patch)
treea044b2ad47d393f4f0439462122e5a9ba129b5b1 /man/sd_bus_message_new_method_error.xml
parentman: document error values for sd_id128_get_*() (diff)
downloadsystemd-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_bus_message_new_method_error.xml')
-rw-r--r--man/sd_bus_message_new_method_error.xml64
1 files changed, 32 insertions, 32 deletions
diff --git a/man/sd_bus_message_new_method_error.xml b/man/sd_bus_message_new_method_error.xml
index 3b7aa36d78..27cec8ed01 100644
--- a/man/sd_bus_message_new_method_error.xml
+++ b/man/sd_bus_message_new_method_error.xml
@@ -127,50 +127,50 @@
<para>These functions return 0 if the error reply was successfully created, and a
negative errno-style error code otherwise.</para>
- </refsect1>
- <refsect1 id='errors'>
- <title>Errors</title>
+ <refsect2 id='errors'>
+ <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 call message <parameter>call</parameter> or the output
- parameter <parameter>m</parameter> are <constant>NULL</constant>.</para>
+ <listitem><para>The call message <parameter>call</parameter> or the output
+ parameter <parameter>m</parameter> are <constant>NULL</constant>.</para>
- <para>Message <parameter>call</parameter> is not a method call
- message.</para>
+ <para>Message <parameter>call</parameter> is not a method call
+ message.</para>
- <para>The error <parameter>error</parameter> parameter to
- <function>sd_bus_message_new_method_error</function> is not set, see
- <citerefentry><refentrytitle>sd_bus_error_is_set</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
- </para>
- </listitem>
- </varlistentry>
+ <para>The error <parameter>error</parameter> parameter to
+ <function>sd_bus_message_new_method_error</function> is not set, see
+ <citerefentry><refentrytitle>sd_bus_error_is_set</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry>
- <term><constant>-EPERM</constant></term>
+ <varlistentry>
+ <term><constant>-EPERM</constant></term>
- <listitem><para>Message <parameter>call</parameter> has been sealed.
- </para></listitem>
- </varlistentry>
+ <listitem><para>Message <parameter>call</parameter> has been sealed.
+ </para></listitem>
+ </varlistentry>
- <varlistentry>
- <term><constant>-ENOTCONN</constant></term>
+ <varlistentry>
+ <term><constant>-ENOTCONN</constant></term>
- <listitem><para>The bus to which message <parameter>call</parameter> is
- attached is not connected.</para></listitem>
- </varlistentry>
+ <listitem><para>The bus to which message <parameter>call</parameter> is
+ attached is not connected.</para></listitem>
+ </varlistentry>
- <varlistentry>
- <term><constant>-ENOMEM</constant></term>
+ <varlistentry>
+ <term><constant>-ENOMEM</constant></term>
- <listitem><para>Memory allocation failed.</para></listitem>
- </varlistentry>
- </variablelist>
+ <listitem><para>Memory allocation failed.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />