lib/compress: fix incorrect structure comment

Message ID 1543331424-53895-1-git-send-email-lee.daly@intel.com (mailing list archive)
State Accepted, archived
Delegated to: akhil goyal
Headers
Series lib/compress: fix incorrect structure comment |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/intel-Performance-Testing success Performance Testing PASS

Commit Message

Daly, Lee Nov. 27, 2018, 3:10 p.m. UTC
  Fixes incorrect comment on compressdev rte_comp_op structure element.
Comment needed to be updated to be compliant with the use of
chained mbufs.

Fixes: f87bdc1ddcf4 ("compressdev: add compression specific data")
Cc: stable@dpdk.org
Cc: fiona.trahe@intel.com

Signed-off-by: Lee Daly <lee.daly@intel.com>
---
 lib/librte_compressdev/rte_comp.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
  

Comments

Fiona Trahe Nov. 27, 2018, 3:17 p.m. UTC | #1
> -----Original Message-----
> From: Daly, Lee
> Sent: Tuesday, November 27, 2018 8:10 AM
> To: Trahe, Fiona <fiona.trahe@intel.com>
> Cc: dev@dpdk.org; Daly, Lee <lee.daly@intel.com>; stable@dpdk.org
> Subject: [PATCH] lib/compress: fix incorrect structure comment
> 
> Fixes incorrect comment on compressdev rte_comp_op structure element.
> Comment needed to be updated to be compliant with the use of
> chained mbufs.
> 
> Fixes: f87bdc1ddcf4 ("compressdev: add compression specific data")
> Cc: stable@dpdk.org
> Cc: fiona.trahe@intel.com
> 
> Signed-off-by: Lee Daly <lee.daly@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
  
Akhil Goyal Dec. 18, 2018, 10:22 a.m. UTC | #2
On 11/27/2018 8:47 PM, Trahe, Fiona wrote:
>
>> -----Original Message-----
>> From: Daly, Lee
>> Sent: Tuesday, November 27, 2018 8:10 AM
>> To: Trahe, Fiona <fiona.trahe@intel.com>
>> Cc: dev@dpdk.org; Daly, Lee <lee.daly@intel.com>; stable@dpdk.org
>> Subject: [PATCH] lib/compress: fix incorrect structure comment
>>
>> Fixes incorrect comment on compressdev rte_comp_op structure element.
>> Comment needed to be updated to be compliant with the use of
>> chained mbufs.
>>
>> Fixes: f87bdc1ddcf4 ("compressdev: add compression specific data")
>> Cc: stable@dpdk.org
>> Cc: fiona.trahe@intel.com
>>
>> Signed-off-by: Lee Daly <lee.daly@intel.com>
> Acked-by: Fiona Trahe <fiona.trahe@intel.com>
>
Applied to dpdk-next-crypto

Thanks
  

Patch

diff --git a/lib/librte_compressdev/rte_comp.h b/lib/librte_compressdev/rte_comp.h
index 395ce29..ea306d5 100644
--- a/lib/librte_compressdev/rte_comp.h
+++ b/lib/librte_compressdev/rte_comp.h
@@ -310,7 +310,7 @@  struct rte_comp_op {
 	struct rte_mbuf *m_src;
 	/**< source mbuf
 	 * The total size of the input buffer(s) can be retrieved using
-	 * rte_pktmbuf_data_len(m_src). The max data size which can fit in a
+	 * rte_pktmbuf_pkt_len(m_src). The max data size which can fit in a
 	 * single mbuf is limited by the uint16_t rte_mbuf.data_len to 64k-1.
 	 * If the input data is bigger than this it can be passed to the PMD in
 	 * a chain of mbufs if the PMD's capabilities indicate it supports this.
@@ -318,7 +318,7 @@  struct rte_comp_op {
 	struct rte_mbuf *m_dst;
 	/**< destination mbuf
 	 * The total size of the output buffer(s) can be retrieved using
-	 * rte_pktmbuf_data_len(m_dst). The max data size which can fit in a
+	 * rte_pktmbuf_pkt_len(m_dst). The max data size which can fit in a
 	 * single mbuf is limited by the uint16_t rte_mbuf.data_len to 64k-1.
 	 * If the output data is expected to be bigger than this a chain of
 	 * mbufs can be passed to the PMD if the PMD's capabilities indicate