diff options
| author | Luca Boccassi <luca.boccassi@microsoft.com> | 2021-07-06 12:55:30 +0100 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2021-07-06 15:18:35 +0200 |
| commit | 48e5ef14af5ade97b0f7491c63443778c7602c43 (patch) | |
| tree | 6bc60286466fc9096cfdc837aced5082275cc000 | |
| parent | ef1a927848d828d432f0b475addee5bd82c990da (diff) | |
| download | systemd-48e5ef14af5ade97b0f7491c63443778c7602c43.tar.gz | |
man: correct return value of sd_bus_open_with_description
Since https://github.com/systemd/systemd/commit/f4b2933ee7890e5d414ab266d8586f19027a2bd9
if a description is not set, sd_bus_open_with_description returns -ENXIO, but the
documnetation stated that it returned successfully with a NULL string.
| -rw-r--r-- | man/sd_bus_set_description.xml | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/man/sd_bus_set_description.xml b/man/sd_bus_set_description.xml index bbd3835f01..ce6b8d387d 100644 --- a/man/sd_bus_set_description.xml +++ b/man/sd_bus_set_description.xml @@ -115,7 +115,7 @@ <citerefentry><refentrytitle>sd_bus_open_with_description</refentrytitle><manvolnum>3</manvolnum></citerefentry> or similar. If not set this way, a default string like <literal>system</literal> or <literal>user</literal> will be returned for the system or user buses, and - <constant>NULL</constant> otherwise.</para> + <constant>-ENXIO</constant> otherwise.</para> <para><function>sd_bus_set_anonymous()</function> enables or disables "anonymous authentication", i.e. lack of authentication, of the bus peer. This function must be called before the bus is @@ -222,7 +222,10 @@ <term><constant>-ENXIO</constant></term> <listitem><para>The bus object passed to <function>sd_bus_get_tid()</function> was not a - default bus object and is not attached to an event loop.</para></listitem> + default bus object and is not attached to an event loop.</para> + + <para>The bus object passed to <function>sd_bus_get_description()</function> did + not have a <parameter>description</parameter>.</para></listitem> </varlistentry> </variablelist> </refsect2> |