[PATCH] doc: announce renaming of ethdev library

[PATCH] doc: announce renaming of ethdev library

[Thomas Monjalon]

The right name of ethdev should be dpdk_netdev. However:
1/ We are using rte_ prefix in the code and library names.
2/ The API uses rte_ethdev
That's why 16.11 will just have the rte_ prefix prepended to
the library filename as every other libraries.

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.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 f502f86..7a55037 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -11,6 +11,9 @@ Deprecation Notices
 * The log history is deprecated.
   It is voided in 16.07 and will be removed in release 16.11.
 
+* The ethdev library file will be renamed from libethdev.* to librte_ethdev.*
+  in release 16.11 in order to have a more consistent namespace.
+
 * The ethdev hotplug API is going to be moved to EAL with a notification
   mechanism added to crypto and ethdev libraries so that hotplug is now
   available to both of them. This API will be stripped of the device arguments
-- 
2.7.0

Re: doc: announce renaming of ethdev library

[Jan Viktorin]

On Tue, 26 Jul 2016 18:22:21 +0200
Thomas Monjalon <thomas.monjalon@6wind.com> wrote:

> The right name of ethdev should be dpdk_netdev. However:
> 1/ We are using rte_ prefix in the code and library names.
> 2/ The API uses rte_ethdev
> That's why 16.11 will just have the rte_ prefix prepended to
> the library filename as every other libraries.
> 
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> 
Acked-by: Jan Viktorin <viktorin@rehivetech.com>

Re: doc: announce renaming of ethdev library

[Christian Ehrhardt]

Hi Thomas,
just my two cents as Ubuntu DPDK maintainer (and part of the Debian Team
that does the same).
(Yeah I really could reuse it three times :-) )

It will be a bit of effort to adapt, but should be no rocket-science.
I like that eventually the namespace will be cleaner.

Just curious, do we already know by looking ahead if ethdev will get an ABI
bump anyway?
So will the transition be:
a) libethdev4 -> librte_ethdev5
b)libethdev4 -> librte_ethdev4
If it is b) would/should one provide a compat symlink then in your Opinion?

Anyway, for now I think it is fair to say:
Acked-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>

Christian Ehrhardt
Software Engineer, Ubuntu Server
Canonical Ltd

On Wed, Jul 27, 2016 at 6:33 PM, Jan Viktorin <viktorin@rehivetech.com>
wrote:

> On Tue, 26 Jul 2016 18:22:21 +0200
> Thomas Monjalon <thomas.monjalon@6wind.com> wrote:
>
> > The right name of ethdev should be dpdk_netdev. However:
> > 1/ We are using rte_ prefix in the code and library names.
> > 2/ The API uses rte_ethdev
> > That's why 16.11 will just have the rte_ prefix prepended to
> > the library filename as every other libraries.
> >
> > Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> >
> Acked-by: Jan Viktorin <viktorin@rehivetech.com>
>

Re: doc: announce renaming of ethdev library

[Thomas Monjalon]

2016-07-28 11:29, Christian Ehrhardt:
> Just curious, do we already know by looking ahead if ethdev will get an ABI
> bump anyway?
> So will the transition be:
> a) libethdev4 -> librte_ethdev5
> b)libethdev4 -> librte_ethdev4
> If it is b) would/should one provide a compat symlink then in your Opinion?

Good point.
We'll make a symlink if the version stay the same.
Maybe it will be bumped because of a rework of the hotplug API.

Re: [PATCH] doc: announce renaming of ethdev library

[Ananyev, Konstantin]

>
> The right name of ethdev should be dpdk_netdev. However:
> 1/ We are using rte_ prefix in the code and library names.
> 2/ The API uses rte_ethdev
 > That's why 16.11 will just have the rte_ prefix prepended to the
> library filename as every other libraries.
>
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.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 f502f86..7a55037 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -11,6 +11,9 @@ Deprecation Notices
>  * The log history is deprecated.
>    It is voided in 16.07 and will be removed in release 16.11.
>
> +* The ethdev library file will be renamed from libethdev.* to
> +librte_ethdev.*
> +  in release 16.11 in order to have a more consistent namespace.
> +
>  * The ethdev hotplug API is going to be moved to EAL with a
> notification
>    mechanism added to crypto and ethdev libraries so that hotplug
> is
> now
 >    available to both of them. This API will be stripped of the
> device arguments
> --
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>

> 2.7.0

Re: doc: announce renaming of ethdev library

[Thomas Monjalon]

> > > The right name of ethdev should be dpdk_netdev. However:
> > > 1/ We are using rte_ prefix in the code and library names.
> > > 2/ The API uses rte_ethdev
> > > That's why 16.11 will just have the rte_ prefix prepended to
> > > the library filename as every other libraries.
> > >
> > > Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> > >
> > Acked-by: Jan Viktorin <viktorin@rehivetech.com>
Acked-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>

Applied