[dpdk-dev] doc: API change notice for librte_table

Message ID 1493749373-55709-1-git-send-email-cristian.dumitrescu@intel.com (mailing list archive)
State Accepted, archived
Headers

Checks

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

Commit Message

Cristian Dumitrescu May 2, 2017, 6:22 p.m. UTC
  Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)
  

Comments

Jasvinder Singh May 8, 2017, 8:23 a.m. UTC | #1
-----Original Message-----
From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Cristian Dumitrescu

Sent: Tuesday, May 2, 2017 7:23 PM
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH] doc: API change notice for librte_table

Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>


Acked-by: Jasvinder Singh <jasvinder.singh@intel.com>
  
Pattan, Reshma May 9, 2017, 4:34 p.m. UTC | #2
> -----Original Message-----

> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Cristian Dumitrescu

> Sent: Tuesday, May 2, 2017 7:23 PM

> To: dev@dpdk.org

> Subject: [dpdk-dev] [PATCH] doc: API change notice for librte_table

> 

> Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@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 a3e7c72..ae937f5 100644

> --- a/doc/guides/rel_notes/deprecation.rst

> +++ b/doc/guides/rel_notes/deprecation.rst

> @@ -81,3 +81,9 @@ Deprecation Notices

> 

>    - ``rte_crpytodev_scheduler_mode_get``, replaced by

> ``rte_cryptodev_scheduler_mode_get``

>    - ``rte_crpytodev_scheduler_mode_set``, replaced by

> ``rte_cryptodev_scheduler_mode_set``

> +

> +* librte_table: The “key_mask” parameter will be added to all the hash

> tables

> +  that currently do not have it, as well as to the hash compute function

> +  prototype. The non-“do-sig” versions of the hash tables will be removed

> +  (including the “signature_offset” parameter) and the “do-sig” versions

> renamed

> +  accordingly.

> --

> 2.7.4


Acked-by: Reshma Pattan <reshma.pattan@intel.com>
  
John McNamara May 9, 2017, 4:45 p.m. UTC | #3
> -----Original Message-----

> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Cristian Dumitrescu

> Sent: Tuesday, May 2, 2017 7:23 PM

> To: dev@dpdk.org

> Subject: [dpdk-dev] [PATCH] doc: API change notice for librte_table

> 

> Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@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 a3e7c72..ae937f5 100644

> --- a/doc/guides/rel_notes/deprecation.rst

> +++ b/doc/guides/rel_notes/deprecation.rst

> @@ -81,3 +81,9 @@ Deprecation Notices

> 

>    - ``rte_crpytodev_scheduler_mode_get``, replaced by

> ``rte_cryptodev_scheduler_mode_get``

>    - ``rte_crpytodev_scheduler_mode_set``, replaced by

> ``rte_cryptodev_scheduler_mode_set``

> +

> +* librte_table: The “key_mask” parameter will be added to all the hash

> tables

> +  that currently do not have it, as well as to the hash compute function

> +  prototype. The non-“do-sig” versions of the hash tables will be removed

> +  (including the “signature_offset” parameter) and the “do-sig” versions

> renamed

> +  accordingly.


It is best not to use “smart quotes” in the text since the renderers do
that automatically and these characters might interfere with it.

Apart from that:

Acked-by: John McNamara <john.mcnamara@intel.com>
  
Thomas Monjalon May 11, 2017, 1:04 a.m. UTC | #4
> > Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
> 
> It is best not to use “smart quotes” in the text since the renderers do
> that automatically and these characters might interfere with it.

Fixed

> Apart from that:
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index a3e7c72..ae937f5 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -81,3 +81,9 @@  Deprecation Notices
 
   - ``rte_crpytodev_scheduler_mode_get``, replaced by ``rte_cryptodev_scheduler_mode_get``
   - ``rte_crpytodev_scheduler_mode_set``, replaced by ``rte_cryptodev_scheduler_mode_set``
+
+* librte_table: The “key_mask” parameter will be added to all the hash tables
+  that currently do not have it, as well as to the hash compute function
+  prototype. The non-“do-sig” versions of the hash tables will be removed
+  (including the “signature_offset” parameter) and the “do-sig” versions renamed
+  accordingly.