doc: announce malloc virt2phys symbol removal

Message ID 1564752563-11850-1-git-send-email-david.marchand@redhat.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc: announce malloc virt2phys symbol removal |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

David Marchand Aug. 2, 2019, 1:29 p.m. UTC
  This symbol has been deprecated for quite some time.
Let's drop it in the next release.

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 doc/guides/rel_notes/deprecation.rst | 3 +++
 1 file changed, 3 insertions(+)
  

Comments

Burakov, Anatoly Aug. 2, 2019, 4:04 p.m. UTC | #1
On 02-Aug-19 2:29 PM, David Marchand wrote:
> This symbol has been deprecated for quite some time.
> Let's drop it in the next release.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---

Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
  
Jerin Jacob Kollanukkaran Aug. 2, 2019, 4:10 p.m. UTC | #2
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Burakov, Anatoly
> Sent: Friday, August 2, 2019 9:35 PM
> To: David Marchand <david.marchand@redhat.com>; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: announce malloc virt2phys symbol
> removal
> 
> On 02-Aug-19 2:29 PM, David Marchand wrote:
> > This symbol has been deprecated for quite some time.
> > Let's drop it in the next release.
> >
> > Signed-off-by: David Marchand <david.marchand@redhat.com>
> > ---
> 
> Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>


Acked-by: Jerin Jacob <jerinj@marvell.com>

> 
> --
> Thanks,
> Anatoly
  
Thomas Monjalon Aug. 5, 2019, 2:39 p.m. UTC | #3
02/08/2019 15:29, David Marchand:
> This symbol has been deprecated for quite some time.
> Let's drop it in the next release.
> ---
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> +* eal: The ``rte_malloc_virt2phy`` function has been deprecated and replaced
> +  by ``rte_malloc_virt2iova`` since v17.11 and will be removed in DPDK 19.11.

For this patch and another one about removing rte_cpu_check_supported(),
I have a general comment on the date of removal.

As was stated recently in the contribution guide:
	http://git.dpdk.org/dpdk/commit/?id=7abe4a24cc
	"Deprecated APIs are removed completely just after the next LTS."

The idea behind this policy is to avoid removals during LTS releases,
in order to have at least one release before X.11 LTS for end users
to prepare replacing the usage of the removed API.

Does it make sense to postpone any API removal after 19.11?
  
David Marchand Aug. 5, 2019, 3:05 p.m. UTC | #4
On Mon, Aug 5, 2019 at 4:39 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> 02/08/2019 15:29, David Marchand:
> > This symbol has been deprecated for quite some time.
> > Let's drop it in the next release.
> > ---
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > +* eal: The ``rte_malloc_virt2phy`` function has been deprecated and replaced
> > +  by ``rte_malloc_virt2iova`` since v17.11 and will be removed in DPDK 19.11.
>
> For this patch and another one about removing rte_cpu_check_supported(),
> I have a general comment on the date of removal.
>
> As was stated recently in the contribution guide:
>         http://git.dpdk.org/dpdk/commit/?id=7abe4a24cc
>         "Deprecated APIs are removed completely just after the next LTS."
>
> The idea behind this policy is to avoid removals during LTS releases,
> in order to have at least one release before X.11 LTS for end users
> to prepare replacing the usage of the removed API.
>
> Does it make sense to postpone any API removal after 19.11?

Those symbols have been marked as deprecated for a long time.
Users had to either disable Werror or they actually migrated to the new apis.
If they chose the lazy way of not migrating to the new apis, I suspect
they forgot about it and/or they won't look at the release notes.


I don't particularly have a problem with waiting for 20.02, those are
easy to remove anyway.
  
Thomas Monjalon Aug. 5, 2019, 3:13 p.m. UTC | #5
05/08/2019 17:05, David Marchand:
> On Mon, Aug 5, 2019 at 4:39 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> > 02/08/2019 15:29, David Marchand:
> > > This symbol has been deprecated for quite some time.
> > > Let's drop it in the next release.
> > > ---
> > > --- a/doc/guides/rel_notes/deprecation.rst
> > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > +* eal: The ``rte_malloc_virt2phy`` function has been deprecated and replaced
> > > +  by ``rte_malloc_virt2iova`` since v17.11 and will be removed in DPDK 19.11.
> >
> > For this patch and another one about removing rte_cpu_check_supported(),
> > I have a general comment on the date of removal.
> >
> > As was stated recently in the contribution guide:
> >         http://git.dpdk.org/dpdk/commit/?id=7abe4a24cc
> >         "Deprecated APIs are removed completely just after the next LTS."
> >
> > The idea behind this policy is to avoid removals during LTS releases,
> > in order to have at least one release before X.11 LTS for end users
> > to prepare replacing the usage of the removed API.
> >
> > Does it make sense to postpone any API removal after 19.11?
> 
> Those symbols have been marked as deprecated for a long time.
> Users had to either disable Werror or they actually migrated to the new apis.
> If they chose the lazy way of not migrating to the new apis, I suspect
> they forgot about it and/or they won't look at the release notes.

Yes I agree.
That's why they can be surprised when hitting the removal.
Avoiding this removal in LTS release is one more care for
the lazy users. The question: is too much caution?

> I don't particularly have a problem with waiting for 20.02, those are
> easy to remove anyway.
  
Andrew Rybchenko Aug. 6, 2019, 1:50 p.m. UTC | #6
On 8/2/19 4:29 PM, David Marchand wrote:
> This symbol has been deprecated for quite some time.
> Let's drop it in the next release.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>

Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>

since it was deprecated in previous LTS, I think it is already OK to remove.
  
Ananyev, Konstantin Aug. 6, 2019, 2 p.m. UTC | #7
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of David Marchand
> Sent: Friday, August 2, 2019 2:29 PM
> To: dev@dpdk.org
> Cc: Burakov, Anatoly <anatoly.burakov@intel.com>
> Subject: [dpdk-dev] [PATCH] doc: announce malloc virt2phys symbol removal
> 
> This symbol has been deprecated for quite some time.
> Let's drop it in the next release.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.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 b57720c..3c98a5c 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -41,6 +41,9 @@ Deprecation Notices
>  * eal: The ``rte_cpu_check_supported`` function has been deprecated since
>    v17.08 and will be removed in DPDK 19.11.
> 
> +* eal: The ``rte_malloc_virt2phy`` function has been deprecated and replaced
> +  by ``rte_malloc_virt2iova`` since v17.11 and will be removed in DPDK 19.11.
> +
>  * vfio: removal of ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` APIs which
>    have been replaced with ``rte_dev_dma_map`` and ``rte_dev_dma_unmap``
>    functions.  The due date for the removal targets DPDK 20.02.
> --

Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>

> 1.8.3.1
  
Kinsella, Ray Aug. 12, 2019, 10:42 a.m. UTC | #8
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Monday 5 August 2019 16:13
> To: David Marchand <david.marchand@redhat.com>
> Cc: dev <dev@dpdk.org>; Burakov, Anatoly <anatoly.burakov@intel.com>;
> Richardson, Bruce <bruce.richardson@intel.com>; Kinsella, Ray
> <ray.kinsella@intel.com>; Traynor, Kevin <ktraynor@redhat.com>; Stephen
> Hemminger <stephen@networkplumber.org>
> Subject: Re: [dpdk-dev] [PATCH] doc: announce malloc virt2phys symbol
> removal
> 
> 05/08/2019 17:05, David Marchand:
> > On Mon, Aug 5, 2019 at 4:39 PM Thomas Monjalon <thomas@monjalon.net>
> wrote:
> > > 02/08/2019 15:29, David Marchand:
> > > > This symbol has been deprecated for quite some time.
> > > > Let's drop it in the next release.
> > > > ---
> > > > --- a/doc/guides/rel_notes/deprecation.rst
> > > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > > +* eal: The ``rte_malloc_virt2phy`` function has been deprecated
> > > > +and replaced
> > > > +  by ``rte_malloc_virt2iova`` since v17.11 and will be removed
> in DPDK 19.11.
> > >
> > > For this patch and another one about removing
> > > rte_cpu_check_supported(), I have a general comment on the date of
> removal.
> > >
> > > As was stated recently in the contribution guide:
> > >         http://git.dpdk.org/dpdk/commit/?id=7abe4a24cc
> > >         "Deprecated APIs are removed completely just after the next
> LTS."
> > >
> > > The idea behind this policy is to avoid removals during LTS
> > > releases, in order to have at least one release before X.11 LTS for
> > > end users to prepare replacing the usage of the removed API.
> > >
> > > Does it make sense to postpone any API removal after 19.11?
> >
> > Those symbols have been marked as deprecated for a long time.
> > Users had to either disable Werror or they actually migrated to the
> new apis.
> > If they chose the lazy way of not migrating to the new apis, I
> suspect
> > they forgot about it and/or they won't look at the release notes.
> 
> Yes I agree.
> That's why they can be surprised when hitting the removal.
> Avoiding this removal in LTS release is one more care for the lazy
> users. The question: is too much caution?
> 
> > I don't particularly have a problem with waiting for 20.02, those are
> > easy to remove anyway.
> 
> 

My 2c is that if they are have signalled as deprecated since v17.11.
They are fair game for removal at this point. 

Ray K
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index b57720c..3c98a5c 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -41,6 +41,9 @@  Deprecation Notices
 * eal: The ``rte_cpu_check_supported`` function has been deprecated since
   v17.08 and will be removed in DPDK 19.11.
 
+* eal: The ``rte_malloc_virt2phy`` function has been deprecated and replaced
+  by ``rte_malloc_virt2iova`` since v17.11 and will be removed in DPDK 19.11.
+
 * vfio: removal of ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` APIs which
   have been replaced with ``rte_dev_dma_map`` and ``rte_dev_dma_unmap``
   functions.  The due date for the removal targets DPDK 20.02.