drivers: add warning note to base dirs

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>
This commit is contained in:
John McNamara 2015-06-10 18:08:47 +01:00 committed by Thomas Monjalon
parent 0e03fe7459
commit eebeb3f60b
3 changed files with 19 additions and 23 deletions

View File

@ -33,7 +33,12 @@
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

View 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
===============
Updating the driver
===================
The following modifications have been made to this code to integrate it with the
Intel® DPDK:
NOTE: The source code in this directory should not be modified apart from
the following file(s):
ixgbe_osdep.h
-------------
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

View 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