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 --- system/doc/Makefile | 1 + system/doc/general_info/Makefile | 100 ++++++++++++++++++++++ system/doc/general_info/book.xml | 44 ++++++++++ system/doc/general_info/deprecations.xml | 77 +++++++++++++++++ system/doc/general_info/part.xml | 34 ++++++++ system/doc/general_info/scheduled_for_removal.xml | 61 +++++++++++++ system/doc/general_info/xmlfiles.mk | 22 +++++ system/doc/system_principles/misc.xml | 8 ++ system/doc/top/Makefile | 5 +- system/doc/top/book.xml | 1 + system/doc/top/templates/index.html.src | 2 + 11 files changed, 354 insertions(+), 1 deletion(-) create mode 100644 system/doc/general_info/Makefile create mode 100644 system/doc/general_info/book.xml create mode 100644 system/doc/general_info/deprecations.xml create mode 100644 system/doc/general_info/part.xml create mode 100644 system/doc/general_info/scheduled_for_removal.xml create mode 100644 system/doc/general_info/xmlfiles.mk (limited to 'system/doc') diff --git a/system/doc/Makefile b/system/doc/Makefile index 0c4adf6554..8f2faeee04 100644 --- a/system/doc/Makefile +++ b/system/doc/Makefile @@ -24,6 +24,7 @@ include $(ERL_TOP)/make/$(TARGET)/otp.mk # SUB_DIRECTORIES = design_principles \ + general_info \ getting_started \ system_architecture_intro \ embedded \ diff --git a/system/doc/general_info/Makefile b/system/doc/general_info/Makefile new file mode 100644 index 0000000000..70db7c525a --- /dev/null +++ b/system/doc/general_info/Makefile @@ -0,0 +1,100 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 1996-2018. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include $(ERL_TOP)/erts/vsn.mk +#VSN=$(SYSTEM_VSN) + +APPLICATION=otp-system-documentation +XMLDIR := $(XMLDIR)/general_info +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = "$(RELEASE_PATH)/doc/general_info" + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- +XML_PART_FILES = part.xml + +include xmlfiles.mk + +XML_CHAPTER_FILES=$(GENERAL_INFO_CHAPTER_FILES) + +TOPDOCDIR=.. + +BOOK_FILES = book.xml + +GIF_FILES = + +XML_FILES = \ + $(BOOK_FILES) $(XML_CHAPTER_FILES) \ + $(XML_PART_FILES) + +# ---------------------------------------------------- + +HTMLDIR = ../html/general_info + +HTML_UG_FILE = $(HTMLDIR)/users_guide.html + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- +XML_FLAGS += +DVIPS_FLAGS += + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +_create_dirs := $(shell mkdir -p $(HTMLDIR)) + +docs: html + +local_docs: PDFDIR=../../pdf + +html: $(GIF_FILES) $(HTML_UG_FILE) + +debug opt: + +clean clean_docs: + rm -rf $(HTMLDIR) + rm -rf $(XMLDIR) + rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) + rm -f errs core *~ + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + +release_docs_spec: docs +# $(INSTALL_DIR) "$(RELEASE_PATH)/pdf" +# $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELEASE_PATH)/pdf" + $(INSTALL_DIR) $(RELSYSDIR) + $(INSTALL_DATA) $(GIF_FILES) $(HTMLDIR)/*.html \ + $(RELSYSDIR) + +release_spec: + diff --git a/system/doc/general_info/book.xml b/system/doc/general_info/book.xml new file mode 100644 index 0000000000..ca9b5fae39 --- /dev/null +++ b/system/doc/general_info/book.xml @@ -0,0 +1,44 @@ + + + + +
+ + 2019 + Ericsson AB. All Rights Reserved. + + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + + + General Information + OTP Team + + 2019-02-23 + + book.xml +
+ + + General Information + + + + + + + + + + diff --git a/system/doc/general_info/deprecations.xml b/system/doc/general_info/deprecations.xml new file mode 100644 index 0000000000..ccfd553bad --- /dev/null +++ b/system/doc/general_info/deprecations.xml @@ -0,0 +1,77 @@ + + + + +
+ + 2019 + Ericsson AB. All Rights Reserved. + + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + + + Deprecations + + + + + deprecations.xml +
+
+ Introduction +

This document aim to list all deprecated functionality in Erlang/OTP. It + was introduced as of OTP 22, and have not yet been updated with all old + deprecations. Deprecations made in other parts of the documentation are of + course still valid. For more information regarding the strategy regarding + deprecations see the documentation of + Support, Compatibility, + Deprecations, and Removal.

+
+
+ + OTP 22 +
+ VxWorks Support +

Some parts of OTP has had limited VxWorks support, such as for + example erl_interface. + This support is now deprecated and has also been + scheduled for removal.

+
+
+ Legacy parts of erl_interface +

The old legacy erl_interface + library (functions with prefix erl_) is deprecated as of OTP 22. These + parts of erl_interface has been informally deprecated + for a very long time. You typically want to replace the usage of + the erl_interface library with the use of the ei library + which also is part of the erl_interface application. The old legacy + erl_interface + library has also been scheduled + for removal.

+
+
+
+ + OTP 18 +
+ erlang:now() +

New time functionality and a new time API was introduced. For more information + see the Time and Time Correction + chapter in the ERTS User's guide and specifically the + Dos and Donts + section on how to replace usage of erlang:now().

+
+
+ diff --git a/system/doc/general_info/part.xml b/system/doc/general_info/part.xml new file mode 100644 index 0000000000..fead7d58e7 --- /dev/null +++ b/system/doc/general_info/part.xml @@ -0,0 +1,34 @@ + + + + +
+ + 2019 + Ericsson AB. All Rights Reserved. + + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + + + General Information + OTP Team + + 2019-02-23 + + part.xml +
+ + + diff --git a/system/doc/general_info/scheduled_for_removal.xml b/system/doc/general_info/scheduled_for_removal.xml new file mode 100644 index 0000000000..a9421df385 --- /dev/null +++ b/system/doc/general_info/scheduled_for_removal.xml @@ -0,0 +1,61 @@ + + + + +
+ + 2019 + Ericsson AB. All Rights Reserved. + + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + + + Scheduled for Removal + + + + + scheduled_for_removal.xml +
+
+ Introduction +

This document list all functionality in Erlang/OTP that currently are + scheduled for removal. For more information regarding the strategy regarding + removal of functionality see the documentation of + Support, Compatibility, + Deprecations, and Removal.

+
+
+ + OTP 23 +
+ VxWorks Support +

Some parts of OTP has had limited VxWorks support, such as for + example erl_interface. + This support will be removed as of OTP 23. This limited support + was formally deprecated as of OTP 22

+
+
+ Legacy parts of erl_interface +

The old legacy erl_interface + library (functions with prefix erl_) will be removed as of + OTP 23. These parts of erl_interface has been informally deprecated + for a very long time, and was formally deprecated in OTP 22. You typically + want to replace the usage of the erl_interface library with the use + of the ei library which also is part of the erl_interface + application.

+
+
+ diff --git a/system/doc/general_info/xmlfiles.mk b/system/doc/general_info/xmlfiles.mk new file mode 100644 index 0000000000..eab1632a4f --- /dev/null +++ b/system/doc/general_info/xmlfiles.mk @@ -0,0 +1,22 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009-2018. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# %CopyrightEnd% +# +GENERAL_INFO_CHAPTER_FILES = \ + deprecations.xml \ + scheduled_for_removal.xml diff --git a/system/doc/system_principles/misc.xml b/system/doc/system_principles/misc.xml index dd6c2a1336..ed3675d180 100644 --- a/system/doc/system_principles/misc.xml +++ b/system/doc/system_principles/misc.xml @@ -33,6 +33,14 @@ misc.xml +
+ Introduction +

This document describes strategy regarding supported Releases, + compatibility, deprecations and removal of functionality. This + document was introduced in OTP 21. Actions taken regarding these + issues before OTP 21 did not adhere this document.

+
+
Supported Releases diff --git a/system/doc/top/Makefile b/system/doc/top/Makefile index 0703b821f1..65d2fcfb6b 100644 --- a/system/doc/top/Makefile +++ b/system/doc/top/Makefile @@ -39,6 +39,7 @@ INFO_FILES = ../../../README.md ../../COPYRIGHT PR.template TOPDOCDIR=. +include ../general_info/xmlfiles.mk include ../installation_guide/xmlfiles.mk include ../system_principles/xmlfiles.mk include ../embedded/xmlfiles.mk @@ -56,6 +57,7 @@ XML_FILES = \ $(BOOK_FILES) XML_GUIDE_FILES = \ + $(GENERAL_INFO_CHAPTER_FILES:%=general_info/%) \ $(INST_GUIDE_CHAPTER_FILES:%=installation_guide/%) \ $(INST_GUIDE_CHAPTER_GEN_FILES:%=installation_guide/%) \ $(SYSTEM_PRINCIPLES_CHAPTER_FILES:%=system_principles/%) \ @@ -79,6 +81,7 @@ XML_GUIDE_FILES = \ XML_GEN_FILES = \ $(XML_GUIDE_FILES:%=$(XMLDIR)/%) \ + $(XMLDIR)/general_info/part.xml \ $(XMLDIR)/installation_guide/part.xml \ $(XMLDIR)/system_principles/part.xml \ $(XMLDIR)/embedded/part.xml \ @@ -91,7 +94,7 @@ XML_GEN_FILES = \ $(XMLDIR)/oam/part.xml -XMLLINT_SRCDIRS= $(XMLDIR)/installation_guide:$(XMLDIR)/system_principles:$(XMLDIR)/embedded:$(XMLDIR)/getting_started:$(XMLDIR)/reference_manual:$(XMLDIR)/programming_examples:$(XMLDIR)/efficiency_guide:$(XMLDIR)/tutorial:$(XMLDIR)/design_principles:$(XMLDIR)/oam +XMLLINT_SRCDIRS= $(XMLDIR)/general_info:$(XMLDIR)/installation_guide:$(XMLDIR)/system_principles:$(XMLDIR)/embedded:$(XMLDIR)/getting_started:$(XMLDIR)/reference_manual:$(XMLDIR)/programming_examples:$(XMLDIR)/efficiency_guide:$(XMLDIR)/tutorial:$(XMLDIR)/design_principles:$(XMLDIR)/oam HTMLDIR= ../html PDFREFDIR= pdf diff --git a/system/doc/top/book.xml b/system/doc/top/book.xml index 61e75591ef..64c1e4caf6 100644 --- a/system/doc/top/book.xml +++ b/system/doc/top/book.xml @@ -36,6 +36,7 @@ + diff --git a/system/doc/top/templates/index.html.src b/system/doc/top/templates/index.html.src index 747d19cf7e..3b61052b99 100644 --- a/system/doc/top/templates/index.html.src +++ b/system/doc/top/templates/index.html.src @@ -41,6 +41,8 @@ limitations under the License.
    -- cgit v1.2.3