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_bus_message_new_signal.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_bus_message_new_signal.xml')
| -rw-r--r-- | man/sd_bus_message_new_signal.xml | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/man/sd_bus_message_new_signal.xml b/man/sd_bus_message_new_signal.xml index 9a890c6f31..61619304db 100644 --- a/man/sd_bus_message_new_signal.xml +++ b/man/sd_bus_message_new_signal.xml @@ -56,40 +56,40 @@ <para>This function returns 0 if the message object was successfully created, and a negative errno-style error code otherwise.</para> - </refsect1> - <refsect1 id='errors'> - <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 output parameter <parameter>m</parameter> is - <constant>NULL</constant>.</para> + <listitem><para>The output parameter <parameter>m</parameter> is + <constant>NULL</constant>.</para> - <para>The <parameter>path</parameter> parameter is not a valid D-Bus path - (<literal>/an/object/path</literal>), the <parameter>interface</parameter> parameter is not - a valid D-Bus interface name (<literal>an.interface.name</literal>), or the - <parameter>member</parameter> parameter is not a valid D-Bus member - (<literal>Name</literal>).</para></listitem> - </varlistentry> + <para>The <parameter>path</parameter> parameter is not a valid D-Bus path + (<literal>/an/object/path</literal>), the <parameter>interface</parameter> parameter is not + a valid D-Bus interface name (<literal>an.interface.name</literal>), or the + <parameter>member</parameter> parameter is not a valid D-Bus member + (<literal>Name</literal>).</para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-ENOTCONN</constant></term> + <varlistentry> + <term><constant>-ENOTCONN</constant></term> - <listitem><para>The bus parameter <parameter>bus</parameter> is <constant>NULL</constant> or - the bus is not connected.</para></listitem> - </varlistentry> + <listitem><para>The bus parameter <parameter>bus</parameter> is <constant>NULL</constant> or + the bus 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" /> |