]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/sd_bus_message_read_basic.xml
man: match parentheses
[thirdparty/systemd.git] / man / sd_bus_message_read_basic.xml
index 101f5d21a4998bf78cebf19314d8faa60ef85d55..e1e993434ac3f5a8b7dd2855b14a8a5c16314ec4 100644 (file)
       If <parameter>p</parameter> is not <constant>NULL</constant>, it should contain
       a pointer to an appropriate object. For example, if <parameter>type</parameter>
       is <constant>'y'</constant>, the object passed in <parameter>p</parameter>
-      should have type <code>uint8_t *</code>. If <parameter>type</parameter> is
+      should have type <type>uint8_t *</type>. If <parameter>type</parameter> is
       <constant>'s'</constant>, the object passed in <parameter>p</parameter> should
-      have type <code>const char **</code>. Note that, if the basic type is a pointer
-      (e.g., <code>const char *</code> in the case of a string), the pointer is only
+      have type <type>const char **</type>. Note that, if the basic type is a pointer
+      (e.g., <type>const char *</type> in the case of a string), the pointer is only
       borrowed and the contents must be copied if they are to be used after the end
       of the messages lifetime. Similarly, during the lifetime of such a pointer, the
       message must not be modified. See the table below for a complete list of allowed
           <row>
             <entry><literal>y</literal></entry>
             <entry><constant>SD_BUS_TYPE_BYTE</constant></entry>
-            <entry>unsigned integer</entry>
-            <entry>uint8_t *</entry>
+            <entry>8bit unsigned integer</entry>
+            <entry><type>uint8_t *</type></entry>
           </row>
 
           <row>
             <entry><literal>b</literal></entry>
             <entry><constant>SD_BUS_TYPE_BOOLEAN</constant></entry>
             <entry>boolean</entry>
-            <entry>int *</entry>
+            <entry><type>int *</type> (NB: not <type>bool *</type>)</entry>
           </row>
 
           <row>
             <entry><literal>n</literal></entry>
             <entry><constant>SD_BUS_TYPE_INT16</constant></entry>
-            <entry>signed integer</entry>
-            <entry>int16_t *</entry>
+            <entry>16bit signed integer</entry>
+            <entry><type>int16_t *</type></entry>
           </row>
 
           <row>
             <entry><literal>q</literal></entry>
             <entry><constant>SD_BUS_TYPE_UINT16</constant></entry>
-            <entry>unsigned integer</entry>
-            <entry>uint16_t *</entry>
+            <entry>16bit unsigned integer</entry>
+            <entry><type>uint16_t *</type></entry>
           </row>
 
           <row>
             <entry><literal>i</literal></entry>
             <entry><constant>SD_BUS_TYPE_INT32</constant></entry>
-            <entry>signed integer</entry>
-            <entry>int32_t *</entry>
+            <entry>32bit signed integer</entry>
+            <entry><type>int32_t *</type></entry>
           </row>
 
           <row>
             <entry><literal>u</literal></entry>
             <entry><constant>SD_BUS_TYPE_UINT32</constant></entry>
-            <entry>unsigned integer</entry>
-            <entry>uint32_t *</entry>
+            <entry>32bit unsigned integer</entry>
+            <entry><type>uint32_t *</type></entry>
           </row>
 
           <row>
             <entry><literal>x</literal></entry>
             <entry><constant>SD_BUS_TYPE_INT64</constant></entry>
-            <entry>signed integer</entry>
-            <entry>int64_t *</entry>
+            <entry>64bit signed integer</entry>
+            <entry><type>int64_t *</type></entry>
           </row>
 
           <row>
             <entry><literal>t</literal></entry>
             <entry><constant>SD_BUS_TYPE_UINT64</constant></entry>
-            <entry>unsigned integer</entry>
-            <entry>uint64_t *</entry>
+            <entry>64bit unsigned integer</entry>
+            <entry><type>uint64_t *</type></entry>
           </row>
 
           <row>
             <entry><literal>d</literal></entry>
             <entry><constant>SD_BUS_TYPE_DOUBLE</constant></entry>
-            <entry>floating-point</entry>
-            <entry>double *</entry>
+            <entry>IEEE 754 double precision floating-point</entry>
+            <entry><type>double *</type></entry>
           </row>
 
           <row>
             <entry><literal>s</literal></entry>
             <entry><constant>SD_BUS_TYPE_STRING</constant></entry>
-            <entry>Unicode string</entry>
-            <entry>const char **</entry>
+            <entry>UTF-8 string</entry>
+            <entry><type>const char **</type></entry>
           </row>
 
           <row>
             <entry><literal>o</literal></entry>
             <entry><constant>SD_BUS_TYPE_OBJECT_PATH</constant></entry>
-            <entry>object path</entry>
-            <entry>const char **</entry>
+            <entry>D-Bus object path string</entry>
+            <entry><type>const char **</type></entry>
           </row>
 
           <row>
             <entry><literal>g</literal></entry>
             <entry><constant>SD_BUS_TYPE_SIGNATURE</constant></entry>
-            <entry>signature</entry>
-            <entry>const char **</entry>
+            <entry>D-Bus signature string</entry>
+            <entry><type>const char **</type></entry>
           </row>
 
           <row>
             <entry><literal>h</literal></entry>
             <entry><constant>SD_BUS_TYPE_UNIX_FD</constant></entry>
             <entry>UNIX file descriptor</entry>
-            <entry>int *</entry>
+            <entry><type>int *</type></entry>
           </row>
        </tbody>
       </tgroup>