d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: rename ABI chapter to deprecation

Browse Source 
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@6wind.com>
This commit is contained in:
Thomas Monjalon 2015-07-18 21:08:58 +02:00
parent fd1fa9bddd
commit 60011cb25a
3 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
MAINTAINERS
View File

@ -60,7 +60,7 @@ F: doc/guides/prog_guide/ext_app_lib_make_help.rst
ABI versioning
M: Neil Horman <nhorman@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

16
doc/guides/rel_notes/abi.rst → doc/guides/rel_notes/deprecation.rst
View File

@ -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

2
doc/guides/rel_notes/index.rst
View File

@ -48,5 +48,5 @@ Contents
updating_apps
known_issues
resolved_issues
abi
deprecation
faq