[dpdk-dev] [PATCH 2/2] doc: updating from 1.7 to 1.8 release note

[Siobhan Butler]

Added instructions for updating from DPDK 1.7.0 to 1.8.0

Signed-off-by: Siobhan Butler <siobhan.a.butler at intel.com>

Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
---
 doc/guides/rel_notes/updating_apps.rst | 29 +++++++++++++++++++++++------
 1 file changed, 23 insertions(+), 6 deletions(-)

diff --git a/doc/guides/rel_notes/updating_apps.rst b/doc/guides/rel_notes/updating_apps.rst
index ba8012d..60d5d60 100644
--- a/doc/guides/rel_notes/updating_apps.rst
+++ b/doc/guides/rel_notes/updating_apps.rst
@@ -2,17 +2,34 @@ Updating Applications from Previous Versions
 ============================================
 
 Although backward compatibility is being maintained across Intel® DPDK releases, code written for previous versions of the Intel® DPDK
-may require some code updates to benefit from performance and user experience enhancements provided in later Intel® DPDK releases.
+may require some code updates to benefit from performance and user experience enhancements provided in later DPDK releases.
+
+Intel® 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 Intel® DPDK 1.7
-----------------------------------
+------------------------------------
 
 Note the following difference between 1.6 and 1.7:
 
 *   The "default" target has been renamed to "native"
 
 Intel® DPDK 1.5 to Intel® DPDK 1.6
-----------------------------------
+------------------------------------
 
 Note the following difference between 1.5 and 1.6:
 
@@ -21,7 +38,7 @@ Note the following difference between 1.5 and 1.6:
     Intel® DPDK release and documented in the *Intel® DPDK Getting Started Guide*.
 
 Intel® DPDK 1.4 to Intel® DPDK 1.5
-----------------------------------
+------------------------------------
 
 Note the following difference between 1.4 and 1.5:
 
@@ -29,7 +46,7 @@ Note the following difference between 1.4 and 1.5:
     that is, DPDK-1.5.2/ rather than just DPDK/ .
 
 Intel® DPDK 1.3 to Intel® DPDK 1.4.x
-------------------------------------
+--------------------------------------
 
 Note the following difference between releases 1.3 and 1.4.x:
 
@@ -50,7 +67,7 @@ Note the following difference between releases 1.3 and 1.4.x:
     For more details on this and how to re-enable the HPET if it is needed, please consult the *Intel® DPDK Getting Started Guide*.
 
 Intel® DPDK 1.2 to Intel® DPDK 1.3
-----------------------------------
+------------------------------------
 
 Note the following difference between releases 1.2 and 1.3:
 
-- 
1.9.4.msysgit.2