picnoir
/
Systemd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

man: document *_with_description functions

This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2018-07-27 09:56:43 +02:00
parent 206ed9c1f6
commit f00ded93e0
2 changed files with 39 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
man/rules/meson.build
View File

@ -166,7 +166,10 @@ manpages = [
'sd_bus_open_system',
'sd_bus_open_system_machine',
'sd_bus_open_system_remote',
'sd_bus_open_user'],
'sd_bus_open_system_with_description',
'sd_bus_open_user',
'sd_bus_open_user_with_description',
'sd_bus_open_with_description'],
''],
['sd_bus_error',
'3',

35
man/sd_bus_default.xml
View File

@ -24,8 +24,11 @@
<refname>sd_bus_default_system</refname>
<refname>sd_bus_open</refname>
<refname>sd_bus_open_with_description</refname>
<refname>sd_bus_open_user</refname>
<refname>sd_bus_open_user_with_description</refname>
<refname>sd_bus_open_system</refname>
<refname>sd_bus_open_system_with_description</refname>
<refname>sd_bus_open_system_remote</refname>
<refname>sd_bus_open_system_machine</refname>
@ -56,16 +59,34 @@
<paramdef>sd_bus **<parameter>bus</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_bus_open_with_description</function></funcdef>
<paramdef>sd_bus **<parameter>bus</parameter></paramdef>
<paramdef>const char *<parameter>description</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_bus_open_user</function></funcdef>
<paramdef>sd_bus **<parameter>bus</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_bus_open_user_with_description</function></funcdef>
<paramdef>sd_bus **<parameter>bus</parameter></paramdef>
<paramdef>const char *<parameter>description</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_bus_open_system</function></funcdef>
<paramdef>sd_bus **<parameter>bus</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_bus_open_system_with_description</function></funcdef>
<paramdef>sd_bus **<parameter>bus</parameter></paramdef>
<paramdef>const char *<parameter>description</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_bus_open_system_remote</function></funcdef>
<paramdef>sd_bus **<parameter>bus</parameter></paramdef>
@ -126,6 +147,20 @@
<function>sd_bus_default_system()</function> to connect to the
user or system buses.</para>
<para><function>sd_bus_open_with_description()</function>,
<function>sd_bus_open_user_with_description()</function>, and
<function>sd_bus_open_system_with_description()</function> are similar to
<function>sd_bus_open()</function>, <function>sd_bus_open_user()</function>, and
<function>sd_bus_open_system()</function>, but allow a description string to be set, see
<citerefentry><refentrytitle>sd_bus_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
<parameter>description</parameter> may be <constant>NULL</constant>, in which case this function
is equivalent to <function>sd_bus_open()</function>. This description string is used in log
messages about the bus object, and including a "name" for the bus makes them easier to
understand. Some messages are emitted during bus initialization, hence using this function is
prefereable to setting the description later with
<function>sd_bus_open_with_description()</function>. The argument is copied internally and will
not be referenced after the function returns.</para>
<para>If the <varname>$DBUS_SESSION_BUS_ADDRESS</varname> environment
variable is set
(cf. <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>),