From: Steven G. Johnson <stevenj@alum.mit.edu>
Date: Sat, 22 Nov 2025 14:34:10 +0000 (-0500)
Subject: document that utf8proc_map simply wraps utf8proc_decompose and utf8proc_reencode... 
X-Git-Tag: archive/raspbian/2.11.3-2+rpi1^2~10^2^2~6
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=ae2f2fb5b8d94f5d8e2d977f2072e2d0301a6439;p=utf8proc.git

document that utf8proc_map simply wraps utf8proc_decompose and utf8proc_reencode (#312)
---

diff --git a/utf8proc.h b/utf8proc.h
index 7619949..b43904f 100644
--- a/utf8proc.h
+++ b/utf8proc.h
@@ -750,6 +750,10 @@ UTF8PROC_DLLEXPORT const char *utf8proc_category_string(utf8proc_int32_t codepoi
  *
  * @note The memory of the new UTF-8 string will have been allocated
  * with `malloc`, and should therefore be deallocated with `free`.
+ *
+ * @note `utf8proc_map` simply calls `utf8proc_decompose` followed by `utf8proc_reencode`,
+ * and applications requiring greater control over memory allocation should instead call
+ * those two functions directly.
  */
 UTF8PROC_DLLEXPORT utf8proc_ssize_t utf8proc_map(
   const utf8proc_uint8_t *str, utf8proc_ssize_t strlen, utf8proc_uint8_t **dstptr, utf8proc_option_t options