From 165b8455d4bf2e3797008a9ad8496b203d017474 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?John=20H=C3=B6gberg?= <john@erlang.org>
Date: Mon, 19 Feb 2018 19:40:10 +0100
Subject: Suggest using enif_make_new_binary when possible

While enif_make_binary will create heap-binaries from ErlNifBinaries
when possible now, enif_alloc_binary still allocates a Binary* off-heap
which is avoided entirely with enif_make_new_binary.
---
 erts/doc/src/erl_nif.xml | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'erts/doc')

diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml
index 23f0c66429..9655fcd994 100644
--- a/erts/doc/src/erl_nif.xml
+++ b/erts/doc/src/erl_nif.xml
@@ -974,6 +974,10 @@ typedef struct {
           <seealso marker="#enif_make_binary"><c>enif_make_binary</c></seealso>.
           An allocated (and owned) <c>ErlNifBinary</c> can be kept between NIF
           calls.</p>
+        <p>If you do not need to reallocate or keep the data alive across NIF
+          calls, consider using <seealso marker="#enif_make_new_binary">
+          <c>enif_make_new_binary</c></seealso> instead as it will allocate
+          small binaries on the process heap when possible.</p>
         <p>Returns <c>true</c> on success, or <c>false</c> if allocation
           fails.</p>
       </desc>
-- 
cgit v1.2.3