From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <jmcnam2x@ecsmtp.ir.intel.com>
Received: from mga09.intel.com (mga09.intel.com [134.134.136.24])
by dpdk.org (Postfix) with ESMTP id 5EF09902
for <dev@dpdk.org>; Wed, 10 Jun 2015 19:08:51 +0200 (CEST)
Received: from orsmga003.jf.intel.com ([10.7.209.27])
by orsmga102.jf.intel.com with ESMTP; 10 Jun 2015 10:08:50 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.13,588,1427785200"; d="scan'208";a="585501164"
Received: from irvmail001.ir.intel.com ([163.33.26.43])
by orsmga003.jf.intel.com with ESMTP; 10 Jun 2015 10:08:49 -0700
Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com
[10.237.217.46])
by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id
t5AH8mmv026787; Wed, 10 Jun 2015 18:08:48 +0100
Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1])
by sivswdev02.ir.intel.com with ESMTP id t5AH8mhD009848;
Wed, 10 Jun 2015 18:08:48 +0100
Received: (from jmcnam2x@localhost)
by sivswdev02.ir.intel.com with id t5AH8m2J009844;
Wed, 10 Jun 2015 18:08:48 +0100
From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Date: Wed, 10 Jun 2015 18:08:45 +0100
Message-Id: <1433956127-9813-1-git-send-email-john.mcnamara@intel.com>
X-Mailer: git-send-email 1.7.4.1
Subject: [dpdk-dev] [PATCH 0/2] docs: add warning note to base dirs readme
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 10 Jun 2015 17:08:51 -0000
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