chiark / gitweb /
importd: enable btrfs quota in /var/lib/machines, if necessary
[elogind.git] / man / sd_bus_message_append_array.xml
index fe84671f3e6dffc3612b6594d388fb53b83f3910..fe81affdc4313683e9bbbfffbf1bd766b81d3da8 100644 (file)
@@ -1,4 +1,4 @@
-<?xml version='1.0'?> <!--*-nxml-*-->
+<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
@@ -68,7 +68,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <funcdef>int sd_bus_message_append_array_memfd</funcdef>
         <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
         <paramdef>char <parameter>type</parameter></paramdef>
-        <paramdef>sd_memfd *<parameter>memfd</parameter></paramdef>
+        <paramdef>int <parameter>memfd</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
@@ -91,7 +91,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
   <refsect1>
     <title>Description</title>
 
-    <para>Function <function>sd_bus_message_append_array</function>
+    <para>The <function>sd_bus_message_append_array</function> functionc
     appends items to message <parameter>m</parameter> as the single
     array. A container will be opened, items appended, and the
     container closed. Parameter <parameter>type</parameter> determines
@@ -104,7 +104,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html#basic-types">Basic Types</ulink>
     section of the D-Bus specification, and listed in
     <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
-    Pointer <parameter>p</parameter> must point to an array of of size
+    Pointer <parameter>p</parameter> must point to an array of size
     <parameter>size</parameter> bytes containing items of the
     respective type. Size <parameter>size</parameter> must be a
     multiple of the size of the type <parameter>type</parameter>. As a
@@ -116,19 +116,19 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     into the memory area containing the message and may be changed
     after this call.</para>
 
-    <para>Function
-    <function>sd_bus_message_append_array_memfd</function> appends
+    <para>The
+    <function>sd_bus_message_append_array_memfd</function> function appends
     items to message <parameter>m</parameter>, similarly to
     <function>sd_bus_message_append_array</function>. Contents of the
     memory file descriptor <parameter>memfd</parameter> are used as
     the contents of the array. Their size must be a multiple of the
     size of the type <parameter>type</parameter>.</para>
 
-    <para>Descriptor <parameter>memfd</parameter> will be sealed
-    and cannot be modified after this call.</para>
+    <para>The descriptor specified with <parameter>memfd</parameter>
+    will be sealed and cannot be modified after this call.</para>
 
-    <para>Function
-    <function>sd_bus_message_append_array_iovec</function> appends
+    <para>The
+    <function>sd_bus_message_append_array_iovec</function> function appends
     items to message <parameter>m</parameter>, similarly to
     <function>sd_bus_message_append_array</function>. Contents of the
     iovec <parameter>iov</parameter> are used as the contents of the
@@ -136,7 +136,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     sum of <structfield>iov_len</structfield> fields) must be a multiple
     of the size of the type <parameter>type</parameter>.</para>
 
-    <para>Pointer <parameter>iov</parameter> must point to
+    <para>The <parameter>iov</parameter> argument must point to
     <parameter>n</parameter> <structname>struct iovec</structname>
     structures. Each structure may have the
     <structname>iov_base</structname> field set, in which case the
@@ -146,8 +146,8 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     memory pointed at by <parameter>iov</parameter> may be changed
     after this call.</para>
 
-    <para>Function
-    <function>sd_bus_message_append_array_space</function> appends
+    <para>The
+    <function>sd_bus_message_append_array_space</function> function appends
     space for an array of items to message <parameter>m</parameter>.
     It behaves the same as
     <function>sd_bus_message_append_array</function>, but instead
@@ -159,7 +159,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, those calls return 0 or a positive integer. On
+    <para>On success, these calls return 0 or a positive integer. On
     failure, they returns a negative errno-style error code.</para>
   </refsect1>
 
@@ -171,7 +171,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><function>sd_bus_append_array()</function> and other
     functions described here are available as a shared library, which
     can be compiled and linked to with the
-    <constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
     file.</para>
   </refsect1>