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_get_cookie.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_get_cookie.xml')
| -rw-r--r-- | man/sd_bus_message_get_cookie.xml | 44 |
1 files changed, 20 insertions, 24 deletions
diff --git a/man/sd_bus_message_get_cookie.xml b/man/sd_bus_message_get_cookie.xml index 3cb57d25ad..7b9408c049 100644 --- a/man/sd_bus_message_get_cookie.xml +++ b/man/sd_bus_message_get_cookie.xml @@ -63,37 +63,33 @@ <refsect1> <title>Return Value</title> - <para>On success, these calls return 0 or a positive integer. On - failure, these calls return a negative errno-style error - code.</para> + <para>On success, these calls return 0 or a positive integer. On failure, they return a negative + errno-style error code.</para> - <para>On success, the cookie/reply cookie is returned in the - specified 64-bit unsigned integer variable.</para> - </refsect1> + <para>On success, the cookie/reply cookie is returned in the specified 64-bit unsigned integer + variable.</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>A specified parameter - is invalid.</para></listitem> - </varlistentry> + <listitem><para>A specified parameter is invalid.</para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-ENODATA</constant></term> + <varlistentry> + <term><constant>-ENODATA</constant></term> - <listitem><para>No cookie has been assigned to this message. - This either indicates that the message has not been sent yet - and hence has no cookie assigned, or that the message is not a - method response message and hence carries a reply cookie - field.</para></listitem> - </varlistentry> - </variablelist> + <listitem><para>No cookie has been assigned to this message. This either indicates that the + message has not been sent yet and hence has no cookie assigned, or that the message is not a method + response message and hence carries a reply cookie field.</para></listitem> + </varlistentry> + </variablelist> + </refsect2> </refsect1> <xi:include href="libsystemd-pkgconfig.xml" /> |