[dpdk-dev] [PATCH] [RFC] doc: announce removal of crypto list end enumerators

[Kusztal, ArkadiuszX]

Hi All,

This is proposal to remove list_end enumerators from algorithms enums.
I do not expect many changes in current list of algorithms but it may happen (ChachaPoly in 20.02, GMAC move to AEAD proposal) so relying on list_end enumerator may be incorrect approach as this value may change across versions. It is used in some parts of DPDK code to specify array size so this would have to be changed with this approach.

Sorry if I not included someone in cc list.

> -----Original Message-----
> From: Kusztal, ArkadiuszX <arkadiuszx.kusztal at intel.com>
> Sent: Wednesday, July 29, 2020 4:47 PM
> To: dev at dpdk.org
> Cc: akhil.goyal at nxp.com; Trahe, Fiona <fiona.trahe at intel.com>;
> anoobj at marvell.com; shallyv at marvell.com; Doherty, Declan
> <declan.doherty at intel.com>; Zhang, Roy Fan <roy.fan.zhang at intel.com>;
> Ananyev, Konstantin <konstantin.ananyev at intel.com>; Kusztal, ArkadiuszX
> <arkadiuszx.kusztal at intel.com>
> Subject: [PATCH] [RFC] doc: announce removal of crypto list end
> enumerators
> 
> Enumerators RTE_CRYPTO_CIPHER_LIST_END,
> RTE_CRYPTO_AUTH_LIST_END, RTE_CRYPTO_AEAD_LIST_END will be
> removed to prevent some problems that may arise when adding new
> algorithms.
> 
> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal at 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 a58a179..34b0e3c 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -142,3 +142,9 @@ Deprecation Notices
>    Python 2 support will be completely removed in 20.11.
>    In 20.08, explicit deprecation warnings will be displayed when running
>    scripts with Python 2.
> +
> +* cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum
> +rte_crypto_aead_algorithm``,
> +  ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum
> +rte_crypto_cipher_algorithm`` and
> +  ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum
> rte_crypto_auth_algorithm``
> +will be
> +  removed.
> +
> \ No newline at end of file
> --
> 2.1.0