]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: document sd_bus_error_setfv()
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Mon, 13 Jun 2022 08:11:22 +0000 (10:11 +0200)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Thu, 30 Jun 2022 08:35:27 +0000 (10:35 +0200)
The description for sd_bus_error_set_errnof/sd_bus_error_set_errnofv are
adjusted to use the same pattern.

man/rules/meson.build
man/sd_bus_error.xml

index e7fe10dcebce55c1d3750e81e21d398784e18025..48da2f8f8c1ccadb3c45ccc35b8c201fc47ca01e 100644 (file)
@@ -267,7 +267,8 @@ manpages = [
    'sd_bus_error_set_errno',
    'sd_bus_error_set_errnof',
    'sd_bus_error_set_errnofv',
-   'sd_bus_error_setf'],
+   'sd_bus_error_setf',
+   'sd_bus_error_setfv'],
   ''],
  ['sd_bus_error_add_map',
   '3',
index d8f3317e29a1ba1578846b19e8a651aa358a9354..6f5e9e4b97b51eb98d4649ea2eb9f97f70756e89 100644 (file)
@@ -22,6 +22,7 @@
     <refname>sd_bus_error_free</refname>
     <refname>sd_bus_error_set</refname>
     <refname>sd_bus_error_setf</refname>
+    <refname>sd_bus_error_setfv</refname>
     <refname>sd_bus_error_set_const</refname>
     <refname>sd_bus_error_set_errno</refname>
     <refname>sd_bus_error_set_errnof</refname>
         <paramdef>…</paramdef>
       </funcprototype>
 
+      <funcprototype>
+        <funcdef>int <function>sd_bus_error_setfv</function></funcdef>
+        <paramdef>sd_bus_error *<parameter>e</parameter></paramdef>
+        <paramdef>const char *<parameter>name</parameter></paramdef>
+        <paramdef>const char *<parameter>format</parameter></paramdef>
+        <paramdef>va_list <parameter>ap</parameter></paramdef>
+      </funcprototype>
+
       <funcprototype>
         <funcdef>int <function>sd_bus_error_set_const</function></funcdef>
         <paramdef>sd_bus_error *<parameter>e</parameter></paramdef>
     which case an <constant>SD_BUS_ERROR_NO_MEMORY</constant> error will be set instead and
     <constant>-ENOMEM</constant> returned. </para>
 
-    <para><function>sd_bus_error_setf()</function> is similar to
-    <function>sd_bus_error_set()</function>, but takes a <citerefentry
-    project='man-pages'><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>
-    format string and corresponding arguments to generate the
-    <structfield>message</structfield> field.</para>
+    <para><function>sd_bus_error_setf()</function> and <function>sd_bus_error_setfv()</function> are similar
+    to <function>sd_bus_error_set()</function>, but take a <citerefentry
+    project='man-pages'><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry> format
+    string and corresponding arguments to generate the <structfield>message</structfield> field.
+    <function>sd_bus_error_setf()</function> uses variadic arguments, and
+    <function>sd_bus_error_setfv()</function> accepts the arguments as a
+    <citerefentry
+    project='man-pages'><refentrytitle>va_arg</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    parameter list.</para>
 
     <para><function>sd_bus_error_set_const()</function> is similar to
     <function>sd_bus_error_set()</function>, but the string parameters are not copied internally, and must
     due to lack of memory, in which case an <constant>SD_BUS_ERROR_NO_MEMORY</constant> error is set instead,
     and <constant>-ENOMEM</constant> is returned.</para>
 
-    <para><function>sd_bus_error_set_errnof()</function> is similar to
-    <function>sd_bus_error_set_errno()</function>, but in addition to
-    <parameter>error</parameter>, takes a <citerefentry
-    project='man-pages'><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>
-    format string and corresponding arguments.  The
-    <structfield>message</structfield> field will be generated from
-    <parameter>format</parameter> and the arguments.</para>
-
-    <para><function>sd_bus_error_set_errnofv()</function> is similar to
-    <function>sd_bus_error_set_errnof()</function>, but takes the
-    format string parameters as <citerefentry
+    <para><function>sd_bus_error_set_errnof()</function> and <function>sd_bus_error_set_errnof()</function>
+    are similar to <function>sd_bus_error_set_errno()</function>, but in addition to
+    <parameter>error</parameter>, take a <citerefentry
+    project='man-pages'><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry> format
+    string and corresponding arguments. The <structfield>message</structfield> field will be generated from
+    <parameter>format</parameter> and the arguments.
+    <function>sd_bus_error_set_errnof()</function> uses variadic arguments, and
+    <function>sd_bus_error_set_errnofv()</function> accepts the arguments as a
+    <citerefentry
     project='man-pages'><refentrytitle>va_arg</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     parameter list.</para>