[dpdk-dev,v3] doc: announce ABI changes planned for unified packet type
Commit Message
The significant ABI changes of all shared libraries are planned to
support unified packet type which will be taken effect from
release 2.2. Here announces that ABI changes in detail.
Signed-off-by: Helin Zhang <helin.zhang@intel.com>
---
doc/guides/rel_notes/abi.rst | 1 +
1 file changed, 1 insertion(+)
v2 changes:
* Added 'struct rte_kni_mbuf' to the ABI change announcement.
v3 changes:
* Re-worded the ABI change announcement, as the ABI changes will be
taken effect from release 2.1 for static libraries, and from
release 2.2 for shared libraries.
Comments
Hi Neil
Please review it and ack it, if no objections! Thank you very much in advance!
- Helin
> -----Original Message-----
> From: Zhang, Helin
> Sent: Tuesday, July 7, 2015 10:45 AM
> To: dev@dpdk.org
> Cc: Liu, Jijiang; Wu, Jingjing; nhorman@tuxdriver.com; Zhang, Helin
> Subject: [PATCH v3] doc: announce ABI changes planned for unified packet type
>
> The significant ABI changes of all shared libraries are planned to support unified
> packet type which will be taken effect from release 2.2. Here announces that ABI
> changes in detail.
>
> Signed-off-by: Helin Zhang <helin.zhang@intel.com>
> ---
> doc/guides/rel_notes/abi.rst | 1 +
> 1 file changed, 1 insertion(+)
>
> v2 changes:
> * Added 'struct rte_kni_mbuf' to the ABI change announcement.
>
> v3 changes:
> * Re-worded the ABI change announcement, as the ABI changes will be
> taken effect from release 2.1 for static libraries, and from
> release 2.2 for shared libraries.
>
> diff --git a/doc/guides/rel_notes/abi.rst b/doc/guides/rel_notes/abi.rst index
> 110c486..9f8a9b3 100644
> --- a/doc/guides/rel_notes/abi.rst
> +++ b/doc/guides/rel_notes/abi.rst
> @@ -12,3 +12,4 @@ Examples of Deprecation Notices
>
> Deprecation Notices
> -------------------
> +* Significant ABI changes are planned for struct rte_mbuf, struct rte_kni_mbuf,
> and several PKT_RX_ flags will be removed, to support unified packet type from
> release 2.1. The upcoming release 2.1 will have those changes for static libraries
> only, while have no change for shared libraries by default. Those changes will be
> taken effect for shared libraries from release 2.2. There is no backward
> compatibility planned from release 2.2. All binaries will need to be rebuilt from
> release 2.2.
> --
> 1.9.3
Acked-by: Jingjing Wu <jingjing.wu@intel.com>
> -----Original Message-----
> From: Zhang, Helin
> Sent: Wednesday, July 08, 2015 1:45 AM
> To: dev@dpdk.org
> Cc: Liu, Jijiang; Wu, Jingjing; nhorman@tuxdriver.com; Zhang, Helin
> Subject: [PATCH v3] doc: announce ABI changes planned for unified packet
> type
>
> The significant ABI changes of all shared libraries are planned to support
> unified packet type which will be taken effect from release 2.2. Here
> announces that ABI changes in detail.
>
> Signed-off-by: Helin Zhang <helin.zhang@intel.com>
> ---
> > The significant ABI changes of all shared libraries are planned to support
> > unified packet type which will be taken effect from release 2.2. Here
> > announces that ABI changes in detail.
> >
> > Signed-off-by: Helin Zhang <helin.zhang@intel.com>
> Acked-by: Jingjing Wu <jingjing.wu@intel.com>
Applied with rewording to take new NEXT_ABI option into account.
@@ -12,3 +12,4 @@ Examples of Deprecation Notices
Deprecation Notices
-------------------
+* Significant ABI changes are planned for struct rte_mbuf, struct rte_kni_mbuf, and several PKT_RX_ flags will be removed, to support unified packet type from release 2.1. The upcoming release 2.1 will have those changes for static libraries only, while have no change for shared libraries by default. Those changes will be taken effect for shared libraries from release 2.2. There is no backward compatibility planned from release 2.2. All binaries will need to be rebuilt from release 2.2.