[dpdk-dev] [PATCH 0/2] docs: add warning note to base dirs readme

John McNamara john.mcnamara at intel.com
Wed Jun 10 19:08:45 CEST 2015


This patch updates the "Source Organisation" section of the Programmers Guide
to add an note that the code in the drivers/net/pmd/base directories should
not be modifed by the user apart from the pmd_osdep.[ch] files.

It also adds a note to the README files in the drivers/net/pmd/base dirs to
highlight the same thing.

P.S. When reviewing documentation patches it is sometimes useful to apply them to a temp
branch and view the differences on a word or character level:

    git diff --color-words   HEAD~1
    git diff --color-words=. HEAD~1

John McNamara (2):
  doc: add explanation about code in the base dirs
  drivers: add warning note to base dirs readme

 doc/guides/prog_guide/source_org.rst | 124 +++++++++++++++++++----------------
 drivers/net/e1000/base/README        |  13 ++--
 drivers/net/ixgbe/base/README        |  16 ++---
 drivers/net/vmxnet3/base/README      |  13 ++--
 4 files changed, 87 insertions(+), 79 deletions(-)

--
1.8.1.4


More information about the dev mailing list