[dpdk-stable] patch 'security: fix return types in documentation' has been queued to LTS release 18.11.9

[Kevin Traynor]

Hi,

FYI, your patch has been queued to LTS release 18.11.9

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 06/03/20. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/d0819d07c086c827b8a2ffba6a106e746f7c58e4

Thanks.

Kevin.

---
>From d0819d07c086c827b8a2ffba6a106e746f7c58e4 Mon Sep 17 00:00:00 2001
From: Lukasz Wojciechowski <l.wojciechow at partner.samsung.com>
Date: Thu, 9 Apr 2020 19:24:51 +0200
Subject: [PATCH] security: fix return types in documentation

[ upstream commit 3139b9568bf0889c76da7b7d728f17502d6ff5a9 ]

Enhance returned values description for rte_security_session_destroy
and some other minor description changes.

Fixes: c261d1431bd8 ("security: introduce security API and framework")

Signed-off-by: Lukasz Wojciechowski <l.wojciechow at partner.samsung.com>
Acked-by: Anoob Joseph <anoobj at marvell.com>
Acked-by: Akhil Goyal <akhil.goyal at nxp.com>
---
 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 ad7898c72b..133ce9481c 100644
--- a/lib/librte_security/rte_security.h
+++ b/lib/librte_security/rte_security.h
@@ -343,5 +343,5 @@ rte_security_session_create(struct rte_security_ctx *instance,
  * @return
  *  - On success returns 0
- *  - On failure return errno
+ *  - On failure returns a negative errno value.
  */
 int __rte_experimental
@@ -367,10 +367,12 @@ rte_security_session_get_size(struct rte_security_ctx *instance);
  *
  * @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
-- 
2.21.3

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-05-28 17:13:01.265693809 +0100
+++ 0041-security-fix-return-types-in-documentation.patch	2020-05-28 17:12:59.109556219 +0100
@@ -1 +1 @@
-From 3139b9568bf0889c76da7b7d728f17502d6ff5a9 Mon Sep 17 00:00:00 2001
+From d0819d07c086c827b8a2ffba6a106e746f7c58e4 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 3139b9568bf0889c76da7b7d728f17502d6ff5a9 ]
+
@@ -10 +11,0 @@
-Cc: stable at dpdk.org
@@ -20 +21 @@
-index ef47118fa7..747830d679 100644
+index ad7898c72b..133ce9481c 100644
@@ -23 +24 @@
-@@ -379,5 +379,5 @@ rte_security_session_create(struct rte_security_ctx *instance,
+@@ -343,5 +343,5 @@ rte_security_session_create(struct rte_security_ctx *instance,
@@ -29,2 +30,2 @@
- __rte_experimental
-@@ -404,10 +404,12 @@ rte_security_session_get_size(struct rte_security_ctx *instance);
+ int __rte_experimental
+@@ -367,10 +367,12 @@ rte_security_session_get_size(struct rte_security_ctx *instance);