From 37db22d38bdc1dbe1eb8cd1df511bdd89dab2b85 Mon Sep 17 00:00:00 2001
From: Yu Watanabe <watanabe.yu+github@gmail.com>
Date: Wed, 16 Sep 2026 19:42:38 +0900
Subject: [PATCH] man: fix function arguments for
 sd_bus_message_append_string_memfd() and friends

Then, added explanations for the missing arguments. Also mentioned that
the memfd is sealed by the function.

(cherry picked from commit 20604d980057da1a606339fb7a660242e8d2db02)
---
 man/sd_bus_message_append_string_memfd.xml | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/man/sd_bus_message_append_string_memfd.xml b/man/sd_bus_message_append_string_memfd.xml
index 750a2eedca..3d18979556 100644
--- a/man/sd_bus_message_append_string_memfd.xml
+++ b/man/sd_bus_message_append_string_memfd.xml
@@ -32,6 +32,8 @@
         <funcdef>int sd_bus_message_append_string_memfd</funcdef>
         <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
         <paramdef>int <parameter>memfd</parameter></paramdef>
+        <paramdef>uint64_t <parameter>offset</parameter></paramdef>
+        <paramdef>uint64_t <parameter>size</parameter></paramdef>
       </funcprototype>
 
       <funcprototype>
@@ -45,7 +47,7 @@
         <funcdef>int sd_bus_message_append_string_space</funcdef>
         <paramdef>sd_bus_message *<parameter>m</parameter></paramdef>
         <paramdef>size_t <parameter>size</parameter></paramdef>
-        <paramdef>char **<parameter>s</parameter></paramdef>
+        <paramdef>char **<parameter>ret</parameter></paramdef>
       </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>
@@ -59,11 +61,17 @@
     used to append a single string (item of type <literal>s</literal>)
     to message <parameter>m</parameter>.</para>
 
-    <para>In case of
-    <function>sd_bus_message_append_string_memfd()</function>, the
-    contents of <parameter>memfd</parameter> are the string. They must
-    satisfy the same constraints as described for the
-    <literal>s</literal> type in
+    <para>In case of <function>sd_bus_message_append_string_memfd()</function>, the contents of
+    <parameter>memfd</parameter> starting at the specified <parameter>offset</parameter> and of the specified
+    <parameter>size</parameter> are used as the string. <parameter>size</parameter> must include the
+    terminating <constant>NUL</constant> byte, i.e. the resulting string has length
+    <parameter>size</parameter> - 1. If <parameter>offset</parameter> is zero and <parameter>size</parameter>
+    is <constant>UINT64_MAX</constant>, the full contents of the memory file descriptor are used, and hence
+    must themselves end in a <constant>NUL</constant> byte. If <parameter>offset</parameter> plus
+    <parameter>size</parameter> exceeds the actual size of the memory file descriptor, this call fails with
+    <constant>-EMSGSIZE</constant>. The memory file descriptor is sealed by this call if it has not been
+    sealed yet, and cannot be modified after this call. The appended contents must satisfy the same
+    constraints as described for the <literal>s</literal> type in
     <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
 
     <para>In case of
@@ -89,7 +97,7 @@
     similar to <function>sd_bus_message_append_basic()</function> with
     type <literal>s</literal>, but instead of copying a string into
     the message, it returns a pointer to the destination area to
-    the caller in pointer <parameter>p</parameter>. Space for the string
+    the caller in pointer <parameter>ret</parameter>. Space for the string
     of length <parameter>size</parameter> plus the terminating
     <constant>NUL</constant> is allocated.</para>
   </refsect1>