From: Yu Watanabe <watanabe.yu+github@gmail.com>
Date: Mon, 9 Nov 2020 20:57:41 +0000 (+0900)
Subject: man: mention that sd_bus_call() may return a negative errno mapped from D-Bus error... 
X-Git-Tag: v247-rc2^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c660668ed9daf15358c522c09ba3932393bd5451;p=thirdparty%2Fsystemd.git

man: mention that sd_bus_call() may return a negative errno mapped from D-Bus error reply

Closes #17556.
---

diff --git a/man/sd_bus_call.xml b/man/sd_bus_call.xml
index 2c27f934ac1..3eeccdb63ee 100644
--- a/man/sd_bus_call.xml
+++ b/man/sd_bus_call.xml
@@ -104,7 +104,12 @@
     <refsect2 id='errors'>
       <title>Errors</title>
 
-      <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems. When
+      <function>sd_bus_call()</function> internally receives a D-Bus error reply, it will set
+      <parameter>ret_error</parameter> if it is not <constant>NULL</constant>, and will return a
+      negative value mapped from the error reply. See
+      <citerefentry><refentrytitle>sd_bus_error_get_errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
+      </para>
 
       <variablelist>
         <varlistentry>
@@ -180,7 +185,8 @@
       <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_bus_call_method_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+      <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     </para>
   </refsect1>