man: clarify that we decode D-Bus bools as "int", not as C99 "bool"

Fixes: #14643

diff --git a/man/sd_bus_message_read.xml b/man/sd_bus_message_read.xml
index aa3cffb43269a58af194569938376a692fd9dbb6..2afa44174229bba1e687e418bd13508462f790d4 100644 (file)
--- a/man/sd_bus_message_read.xml
+++ b/man/sd_bus_message_read.xml
@@ -174,6 +174,14 @@ int64_t x;
 
 sd_bus_message_read(m, "x", &amp;x);</programlisting>
 
+    <para>Read a boolean value:</para>
+
+    <programlisting>sd_bus_message *m;
+int x; /* Do not use C99 'bool' type here, it's typically smaller
+          in memory and would cause memory corruption */
+
+sd_bus_message_read(m, "b", &amp;x);</programlisting>
+
     <para>Read all types of integers:</para>
 
     <programlisting>uint8_t y;

diff --git a/man/sd_bus_message_read_basic.xml b/man/sd_bus_message_read_basic.xml
index 92574f70917bf516ec809b7c31614dcac087afd4..0502976dce48701d333996dd86ee5f62e30e578b 100644 (file)
--- a/man/sd_bus_message_read_basic.xml
+++ b/man/sd_bus_message_read_basic.xml
@@ -93,7 +93,7 @@
             <entry><literal>b</literal></entry>
             <entry><constant>SD_BUS_TYPE_BOOLEAN</constant></entry>
             <entry>boolean</entry>
-            <entry><type>int *</type></entry>
+            <entry><type>int *</type> (NB: not <type>bool *</type>)</entry>
           </row>
 
           <row>