diff mbox series

[02/13] librte_security: fix return types in documentation

Message ID 20200312151654.7218-3-l.wojciechow@partner.samsung.com (mailing list archive)
State Superseded, archived
Delegated to: akhil goyal
Headers
Series Fixes and unit tests for librte_security |

Checks

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

Commit Message

Lukasz Wojciechowski March 12, 2020, 3:16 p.m. UTC 
  Enhance returned values description for rte_security_session_destroy
and some other minor description changes.

Signed-off-by: Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
Change-Id: Ic18ee9e76507f8888da1a0921b3a2a914a2434d2
---
 lib/librte_security/rte_security.h | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

Comments

Anoob Joseph March 17, 2020, 4:34 p.m. UTC | #1 
Hi Lukasz,

I think you will need to change the title to something like,

"security: fix return types in documentation"

Also, "Fixes" tag is missing. This should be applicable for stable also.

Thanks,
Anoob

> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Lukasz Wojciechowski
> Sent: Thursday, March 12, 2020 8:47 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH 02/13] librte_security: fix return types in
> documentation
> 
> Enhance returned values description for rte_security_session_destroy and some
> other minor description changes.
> 
> Signed-off-by: Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
> Change-Id: Ic18ee9e76507f8888da1a0921b3a2a914a2434d2
> ---
>  lib/librte_security/rte_security.h | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 
> diff --git a/lib/librte_security/rte_security.h b/lib/librte_security/rte_security.h
> index ef47118fa..747830d67 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,
> --
> 2.17.1
diff mbox series

Patch

diff --git a/lib/librte_security/rte_security.h b/lib/librte_security/rte_security.h
index ef47118fa..747830d67 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,