Info about support, compatibility, deprecation and removal #1839
Conversation
|
👍 What about HiPE-compiled code? Is it the same compatibility guarantees? |
|
No, will add information about hipe code as well. Hipe is a bit special as well. We have recently updated the HiPE application with more information about this in 01b9a90 |
| <item> | ||
| <p> | ||
| Erlang nodes can communicate across at least | ||
| two preceding and two subsequent releases. |
There was a problem hiding this comment.
It is unclear to the uninitiated reader whether 'releases' here includes 'maintenance package' or means 'major releases'. It would be worthwhile to be specific, since it has big implications on time durations
There was a problem hiding this comment.
I added a section in the versions.xml file about this (part of this commit), which is linked from the misc.xml document, in order to clarify such questions.
| <tag>Bug Fixes</tag> | ||
| <item> | ||
| <p> | ||
| We will not be bug compatible. A bug fix might introduce |
There was a problem hiding this comment.
bug compatible -> bug-compatible ?
| is preferred to be used instead of the old API that is being | ||
| deprecated. The deprecation does <em>not</em> imply removal | ||
| of the API unless an upcoming removal is explicitly stated | ||
| in the deprecation. |
There was a problem hiding this comment.
Is it stated in the release notes, or in the compiler warning? Where should a developer keep a watch to know?
There was a problem hiding this comment.
Will include more info here
| <title>Removal</title> | ||
| <p> | ||
| When it becomes necessary to remove legacy solutions they | ||
| are always phased out giving time for users to adopt. |
There was a problem hiding this comment.
A bit weird to read. Maybe something like?
"Legacy solutions may eventually need to be removed. In such cases, they will be phased out on a long enough time period to give users the time to adapt."
rickard-green
force-pushed
the
rickard/misc-doc
branch
from
68d13f5
to
a956d41
Compare
| of ERTS that was used when compiling the code. It might | ||
| however work on other builds, the emulator verifies | ||
| checksums in order to determine if it can load the code | ||
| or not. Note that HiPE have some limitations. For more |
| <marker id="deprecation"/> | ||
| <title>Deprecation</title> | ||
| <p> | ||
| Functionality is deprecated when a new functionality is |
There was a problem hiding this comment.
"deprecated when new functionality" (no "a")
rickard-green
force-pushed
the
rickard/misc-doc
branch
from
a956d41
to
93c74cd
Compare
rickard-green
force-pushed
the
rickard/misc-doc
branch
from
93c74cd
to
9f9c9b1
Compare
No description provided.