drivers: add warning note to base dirs
authorJohn McNamara <john.mcnamara@intel.com>
Wed, 10 Jun 2015 17:08:47 +0000 (18:08 +0100)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Mon, 10 Aug 2015 22:22:41 +0000 (00:22 +0200)
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 <john.mcnamara@intel.com>
drivers/net/e1000/base/README
drivers/net/ixgbe/base/README
drivers/net/vmxnet3/base/README

index 851e54e..59275b6 100644 (file)
 This directory contains source code of FreeBSD em & igb drivers of version
 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
+===================
+
+NOTE: The source code in this directory should not be modified apart from
+the following file(s):
+
+    e1000_osdep.c
+    e1000_osdep.h
index ac38708..cec48a6 100644 (file)
@@ -52,16 +52,10 @@ This driver is valid for the product(s) listed below
 * Intel® Ethernet Server Adapter X520-T2
 * Intel® Ethernet Controller X550-BT2
 
-Updating driver
-===============
-
-The following modifications have been made to this code to integrate it with the
-Intel® DPDK:
-
+Updating the driver
+===================
 
-ixgbe_osdep.h
--------------
+NOTE: The source code in this directory should not be modified apart from
+the following file(s):
 
-The OS dependency layer has been extensively modified to support the drivers in
-the Intel® DPDK environment. It is expected that these files will not need to be
-changed on updating the driver.
+    ixgbe_osdep.h
index f13fec7..599a366 100644 (file)
@@ -38,13 +38,10 @@ In which, upt1_defs.h and vmxnet3_defs.h is introduced 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.
 
-Updating driver
-===============
-
-The following modifications have been made to this code to integrate it with the
-Intel DPDK:
-
-
--------------
+Updating the driver
+===================
 
+NOTE: The source code in this directory should not be modified apart from
+the following file(s):
 
+    vmxnet3_osdep.h