[PATCH 0/2] doc: update to release notes

[PATCH 0/2] doc: update to release notes

[Siobhan Butler]

Update to release notes to add VXLAN features.
Added 1.8 to 'updating apps' section of release notes. 

Siobhan Butler (2):
  doc: add vxlan support to release notes
  doc: updating from 1.7 to 1.8 release note

 doc/guides/rel_notes/new_features.rst       |  2 ++
 doc/guides/rel_notes/supported_features.rst |  5 +++++
 doc/guides/rel_notes/updating_apps.rst      | 29 +++++++++++++++++++++++------
 3 files changed, 30 insertions(+), 6 deletions(-)

-- 
1.9.4.msysgit.2

[PATCH 1/2] doc: add vxlan support to release notes

[Siobhan Butler]

Added to New and Supported features for VXLAN feature.

Signed-off-by: Siobhan Butler <siobhan.a.butler-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
 doc/guides/rel_notes/new_features.rst       | 2 ++
 doc/guides/rel_notes/supported_features.rst | 5 +++++
 2 files changed, 7 insertions(+)

diff --git a/doc/guides/rel_notes/new_features.rst b/doc/guides/rel_notes/new_features.rst
index 568d0c9..9c6ba51 100644
--- a/doc/guides/rel_notes/new_features.rst
+++ b/doc/guides/rel_notes/new_features.rst
@@ -49,4 +49,6 @@ New Features
 
 *   Support NIC filters in addition to flow director for Intel® 1GbE and 10GbE Controllers
 
+*   Support for VXLAN packet on Intel(R) 40GbE Controllers
+
 For further features supported in this release, see Chapter 3 Supported Features.
diff --git a/doc/guides/rel_notes/supported_features.rst b/doc/guides/rel_notes/supported_features.rst
index c51eb26..510d489 100644
--- a/doc/guides/rel_notes/supported_features.rst
+++ b/doc/guides/rel_notes/supported_features.rst
@@ -360,3 +360,8 @@ Supported Features
     *   Exact match flow classification in the L3 Forwarding sample application
 
     *   Support in LPM for IPv6 addresses
+
+* Tunneling packet support:
+
+    *   Provide the APIs for VXLAN destination UDP port and VXLAN packet filter configuration
+        and support VXLAN TX checksum offload on Intel(R) 40GbE Controllers.
-- 
1.9.4.msysgit.2

Re: [PATCH 1/2] doc: add vxlan support to release notes

[Iremonger, Bernard]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Siobhan Butler
> Sent: Thursday, December 18, 2014 2:52 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH 1/2] doc: add vxlan support to release notes
> 
> Added to New and Supported features for VXLAN feature.
> 
> Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>

Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>

 I have applied the patch to my tree next/dpdk-doc.

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

[Siobhan Butler]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=UTF-8, Size: 3707 bytes --]

Added instructions for updating from DPDK 1.7.0 to 1.8.0

Signed-off-by: Siobhan Butler <siobhan.a.butler-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Signed-off-by: Bruce Richardson <bruce.richardson-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
 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

Re: [PATCH 2/2] doc: updating from 1.7 to 1.8 release note

[Iremonger, Bernard]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Siobhan Butler
> Sent: Thursday, December 18, 2014 2:52 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH 2/2] doc: updating from 1.7 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>

 I have applied the patch to my tree next/dpdk-doc.

[PATCH v2 0/2] doc: update to release notes

[Pablo de Lara]

Update to release notes to add VXLAN features.
Added 1.8 to 'updating apps' section of release notes. 

Changes to v2:
Rebase to latest document

Siobhan Butler (2):
  doc: add vxlan support to release notes
  doc: updating from 1.7 to 1.8 release note

 doc/guides/rel_notes/new_features.rst       |  2 ++
 doc/guides/rel_notes/supported_features.rst |  5 +++++
 doc/guides/rel_notes/updating_apps.rst      | 13 +++++++++++++
 3 files changed, 20 insertions(+)

-- 
2.1.0

[PATCH v2 1/2] doc: add vxlan support to release notes

[Pablo de Lara]

From: Siobhan Butler <siobhan.a.butler-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Added to New and Supported features for VXLAN feature.

Signed-off-by: Siobhan Butler <siobhan.a.butler-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
 doc/guides/rel_notes/new_features.rst       | 2 ++
 doc/guides/rel_notes/supported_features.rst | 5 +++++
 2 files changed, 7 insertions(+)

diff --git a/doc/guides/rel_notes/new_features.rst b/doc/guides/rel_notes/new_features.rst
index 00895ce..2c37af7 100644
--- a/doc/guides/rel_notes/new_features.rst
+++ b/doc/guides/rel_notes/new_features.rst
@@ -54,6 +54,8 @@ New Features
 
     *   Support configuring hash functions
 
+    *   Support for VXLAN packet on Intel(R) 40GbE Controllers
+
 *   Packet Distributor Sample Application
 
 For further features supported in this release, see Chapter 3 Supported Features.
diff --git a/doc/guides/rel_notes/supported_features.rst b/doc/guides/rel_notes/supported_features.rst
index 37e5416..e683ead 100644
--- a/doc/guides/rel_notes/supported_features.rst
+++ b/doc/guides/rel_notes/supported_features.rst
@@ -382,3 +382,8 @@ Supported Features
     *   Exact match flow classification in the L3 Forwarding sample application
 
     *   Support in LPM for IPv6 addresses
+
+* Tunneling packet support:
+
+    *   Provide the APIs for VXLAN destination UDP port and VXLAN packet filter configuration
+        and support VXLAN TX checksum offload on Intel(R) 40GbE Controllers.
-- 
2.1.0

[PATCH v2 2/2] doc: updating from 1.7 to 1.8 release note

[Pablo de Lara]

From: Siobhan Butler <siobhan.a.butler-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Added instructions for updating from DPDK 1.7.0 to 1.8.0

Signed-off-by: Siobhan Butler <siobhan.a.butler-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Signed-off-by: Bruce Richardson <bruce.richardson-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
 doc/guides/rel_notes/updating_apps.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/doc/guides/rel_notes/updating_apps.rst b/doc/guides/rel_notes/updating_apps.rst
index 034554d..4dbf268 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
 ---------------------------
-- 
2.1.0