[dpdk-dev] [PATCH v4] mbuf: minor cleanup

[Olivier Matz]

On Mon, Oct 26, 2020 at 03:42:01PM +0100, Morten Brørup wrote:
> The mbuf header files had some commenting style errors that affected the
> API documentation.
> Also, the RTE_ prefix was missing on a macro and a definition.
> 
> Note: This patch does not touch the offload and attachment flags that are
> also missing the RTE_ prefix.
> 
> Changes only affecting documentation:
> * Removed the MBUF_INVALID_PORT definition from rte_mbuf.h; it is
>   already defined in rte_mbuf_core.h.
>   This removal also reestablished the description of the
>   rte_pktmbuf_reset() function.
> * Corrected the comment related to RTE_MBUF_MAX_NB_SEGS.
> * Corrected the comment related to PKT_TX_QINQ_PKT.
> 
> Changes regarding missing RTE_ prefix:
> * Converted the MBUF_RAW_ALLOC_CHECK() macro to an
>   __rte_mbuf_raw_sanity_check() inline function.
>   Added backwards compatible macro with the original name.
> * Renamed the MBUF_INVALID_PORT definition to RTE_MBUF_PORT_INVALID.
>   Added backwards compatible definition with the original name.
> 
> v2:
> * Use RTE_MBUF_PORT_INVALID instead of MBUF_INVALID_PORT in rte_mbuf.c.
> 
> v3:
> * The functions/macros used in __rte_mbuf_raw_sanity_check() require
>   RTE_ENABLE_ASSERT or RTE_LIBRTE_MBUF_DEBUG, or they don't use the mbuf
>   parameter, which generates a compiler waning. So mark the mbuf parameter
>   __rte_unused if none of them are defined.
> 
> v4:
> * Removed compile time variants of __rte_mbuf_raw_sanity_check(); keeping
>   the one variant where the mbuf parameter is marked __rte_unused.
> * Reflect in the __rte_mbuf_raw_sanity_check() description headline that
>   it is for debug mode.
> * Improved the description of RTE_MBUF_PORT_INVALID.
> * Updated sfc driver to use __rte_mbuf_raw_sanity_check() instead of
>   MBUF_RAW_ALLOC_CHECK().
> 
> Signed-off-by: Morten Brørup <mb at smartsharesystems.com>

Acked-by: Olivier Matz <olivier.matz at 6wind.com>

Thanks!