doc: deprecation notice to add new hash function

Message ID 20230524113827.7351-1-xuemingl@nvidia.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc: deprecation notice to add new hash function |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/github-robot: build success github build: passed
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-unit-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS

Commit Message

Xueming Li May 24, 2023, 11:38 a.m. UTC
  Deprecation notice to annouce new RSS hash function type.
The new symmetric hash function sort L3 address and L4 ports
before Toeplitz calculation.

Signed-off-by: Xueming Li <xuemingl@nvidia.com>
---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)
  

Comments

Ori Kam May 24, 2023, 12:50 p.m. UTC | #1
Hi Xueming,

> -----Original Message-----
> From: Xueming(Steven) Li <xuemingl@nvidia.com>
> Sent: Wednesday, May 24, 2023 2:38 PM
> 
> Deprecation notice to annouce new RSS hash function type.
> The new symmetric hash function sort L3 address and L4 ports
> before Toeplitz calculation.
> 
> Signed-off-by: Xueming Li <xuemingl@nvidia.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index dcc1ca1696..fc988c3bfe 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -163,3 +163,7 @@ Deprecation Notices
>    The new port library API (functions rte_swx_port_*)
>    will gradually transition from experimental to stable status
>    starting with DPDK 23.07 release.
> +
> +* ethdev: The enum ``rte_eth_hash_function`` will be extended to add
> +  new subtype value
> ``RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ_SORT`` in
> +  DPDK 23.11.
> --
> 2.25.1

Acked-by: Ori Kam <orika@nvidia.com>
Best,
Ori
  
Stephen Hemminger May 24, 2023, 2:49 p.m. UTC | #2
On Wed, 24 May 2023 19:38:27 +0800
Xueming Li <xuemingl@nvidia.com> wrote:

> +
> +* ethdev: The enum ``rte_eth_hash_function`` will be extended to add
> +  new subtype value ``RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ_SORT`` in
> +  DPDK 23.11.

Simple new additions like this don't need to clutter the deprecation
part of the release notes. This is for changes which would break applications.
  
Thomas Monjalon July 28, 2023, 3:10 p.m. UTC | #3
24/05/2023 16:49, Stephen Hemminger:
> On Wed, 24 May 2023 19:38:27 +0800
> Xueming Li <xuemingl@nvidia.com> wrote:
> 
> > +
> > +* ethdev: The enum ``rte_eth_hash_function`` will be extended to add
> > +  new subtype value ``RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ_SORT`` in
> > +  DPDK 23.11.
> 
> Simple new additions like this don't need to clutter the deprecation
> part of the release notes. This is for changes which would break applications.

Marking this patch as superseded.
My patch is mentioning such case: adding an enum field.
https://patches.dpdk.org/project/dpdk/patch/20230728142946.1201459-1-thomas@monjalon.net/
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index dcc1ca1696..fc988c3bfe 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -163,3 +163,7 @@  Deprecation Notices
   The new port library API (functions rte_swx_port_*)
   will gradually transition from experimental to stable status
   starting with DPDK 23.07 release.
+
+* ethdev: The enum ``rte_eth_hash_function`` will be extended to add
+  new subtype value ``RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ_SORT`` in
+  DPDK 23.11.