From: Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
To: Akhil Goyal <akhil.goyal@nxp.com>,
Declan Doherty <declan.doherty@intel.com>,
Aviad Yehezkel <aviadye@mellanox.com>,
Boris Pismenny <borisp@mellanox.com>,
Radu Nicolau <radu.nicolau@intel.com>
Cc: dev@dpdk.org, stable@dpdk.org
Subject: [dpdk-stable] [PATCH v2 02/13] security: fix return types in documentation
Date: Wed, 8 Apr 2020 05:13:40 +0200 [thread overview]
Message-ID: <20200408031351.4288-3-l.wojciechow@partner.samsung.com> (raw)
In-Reply-To: <20200408031351.4288-1-l.wojciechow@partner.samsung.com>
Enhance returned values description for rte_security_session_destroy
and some other minor description changes.
Fixes: c261d1431bd8 ("security: introduce security API and framework")
Cc: akhil.goyal@nxp.com
Cc: stable@dpdk.org
Signed-off-by: Lukasz Wojciechowski <l.wojciechow@partner.samsung.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 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
next prev parent reply other threads:[~2020-04-08 3:14 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20200312151654.7218-1-l.wojciechow@partner.samsung.com>
[not found] ` <20200408031351.4288-1-l.wojciechow@partner.samsung.com>
[not found] ` <CGME20200408031447eucas1p1376332353faa0d217e7be8c32271405f@eucas1p1.samsung.com>
2020-04-08 3:13 ` [dpdk-stable] [PATCH v2 01/13] security: fix verification of parameters Lukasz Wojciechowski
2020-04-08 12:54 ` Thomas Monjalon
2020-04-08 13:02 ` [dpdk-stable] [dpdk-dev] " Anoob Joseph
2020-04-08 13:26 ` Thomas Monjalon
2020-04-08 14:44 ` [dpdk-stable] [EXT] " Anoob Joseph
2020-04-08 15:49 ` Lukasz Wojciechowski
2020-04-08 17:51 ` Thomas Monjalon
2020-04-09 10:14 ` Bruce Richardson
2020-04-09 10:54 ` Thomas Monjalon
2020-04-09 11:13 ` Bruce Richardson
2020-04-09 14:07 ` Lukasz Wojciechowski
2020-04-09 14:21 ` Lukasz Wojciechowski
2020-04-09 15:22 ` Thomas Monjalon
2020-04-09 16:10 ` Lukasz Wojciechowski
2020-04-10 8:45 ` Bruce Richardson
[not found] ` <CGME20200408031448eucas1p2b36997fc73f5b5e2aadb6e4bb965063b@eucas1p2.samsung.com>
2020-04-08 3:13 ` Lukasz Wojciechowski [this message]
[not found] ` <CGME20200408031448eucas1p2d6df7ff419bb093606a2f9115297f45a@eucas1p2.samsung.com>
2020-04-08 3:13 ` [dpdk-stable] [PATCH v2 03/13] security: fix session counter Lukasz Wojciechowski
[not found] ` <CGME20200408031449eucas1p1ca89719463cbaf29e9f7c81beaec88c2@eucas1p1.samsung.com>
2020-04-08 3:13 ` [dpdk-stable] [PATCH v2 04/13] app/test: fix macro definition Lukasz Wojciechowski
2020-04-08 12:53 ` Thomas Monjalon
2020-04-08 16:15 ` Lukasz Wojciechowski
2020-04-08 17:47 ` Thomas Monjalon
2020-04-09 14:10 ` Lukasz Wojciechowski
[not found] ` <20200409172502.1693-1-l.wojciechow@partner.samsung.com>
[not found] ` <CGME20200409172529eucas1p1f02aaf66052f45ac75ba9e9f63ef1c3a@eucas1p1.samsung.com>
2020-04-09 17:24 ` [dpdk-stable] [PATCH v3 01/13] security: fix verification of parameters Lukasz Wojciechowski
2020-04-13 15:42 ` [dpdk-stable] [dpdk-dev] " Anoob Joseph
[not found] ` <CGME20200409172530eucas1p27297a83a9d7508e3f8a8f88850cbe37c@eucas1p2.samsung.com>
2020-04-09 17:24 ` [dpdk-stable] [PATCH v3 02/13] security: fix return types in documentation Lukasz Wojciechowski
2020-04-13 15:43 ` [dpdk-stable] [dpdk-dev] " Anoob Joseph
[not found] ` <CGME20200409172531eucas1p1c3ec21532e5e232ff2d68d56f096e71c@eucas1p1.samsung.com>
2020-04-09 17:24 ` [dpdk-stable] [PATCH v3 03/13] security: fix session counter Lukasz Wojciechowski
2020-04-13 15:48 ` [dpdk-stable] [dpdk-dev] " Anoob Joseph
[not found] ` <CGME20200409172532eucas1p285bc6767be1d62a0098d177a7757169f@eucas1p2.samsung.com>
2020-04-09 17:24 ` [dpdk-stable] [PATCH v3 04/13] app/test: remove macro definition Lukasz Wojciechowski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200408031351.4288-3-l.wojciechow@partner.samsung.com \
--to=l.wojciechow@partner.samsung.com \
--cc=akhil.goyal@nxp.com \
--cc=aviadye@mellanox.com \
--cc=borisp@mellanox.com \
--cc=declan.doherty@intel.com \
--cc=dev@dpdk.org \
--cc=radu.nicolau@intel.com \
--cc=stable@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).