diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2018-07-27 08:06:07 +0200 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2018-08-02 15:45:24 +0200 |
commit | 2c47fff6d2d9750ddf9e97fc45714aa8984b5eb6 (patch) | |
tree | 17d7ed111393a2ad8205c1f2068433977f829779 /man/sd_bus_new.xml | |
parent | man: add sd_bus_message_new_call(3) (diff) | |
download | systemd-2c47fff6d2d9750ddf9e97fc45714aa8984b5eb6.tar.xz systemd-2c47fff6d2d9750ddf9e97fc45714aa8984b5eb6.zip |
man: clarify what can be NULL in an sd_bus_unrefp call
Confusingly, the argument is called 'bus' in all cases. Let's not give people
the idea to call sd_bus_unrefp(NULL).
Diffstat (limited to 'man/sd_bus_new.xml')
-rw-r--r-- | man/sd_bus_new.xml | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/man/sd_bus_new.xml b/man/sd_bus_new.xml index b095518f8f..5180ae7815 100644 --- a/man/sd_bus_new.xml +++ b/man/sd_bus_new.xml @@ -48,7 +48,7 @@ <funcprototype> <funcdef>void <function>sd_bus_unrefp</function></funcdef> - <paramdef>sd_bus **<parameter>bus</parameter></paramdef> + <paramdef>sd_bus **<parameter>busp</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -105,10 +105,12 @@ … }</programlisting> - <para><function>sd_bus_ref()</function>, - <function>sd_bus_unref()</function> and - <function>sd_bus_unrefp()</function> execute no operation if the - passed in bus object is <constant>NULL</constant>.</para> + <para><function>sd_bus_ref()</function> and <function>sd_bus_unref()</function> + execute no operation if the passed in bus object address is + <constant>NULL</constant>. <function>sd_bus_unrefp()</function> will first + dereference its argument, which must not be <constant>NULL</constant>, and will + execute no operation if <emphasis>that</emphasis> is <constant>NULL</constant>. + </para> </refsect1> <refsect1> |