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

[luca.boccassi at gmail.com]

Hi,

FYI, your patch has been queued to stable release 19.11.3

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 05/21/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.

Thanks.

Luca Boccassi

---
>From 477f8e08d34ca2c7e113e86c1463c0eeb5bf55f7 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 546779df2b..b4b4eb2d85 100644
--- a/lib/librte_security/rte_security.h
+++ b/lib/librte_security/rte_security.h
@@ -374,7 +374,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
@@ -399,12 +399,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.20.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-05-19 14:04:44.671321028 +0100
+++ 0001-security-fix-return-types-in-documentation.patch	2020-05-19 14:04:44.048645327 +0100
@@ -1,13 +1,14 @@
-From 3139b9568bf0889c76da7b7d728f17502d6ff5a9 Mon Sep 17 00:00:00 2001
+From 477f8e08d34ca2c7e113e86c1463c0eeb5bf55f7 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")
-Cc: stable at dpdk.org
 
 Signed-off-by: Lukasz Wojciechowski <l.wojciechow at partner.samsung.com>
 Acked-by: Anoob Joseph <anoobj at marvell.com>
@@ -17,10 +18,10 @@
  1 file changed, 5 insertions(+), 3 deletions(-)
 
 diff --git a/lib/librte_security/rte_security.h b/lib/librte_security/rte_security.h
-index ef47118fa7..747830d679 100644
+index 546779df2b..b4b4eb2d85 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,
+@@ -374,7 +374,7 @@ rte_security_session_create(struct rte_security_ctx *instance,
   * @param   conf	update configuration parameters
   * @return
   *  - On success returns 0
@@ -29,7 +30,7 @@
   */
  __rte_experimental
  int
-@@ -403,12 +403,14 @@ rte_security_session_get_size(struct rte_security_ctx *instance);
+@@ -399,12 +399,14 @@ rte_security_session_get_size(struct rte_security_ctx *instance);
   * return it to its original mempool.
   *
   * @param   instance	security instance