doc: announce inclusive naming function name changes

Message ID 20230331185121.193521-1-stephen@networkplumber.org (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc: announce inclusive naming function name changes |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/intel-Testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-unit-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/github-robot: build success github build: passed
ci/iol-abi-testing success Testing PASS

Commit Message

Stephen Hemminger March 31, 2023, 6:51 p.m. UTC
  In order to suppor inclusive naming, some of the functions in
DPDK will need to be renamed. Do this through deprecation
process now for 23.07.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/rel_notes/deprecation.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index dcc1ca169668..bae39ad5ffd4 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -163,3 +163,19 @@  Deprecation Notices
   The new port library API (functions rte_swx_port_*)
   will gradually transition from experimental to stable status
   starting with DPDK 23.07 release.
+
+* mbuf: The function ``rte_mbuf_sanity_check`` will be deprecated in DPDK 23.07
+  and removed in DPDK 23.11. The new function will be ``rte_mbuf_validate``.
+
+* jobstats: The function ``rte_jobstats_abort`` will be deprecated in DPDK 23.07
+  and removed in DPDK 23.11. The new function will be ``rte_jobstats_cancel``.
+
+* bonding: References to slave will be removed in DPDK 23.11. The following
+  functions will be deprecated in DPDK 23.07, and removed in DPDK 23.11.
+  The old functions:
+  ``rte_eth_bond_8023ad_slave_info``, ``rte_eth_bond_active_slaves_get``,
+  ``rte_eth_bond_slave_add``, ``rte_eth_bond_slave_remove``, and
+  ``rte_eth_bond_slaves_get`` will be replaced by:
+  ``rte_eth_bond_8023ad_child_info``, ``rte_eth_bond_active_children_get``,
+  ``rte_eth_bond_child_add``, ``rte_eth_bond_child_remove``,
+  and ``rte_eth_bond_children_get``.