[v3] doc: announce ring API change

Message ID 20190118153117.23810-1-gage.eads@intel.com
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • [v3] doc: announce ring API change
Related show

Checks

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

Commit Message

Eads, Gage Jan. 18, 2019, 3:31 p.m.
In order to support the non-blocking ring[1], an API change (additional
argument to rte_ring_get_memsize()) is required in librte_ring. This commit
updates the deprecation notice to pave the way for its inclusion in
19.05.

[1] http://mails.dpdk.org/archives/dev/2019-January/123774.html

Signed-off-by: Gage Eads <gage.eads@intel.com>
---
v3:
 - "two changes are planned" -> "one change is planned"
v2:
 - Drop the ABI change notice

 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Thomas Monjalon Feb. 1, 2019, 11:16 a.m. | #1
18/01/2019 16:31, Gage Eads:
> In order to support the non-blocking ring[1], an API change (additional
> argument to rte_ring_get_memsize()) is required in librte_ring. This commit
> updates the deprecation notice to pave the way for its inclusion in
> 19.05.
> 
> [1] http://mails.dpdk.org/archives/dev/2019-January/123774.html
> 
> Signed-off-by: Gage Eads <gage.eads@intel.com>

Nobody agreed on this change.

Gage, do you still want to push non-blocking ring in 19.05?


---

> +* ring: one change is planned for rte_ring in v19.05:
> +
> +  - rte_ring_get_memsize() will get a new ``flags`` parameter, so it can
> +    calculate the memory required for rings that require more than 8B per entry
> +    (such as the upcoming non-blocking ring).
Eads, Gage Feb. 1, 2019, 2:18 p.m. | #2
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Friday, February 1, 2019 5:17 AM
> To: dev@dpdk.org; Eads, Gage <gage.eads@intel.com>
> Cc: olivier.matz@6wind.com; arybchenko@solarflare.com; Richardson, Bruce
> <bruce.richardson@intel.com>; Ananyev, Konstantin
> <konstantin.ananyev@intel.com>; stephen@networkplumber.org; Mcnamara,
> John <john.mcnamara@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v3] doc: announce ring API change
> 
> 18/01/2019 16:31, Gage Eads:
> > In order to support the non-blocking ring[1], an API change
> > (additional argument to rte_ring_get_memsize()) is required in
> > librte_ring. This commit updates the deprecation notice to pave the
> > way for its inclusion in 19.05.
> >
> > [1] http://mails.dpdk.org/archives/dev/2019-January/123774.html
> >
> > Signed-off-by: Gage Eads <gage.eads@intel.com>
> 
> Nobody agreed on this change.
> 
> Gage, do you still want to push non-blocking ring in 19.05?
> 

It was optimistic to try for agreement before the 19.02 release :) -- no, let's delay it until 19.08. I'll edit and resubmit this patch.

> 
> ---
> 
> > +* ring: one change is planned for rte_ring in v19.05:
> > +
> > +  - rte_ring_get_memsize() will get a new ``flags`` parameter, so it can
> > +    calculate the memory required for rings that require more than 8B per
> entry
> > +    (such as the upcoming non-blocking ring).
> 
> 
> 
>

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index d4aea4b46..91e048a6a 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -83,3 +83,9 @@  Deprecation Notices
   - The size and layout of ``rte_cryptodev_qp_conf`` and syntax of
     ``rte_cryptodev_queue_pair_setup`` will change to to allow to use
     two different mempools for crypto and device private sessions.
+
+* ring: one change is planned for rte_ring in v19.05:
+
+  - rte_ring_get_memsize() will get a new ``flags`` parameter, so it can
+    calculate the memory required for rings that require more than 8B per entry
+    (such as the upcoming non-blocking ring).