From: Luca Boccassi <luca.boccassi@microsoft.com>
Date: Tue, 6 Jul 2021 11:55:30 +0000 (+0100)
Subject: man: correct return value of sd_bus_open_with_description
X-Git-Tag: v249~11
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=48e5ef14af5ade97b0f7491c63443778c7602c43;p=thirdparty%2Fsystemd.git

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.
---

diff --git a/man/sd_bus_set_description.xml b/man/sd_bus_set_description.xml
index bbd3835f01d..ce6b8d387d8 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>