From 00fa7a8def826d2a4c8fb9e2c38208103bf04341 Mon Sep 17 00:00:00 2001
From: Rickard Green <rickard@erlang.org>
Date: Sat, 23 Feb 2019 18:59:06 +0100
Subject: Document deprecations and removals

---
 lib/erl_interface/doc/src/ref_man_ei.xml | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

(limited to 'lib/erl_interface/doc/src/ref_man_ei.xml')

diff --git a/lib/erl_interface/doc/src/ref_man_ei.xml b/lib/erl_interface/doc/src/ref_man_ei.xml
index 92ff9ed328..d8d1deaea1 100644
--- a/lib/erl_interface/doc/src/ref_man_ei.xml
+++ b/lib/erl_interface/doc/src/ref_man_ei.xml
@@ -30,8 +30,14 @@
     <file>ref_man_ei.xml</file>
   </header>
   <description>
-    <p>The <c>ei</c> library is a <c>C</c> interface library for
-      communication with <c>Erlang</c>.</p>
+    <note><p>The support for VxWorks is deprecated as of OTP 22, and
+    will be removed in OTP 23.</p></note>
+    <note><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></note>
     <note>
       <p>By default, the <c>ei</c> library is only guaranteed
         to be compatible with other Erlang/OTP components from the same
-- 
cgit v1.2.3