@@@ doc wip

[mLib] / utils / gprintf.3.in

diff --git a/utils/gprintf.3.in b/utils/gprintf.3.in
index c086f85efdde80c04182048e72231d204367a716..a50af8e488af0a3ae138cd258dbefec77b55b941 100644 (file)
--- a/utils/gprintf.3.in
+++ b/utils/gprintf.3.in
@@ -179,11 +179,15 @@ function is a utility for implementing
 .B nputf
 operations.
 On entry,
+.I a
+should be a pointer to an arena,
+typically
+.BR arena_global (3);
 .BI * buf_inout
 should be a pointer to a buffer of
 .BI * sz_inout
-bytes, allocated from
-.BR arena_global (3);
+bytes, allocated from the arena
+.IR a ;
 instead,
 .BI * buf_inout
 may be null
@@ -207,8 +211,6 @@ and return the actual output length.
 The function is designed to be efficient when called multiple times,
 retaining the same buffer across calls,
 resizing it as necessary in a geometric progression.
-When the buffer is no longer wanted, free it using
-.BR xfree (3).
 .PP
 A typical
 .B nputf