Re: [PATCH 2/3] doc: announce bonding data change

[Ferruh Yigit <ferruh.yigit@amd.com>]

On 7/14/2023 9:15 AM, Chaoyong He wrote:
> In order to support inclusive naming, the data structure of bonding 8023
> info 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      | 3 +++
>  drivers/net/bonding/rte_eth_bond_8023ad.c | 2 +-
>  drivers/net/bonding/rte_eth_bond_8023ad.h | 4 ++--
>  drivers/net/bonding/rte_eth_bond_pmd.c    | 4 ++--
>  4 files changed, 8 insertions(+), 5 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index c9477dd0da..5b16b66267 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -165,3 +165,6 @@ Deprecation Notices
>  * bonding: The macro ``RTE_ETH_DEV_BONDED_SLAVE`` will be deprecated in
>    DPDK 23.07, and removed in DPDK 23.11. The relevant code can be updated using
>    ``RTE_ETH_DEV_BONDING_MEMBER``.
> +  The data structure ``struct rte_eth_bond_8023ad_slave_info`` will be
> +  deprecated in DPDK 23.07, and removed in DPDK 23.11. The relevant code can be
> +  updated using ``struct rte_eth_bond_8023ad_member_info``.

<...>

> --- a/drivers/net/bonding/rte_eth_bond_8023ad.h
> +++ b/drivers/net/bonding/rte_eth_bond_8023ad.h
> @@ -141,7 +141,7 @@ struct rte_eth_bond_8023ad_conf {
>  	enum rte_bond_8023ad_agg_selection agg_selection;
>  };
>  
> -struct rte_eth_bond_8023ad_slave_info {
> +struct rte_eth_bond_8023ad_member_info {
>  	enum rte_bond_8023ad_selection selected;
>  	uint8_t actor_state;
>  	struct port_params actor;

There is no good way to deprecate struct names.

For macros it is possible to keep both old and new ones, old ones will
give warning but still continue to work, so that is just a heads up for
the user.
But above is rename and will break the application, forcing user to
update their code.
And if we will force user to update their code, this should be done on
ABI break release, v23.11.

That is why I suggest just keep the deprecation notice update, saying
that struct will be renamed in v23.11, without mentioning from
deprecating struct in this release etc..