[dpdk-dev] [PATCH v2] ethdev: fix comments for offload capabilities

[Andrew Rybchenko]

On 05/09/2018 03:32 PM, Wei Dai wrote:
> Indeed, rx_offload_capa or tx_offload_capa  in struct rte_eth_dev_info
> includes not only per port offloading features but also per queue ones.
> This patch make its meaning much clearer.
>
> Fixes: ce17eddefc20 ("ethdev: introduce Rx queue offloads API")
> Fixes: cba7f53b717d ("ethdev: introduce Tx queue offloads API")
> Cc: stable at dpdk.org
>
> Signed-off-by: Wei Dai <wei.dai at intel.com>
>
> ---
> v2: fix coding style issues
> ---
>   lib/librte_ethdev/rte_ethdev.h | 8 ++++++--
>   1 file changed, 6 insertions(+), 2 deletions(-)
>
> diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
> index 7ccf4ba..98e3114 100644
> --- a/lib/librte_ethdev/rte_ethdev.h
> +++ b/lib/librte_ethdev/rte_ethdev.h
> @@ -1067,9 +1067,13 @@ struct rte_eth_dev_info {
>   	uint16_t max_vfs; /**< Maximum number of VFs. */
>   	uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
>   	uint64_t rx_offload_capa;
> -	/**< Device per port RX offload capabilities. */
> +	/**< Rx offload capabilities including all per port ones
> +	 * and all per queue ones.
> +	 */
>   	uint64_t tx_offload_capa;
> -	/**< Device per port TX offload capabilities. */
> +	/**< Tx offload capabilities including all per port ones
> +	 * and all per queue ones.
> +	 */
>   	uint64_t rx_queue_offload_capa;
>   	/**< Device per queue RX offload capabilities. */
>   	uint64_t tx_queue_offload_capa;

Just a minor nit.
May I suggest to put comments before structure member and use /**.
Right now it looks very confusing.

Andrew.