Re: [PATCH] cryptodev: add backward-compatible enum

[David Marchand <david.marchand@redhat.com>]

On Wed, Mar 16, 2022 at 1:23 PM <luca.boccassi@gmail.com> wrote:
>
> From: Luca Boccassi <bluca@debian.org>
>
> The enum was renamed to fix a typo in main, and backported.
> But in the stable release we want to keep backward compatibility
> when possible, so also define the old name so that both old and
> new code will work.
>
> Fixes: 7b5609a5a0e7 ("cryptodev: fix RSA key type name")
>
> Signed-off-by: Luca Boccassi <bluca@debian.org>
> ---
> Thanks David for the report. Might be interesting for other LTS branches too.
>
>  lib/librte_cryptodev/rte_crypto_asym.h | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/lib/librte_cryptodev/rte_crypto_asym.h b/lib/librte_cryptodev/rte_crypto_asym.h
> index 9c5bb9233a..8133a31ad4 100644
> --- a/lib/librte_cryptodev/rte_crypto_asym.h
> +++ b/lib/librte_cryptodev/rte_crypto_asym.h
> @@ -147,6 +147,8 @@ enum rte_crypto_rsa_priv_key_type {
>         RTE_RSA_KEY_TYPE_EXP,
>         /**< RSA private key is an exponent */
>         RTE_RSA_KEY_TYPE_QT,
> +       /**< Backward-compatible definition of old name */
> +       RTE_RSA_KET_TYPE_QT = RTE_RSA_KEY_TYPE_QT,
>         /**< RSA private key is in quintuple format
>          * See rte_crypto_rsa_priv_key_qt
>          */

You should move this compat item after the comment.
Idem the doxygen tag should be *after* the new item.

Like:
diff --git a/lib/librte_cryptodev/rte_crypto_asym.h
b/lib/librte_cryptodev/rte_crypto_asym.h
index 9c5bb9233a..d59e05323e 100644
--- a/lib/librte_cryptodev/rte_crypto_asym.h
+++ b/lib/librte_cryptodev/rte_crypto_asym.h
@@ -150,6 +150,8 @@ enum rte_crypto_rsa_priv_key_type {
        /**< RSA private key is in quintuple format
         * See rte_crypto_rsa_priv_key_qt
         */
+       RTE_RSA_KET_TYPE_QT = RTE_RSA_KEY_TYPE_QT,
+       /**< Backward-compatible definition of old name */
 };

 /**

I tried this patch (after moving the hunk after the comment) on top of
current 20.11 branch.
It fixes the ABI check (more a API check in this case).



-- 
David Marchand