From 425889ba69b69a9b6fb14bfbef121d51b78e853a Mon Sep 17 00:00:00 2001
From: Erlang/OTP <otp@erlang.org>
Date: Tue, 23 Apr 2019 17:38:37 +0200
Subject: Prepare release

---
 lib/erl_interface/doc/src/ei.xml    |  6 +--
 lib/erl_interface/doc/src/notes.xml | 76 +++++++++++++++++++++++++++++++++++++
 2 files changed, 79 insertions(+), 3 deletions(-)

(limited to 'lib/erl_interface/doc')

diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml
index 254ae27cc8..18f74d2655 100644
--- a/lib/erl_interface/doc/src/ei.xml
+++ b/lib/erl_interface/doc/src/ei.xml
@@ -183,7 +183,7 @@ typedef enum {
       </func>
 
       <func>
-          <name since="OTP @OTP-15712@"><ret>int</ret><nametext>ei_decode_bitstring(const char *buf, int *index, void *p, size_t plen, size_t *bitsp)</nametext></name>
+          <name since="OTP 22.0"><ret>int</ret><nametext>ei_decode_bitstring(const char *buf, int *index, void *p, size_t plen, size_t *bitsp)</nametext></name>
           <fsummary>Decode a bitstring.</fsummary>
           <desc>
             <p>Decodes a bitstring from the binary format.</p>
@@ -490,8 +490,8 @@ typedef enum {
     </func>
 
     <func>
-      <name since="OTP @OTP-15712@"><ret>int</ret><nametext>ei_encode_bitstring(char *buf, int *index, const void *p, size_t bits)</nametext></name>
-      <name since="OTP @OTP-15712@"><ret>int</ret><nametext>ei_x_encode_bitstring(ei_x_buff* x, const void *p, size_t bits)</nametext></name>
+      <name since="OTP 22.0"><ret>int</ret><nametext>ei_encode_bitstring(char *buf, int *index, const void *p, size_t bits)</nametext></name>
+      <name since="OTP 22.0"><ret>int</ret><nametext>ei_x_encode_bitstring(ei_x_buff* x, const void *p, size_t bits)</nametext></name>
       <fsummary>Encode a bitstring.</fsummary>
       <desc>
         <p>Encodes a bitstring in the binary format. The data is at
diff --git a/lib/erl_interface/doc/src/notes.xml b/lib/erl_interface/doc/src/notes.xml
index fc6a1bb548..f6c4c68cb1 100644
--- a/lib/erl_interface/doc/src/notes.xml
+++ b/lib/erl_interface/doc/src/notes.xml
@@ -31,6 +31,82 @@
   </header>
   <p>This document describes the changes made to the Erl_interface application.</p>
 
+<section><title>Erl_Interface 3.12</title>
+
+    <section><title>Fixed Bugs and Malfunctions</title>
+      <list>
+        <item>
+          <p>
+	    The vxworks configure has been updated to respect the
+	    environment CFLAGS.</p>
+          <p>
+	    Own Id: OTP-15773</p>
+        </item>
+      </list>
+    </section>
+
+
+    <section><title>Improvements and New Features</title>
+      <list>
+        <item>
+          <p>
+	    Minor adjustments made to build system for parallel
+	    configure.</p>
+          <p>
+	    Own Id: OTP-15340 Aux Id: OTP-14625 </p>
+        </item>
+        <item>
+          <p>
+	    The limited support for VxWorks is deprecated as of OTP
+	    22, and will be removed in OTP 23.</p>
+          <p>
+	    *** POTENTIAL INCOMPATIBILITY ***</p>
+          <p>
+	    Own Id: OTP-15621</p>
+        </item>
+        <item>
+	    <p>The old legacy <c>erl_interface</c> library (functions
+	    with prefix <c>erl_</c>) is deprecated as of OTP 22, and
+	    will be removed in OTP 23. This does not apply to the
+	    <c>ei</c> library. Reasonably new <c>gcc</c> compilers
+	    will issue deprecation warnings. In order to disable
+	    these warnings, define the macro
+	    <c>EI_NO_DEPR_WARN</c>.</p>
+          <p>
+	    *** POTENTIAL INCOMPATIBILITY ***</p>
+          <p>
+	    Own Id: OTP-15622</p>
+        </item>
+        <item>
+	    <p>Added support to receive, decode, encode and send both
+	    bit strings and export funs (<c>fun M:F/A</c>).</p>
+	    <p>New functions <c>ei_decode_bitstring</c> and
+	    <c>ei_encode_bitstring</c> have been added in order to
+	    decode and encode bit strings where number of bits is not
+	    necessary divisible by 8 (a whole number of bytes). The
+	    existing functions <c>ei_decode_fun</c> and
+	    <c>ei_encode_fun</c> can now also handle export funs.</p>
+	    <p>Before this change, bit strings and export funs sent
+	    to an erl_interface c-node were encoded using an
+	    undocumented fallback tuple format. For bit strings
+	    <c>{Binary,BitsInLastByte}</c> and for export funs
+	    <c>{M,F}</c>. Existing c-node implementations expecting
+	    these tuples must be changed to instead use
+	    <c>ei_decode_bitstring</c> and <c>ei_decode_fun</c>. As a
+	    temporary solution you can also build erl_interface with
+	    macro <c>EI_COMPAT=21</c> or call
+	    <c>ei_set_compat_rel(21)</c> to receive the old fallback
+	    tuples.</p>
+          <p>
+	    *** POTENTIAL INCOMPATIBILITY ***</p>
+          <p>
+	    Own Id: OTP-15712 Aux Id: OTP-15774 </p>
+        </item>
+      </list>
+    </section>
+
+</section>
+
 <section><title>Erl_Interface 3.11.2</title>
 
     <section><title>Fixed Bugs and Malfunctions</title>
-- 
cgit v1.2.3