[v4,2/2] doc: announce deprecation of refcnt atomic member

Message ID 1594310331-23345-2-git-send-email-phil.yang@arm.com (mailing list archive)
State Superseded, archived
Delegated to: David Marchand
Headers
Series [v4,1/2] mbuf: use C11 atomic built-ins for refcnt operations |

Checks

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

Commit Message

Phil Yang July 9, 2020, 3:58 p.m. UTC
  refcnt_atomic member in structures rte_mbuf and rte_mbuf_ext_shared_info
will be deprecated in 20.11 release.

Signed-off-by: Phil Yang <phil.yang@arm.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)
  

Comments

Ruifeng Wang July 10, 2020, 2:55 a.m. UTC | #1
> -----Original Message-----
> From: Phil Yang <phil.yang@arm.com>
> Sent: Thursday, July 9, 2020 11:59 PM
> To: olivier.matz@6wind.com; dev@dpdk.org
> Cc: stephen@networkplumber.org; david.marchand@redhat.com;
> drc@linux.vnet.ibm.com; Honnappa Nagarahalli
> <Honnappa.Nagarahalli@arm.com>; Ruifeng Wang
> <Ruifeng.Wang@arm.com>; nd <nd@arm.com>
> Subject: [PATCH v4 2/2] doc: announce deprecation of refcnt atomic member
> 
> refcnt_atomic member in structures rte_mbuf and
> rte_mbuf_ext_shared_info will be deprecated in 20.11 release.
The plan should be deprecate it in 20.08 release and remove it in 20.11 release.

> 
> Signed-off-by: Phil Yang <phil.yang@arm.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 74f8c34..7225570 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -123,6 +123,12 @@ Deprecation Notices
>    in "rte_sched.h". These changes are aligned to improvements suggested in
> the
>    RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
> 
> +* mbuf: ``refcnt_atomic`` member in structures ``rte_mbuf`` and
> +  ``rte_mbuf_ext_shared_info`` is of type ``rte_atomic16_t``. Due to
> +adoption
> +  of C11 atomic built-ins it will be of type ``uint16_t``.
> +``refcnt_atomic``
> +  will be removed in 20.11. It will be replaced with ``refcnt`` of type
> +  ``uint16_t``.
> +
>  * metrics: The function ``rte_metrics_init`` will have a non-void return
>    in order to notify errors instead of calling ``rte_exit``.
> 
> --
> 2.7.4
  
Phil Yang July 13, 2020, 3:54 p.m. UTC | #2
Ruifeng Wang <Ruifeng.Wang@arm.com> writes:

<snip>

> > Subject: [PATCH v4 2/2] doc: announce deprecation of refcnt atomic
> member
> >
> > refcnt_atomic member in structures rte_mbuf and
> > rte_mbuf_ext_shared_info will be deprecated in 20.11 release.
> The plan should be deprecate it in 20.08 release and remove it in 20.11
> release.

Yes. Just like Oliver suggested, we will deprecate it in 20.08 release and remove it in 20.11.
http://patchwork.dpdk.org/patch/73632/

Let's see if we have any other comments.
+Jerin and Konstantin.

Thanks,
Phil
> 
> >
> > Signed-off-by: Phil Yang <phil.yang@arm.com>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 6 ++++++
> >  1 file changed, 6 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst
> > b/doc/guides/rel_notes/deprecation.rst
> > index 74f8c34..7225570 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -123,6 +123,12 @@ Deprecation Notices
> >    in "rte_sched.h". These changes are aligned to improvements suggested
> in
> > the
> >    RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
> >
> > +* mbuf: ``refcnt_atomic`` member in structures ``rte_mbuf`` and
> > +  ``rte_mbuf_ext_shared_info`` is of type ``rte_atomic16_t``. Due to
> > +adoption
> > +  of C11 atomic built-ins it will be of type ``uint16_t``.
> > +``refcnt_atomic``
> > +  will be removed in 20.11. It will be replaced with ``refcnt`` of type
> > +  ``uint16_t``.
> > +
> >  * metrics: The function ``rte_metrics_init`` will have a non-void return
> >    in order to notify errors instead of calling ``rte_exit``.
> >
> > --
> > 2.7.4
  
Ananyev, Konstantin July 14, 2020, 10:41 a.m. UTC | #3
> refcnt_atomic member in structures rte_mbuf and rte_mbuf_ext_shared_info
> will be deprecated in 20.11 release.
> 
> Signed-off-by: Phil Yang <phil.yang@arm.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 74f8c34..7225570 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -123,6 +123,12 @@ Deprecation Notices
>    in "rte_sched.h". These changes are aligned to improvements suggested in the
>    RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
> 
> +* mbuf: ``refcnt_atomic`` member in structures ``rte_mbuf`` and
> +  ``rte_mbuf_ext_shared_info`` is of type ``rte_atomic16_t``. Due to adoption
> +  of C11 atomic built-ins it will be of type ``uint16_t``. ``refcnt_atomic``
> +  will be removed in 20.11. It will be replaced with ``refcnt`` of type
> +  ``uint16_t``.
> +
>  * metrics: The function ``rte_metrics_init`` will have a non-void return
>    in order to notify errors instead of calling ``rte_exit``.
> 
> --

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

> 2.7.4
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 74f8c34..7225570 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -123,6 +123,12 @@  Deprecation Notices
   in "rte_sched.h". These changes are aligned to improvements suggested in the
   RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
 
+* mbuf: ``refcnt_atomic`` member in structures ``rte_mbuf`` and
+  ``rte_mbuf_ext_shared_info`` is of type ``rte_atomic16_t``. Due to adoption
+  of C11 atomic built-ins it will be of type ``uint16_t``. ``refcnt_atomic``
+  will be removed in 20.11. It will be replaced with ``refcnt`` of type
+  ``uint16_t``.
+
 * metrics: The function ``rte_metrics_init`` will have a non-void return
   in order to notify errors instead of calling ``rte_exit``.