]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: correct return value of sd_bus_open_with_description
authorLuca Boccassi <luca.boccassi@microsoft.com>
Tue, 6 Jul 2021 11:55:30 +0000 (12:55 +0100)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Tue, 6 Jul 2021 13:18:35 +0000 (15:18 +0200)
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.

man/sd_bus_set_description.xml

index bbd3835f01d64306149104d2603259632bf2687e..ce6b8d387d83c4a7d8bc335b67baadd839c3b2a1 100644 (file)
     <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
           <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>