From: Daan De Meyer <daan.j.demeyer@gmail.com>
Date: Sat, 11 Apr 2020 19:57:36 +0000 (+0200)
Subject: sd-bus: Add sd_bus_set_exec docs
X-Git-Tag: v246-rc1~602^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F15406%2Fhead;p=thirdparty%2Fsystemd.git

sd-bus: Add sd_bus_set_exec docs
---

diff --git a/man/rules/meson.build b/man/rules/meson.build
index 16e0ffca3f7..aa9271a2a04 100644
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -342,7 +342,7 @@ manpages = [
    'sd_bus_request_name_async'],
   ''],
  ['sd_bus_send', '3', [], ''],
- ['sd_bus_set_address', '3', ['sd_bus_get_address'], ''],
+ ['sd_bus_set_address', '3', ['sd_bus_get_address', 'sd_bus_set_exec'], ''],
  ['sd_bus_set_close_on_exit', '3', ['sd_bus_get_close_on_exit'], ''],
  ['sd_bus_set_connected_signal', '3', ['sd_bus_get_connected_signal'], ''],
  ['sd_bus_set_description',
diff --git a/man/sd_bus_set_address.xml b/man/sd_bus_set_address.xml
index b022741ff49..8404da53f1e 100644
--- a/man/sd_bus_set_address.xml
+++ b/man/sd_bus_set_address.xml
@@ -19,6 +19,7 @@
   <refnamediv>
     <refname>sd_bus_set_address</refname>
     <refname>sd_bus_get_address</refname>
+    <refname>sd_bus_set_exec</refname>
 
     <refpurpose>Set or query the address of the bus connection</refpurpose>
   </refnamediv>
@@ -30,15 +31,21 @@
       <funcprototype>
         <funcdef>int <function>sd_bus_set_address</function></funcdef>
         <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
-        <paramdef>const char* <parameter>address</parameter></paramdef>
+        <paramdef>const char *<parameter>address</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
         <funcdef>int <function>sd_bus_get_address</function></funcdef>
         <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
-        <paramdef>const char** <parameter>address</parameter></paramdef>
+        <paramdef>const char **<parameter>address</parameter></paramdef>
       </funcprototype>
 
+      <funcprototype>
+        <funcdef>int <function>sd_bus_set_exec</function></funcdef>
+        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
+        <paramdef>const char *<parameter>path</parameter></paramdef>
+        <paramdef>char *const *<parameter>argv</parameter></paramdef>
+      </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>
 
@@ -68,13 +75,13 @@
         the rest is optional. <replaceable>family</replaceable> may be either <option>ipv4</option> or
         <option>ipv6</option>.</para>
       </listitem>
-      
+
       <listitem>
         <para>An executable to spawn specified as
         <literal>unixexec:guid=<replaceable>guid</replaceable>,path=<replaceable>path</replaceable>,argv1=<replaceable>argument</replaceable>,argv2=<replaceable>argument</replaceable>,...</literal>.
         The <varname>path=</varname> key must be present, while <varname>guid=</varname> is optional.</para>
       </listitem>
-      
+
       <listitem>
         <para>A machine (container) to connect to specified as
         <literal>x-machine-unix:guid=<replaceable>guid</replaceable>,machine=<replaceable>machine</replaceable>,pid=<replaceable>pid</replaceable></literal>.
@@ -104,6 +111,11 @@
     automatically by
     <citerefentry><refentrytitle>sd_bus_open</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
     similar calls, based on environment variables or built-in defaults.</para>
+
+    <para><function>sd_bus_set_exec</function> is a shorthand function for setting a
+    <literal>unixexec</literal> address that spawns the given executable with the given arguments.
+    If <parameter>argv</parameter> is <constant>NULL</constant>, the given executable is spawned
+    without any extra arguments.</para>
   </refsect1>
 
   <refsect1>