This chapter is for ABI and API. That's why a renaming is required.
Remove also the examples which are now in the referenced guidelines.
Signed-off-by: Thomas Monjalon <thomas.monjalon at 6wind.com>
---
MAINTAINERS | 2 +-
doc/guides/rel_notes/{abi.rst => deprecation.rst} | 16 +++++-----------
doc/guides/rel_notes/index.rst | 2 +-
3 files changed, 7 insertions(+), 13 deletions(-)
rename doc/guides/rel_notes/{abi.rst => deprecation.rst} (51%)
diff --git a/MAINTAINERS b/MAINTAINERS
index 2a32659..6531900 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -60,7 +60,7 @@ F: doc/guides/prog_guide/ext_app_lib_make_help.rst
ABI versioning
M: Neil Horman <nhorman at tuxdriver.com>
F: lib/librte_compat/
-F: doc/guides/rel_notes/abi.rst
+F: doc/guides/rel_notes/deprecation.rst
F: scripts/validate-abi.sh
diff --git a/doc/guides/rel_notes/abi.rst b/doc/guides/rel_notes/deprecation.rst
similarity index 51%
rename from doc/guides/rel_notes/abi.rst
rename to doc/guides/rel_notes/deprecation.rst
index 7a08830..eef01f1 100644
--- a/doc/guides/rel_notes/abi.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -1,17 +1,11 @@
-ABI policy
-==========
+Deprecation
+===========
See the :doc:`guidelines document for details of the ABI policy
</guidelines/versioning>`.
-ABI deprecation notices are to be posted here.
+API and ABI deprecation notices are to be posted here.
-
-Examples of Deprecation Notices
--------------------------------
-
-* The Macro #RTE_FOO is deprecated and will be removed with version 2.0, to be
replaced with the inline function rte_bar()
-* The function rte_mbuf_grok has been updated to include new parameter in
version 2.0. Backwards compatibility will be maintained for this function
until the release of version 2.1
-* The members struct foo have been reorganized in release 2.0. Existing
binary applications will have backwards compatibility in release 2.0, while
newly built binaries will need to reference new structure variant struct foo2.
Compatibility will be removed in release 2.2, and all applications will require
updating and rebuilding to the new structure at that time, which will be
renamed to the original struct foo.
-* Significant ABI changes are planned for the librte_dostuff library. The
upcoming release 2.0 will not contain these changes, but release 2.1 will, and
no backwards compatibility is planned due to the invasive nature of these
changes. Binaries using this library built prior to version 2.1 will require
updating and recompilation.
+Help to update from a previous release is provided in
+:doc:`another section </rel_notes/updating_apps>`.
Deprecation Notices
diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst
index d790783..9d66cd8 100644
--- a/doc/guides/rel_notes/index.rst
+++ b/doc/guides/rel_notes/index.rst
@@ -48,5 +48,5 @@ Contents
updating_apps
known_issues
resolved_issues
- abi
+ deprecation
faq
--
2.4.2
