diff mbox series

cryptodev: add missing doc

Message ID 20230907130037.208-1-anoobj@marvell.com (mailing list archive)
State Superseded, archived
Delegated to: akhil goyal
Headers
Series cryptodev: add missing doc |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/github-robot: build success github build: passed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS

Commit Message

Anoob Joseph Sept. 7, 2023, 1 p.m. UTC 
  Description for rte_cryptodev_get_sec_ctx is missing. Add the same.

Signed-off-by: Anoob Joseph <anoobj@marvell.com>
---
 lib/cryptodev/rte_cryptodev.h | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

Thomas Monjalon Sept. 11, 2023, 10:15 a.m. UTC | #1 
07/09/2023 15:00, Anoob Joseph:
> Description for rte_cryptodev_get_sec_ctx is missing. Add the same.
> 
> Signed-off-by: Anoob Joseph <anoobj@marvell.com>

Looks like a fix, please add "Fixes:" line.
diff mbox series

Patch

diff --git a/lib/cryptodev/rte_cryptodev.h b/lib/cryptodev/rte_cryptodev.h
index ba730373fb..8876e0427f 100644
--- a/lib/cryptodev/rte_cryptodev.h
+++ b/lib/cryptodev/rte_cryptodev.h
@@ -973,6 +973,15 @@  struct rte_cryptodev_cb_rcu {
 	/**< RCU QSBR variable per queue pair */
 };
 
+/**
+ * Get the security context for the cryptodev.
+ *
+ * @param dev_id
+ *   The device identifier.
+ * @return
+ *   - NULL on error.
+ *   - Pointer to security context on success.
+ */
 void *
 rte_cryptodev_get_sec_ctx(uint8_t dev_id);