From mboxrd@z Thu Jan 1 00:00:00 1970 From: John McNamara Subject: =?utf-8?q?=5BPATCH_2/2=5D_drivers=3A_add_warning_note_?= =?utf-8?q?to_base_dirs_readme?= Date: Wed, 10 Jun 2015 18:08:47 +0100 Message-ID: <1433956127-9813-3-git-send-email-john.mcnamara@intel.com> References: <1433956127-9813-1-git-send-email-john.mcnamara@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable To: dev@dpdk.org Return-path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id EC2C5C300 for ; Wed, 10 Jun 2015 19:08:59 +0200 (CEST) In-Reply-To: <1433956127-9813-1-git-send-email-john.mcnamara@intel.com> List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" This patch adds a note to the README files in the drivers/net/pmd/base dirs to highlight that the code should not be modifed by the user apart from the pmd_osdep.[ch] files. Signed-off-by: John McNamara --- drivers/net/e1000/base/README | 13 +++++++++---- drivers/net/ixgbe/base/README | 16 +++++----------- drivers/net/vmxnet3/base/README | 13 +++++-------- 3 files changed, 19 insertions(+), 23 deletions(-) diff --git a/drivers/net/e1000/base/README b/drivers/net/e1000/base/READM= E index 851e54e..59275b6 100644 --- a/drivers/net/e1000/base/README +++ b/drivers/net/e1000/base/README @@ -33,7 +33,12 @@ This directory contains source code of FreeBSD em & igb drivers of versi= on cid-shared-code.2014.04.21 released by LAD. The sub-directory of lad/ contains the original source package. -Few changes to the original FreeBSD sources were made to: -- Adopt it for PMD usage mode: - e1000_osdep.c - e1000_osdep.h + +Updating the driver +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +NOTE: The source code in this directory should not be modified apart fro= m +the following file(s): + + e1000_osdep.c + e1000_osdep.h diff --git a/drivers/net/ixgbe/base/README b/drivers/net/ixgbe/base/READM= E index ba1249b..b629dc8 100644 --- a/drivers/net/ixgbe/base/README +++ b/drivers/net/ixgbe/base/README @@ -52,16 +52,10 @@ This driver is valid for the product(s) listed below * Intel=C2=AE Ethernet Server Adapter X520-T2 * Intel=C2=AE Ethernet Controller X550-BT2 =20 -Updating driver -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D - -The following modifications have been made to this code to integrate it = with the -Intel=C2=AE DPDK: - +Updating the driver +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -ixgbe_osdep.h -------------- +NOTE: The source code in this directory should not be modified apart fro= m +the following file(s): =20 -The OS dependency layer has been extensively modified to support the dri= vers in -the Intel=C2=AE DPDK environment. It is expected that these files will n= ot need to be -changed on updating the driver. + ixgbe_osdep.h diff --git a/drivers/net/vmxnet3/base/README b/drivers/net/vmxnet3/base/R= EADME index f13fec7..599a366 100644 --- a/drivers/net/vmxnet3/base/README +++ b/drivers/net/vmxnet3/base/README @@ -38,13 +38,10 @@ In which, upt1_defs.h and vmxnet3_defs.h is introduce= d without any change. The other 4 files: includeCheck.h, vmware_pack_begin.h, vmware_pack_end.= h and vmxnet3_osdep.h are crated to adapt to the needs from above 2 files. =20 -Updating driver -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D - -The following modifications have been made to this code to integrate it = with the -Intel DPDK: - - -------------- +Updating the driver +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 +NOTE: The source code in this directory should not be modified apart fro= m +the following file(s): =20 + vmxnet3_osdep.h --=20 1.8.1.4