]> git.ipfire.org Git - thirdparty/man-pages.git/commitdiff
man/man3/wc{,r}tomb.3: wfix regarding MB_CUR_MAX
authorKang-Che Sung <explorer09@gmail.com>
Sun, 16 Mar 2025 18:32:13 +0000 (02:32 +0800)
committerAlejandro Colomar <alx@kernel.org>
Thu, 20 Mar 2025 22:14:45 +0000 (23:14 +0100)
Add the missing length requirement about MB_CUR_MAX to wcrtomb(3).

Change the wording on the MB_CUR_MAX requirement in wctomb(3). If
programmers know the wide character to convert beforehand, they are
allowed to use a buffer smaller than MB_CUR_MAX bytes, as long as it
"fits" the sequence.

Signed-off-by: Kang-Che Sung <explorer09@gmail.com>
Message-ID: <CADDzAfN7_kdv4iQtH=OpgSWtRuqOZXYhxsBiz_OF8Zqf-zy4_Q@mail.gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
man/man3/wcrtomb.3
man/man3/wctomb.3

index 967a1a0f6623bb947f917af6a1632efaa47a8e4d..162d97df888b841a080eeaf55f0524eb9f219436 100644 (file)
@@ -94,6 +94,14 @@ is NULL, a static anonymous
 state known only to the
 .BR wcrtomb ()
 function is used instead.
+.P
+At most
+.B MB_CUR_MAX
+bytes will be written at
+.IR s .
+The programmer must ensure that there is enough room to store the
+multibyte sequence at
+.IR s .
 .SH RETURN VALUE
 The
 .BR wcrtomb ()
index fce54cb4b40812247c04220a297e352c6a920471..643e2e67788154839fab54800976d8b9f95f71ad 100644 (file)
@@ -42,10 +42,12 @@ that is, the number of
 bytes written at
 .IR s .
 .P
-The programmer must ensure that there is
-room for at least
+At most
 .B MB_CUR_MAX
-bytes at
+bytes will be written at
+.IR s .
+The programmer must ensure that there is enough room to store the
+multibyte sequence at
 .IR s .
 .P
 If