diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2022-06-13 10:11:22 +0200 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2022-06-30 10:35:27 +0200 |
commit | 870c2aaf8cc21d9e096d4d26421fd651cad9d019 (patch) | |
tree | fb1aee94fecd2dee83c7de8d97ad1071143ed73a | |
parent | meson: update man-generation rules for sd_hwdb_new_from_path (diff) | |
download | systemd-870c2aaf8cc21d9e096d4d26421fd651cad9d019.tar.xz systemd-870c2aaf8cc21d9e096d4d26421fd651cad9d019.zip |
man: document sd_bus_error_setfv()
The description for sd_bus_error_set_errnof/sd_bus_error_set_errnofv are
adjusted to use the same pattern.
-rw-r--r-- | man/rules/meson.build | 3 | ||||
-rw-r--r-- | man/sd_bus_error.xml | 43 |
2 files changed, 29 insertions, 17 deletions
diff --git a/man/rules/meson.build b/man/rules/meson.build index e7fe10dceb..48da2f8f8c 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -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', diff --git a/man/sd_bus_error.xml b/man/sd_bus_error.xml index d8f3317e29..6f5e9e4b97 100644 --- a/man/sd_bus_error.xml +++ b/man/sd_bus_error.xml @@ -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> @@ -75,6 +76,14 @@ </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> <paramdef>const char *<parameter>name</parameter></paramdef> @@ -196,11 +205,15 @@ 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 @@ -223,17 +236,15 @@ 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> |