[dpdk-dev] [PATCH 1/2] rte_kni: Fix documentation.

[Ferruh Yigit]

On 5/14/2016 7:22 PM, Alex Wang wrote:
> From: Alex Wang <alex at awakenetworks.com>
> 
> The 'mbufs' alloc/free descriptions for 'rte_kni_tx_burst()'
> and 'rte_kni_rx_burst()' should be inverted.
> 
> Signed-off-by: Alex Wang <alex at awakenetworks.com>
> ---
>  lib/librte_kni/rte_kni.h | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> 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.
> 

Hi Alex,

Can you please update the patch subject,
- replace "rte_kni" tag with a "kni",
- after space start with lowercase,
- remove the "." at the end of the sentences,
like:
"kni: fix documentation"
(these are defined in
http://dpdk.org/doc/guides/contributing/patches.html#commit-messages-subject-line)

Also can you please add a "Fixes" line, more details on:
http://dpdk.org/doc/guides/contributing/patches.html#commit-messages-body

Although this information converted into documentation, this is not
really the documentation, and the patch title gives little information,
if possible can you please add more information while keeping it around
50 chars limit.

finally, patch content is OK.

Thanks,
ferruh