From: "Trahe, Fiona" <fiona.trahe@intel.com>
To: "De Lara Guarch, Pablo" <pablo.de.lara.guarch@intel.com>,
"Doherty, Declan" <declan.doherty@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>,
"De Lara Guarch, Pablo" <pablo.de.lara.guarch@intel.com>,
"stable@dpdk.org" <stable@dpdk.org>,
"Trahe, Fiona" <fiona.trahe@intel.com>
Subject: Re: [dpdk-dev] [PATCH] cryptodev: fix crypto op bulk alloc Doxygen
Date: Thu, 27 Jul 2017 09:03:08 +0000 [thread overview]
Message-ID: <348A99DA5F5B7549AA880327E580B4358923CF56@IRSMSX101.ger.corp.intel.com> (raw)
In-Reply-To: <20170726042712.8355-1-pablo.de.lara.guarch@intel.com>
Hi Pablo,
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Pablo de Lara
> Sent: Wednesday, July 26, 2017 5:27 AM
> To: Doherty, Declan <declan.doherty@intel.com>
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; stable@dpdk.org
> Subject: [dpdk-dev] [PATCH] cryptodev: fix crypto op bulk alloc Doxygen
>
> 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 <pablo.de.lara.guarch@intel.com>
> ---
> lib/librte_cryptodev/rte_crypto.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/lib/librte_cryptodev/rte_crypto.h b/lib/librte_cryptodev/rte_crypto.h
> index 0908368..9f10818 100644
> --- a/lib/librte_cryptodev/rte_crypto.h
> +++ b/lib/librte_cryptodev/rte_crypto.h
> @@ -266,8 +266,8 @@ 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
> + * - 0 if no operations could be allocated
> + * - nb_ops if the number of operations requested were allocated
> */
>
My first thought was what's returned if some ops could be allocated, but not the requested number?
Maybe instead:
- 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
> --
> 2.9.4
next prev parent reply other threads:[~2017-07-27 9:03 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-07-26 4:27 Pablo de Lara
2017-07-27 9:03 ` Trahe, Fiona [this message]
2017-07-27 15:57 ` De Lara Guarch, Pablo
2017-07-27 16:05 ` [dpdk-dev] [PATCH v2] " Pablo de Lara
2017-07-27 16:16 ` Trahe, Fiona
2017-07-27 18:49 ` De Lara Guarch, Pablo
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=348A99DA5F5B7549AA880327E580B4358923CF56@IRSMSX101.ger.corp.intel.com \
--to=fiona.trahe@intel.com \
--cc=declan.doherty@intel.com \
--cc=dev@dpdk.org \
--cc=pablo.de.lara.guarch@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).