diff options
| author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2018-07-27 17:47:17 +0200 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2018-08-02 15:49:45 +0200 |
| commit | 9905256523a396ea80b34809e836af4b30c1a67a (patch) | |
| tree | 8d35b8f5135adb63a975f72730bcf981e476ed5f | |
| parent | 2c48865bd005591113a49a3914172473e0f9618f (diff) | |
| download | systemd-9905256523a396ea80b34809e836af4b30c1a67a.tar.gz | |
man: document sd_bus_message_get_bus() in sd_bus_message_new(3)
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.
| -rw-r--r-- | man/rules/meson.build | 1 | ||||
| -rw-r--r-- | man/sd_bus_message_new.xml | 11 |
2 files changed, 12 insertions, 0 deletions
diff --git a/man/rules/meson.build b/man/rules/meson.build index acd8710ff0..b249adc48f 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -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'], diff --git a/man/sd_bus_message_new.xml b/man/sd_bus_message_new.xml index e7cb0c5791..78bca8a89c 100644 --- a/man/sd_bus_message_new.xml +++ b/man/sd_bus_message_new.xml @@ -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> @@ -59,6 +60,11 @@ <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> @@ -117,6 +123,9 @@ 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> @@ -130,6 +139,8 @@ <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> |