From mboxrd@z Thu Jan 1 00:00:00 1970 From: John McNamara Subject: [PATCH 0/2] docs: add warning note to base dirs readme Date: Wed, 10 Jun 2015 18:08:45 +0100 Message-ID: <1433956127-9813-1-git-send-email-john.mcnamara@intel.com> To: dev@dpdk.org Return-path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 5EF09902 for ; Wed, 10 Jun 2015 19:08:51 +0200 (CEST) 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 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