doc: announce inclusive naming function name changes

Message ID 20230519063334.1645933-1-chaoyong.he@corigine.com (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/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/github-robot: build success github build: passed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS

Commit Message

Chaoyong He May 19, 2023, 6:33 a.m. UTC
  In order to support 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: Chaoyong He <chaoyong.he@corigine.com>
---
 doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
  

Comments

Ferruh Yigit May 19, 2023, 9:02 a.m. UTC | #1
On 5/19/2023 7:33 AM, Chaoyong He wrote:
> In order to support 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: Chaoyong He <chaoyong.he@corigine.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index dcc1ca1696..267a49aa13 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -163,3 +163,15 @@ 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.
> +
> +* 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_member_info``,
> +  ``rte_eth_bond_active_members_get``,
> +  ``rte_eth_bond_member_add``, ``rte_eth_bond_member_remove``,
> +  and ``rte_eth_bond_members_get``.

Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
  
Stephen Hemminger May 19, 2023, 4:12 p.m. UTC | #2
On Fri, 19 May 2023 14:33:34 +0800
Chaoyong He <chaoyong.he@corigine.com> wrote:

> In order to support 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: Chaoyong He <chaoyong.he@corigine.com>

Acked-by: Stephen Hemminger <stephen@networkplumber.org>
  
Tyler Retzlaff May 19, 2023, 8:05 p.m. UTC | #3
On Fri, May 19, 2023 at 02:33:34PM +0800, Chaoyong He wrote:
> In order to support 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: Chaoyong He <chaoyong.he@corigine.com>
> ---

Acked-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
  
Chenbo Xia June 8, 2023, 3:04 a.m. UTC | #4
> -----Original Message-----
> From: Chaoyong He <chaoyong.he@corigine.com>
> Sent: Friday, May 19, 2023 2:34 PM
> To: dev@dpdk.org
> Cc: oss-drivers@corigine.com; niklas.soderlund@corigine.com; Chaoyong He
> <chaoyong.he@corigine.com>
> Subject: [PATCH] doc: announce inclusive naming function name changes
> 
> In order to support 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: Chaoyong He <chaoyong.he@corigine.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index dcc1ca1696..267a49aa13 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -163,3 +163,15 @@ 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.
> +
> +* 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_member_info``,
> +  ``rte_eth_bond_active_members_get``,
> +  ``rte_eth_bond_member_add``, ``rte_eth_bond_member_remove``,
> +  and ``rte_eth_bond_members_get``.
> --
> 2.39.1

Acked-by: Chenbo Xia <chenbo.xia@intel.com>
  
Stephen Hemminger July 4, 2023, 2:21 a.m. UTC | #5
On Fri, 19 May 2023 14:33:34 +0800
Chaoyong He <chaoyong.he@corigine.com> wrote:

> In order to support 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: Chaoyong He <chaoyong.he@corigine.com>

Can this please get merged for 23.07, sufficient ACK's
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index dcc1ca1696..267a49aa13 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -163,3 +163,15 @@  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.
+
+* 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_member_info``,
+  ``rte_eth_bond_active_members_get``,
+  ``rte_eth_bond_member_add``, ``rte_eth_bond_member_remove``,
+  and ``rte_eth_bond_members_get``.