]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: document sd_bus_message_get_bus() in sd_bus_message_new(3)
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Fri, 27 Jul 2018 15:47:17 +0000 (17:47 +0200)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Thu, 2 Aug 2018 13:49:45 +0000 (15:49 +0200)
It's not a particularly obvious place, but it's a trivial function that isn't
worth a man page of its own, and it doesn't fit anywhere else either.

man/rules/meson.build
man/sd_bus_message_new.xml

index acd8710ff0728709ca18d35211d2fbf8afab2f5f..b249adc48f52b9012d195f4fb57c838bb3e39ad9 100644 (file)
@@ -225,6 +225,7 @@ manpages = [
    'SD_BUS_MESSAGE_METHOD_ERROR',
    'SD_BUS_MESSAGE_METHOD_RETURN',
    'SD_BUS_MESSAGE_SIGNAL',
+   'sd_bus_message_get_bus',
    'sd_bus_message_ref',
    'sd_bus_message_unref',
    'sd_bus_message_unrefp'],
index e7cb0c57913bf7b8164e56220216f1da917b8537..78bca8a89cd79f29ffa9a2ac7a5393f0737fc222 100644 (file)
@@ -23,6 +23,7 @@
     <refname>SD_BUS_MESSAGE_METHOD_RETURN</refname>
     <refname>SD_BUS_MESSAGE_METHOD_ERROR</refname>
     <refname>SD_BUS_MESSAGE_SIGNAL</refname>
+    <refname>sd_bus_message_get_bus</refname>
 
     <refpurpose>Create a new bus message object and create or destroy references to it</refpurpose>
   </refnamediv>
         <funcdef>void <function>sd_bus_message_unrefp</function></funcdef>
         <paramdef>sd_bus_message **<parameter>mp</parameter></paramdef>
       </funcprototype>
+
+      <funcprototype>
+        <funcdef>sd_bus *<function>sd_bus_message_get_bus</function></funcdef>
+        <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
+      </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>
 
     its argument, which must not be <constant>NULL</constant>, and will execute no operation if
     <emphasis>that</emphasis> is <constant>NULL</constant>.
     </para>
+
+    <para><function>sd_bus_message_get_bus()</function> returns the bus object that message
+    <parameter>m</parameter> is attached to.</para>
   </refsect1>
 
   <refsect1>
 
     <para><function>sd_bus_message_unref()</function> always returns
     <constant>NULL</constant>.</para>
+
+    <para><function>sd_bus_message_get_bus()</function> always returns the bus object.</para>
   </refsect1>
 
   <refsect1>