[PATCH] doc: deprecation notice to add RSS hash algorithm field

[PATCH] doc: deprecation notice to add RSS hash algorithm field

[Dongdong Liu]

Deprecation notice to add "func" field to ``rte_eth_rss_conf``
structure for RSS hash algorithm.

Signed-off-by: Dongdong Liu <liudongdong3@huawei.com>
---
 doc/guides/rel_notes/deprecation.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index dcc1ca1696..1459244af5 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -118,6 +118,9 @@ Deprecation Notices
   The legacy actions should be removed
   once ``MODIFY_FIELD`` alternative is implemented in drivers.
 
+* ethdev: Add "func" field to ``rte_eth_rss_conf`` structure for
+  RSS hash algorithm in DPDK 23.11.
+
 * net/bnx2x: Starting from DPDK 23.07, the Marvell QLogic bnx2x driver will be removed.
   This decision has been made to alleviate the burden of maintaining a discontinued product.
 
-- 
2.22.0

Re: [PATCH] doc: deprecation notice to add RSS hash algorithm field

[Stephen Hemminger]

On Tue, 6 Jun 2023 20:11:26 +0800
Dongdong Liu <liudongdong3@huawei.com> wrote:

> Deprecation notice to add "func" field to ``rte_eth_rss_conf``
> structure for RSS hash algorithm.
> 
> Signed-off-by: Dongdong Liu <liudongdong3@huawei.com>
> ---

New fields do not require deprecation notice.
Since this seems to be a repeated issue, perhaps someone should
add this to the documentation.

Re: [PATCH] doc: deprecation notice to add RSS hash algorithm field

[Ferruh Yigit]

On 6/6/2023 4:39 PM, Stephen Hemminger wrote:
> On Tue, 6 Jun 2023 20:11:26 +0800
> Dongdong Liu <liudongdong3@huawei.com> wrote:
> 
>> Deprecation notice to add "func" field to ``rte_eth_rss_conf``
>> structure for RSS hash algorithm.
>>
>> Signed-off-by: Dongdong Liu <liudongdong3@huawei.com>
>> ---
> 
> New fields do not require deprecation notice.
> Since this seems to be a repeated issue, perhaps someone should
> add this to the documentation.
>


Hi Stephen,

This is follow up to an existing patchset:
https://patches.dpdk.org/project/dpdk/list/?series=27400&state=*

Although field is addition to the "struct rte_eth_rss_conf" struct, it
is embedded into "struct rte_eth_conf" which is parameter to an API, so
change cause size increase in outer struct and causes ABI breakage,
requiring deprecation notice.

Re: [PATCH] doc: deprecation notice to add RSS hash algorithm field

[Stephen Hemminger]

On Tue, 6 Jun 2023 16:50:53 +0100
Ferruh Yigit <ferruh.yigit@amd.com> wrote:

> On 6/6/2023 4:39 PM, Stephen Hemminger wrote:
> > On Tue, 6 Jun 2023 20:11:26 +0800
> > Dongdong Liu <liudongdong3@huawei.com> wrote:
> >   
> >> Deprecation notice to add "func" field to ``rte_eth_rss_conf``
> >> structure for RSS hash algorithm.
> >>
> >> Signed-off-by: Dongdong Liu <liudongdong3@huawei.com>
> >> ---  
> > 
> > New fields do not require deprecation notice.
> > Since this seems to be a repeated issue, perhaps someone should
> > add this to the documentation.
> >  
> 
> 
> Hi Stephen,
> 
> This is follow up to an existing patchset:
> https://patches.dpdk.org/project/dpdk/list/?series=27400&state=*
> 
> Although field is addition to the "struct rte_eth_rss_conf" struct, it
> is embedded into "struct rte_eth_conf" which is parameter to an API, so
> change cause size increase in outer struct and causes ABI breakage,
> requiring deprecation notice.

It will change ABI so will have to wait for 23.11.
But the purpose of deprecation notice is more about telling users that API
will change.

The automated tools may give false complaint. Ok to add to deprecation,
but really not necessary.

Re: [PATCH] doc: deprecation notice to add RSS hash algorithm field

[Thomas Monjalon]

06/06/2023 18:35, Stephen Hemminger:
> On Tue, 6 Jun 2023 16:50:53 +0100
> Ferruh Yigit <ferruh.yigit@amd.com> wrote:
> 
> > On 6/6/2023 4:39 PM, Stephen Hemminger wrote:
> > > On Tue, 6 Jun 2023 20:11:26 +0800
> > > Dongdong Liu <liudongdong3@huawei.com> wrote:
> > >   
> > >> Deprecation notice to add "func" field to ``rte_eth_rss_conf``
> > >> structure for RSS hash algorithm.
> > >>
> > >> Signed-off-by: Dongdong Liu <liudongdong3@huawei.com>
> > >> ---  
> > > 
> > > New fields do not require deprecation notice.
> > > Since this seems to be a repeated issue, perhaps someone should
> > > add this to the documentation.

I've just sent such a patch:
https://patches.dpdk.org/project/dpdk/patch/20230728142946.1201459-1-thomas@monjalon.net/


> > Hi Stephen,
> > 
> > This is follow up to an existing patchset:
> > https://patches.dpdk.org/project/dpdk/list/?series=27400&state=*
> > 
> > Although field is addition to the "struct rte_eth_rss_conf" struct, it
> > is embedded into "struct rte_eth_conf" which is parameter to an API, so
> > change cause size increase in outer struct and causes ABI breakage,
> > requiring deprecation notice.
> 
> It will change ABI so will have to wait for 23.11.
> But the purpose of deprecation notice is more about telling users that API
> will change.
> 
> The automated tools may give false complaint. Ok to add to deprecation,
> but really not necessary.


This deprecation notice is marked as superseded,
given my patch above should be enough.