From: Pablo de Lara Date: Wed, 26 Jul 2017 04:27:12 +0000 (+0100) Subject: cryptodev: fix doxygen comment of bulk alloc X-Git-Tag: spdx-start~2354 X-Git-Url: http://git.droids-corp.org/?p=dpdk.git;a=commitdiff_plain;h=15ed07656d0540ffe8552bda240fb922b55a1095 cryptodev: fix doxygen comment of bulk alloc When calling rte_crypto_op_bulk_alloc, the function may return either a 0, if not enough objects are available in the mempool or the number of operations requested, it there are enough available. However, the Doxygen comments were not matching these two cases. Fixes: c0f87eb5252b ("cryptodev: change burst API to be crypto op oriented") Cc: stable@dpdk.org Signed-off-by: Pablo de Lara Acked-by: Fiona Trahe --- diff --git a/lib/librte_cryptodev/rte_crypto.h b/lib/librte_cryptodev/rte_crypto.h index 09083687d1..10fe0804b2 100644 --- a/lib/librte_cryptodev/rte_crypto.h +++ b/lib/librte_cryptodev/rte_crypto.h @@ -266,8 +266,9 @@ rte_crypto_op_alloc(struct rte_mempool *mempool, enum rte_crypto_op_type type) * @param nb_ops Number of crypto operations to allocate * * @returns - * - On success returns a valid rte_crypto_op structure - * - On failure returns NULL + * - nb_ops if the number of operations requested were allocated. + * - 0 if the requested number of ops are not available. + * None are allocated in this case. */ static inline unsigned