From 15aaf359c770d302bef57482c13341646ef275cd Mon Sep 17 00:00:00 2001
From: Anthony Ramine <n.oxyde@gmail.com>
Date: Wed, 22 Nov 2017 22:24:45 +0100
Subject: Document alignment guarantees of enif_alloc and enif_realloc

---
 erts/doc/src/erl_nif.xml | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'erts')

diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml
index 88eb6725cb..ef3cdb89e9 100644
--- a/erts/doc/src/erl_nif.xml
+++ b/erts/doc/src/erl_nif.xml
@@ -952,6 +952,8 @@ typedef struct {
       <desc>
         <p>Allocates memory of <c>size</c> bytes.</p>
         <p>Returns <c>NULL</c> if the allocation fails.</p>
+        <p>The returned pointer is suitably aligned for any built-in type that
+          fit in the allocated memory.</p>
       </desc>
     </func>
 
@@ -2768,6 +2770,8 @@ enif_map_iterator_destroy(env, &amp;iter);</code>
           <seealso marker="#enif_alloc"><c>enif_alloc</c></seealso> to
           <c>size</c> bytes.</p>
         <p>Returns <c>NULL</c> if the reallocation fails.</p>
+        <p>The returned pointer is suitably aligned for any built-in type that
+          fit in the allocated memory.</p>
       </desc>
     </func>
 
-- 
cgit v1.2.3