From: Siobhan Butler <siobhan.a.butler@intel.com>
Date: Thu, 18 Dec 2014 15:48:47 +0000 (+0000)
Subject: doc: updating to 1.8 release note
X-Git-Tag: spdx-start~9863
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=5ef25d82fd0b165b4d7fb368965d40be9e8416a4;p=dpdk.git

doc: updating to 1.8 release note

Added instructions for updating from DPDK 1.7.0 to 1.8.0

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
---

diff --git a/doc/guides/rel_notes/updating_apps.rst b/doc/guides/rel_notes/updating_apps.rst
index 034554d806..4dbf26847f 100644
--- a/doc/guides/rel_notes/updating_apps.rst
+++ b/doc/guides/rel_notes/updating_apps.rst
@@ -7,6 +7,19 @@ may require some code updates to benefit from performance and user experience en
 DPDK 1.7 to DPDK 1.8
 --------------------
 
+Note that in DPDK 1.8, the structure of the rte_mbuf has changed considerably from all previous versions.
+It is recommended that users familiarize themselves with the new structure defined in the file rte_mbuf.h in the release package.
+The follow are some common changes that need to be made to code using mbufs, following an update to DPDK 1.8:
+
+*   Any references to fields in the pkt or ctrl sub-structures of the mbuf, need to be replaced with references to the field
+    directly from the rte_mbuf, i.e. buf->pkt.data_len should be replace by buf->data_len.
+
+*   Any direct references to the data field of the mbuf (original buf->pkt.data) should now be replace by the macro rte_pktmbuf_mtod
+    to get a computed data address inside the mbuf buffer area.
+
+*   Any references to the in_port mbuf field should be replace by references to the port field.
+
+NOTE: The above list is not exhaustive, but only includes the most commonly required changes to code using mbufs.
 
 Intel® DPDK 1.6 to DPDK 1.7
 ---------------------------