[dpdk-dev] [PATCH v2] doc: announce removal of indirect mbuf check macro

[Andrew Rybchenko]

On 05/25/2018 04:20 AM, Yongseok Koh wrote:
> Link: http://dpdk.org/ml/archives/dev/2018-April/099476.html
>
> Signed-off-by: Yongseok Koh <yskoh at mellanox.com>
> ---
>
> v2:
> * modify removal deadline and add more comments in the deprecation note
> * mark deprecation on the comment of the macro in rte_mbuf.h
>
>   doc/guides/rel_notes/deprecation.rst | 7 +++++++
>   lib/librte_mbuf/rte_mbuf.h           | 3 ++-
>   2 files changed, 9 insertions(+), 1 deletion(-)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 1e2443c76..e1630c2cf 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -42,6 +42,13 @@ Deprecation Notices
>     is defined in librte_sched in a non-generic way. The new generic format
>     will contain: queue ID, traffic class, color. Field size will not change.
>   
> +* mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
> +  replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
> +  ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
> +  can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new
> +  experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro
> +  is to fix this semantic inconsistency.
> +
>   * ethdev: a new Tx and Rx offload API was introduced on 17.11.
>     In the new API, offloads are divided into per-port and per-queue offloads.
>     Offloads are disabled by default and enabled per application request.
> diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h
> index e136d12b7..8e6b4d292 100644
> --- a/lib/librte_mbuf/rte_mbuf.h
> +++ b/lib/librte_mbuf/rte_mbuf.h
> @@ -738,7 +738,8 @@ rte_mbuf_to_baddr(struct rte_mbuf *md)
>   #define RTE_MBUF_CLONED(mb)     ((mb)->ol_flags & IND_ATTACHED_MBUF)
>   
>   /**
> - * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
> + * Deprecated.
> + * Use RTE_MBUF_CLONED().
>    */
>   #define RTE_MBUF_INDIRECT(mb)   RTE_MBUF_CLONED(mb)
>   

Acked-by: Andrew Rybchenko <arybchenko at solarflare.com>