[1/2] doc: announce eth queue release callback parameter change

Message ID 20210802131056.2683266-1-xuemingl@nvidia.com (mailing list archive)
State Rejected, archived
Delegated to: Thomas Monjalon
Headers
Series [1/2] doc: announce eth queue release callback parameter change |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Xueming Li Aug. 2, 2021, 1:10 p.m. UTC
  This patch announces the parameter change of eth_queue_release_t
callback API to eth_dev_ops in DPDK v21.11.

[1] mail list discussion:
https://mails.dpdk.org/archives/dev/2021-July/215654.html

Signed-off-by: Xueming Li <xuemingl@nvidia.com>
---
 doc/guides/rel_notes/deprecation.rst | 3 +++
 1 file changed, 3 insertions(+)
  

Comments

Andrew Rybchenko Aug. 4, 2021, 12:27 p.m. UTC | #1
On 8/2/21 4:10 PM, Xueming Li wrote:
> This patch announces the parameter change of eth_queue_release_t
> callback API to eth_dev_ops in DPDK v21.11.
> 
> [1] mail list discussion:
> https://mails.dpdk.org/archives/dev/2021-July/215654.html
> 
> Signed-off-by: Xueming Li <xuemingl@nvidia.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 d9c0e65921..c38aebe99d 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -131,6 +131,9 @@ Deprecation Notices
>     consistent with existing outer header checksum status flag naming, which
>     should help in reducing confusion about its usage.
>   
> +* ethdev: queue release callback parameter will be changed to device and queue
> +  ID to align with other queue configureation callback.
> +
>   * i40e: As there are both i40evf and iavf pmd, the functions of them are
>     duplicated. And now more and more advanced features are developed on iavf.
>     To keep consistent with kernel driver's name
> 

Isn't it an internal callback and no deprecation notice required to
change it?

"to align with" is a bit weak justification that so huge change is
required (really many sources must be fixed). I guess it could be
required for shared RxQ. If so, it should be mentioned.
  
Xueming Li Aug. 4, 2021, 12:31 p.m. UTC | #2
> -----Original Message-----
> From: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> Sent: Wednesday, August 4, 2021 8:28 PM
> To: Xueming(Steven) Li <xuemingl@nvidia.com>
> Cc: dev@dpdk.org; Ray Kinsella <mdr@ashroe.eu>
> Subject: Re: [dpdk-dev] [PATCH 1/2] doc: announce eth queue release callback parameter change
> 
> On 8/2/21 4:10 PM, Xueming Li wrote:
> > This patch announces the parameter change of eth_queue_release_t
> > callback API to eth_dev_ops in DPDK v21.11.
> >
> > [1] mail list discussion:
> > https://mails.dpdk.org/archives/dev/2021-July/215654.html
> >
> > Signed-off-by: Xueming Li <xuemingl@nvidia.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 d9c0e65921..c38aebe99d 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -131,6 +131,9 @@ Deprecation Notices
> >     consistent with existing outer header checksum status flag naming, which
> >     should help in reducing confusion about its usage.
> >
> > +* ethdev: queue release callback parameter will be changed to device
> > +and queue
> > +  ID to align with other queue configureation callback.
> > +
> >   * i40e: As there are both i40evf and iavf pmd, the functions of them are
> >     duplicated. And now more and more advanced features are developed on iavf.
> >     To keep consistent with kernel driver's name
> >
> 
> Isn't it an internal callback and no deprecation notice required to change it?

Agree, let's drop this deprecation notice. Thanks for pointing this out.

> 
> "to align with" is a bit weak justification that so huge change is required (really many sources must be fixed). I guess it could be
> required for shared RxQ. If so, it should be mentioned.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index d9c0e65921..c38aebe99d 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -131,6 +131,9 @@  Deprecation Notices
   consistent with existing outer header checksum status flag naming, which
   should help in reducing confusion about its usage.
 
+* ethdev: queue release callback parameter will be changed to device and queue
+  ID to align with other queue configureation callback.
+
 * i40e: As there are both i40evf and iavf pmd, the functions of them are
   duplicated. And now more and more advanced features are developed on iavf.
   To keep consistent with kernel driver's name