diff mbox series

compressdev: fix compression api description

Message ID 1538140468-15364-1-git-send-email-tomaszx.jozwiak@intel.com (mailing list archive)
State Accepted, archived
Delegated to: akhil goyal
Headers
Series compressdev: fix compression api description |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Tomasz Jozwiak Sept. 28, 2018, 1:14 p.m. UTC 
  This patch fixes description of API functions:
  -  rte_comp_op_raw_bulk_alloc
  -  rte_comp_op_bulk_alloc

Fixes: 96086db5a369 ("compressdev: add operation management")
Signed-off-by: Tomasz Jozwiak <tomaszx.jozwiak@intel.com>
---
 lib/librte_compressdev/rte_comp.c | 4 ++--
 lib/librte_compressdev/rte_comp.h | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

Comments

Fiona Trahe Oct. 1, 2018, 1:38 p.m. UTC | #1 
> -----Original Message-----
> From: Jozwiak, TomaszX
> Sent: Friday, September 28, 2018 2:14 PM
> To: dev@dpdk.org; Trahe, Fiona <fiona.trahe@intel.com>; Jozwiak, TomaszX
> <tomaszx.jozwiak@intel.com>; stable@dpdk.org; akhil.goyal@nxp.com
> Subject: [PATCH] compressdev: fix compression api description
> 
> This patch fixes description of API functions:
>   -  rte_comp_op_raw_bulk_alloc
>   -  rte_comp_op_bulk_alloc
> 
> Fixes: 96086db5a369 ("compressdev: add operation management")
> Signed-off-by: Tomasz Jozwiak <tomaszx.jozwiak@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
Akhil Goyal Oct. 1, 2018, 1:47 p.m. UTC | #2 
On 10/1/2018 7:08 PM, Trahe, Fiona wrote:
>
>> -----Original Message-----
>> From: Jozwiak, TomaszX
>> Sent: Friday, September 28, 2018 2:14 PM
>> To: dev@dpdk.org; Trahe, Fiona <fiona.trahe@intel.com>; Jozwiak, TomaszX
>> <tomaszx.jozwiak@intel.com>; stable@dpdk.org; akhil.goyal@nxp.com
>> Subject: [PATCH] compressdev: fix compression api description
>>
>> This patch fixes description of API functions:
>>    -  rte_comp_op_raw_bulk_alloc
>>    -  rte_comp_op_bulk_alloc
>>
>> Fixes: 96086db5a369 ("compressdev: add operation management")
>> Signed-off-by: Tomasz Jozwiak <tomaszx.jozwiak@intel.com>
> Acked-by: Fiona Trahe <fiona.trahe@intel.com>
Applied to dpdk-next-crypto

Thanks
diff mbox series

Patch

diff --git a/lib/librte_compressdev/rte_comp.c b/lib/librte_compressdev/rte_comp.c
index 98ad0cf..c663be5 100644
--- a/lib/librte_compressdev/rte_comp.c
+++ b/lib/librte_compressdev/rte_comp.c
@@ -83,8 +83,8 @@  struct rte_comp_op_pool_private {
  * @param nb_ops
  *   Number of operations to allocate
  * @return
- *   - 0: Success
- *   - -ENOENT: Not enough entries in the mempool; no ops are retrieved.
+ *   - nb_ops: Success, the nb_ops requested was allocated
+ *   - 0: Not enough entries in the mempool; no ops are retrieved.
  */
 static inline int
 rte_comp_op_raw_bulk_alloc(struct rte_mempool *mempool,
diff --git a/lib/librte_compressdev/rte_comp.h b/lib/librte_compressdev/rte_comp.h
index ee9056e..395ce29 100644
--- a/lib/librte_compressdev/rte_comp.h
+++ b/lib/librte_compressdev/rte_comp.h
@@ -448,8 +448,8 @@  rte_comp_op_alloc(struct rte_mempool *mempool);
  * @param nb_ops
  *   Number of operations to allocate
  * @return
- *   - 0: Success
- *   - -ENOENT: Not enough entries in the mempool; no ops are retrieved.
+ *   - nb_ops: Success, the nb_ops requested was allocated
+ *   - 0: Not enough entries in the mempool; no ops are retrieved.
  */
 int __rte_experimental
 rte_comp_op_bulk_alloc(struct rte_mempool *mempool,