[dpdk-dev,v1] doc: add distributor library API change notice

Message ID 1486368509-59989-1-git-send-email-david.hunt@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

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

Commit Message

Hunt, David Feb. 6, 2017, 8:08 a.m. UTC
  Given that the packet distributor library improvements (1) will
not be in 17.02, I plan on doing some consolidation of the
API for burst operation for 17.05, merging the two api's into
one, with options for single or burst operation.

(1) http://dpdk.org/dev/patchwork/patch/19911/

Signed-off-by: David Hunt <david.hunt@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)
  

Comments

Bruce Richardson Feb. 7, 2017, 10:50 a.m. UTC | #1
On Mon, Feb 06, 2017 at 08:08:29AM +0000, David Hunt wrote:
> Given that the packet distributor library improvements (1) will
> not be in 17.02, I plan on doing some consolidation of the
> API for burst operation for 17.05, merging the two api's into
> one, with options for single or burst operation.
> 

+1 for merging APIs

Acked-by: Bruce Richardson <bruce.richardson@intel.com>
  
Van Haaren, Harry Feb. 7, 2017, 5:12 p.m. UTC | #2
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of David Hunt
> Sent: Monday, February 6, 2017 8:08 AM
> To: dev@dpdk.org
> Cc: Richardson, Bruce <bruce.richardson@intel.com>; Hunt, David <david.hunt@intel.com>
> Subject: [dpdk-dev] [PATCH v1] doc: add distributor library API change notice
> 
> Given that the packet distributor library improvements (1) will
> not be in 17.02, I plan on doing some consolidation of the
> API for burst operation for 17.05, merging the two api's into
> one, with options for single or burst operation.
> 
> (1) http://dpdk.org/dev/patchwork/patch/19911/
> 
> Signed-off-by: David Hunt <david.hunt@intel.com>

Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
  
Ferruh Yigit Feb. 9, 2017, 2:20 p.m. UTC | #3
On 2/6/2017 8:08 AM, David Hunt wrote:
> Given that the packet distributor library improvements (1) will
> not be in 17.02, I plan on doing some consolidation of the
> API for burst operation for 17.05, merging the two api's into
> one, with options for single or burst operation.
> 
> (1) http://dpdk.org/dev/patchwork/patch/19911/
> 
> Signed-off-by: David Hunt <david.hunt@intel.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 755dc65..925e156 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -55,6 +55,12 @@ Deprecation Notices
>    and will be removed in 17.02.
>    It is replaced by ``rte_mempool_generic_get/put`` functions.
>  
> +* lib: distributor library API will be changed to incorporate a burst-
> +  oriented API. This will include a change to ``rte_distributor_create``
> +  to specify which type of instance to create (single or burst), and
> +  additional calls for ``rte_poll_pkt_burst`` and ``rte_return_pkt_burst``,
> +  among others.

Should new APIs (rte_poll_pkt_burst & rte_return_pkt_burst) have
"rte_distributor_" name space? Apart from this:

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
Hunt, David Feb. 9, 2017, 5:02 p.m. UTC | #4
On 9/2/2017 2:20 PM, Ferruh Yigit wrote:
> On 2/6/2017 8:08 AM, David Hunt wrote:
>> Given that the packet distributor library improvements (1) will
>> not be in 17.02, I plan on doing some consolidation of the
>> API for burst operation for 17.05, merging the two api's into
>> one, with options for single or burst operation.
>>
>> (1) http://dpdk.org/dev/patchwork/patch/19911/
>>
>> Signed-off-by: David Hunt <david.hunt@intel.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 755dc65..925e156 100644
>> --- a/doc/guides/rel_notes/deprecation.rst
>> +++ b/doc/guides/rel_notes/deprecation.rst
>> @@ -55,6 +55,12 @@ Deprecation Notices
>>     and will be removed in 17.02.
>>     It is replaced by ``rte_mempool_generic_get/put`` functions.
>>   
>> +* lib: distributor library API will be changed to incorporate a burst-
>> +  oriented API. This will include a change to ``rte_distributor_create``
>> +  to specify which type of instance to create (single or burst), and
>> +  additional calls for ``rte_poll_pkt_burst`` and ``rte_return_pkt_burst``,
>> +  among others.
> Should new APIs (rte_poll_pkt_burst & rte_return_pkt_burst) have
> "rte_distributor_" name space? Apart from this:
>
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
>

Ferruh,
     Thanks for the third Ack.

Thomas,
    Would you prefer me to re-spin the patch after inserting 
"_distributor" into
the two function names, or would you be so good as to do it during the 
merge?

Regards,
Dave.
  
Thomas Monjalon Feb. 9, 2017, 5:49 p.m. UTC | #5
2017-02-09 17:02, Hunt, David:
> On 9/2/2017 2:20 PM, Ferruh Yigit wrote:
> > On 2/6/2017 8:08 AM, David Hunt wrote:
> >> +* lib: distributor library API will be changed to incorporate a burst-
> >> +  oriented API. This will include a change to ``rte_distributor_create``
> >> +  to specify which type of instance to create (single or burst), and
> >> +  additional calls for ``rte_poll_pkt_burst`` and ``rte_return_pkt_burst``,
> >> +  among others.
> > Should new APIs (rte_poll_pkt_burst & rte_return_pkt_burst) have
> > "rte_distributor_" name space? Apart from this:
> >
> > Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
> 
> Ferruh,
>      Thanks for the third Ack.
> 
> Thomas,
>     Would you prefer me to re-spin the patch after inserting 
> "_distributor" into
> the two function names, or would you be so good as to do it during the 
> merge?

I can do it Dave :)
  
Thomas Monjalon Feb. 13, 2017, 4:29 p.m. UTC | #6
2017-02-09 18:49, Thomas Monjalon:
> 2017-02-09 17:02, Hunt, David:
> > On 9/2/2017 2:20 PM, Ferruh Yigit wrote:
> > > On 2/6/2017 8:08 AM, David Hunt wrote:
> > >> +* lib: distributor library API will be changed to incorporate a burst-
> > >> +  oriented API. This will include a change to ``rte_distributor_create``
> > >> +  to specify which type of instance to create (single or burst), and
> > >> +  additional calls for ``rte_poll_pkt_burst`` and ``rte_return_pkt_burst``,
> > >> +  among others.
> > > Should new APIs (rte_poll_pkt_burst & rte_return_pkt_burst) have
> > > "rte_distributor_" name space? Apart from this:
> > >
> > > Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
> > 
> > Ferruh,
> >      Thanks for the third Ack.
> > 
> > Thomas,
> >     Would you prefer me to re-spin the patch after inserting 
> > "_distributor" into
> > the two function names, or would you be so good as to do it during the 
> > merge?
> 
> I can do it Dave :)

Applied
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 755dc65..925e156 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -55,6 +55,12 @@  Deprecation Notices
   and will be removed in 17.02.
   It is replaced by ``rte_mempool_generic_get/put`` functions.
 
+* lib: distributor library API will be changed to incorporate a burst-
+  oriented API. This will include a change to ``rte_distributor_create``
+  to specify which type of instance to create (single or burst), and
+  additional calls for ``rte_poll_pkt_burst`` and ``rte_return_pkt_burst``,
+  among others.
+
 * ethdev: the legacy filter API, including
   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,