From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Fri, 27 Jul 2018 12:07:02 +0000 (+0200)
Subject: man: document sd_bus_message_new_method_return
X-Git-Tag: v240~868^2~10
X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fsystemd.git;a=commitdiff_plain;h=7ddee2171627d6ce059a6a66b46b0b4367b77bd5

man: document sd_bus_message_new_method_return
---

diff --git a/man/rules/meson.build b/man/rules/meson.build
index 8a69d046bf6..7ddd415c58f 100644
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -223,7 +223,10 @@ manpages = [
    'sd_bus_message_unref',
    'sd_bus_message_unrefp'],
   ''],
- ['sd_bus_message_new_method_call', '3', [], ''],
+ ['sd_bus_message_new_method_call',
+  '3',
+  ['sd_bus_message_new_method_return'],
+  ''],
  ['sd_bus_message_new_method_error',
   '3',
   ['sd_bus_message_new_method_errno',
diff --git a/man/sd_bus_message_new_method_call.xml b/man/sd_bus_message_new_method_call.xml
index 1226f1050c2..c643177ba47 100644
--- a/man/sd_bus_message_new_method_call.xml
+++ b/man/sd_bus_message_new_method_call.xml
@@ -18,6 +18,7 @@
 
   <refnamediv>
     <refname>sd_bus_message_new_method_call</refname>
+    <refname>sd_bus_message_new_method_return</refname>
 
     <refpurpose>Create a method call message</refpurpose>
   </refnamediv>
@@ -35,6 +36,12 @@
         <paramdef>const char *<parameter>interface</parameter></paramdef>
         <paramdef>const char *<parameter>member</parameter></paramdef>
       </funcprototype>
+
+      <funcprototype>
+        <funcdef>int sd_bus_message_new_method_return</funcdef>
+        <paramdef>sd_bus_message *<parameter>call</parameter></paramdef>
+        <paramdef>sd_bus_message **<parameter>m</parameter></paramdef>
+      </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>
 
@@ -62,6 +69,12 @@
     <parameter>interface</parameter> parameter may be <constant>NULL</constant>, if the destination
     has only a single member with the given name and there is no ambiguity if the interface name is
     omitted.</para>
+
+    <para>The <function>sd_bus_message_new_method_call()</function> function creates a new bus
+    message object that is a reply to the method call <parameter>call</parameter> and returns it in
+    the <parameter>m</parameter> output parameter. The <parameter>call</parameter> parameter must be
+    a method call message. The sender of <parameter>call</parameter> is used as the destination.
+    </para>
   </refsect1>
 
   <refsect1>
@@ -88,7 +101,10 @@
         parameter is not a valid D-Bus path (<literal>/an/object/path</literal>), the
         <parameter>interface</parameter> parameter is non-null and is not a valid D-Bus interface
         name (<literal>an.interface.name</literal>), or the <parameter>member</parameter> parameter
-        is not a valid D-Bus member (<literal>Name</literal>).</para></listitem>
+        is not a valid D-Bus member (<literal>Name</literal>).</para>
+
+        <para>The <parameter>call</parameter> parameter is not a method call object.</para>
+        </listitem>
       </varlistentry>
 
       <varlistentry>
@@ -103,6 +119,22 @@
 
         <listitem><para>Memory allocation failed.</para></listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term><constant>-EPERM</constant></term>
+
+        <listitem>
+        <para>The <parameter>call</parameter> parameter is not sealed.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><constant>-EOPNOTSUPP</constant></term>
+
+        <listitem>
+        <para>The <parameter>call</parameter> message does not have a cookie.</para>
+        </listitem>
+      </varlistentry>
     </variablelist>
   </refsect1>