[dpdk-dev,1/2,v2] kni: fix inverted function comments

Message ID 1463815522-27916-1-git-send-email-ee07b291@gmail.com (mailing list archive)
State Superseded, archived
Headers

Commit Message

ALeX Wang May 21, 2016, 7:25 a.m. UTC
  From: Alex Wang <alex@awakenetworks.com>

The 'mbufs' alloc/free descriptions for
'rte_kni_tx_burst()' and 'rte_kni_rx_burst()'
should be inverted.

Fixes: 3fc5ca2 (kni: initial import)

Signed-off-by: Alex Wang <alex@awakenetworks.com>
---
 lib/librte_kni/rte_kni.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
  

Comments

Ferruh Yigit May 23, 2016, 5 p.m. UTC | #1
On 5/21/2016 8:25 AM, Alex Wang wrote:
> From: Alex Wang <alex@awakenetworks.com>
> 
> The 'mbufs' alloc/free descriptions for
> 'rte_kni_tx_burst()' and 'rte_kni_rx_burst()'
> should be inverted.
> 
> Fixes: 3fc5ca2 (kni: initial import)
> 
> Signed-off-by: Alex Wang <alex@awakenetworks.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
  

Patch

diff --git a/lib/librte_kni/rte_kni.h b/lib/librte_kni/rte_kni.h
index ef9faa9..25fa45e 100644
--- a/lib/librte_kni/rte_kni.h
+++ b/lib/librte_kni/rte_kni.h
@@ -161,8 +161,8 @@  extern int rte_kni_handle_request(struct rte_kni *kni);
 /**
  * Retrieve a burst of packets from a KNI interface. The retrieved packets are
  * stored in rte_mbuf structures whose pointers are supplied in the array of
- * mbufs, and the maximum number is indicated by num. It handles the freeing of
- * the mbufs in the free queue of KNI interface.
+ * mbufs, and the maximum number is indicated by num. It handles allocating
+ * the mbufs for KNI interface alloc queue.
  *
  * @param kni
  *  The KNI interface context.
@@ -180,8 +180,8 @@  extern unsigned rte_kni_rx_burst(struct rte_kni *kni,
 /**
  * Send a burst of packets to a KNI interface. The packets to be sent out are
  * stored in rte_mbuf structures whose pointers are supplied in the array of
- * mbufs, and the maximum number is indicated by num. It handles allocating
- * the mbufs for KNI interface alloc queue.
+ * mbufs, and the maximum number is indicated by num. It handles the freeing of
+ * the mbufs in the free queue of KNI interface.
  *
  * @param kni
  *  The KNI interface context.