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_get_fd.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_get_fd.xml')
| -rw-r--r-- | man/sd_bus_get_fd.xml | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/man/sd_bus_get_fd.xml b/man/sd_bus_get_fd.xml index a8c1b1a63d..6a022b1a19 100644 --- a/man/sd_bus_get_fd.xml +++ b/man/sd_bus_get_fd.xml @@ -104,41 +104,41 @@ <para><function>sd_bus_get_timeout()</function> returns zero or positive on success, or a negative <varname>errno</varname>-style error code on error.</para> - </refsect1> - <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>An invalid bus object was passed.</para></listitem> - </varlistentry> + <listitem><para>An invalid bus object was passed.</para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-ECHILD</constant></term> + <varlistentry> + <term><constant>-ECHILD</constant></term> - <listitem><para>The bus connection was allocated in a parent process and is being reused in a child process - after <function>fork()</function>.</para></listitem> - </varlistentry> + <listitem><para>The bus connection was allocated in a parent process and is being reused in a child + process after <function>fork()</function>.</para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-ENOTCONN</constant></term> + <varlistentry> + <term><constant>-ENOTCONN</constant></term> - <listitem><para>The bus connection has been terminated.</para></listitem> - </varlistentry> + <listitem><para>The bus connection has been terminated.</para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-EPERM</constant></term> + <varlistentry> + <term><constant>-EPERM</constant></term> - <listitem><para>Two distinct file descriptors were passed for input and output using - <function>sd_bus_set_fd()</function>, which <function>sd_bus_get_fd()</function> cannot - return.</para></listitem> - </varlistentry> - </variablelist> + <listitem><para>Two distinct file descriptors were passed for input and output using + <function>sd_bus_set_fd()</function>, which <function>sd_bus_get_fd()</function> cannot + return.</para></listitem> + </varlistentry> + </variablelist> + </refsect2> </refsect1> <xi:include href="libsystemd-pkgconfig.xml" /> |