From: Lukasz Wojciechowski Date: Thu, 9 Apr 2020 17:24:51 +0000 (+0200) Subject: security: fix return types in documentation X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=3139b9568bf0889c76da7b7d728f17502d6ff5a9;p=dpdk.git security: fix return types in documentation Enhance returned values description for rte_security_session_destroy and some other minor description changes. Fixes: c261d1431bd8 ("security: introduce security API and framework") Cc: stable@dpdk.org Signed-off-by: Lukasz Wojciechowski Acked-by: Anoob Joseph Acked-by: Akhil Goyal --- diff --git a/lib/librte_security/rte_security.h b/lib/librte_security/rte_security.h index ef47118fa7..747830d679 100644 --- a/lib/librte_security/rte_security.h +++ b/lib/librte_security/rte_security.h @@ -378,7 +378,7 @@ rte_security_session_create(struct rte_security_ctx *instance, * @param conf update configuration parameters * @return * - On success returns 0 - * - On failure return errno + * - On failure returns a negative errno value. */ __rte_experimental int @@ -403,12 +403,14 @@ rte_security_session_get_size(struct rte_security_ctx *instance); * return it to its original mempool. * * @param instance security instance - * @param sess security session to freed + * @param sess security session to be freed * * @return * - 0 if successful. - * - -EINVAL if session is NULL. + * - -EINVAL if session or context instance is NULL. * - -EBUSY if not all device private data has been freed. + * - -ENOTSUP if destroying private data is not supported. + * - other negative values in case of freeing private data errors. */ int rte_security_session_destroy(struct rte_security_ctx *instance,