doc: announce common prefix for ethdev

Message ID 20210630092117.1368109-1-ferruh.yigit@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: announce common prefix for ethdev |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot fail github build: failed
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Ferruh Yigit June 30, 2021, 9:21 a.m. UTC
  Announce adding 'RTE_ETH_' prefix to all public ethdev macros/enums on
v21.11.
Backward compatibility macros will be added on v21.11 and they will be
removed on v22.11.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
Cc: Andrew Rybchenko <arybchenko@solarflare.com>
Cc: Thomas Monjalon <thomas@monjalon.net>
Cc: David Marchand <david.marchand@redhat.com>
Cc: Qi Z Zhang <qi.z.zhang@intel.com>
Cc: Raslan Darawsheh <rasland@nvidia.com>
Cc: Ajit Khaparde <ajit.khaparde@broadcom.com>
Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)
  

Comments

Andrew Rybchenko June 30, 2021, 1:57 p.m. UTC | #1
On 6/30/21 12:21 PM, Ferruh Yigit wrote:
> Announce adding 'RTE_ETH_' prefix to all public ethdev macros/enums on
> v21.11.
> Backward compatibility macros will be added on v21.11 and they will be
> removed on v22.11.
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
> Cc: Andrew Rybchenko <arybchenko@solarflare.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>
> Cc: David Marchand <david.marchand@redhat.com>
> Cc: Qi Z Zhang <qi.z.zhang@intel.com>
> Cc: Raslan Darawsheh <rasland@nvidia.com>
> Cc: Ajit Khaparde <ajit.khaparde@broadcom.com>
> Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>
> ---
>   doc/guides/rel_notes/deprecation.rst | 5 +++++
>   1 file changed, 5 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 9584d6bfd723..ae79673e37e3 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -118,6 +118,11 @@ Deprecation Notices
>     consistent with existing outer header checksum status flag naming, which
>     should help in reducing confusion about its usage.
>   
> +* ethdev: Will add 'RTE_ETH_' prefix to all ethdev macros/enums in v21.11. Macros
> +  will be added for backward compatibility. Backward compatibility macros will be
> +  removed on v22.11. A few old backward compatibility macros from 2013 that does
> +  not have proper prefix will be removed on v21.11.
> +
>   * 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
> 

Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
  
Jerin Jacob June 30, 2021, 3:03 p.m. UTC | #2
On Wed, Jun 30, 2021 at 7:28 PM Andrew Rybchenko
<andrew.rybchenko@oktetlabs.ru> wrote:
>
> On 6/30/21 12:21 PM, Ferruh Yigit wrote:
> > Announce adding 'RTE_ETH_' prefix to all public ethdev macros/enums on
> > v21.11.
> > Backward compatibility macros will be added on v21.11 and they will be
> > removed on v22.11.
> >
> > Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> > ---
> > Cc: Andrew Rybchenko <arybchenko@solarflare.com>
> > Cc: Thomas Monjalon <thomas@monjalon.net>
> > Cc: David Marchand <david.marchand@redhat.com>
> > Cc: Qi Z Zhang <qi.z.zhang@intel.com>
> > Cc: Raslan Darawsheh <rasland@nvidia.com>
> > Cc: Ajit Khaparde <ajit.khaparde@broadcom.com>
> > Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>
> > ---
> >   doc/guides/rel_notes/deprecation.rst | 5 +++++
> >   1 file changed, 5 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index 9584d6bfd723..ae79673e37e3 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -118,6 +118,11 @@ Deprecation Notices
> >     consistent with existing outer header checksum status flag naming, which
> >     should help in reducing confusion about its usage.
> >
> > +* ethdev: Will add 'RTE_ETH_' prefix to all ethdev macros/enums in v21.11. Macros
> > +  will be added for backward compatibility. Backward compatibility macros will be
> > +  removed on v22.11. A few old backward compatibility macros from 2013 that does
> > +  not have proper prefix will be removed on v21.11.
> > +
> >   * 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
> >
>
> Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
Acked-by: Jerin Jacob <jerinj@marvell.com>
  
Ajit Khaparde June 30, 2021, 3:11 p.m. UTC | #3
On Wed, Jun 30, 2021 at 8:03 AM Jerin Jacob <jerinjacobk@gmail.com> wrote:
>
> On Wed, Jun 30, 2021 at 7:28 PM Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru> wrote:
> >
> > On 6/30/21 12:21 PM, Ferruh Yigit wrote:
> > > Announce adding 'RTE_ETH_' prefix to all public ethdev macros/enums on
> > > v21.11.
> > > Backward compatibility macros will be added on v21.11 and they will be
> > > removed on v22.11.
> > >
> > > Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> > > ---
> > > Cc: Andrew Rybchenko <arybchenko@solarflare.com>
> > > Cc: Thomas Monjalon <thomas@monjalon.net>
> > > Cc: David Marchand <david.marchand@redhat.com>
> > > Cc: Qi Z Zhang <qi.z.zhang@intel.com>
> > > Cc: Raslan Darawsheh <rasland@nvidia.com>
> > > Cc: Ajit Khaparde <ajit.khaparde@broadcom.com>
> > > Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>
> > > ---
> > >   doc/guides/rel_notes/deprecation.rst | 5 +++++
> > >   1 file changed, 5 insertions(+)
> > >
> > > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > > index 9584d6bfd723..ae79673e37e3 100644
> > > --- a/doc/guides/rel_notes/deprecation.rst
> > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > @@ -118,6 +118,11 @@ Deprecation Notices
> > >     consistent with existing outer header checksum status flag naming, which
> > >     should help in reducing confusion about its usage.
> > >
> > > +* ethdev: Will add 'RTE_ETH_' prefix to all ethdev macros/enums in v21.11. Macros
> > > +  will be added for backward compatibility. Backward compatibility macros will be
> > > +  removed on v22.11. A few old backward compatibility macros from 2013 that does
> > > +  not have proper prefix will be removed on v21.11.
> > > +
> > >   * 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
> > >
> >
> > Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> Acked-by: Jerin Jacob <jerinj@marvell.com>
Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
  
Raslan Darawsheh June 30, 2021, 3:14 p.m. UTC | #4
> -----Original Message-----
> From: Ajit Khaparde <ajit.khaparde@broadcom.com>
> Sent: Wednesday, June 30, 2021 6:12 PM
> To: Jerin Jacob <jerinjacobk@gmail.com>
> Cc: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>; Ferruh Yigit
> <ferruh.yigit@intel.com>; Ray Kinsella <mdr@ashroe.eu>; Neil Horman
> <nhorman@tuxdriver.com>; dpdk-dev <dev@dpdk.org>; Andrew
> Rybchenko <arybchenko@solarflare.com>; NBU-Contact-Thomas Monjalon
> <thomas@monjalon.net>; David Marchand <david.marchand@redhat.com>;
> Qi Z Zhang <qi.z.zhang@intel.com>; Raslan Darawsheh
> <rasland@nvidia.com>; Jerin Jacob Kollanukkaran <jerinj@marvell.com>
> Subject: Re: [dpdk-dev] [PATCH] doc: announce common prefix for ethdev
> 
> On Wed, Jun 30, 2021 at 8:03 AM Jerin Jacob <jerinjacobk@gmail.com>
> wrote:
> >
> > On Wed, Jun 30, 2021 at 7:28 PM Andrew Rybchenko
> > <andrew.rybchenko@oktetlabs.ru> wrote:
> > >
> > > On 6/30/21 12:21 PM, Ferruh Yigit wrote:
> > > > Announce adding 'RTE_ETH_' prefix to all public ethdev macros/enums
> on
> > > > v21.11.
> > > > Backward compatibility macros will be added on v21.11 and they will be
> > > > removed on v22.11.
> > > >
> > > > Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> > > > ---
> > > > Cc: Andrew Rybchenko <arybchenko@solarflare.com>
> > > > Cc: Thomas Monjalon <thomas@monjalon.net>
> > > > Cc: David Marchand <david.marchand@redhat.com>
> > > > Cc: Qi Z Zhang <qi.z.zhang@intel.com>
> > > > Cc: Raslan Darawsheh <rasland@nvidia.com>
> > > > Cc: Ajit Khaparde <ajit.khaparde@broadcom.com>
> > > > Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>
> > > > ---
> > > >   doc/guides/rel_notes/deprecation.rst | 5 +++++
> > > >   1 file changed, 5 insertions(+)
> > > >
> > > > diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> > > > index 9584d6bfd723..ae79673e37e3 100644
> > > > --- a/doc/guides/rel_notes/deprecation.rst
> > > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > > @@ -118,6 +118,11 @@ Deprecation Notices
> > > >     consistent with existing outer header checksum status flag naming,
> which
> > > >     should help in reducing confusion about its usage.
> > > >
> > > > +* ethdev: Will add 'RTE_ETH_' prefix to all ethdev macros/enums in
> v21.11. Macros
> > > > +  will be added for backward compatibility. Backward compatibility
> macros will be
> > > > +  removed on v22.11. A few old backward compatibility macros from
> 2013 that does
> > > > +  not have proper prefix will be removed on v21.11.
> > > > +
> > > >   * 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
> > > >
> > >
> > > Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> > Acked-by: Jerin Jacob <jerinj@marvell.com>
> Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
Acked-by: Raslan Darawsheh <rasland@nvidia.com>
  
Tyler Retzlaff June 30, 2021, 7:43 p.m. UTC | #5
On Wed, Jun 30, 2021 at 03:14:51PM +0000, Raslan Darawsheh wrote:
> 
> > -----Original Message-----
> > From: Ajit Khaparde <ajit.khaparde@broadcom.com>
> > Sent: Wednesday, June 30, 2021 6:12 PM
> > To: Jerin Jacob <jerinjacobk@gmail.com>
> > Cc: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>; Ferruh Yigit
> > <ferruh.yigit@intel.com>; Ray Kinsella <mdr@ashroe.eu>; Neil Horman
> > <nhorman@tuxdriver.com>; dpdk-dev <dev@dpdk.org>; Andrew
> > Rybchenko <arybchenko@solarflare.com>; NBU-Contact-Thomas Monjalon
> > <thomas@monjalon.net>; David Marchand <david.marchand@redhat.com>;
> > Qi Z Zhang <qi.z.zhang@intel.com>; Raslan Darawsheh
> > <rasland@nvidia.com>; Jerin Jacob Kollanukkaran <jerinj@marvell.com>
> > Subject: Re: [dpdk-dev] [PATCH] doc: announce common prefix for ethdev
> > 
> > On Wed, Jun 30, 2021 at 8:03 AM Jerin Jacob <jerinjacobk@gmail.com>
> > wrote:
> > >
> > > On Wed, Jun 30, 2021 at 7:28 PM Andrew Rybchenko
> > > <andrew.rybchenko@oktetlabs.ru> wrote:
> > > >
> > > > On 6/30/21 12:21 PM, Ferruh Yigit wrote:
> > > > > Announce adding 'RTE_ETH_' prefix to all public ethdev macros/enums
> > on
> > > > > v21.11.
> > > > > Backward compatibility macros will be added on v21.11 and they will be
> > > > > removed on v22.11.
> > > > >
> > > > > Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> > > > > ---
> > > > > Cc: Andrew Rybchenko <arybchenko@solarflare.com>
> > > > > Cc: Thomas Monjalon <thomas@monjalon.net>
> > > > > Cc: David Marchand <david.marchand@redhat.com>
> > > > > Cc: Qi Z Zhang <qi.z.zhang@intel.com>
> > > > > Cc: Raslan Darawsheh <rasland@nvidia.com>
> > > > > Cc: Ajit Khaparde <ajit.khaparde@broadcom.com>
> > > > > Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>
> > > > > ---
> > > > >   doc/guides/rel_notes/deprecation.rst | 5 +++++
> > > > >   1 file changed, 5 insertions(+)
> > > > >
> > > > > diff --git a/doc/guides/rel_notes/deprecation.rst
> > b/doc/guides/rel_notes/deprecation.rst
> > > > > index 9584d6bfd723..ae79673e37e3 100644
> > > > > --- a/doc/guides/rel_notes/deprecation.rst
> > > > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > > > @@ -118,6 +118,11 @@ Deprecation Notices
> > > > >     consistent with existing outer header checksum status flag naming,
> > which
> > > > >     should help in reducing confusion about its usage.
> > > > >
> > > > > +* ethdev: Will add 'RTE_ETH_' prefix to all ethdev macros/enums in
> > v21.11. Macros
> > > > > +  will be added for backward compatibility. Backward compatibility
> > macros will be
> > > > > +  removed on v22.11. A few old backward compatibility macros from
> > 2013 that does
> > > > > +  not have proper prefix will be removed on v21.11.
> > > > > +
> > > > >   * 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
> > > > >
> > > >
> > > > Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> > > Acked-by: Jerin Jacob <jerinj@marvell.com>
> > Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> Acked-by: Raslan Darawsheh <rasland@nvidia.com>
Acked-by: Tyler Retzlaff <roretzla@microsoft.com>
  
Thomas Monjalon July 31, 2021, 9:07 p.m. UTC | #6
> > > > > > Announce adding 'RTE_ETH_' prefix to all public ethdev macros/enums
> > > on
> > > > > > v21.11.
> > > > > > Backward compatibility macros will be added on v21.11 and they will be
> > > > > > removed on v22.11.
> > > > > >
> > > > > > Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> > > > > > --- a/doc/guides/rel_notes/deprecation.rst
> > > > > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > > > > +* ethdev: Will add 'RTE_ETH_' prefix to all ethdev macros/enums in
> > > v21.11. Macros
> > > > > > +  will be added for backward compatibility. Backward compatibility
> > > macros will be
> > > > > > +  removed on v22.11. A few old backward compatibility macros from
> > > 2013 that does
> > > > > > +  not have proper prefix will be removed on v21.11.
> > > > > > +
> > > > >
> > > > > Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> > > > Acked-by: Jerin Jacob <jerinj@marvell.com>
> > > Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> > Acked-by: Raslan Darawsheh <rasland@nvidia.com>
> Acked-by: Tyler Retzlaff <roretzla@microsoft.com>

Applied, thanks.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 9584d6bfd723..ae79673e37e3 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -118,6 +118,11 @@  Deprecation Notices
   consistent with existing outer header checksum status flag naming, which
   should help in reducing confusion about its usage.
 
+* ethdev: Will add 'RTE_ETH_' prefix to all ethdev macros/enums in v21.11. Macros
+  will be added for backward compatibility. Backward compatibility macros will be
+  removed on v22.11. A few old backward compatibility macros from 2013 that does
+  not have proper prefix will be removed on v21.11.
+
 * 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