From 00fa7a8def826d2a4c8fb9e2c38208103bf04341 Mon Sep 17 00:00:00 2001 From: Rickard Green Date: Sat, 23 Feb 2019 18:59:06 +0100 Subject: Document deprecations and removals --- lib/erl_interface/doc/src/ei.xml | 3 +++ lib/erl_interface/doc/src/ei_connect.xml | 3 +++ lib/erl_interface/doc/src/ei_users_guide.xml | 12 ++++++++++++ lib/erl_interface/doc/src/erl_connect.xml | 9 +++++++++ lib/erl_interface/doc/src/erl_eterm.xml | 9 +++++++++ lib/erl_interface/doc/src/erl_global.xml | 9 +++++++++ lib/erl_interface/doc/src/erl_interface.xml | 12 ++++++++++++ lib/erl_interface/doc/src/erl_malloc.xml | 8 ++++++++ lib/erl_interface/doc/src/erl_marshal.xml | 8 ++++++++ lib/erl_interface/doc/src/ref_man.xml | 8 ++++++++ lib/erl_interface/doc/src/ref_man_ei.xml | 10 ++++++++-- lib/erl_interface/doc/src/ref_man_erl_interface.xml | 8 ++++++++ 12 files changed, 97 insertions(+), 2 deletions(-) (limited to 'lib/erl_interface/doc/src') diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml index ae322255ad..2bdb390644 100644 --- a/lib/erl_interface/doc/src/ei.xml +++ b/lib/erl_interface/doc/src/ei.xml @@ -35,6 +35,9 @@ ei Routines for handling the Erlang binary term format. +

The support for VxWorks is deprecated as of OTP 22, and + will be removed in OTP 23.

 +

The library ei contains macros and functions to encode and decode the Erlang binary term format.

diff --git a/lib/erl_interface/doc/src/ei_connect.xml b/lib/erl_interface/doc/src/ei_connect.xml index e318dd6664..df40973270 100644 --- a/lib/erl_interface/doc/src/ei_connect.xml +++ b/lib/erl_interface/doc/src/ei_connect.xml @@ -34,6 +34,9 @@ ei_connect Communicate with distributed Erlang. +

The support for VxWorks is deprecated as of OTP 22, and + will be removed in OTP 23.

 +

This module enables C-programs to communicate with Erlang nodes, using the Erlang distribution over TCP/IP.

diff --git a/lib/erl_interface/doc/src/ei_users_guide.xml b/lib/erl_interface/doc/src/ei_users_guide.xml index 2dfd99e35a..7ca10d1a99 100644 --- a/lib/erl_interface/doc/src/ei_users_guide.xml +++ b/lib/erl_interface/doc/src/ei_users_guide.xml @@ -33,6 +33,18 @@ ei_users_guide.xml +
+ Deprecation and Removal +

The support for VxWorks is deprecated as of OTP 22, and + will be removed in OTP 23.

 +

The old legacy erl_interface library (functions + with prefix erl_) is deprecated as of OTP 22, and will be + removed in OTP 23. This does not apply to the ei + library. Reasonably new gcc compilers will issue deprecation + warnings. In order to disable these warnings, define the macro + EI_NO_DEPR_WARN.

 +
+
Introduction

The Erl_Interface library contains functions that help you diff --git a/lib/erl_interface/doc/src/erl_connect.xml b/lib/erl_interface/doc/src/erl_connect.xml index 139ac9e2f0..9492a82864 100644 --- a/lib/erl_interface/doc/src/erl_connect.xml +++ b/lib/erl_interface/doc/src/erl_connect.xml @@ -35,6 +35,15 @@ erl_connect Communicate with distributed Erlang. +

The support for VxWorks is deprecated as of OTP 22, and + will be removed in OTP 23.

+

The old legacy erl_interface library (functions + with prefix erl_) is deprecated as of OTP 22, and will be + removed in OTP 23. This does not apply to the ei + library. Reasonably new gcc compilers will issue deprecation + warnings. In order to disable these warnings, define the macro + EI_NO_DEPR_WARN.

 +

This module provides support for communication between distributed Erlang nodes and C-nodes, in a manner that is transparent to Erlang processes.

diff --git a/lib/erl_interface/doc/src/erl_eterm.xml b/lib/erl_interface/doc/src/erl_eterm.xml index 070ed30dfe..295760b4e6 100644 --- a/lib/erl_interface/doc/src/erl_eterm.xml +++ b/lib/erl_interface/doc/src/erl_eterm.xml @@ -35,6 +35,15 @@ erl_eterm Functions for Erlang term construction. +

The support for VxWorks is deprecated as of OTP 22, and + will be removed in OTP 23.

 +

The old legacy erl_interface library (functions + with prefix erl_) is deprecated as of OTP 22, and will be + removed in OTP 23. This does not apply to the ei + library. Reasonably new gcc compilers will issue deprecation + warnings. In order to disable these warnings, define the macro + EI_NO_DEPR_WARN.

 +

This module provides functions for creating and manipulating Erlang terms.

diff --git a/lib/erl_interface/doc/src/erl_global.xml b/lib/erl_interface/doc/src/erl_global.xml index 72d43e81d5..39085b46f0 100644 --- a/lib/erl_interface/doc/src/erl_global.xml +++ b/lib/erl_interface/doc/src/erl_global.xml @@ -35,6 +35,15 @@ erl_global Access globally registered names. +

The support for VxWorks is deprecated as of OTP 22, and + will be removed in OTP 23.

 +

The old legacy erl_interface library (functions + with prefix erl_) is deprecated as of OTP 22, and will be + removed in OTP 23. This does not apply to the ei + library. Reasonably new gcc compilers will issue deprecation + warnings. In order to disable these warnings, define the macro + EI_NO_DEPR_WARN.

 +

This module provides support for registering, looking up, and unregistering names in the global module. For more information, see diff --git a/lib/erl_interface/doc/src/erl_interface.xml b/lib/erl_interface/doc/src/erl_interface.xml index 4e66655b39..decd66046a 100644 --- a/lib/erl_interface/doc/src/erl_interface.xml +++ b/lib/erl_interface/doc/src/erl_interface.xml @@ -57,6 +57,18 @@ the registry +

+ Deprecation and Removal +

The support for VxWorks is deprecated as of OTP 22, and + will be removed in OTP 23.

 +

The old legacy erl_interface library (functions + with prefix erl_) is deprecated as of OTP 22, and will be + removed in OTP 23. This does not apply to the ei + library. Reasonably new gcc compilers will issue deprecation + warnings. In order to disable these warnings, define the macro + EI_NO_DEPR_WARN.

 +
+
Compiling and Linking Your Code

In order to use any of the Erl_Interface functions, include the diff --git a/lib/erl_interface/doc/src/erl_malloc.xml b/lib/erl_interface/doc/src/erl_malloc.xml index aae3b7e078..6650620064 100644 --- a/lib/erl_interface/doc/src/erl_malloc.xml +++ b/lib/erl_interface/doc/src/erl_malloc.xml @@ -35,6 +35,14 @@ erl_malloc Memory allocation functions. +

The support for VxWorks is deprecated as of OTP 22, and + will be removed in OTP 23.

+

The old legacy erl_interface library (functions + with prefix erl_) is deprecated as of OTP 22, and will be + removed in OTP 23. This does not apply to the ei + library. Reasonably new gcc compilers will issue deprecation + warnings. In order to disable these warnings, define the macro + EI_NO_DEPR_WARN.

This module provides functions for allocating and deallocating memory.

diff --git a/lib/erl_interface/doc/src/erl_marshal.xml b/lib/erl_interface/doc/src/erl_marshal.xml index 1a6d3bb43c..33d359d871 100644 --- a/lib/erl_interface/doc/src/erl_marshal.xml +++ b/lib/erl_interface/doc/src/erl_marshal.xml @@ -35,6 +35,14 @@ erl_marshal Encoding and decoding of Erlang terms. +

The support for VxWorks is deprecated as of OTP 22, and + will be removed in OTP 23.

 +

The old legacy erl_interface library (functions + with prefix erl_) is deprecated as of OTP 22, and will be + removed in OTP 23. This does not apply to the ei + library. Reasonably new gcc compilers will issue deprecation + warnings. In order to disable these warnings, define the macro + EI_NO_DEPR_WARN.

This module contains functions for encoding Erlang terms into a sequence of bytes, and for decoding Erlang terms from a sequence of bytes.

diff --git a/lib/erl_interface/doc/src/ref_man.xml b/lib/erl_interface/doc/src/ref_man.xml index 1e20637cb7..a4f947c79f 100644 --- a/lib/erl_interface/doc/src/ref_man.xml +++ b/lib/erl_interface/doc/src/ref_man.xml @@ -29,6 +29,14 @@ ref_man.xml +

The support for VxWorks is deprecated as of OTP 22, and + will be removed in OTP 23.

 +

The old legacy erl_interface library (functions + with prefix erl_) is deprecated as of OTP 22, and will be + removed in OTP 23. This does not apply to the ei + library. Reasonably new gcc compilers will issue deprecation + warnings. In order to disable these warnings, define the macro + EI_NO_DEPR_WARN.

 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 @@ ref_man_ei.xml -

The ei library is a C interface library for - communication with Erlang.

+

The support for VxWorks is deprecated as of OTP 22, and + will be removed in OTP 23.

 +

The old legacy erl_interface library (functions + with prefix erl_) is deprecated as of OTP 22, and will be + removed in OTP 23. This does not apply to the ei + library. Reasonably new gcc compilers will issue deprecation + warnings. In order to disable these warnings, define the macro + EI_NO_DEPR_WARN.

By default, the ei library is only guaranteed to be compatible with other Erlang/OTP components from the same diff --git a/lib/erl_interface/doc/src/ref_man_erl_interface.xml b/lib/erl_interface/doc/src/ref_man_erl_interface.xml index 4b1d0e9981..2b69d0fa74 100644 --- a/lib/erl_interface/doc/src/ref_man_erl_interface.xml +++ b/lib/erl_interface/doc/src/ref_man_erl_interface.xml @@ -30,6 +30,14 @@ ref_man_erl_interface.xml +

The support for VxWorks is deprecated as of OTP 22, and + will be removed in OTP 23.

 +

The old legacy erl_interface library (functions + with prefix erl_) is deprecated as of OTP 22, and will be + removed in OTP 23. This does not apply to the ei + library. Reasonably new gcc compilers will issue deprecation + warnings. In order to disable these warnings, define the macro + EI_NO_DEPR_WARN.

The erl_interface library is a C interface library for communication with Erlang.

-- cgit v1.2.3